Class: Lol::LeagueRequest

Inherits:
Request
  • Object
show all
Defined in:
lib/lol/league_request.rb

Instance Attribute Summary

Attributes inherited from Request

#api_key, #cache_store, #region

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Request

#api_base_url, #api_query_string, #api_url, #cached?, #clean_url, #initialize, #perform_request, #post_api_url, #store, #ttl

Constructor Details

This class inherits a constructor from Lol::Request

Class Method Details

.api_version ⇒ String

Returns the supported API Version

Returns:

  • (String) —

    the supported api version



5
6
7
 
# File 'lib/lol/league_request.rb', line 5

def self.api_version
  "v2.5"
end

Instance Method Details

#by_team(*team_ids) ⇒ Object

Retrieves leagues data for team

Parameters:

  • (Array<String>) 


27
28
29
 
# File 'lib/lol/league_request.rb', line 27

def by_team(*team_ids)
  perform_league_request("league/by-team/#{team_ids.join(',')}")
end

#challenger(game_queue_type = "RANKED_SOLO_5x5") ⇒ League

Retrieves challenger tier leagues

Parameters:

  • game (String) —

    queue type

Returns:



42
43
44
45
 
# File 'lib/lol/league_request.rb', line 42

def challenger(game_queue_type="RANKED_SOLO_5x5")
  league_json = perform_request(api_url('league/challenger', { :type => game_queue_type }))
  League.new(league_json)
end

#entries_by_team(*team_ids) ⇒ Object

Retrieves leagues entry data for team TODO: Change name to?

Parameters:

  • (Array<String>) 


35
36
37
 
# File 'lib/lol/league_request.rb', line 35

def entries_by_team(*team_ids)
  perform_league_request("league/by-team/#{team_ids.join(',')}/entry")
end

#get(*summoner_ids) ⇒ Object

Retrieves leagues data for summoner, including leagues for all of summoner’s teams

Parameters:

  • (Array<String>) 


12
13
14
 
# File 'lib/lol/league_request.rb', line 12

def get(*summoner_ids)
  perform_league_request("league/by-summoner/#{summoner_ids.join(",")}")
end

#get_entries(*summoner_ids) ⇒ Object

Retrieves leagues entry data for summoner, including league entries for all of summoner’s teams TODO: Change name to entries?

Parameters:

  • (Array<String>) 


20
21
22
 
# File 'lib/lol/league_request.rb', line 20

def get_entries(*summoner_ids)
  perform_league_request("league/by-summoner/#{summoner_ids.join(',')}/entry")
end

#master(game_queue_type = "RANKED_SOLO_5x5") ⇒ Object 



47
48
49
50
 
# File 'lib/lol/league_request.rb', line 47

def master(game_queue_type="RANKED_SOLO_5x5")
  league_json = perform_request(api_url('league/master', { :type => game_queue_type }))
  League.new(league_json)
end