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_url, #cached?, #initialize, #perform_request, #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.3"
end

Instance Method Details

#by_team(team_id) ⇒ Array

Retrieves leagues data for team

Parameters:

  • (String)

Returns:

  • (Array) 


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

def by_team team_id
  perform_request(api_url("league/by-team/#{team_id}")).map { |l| League.new l }
end

#challenger ⇒ Array

Retrieves challenger tier leagues

Returns:

  • (Array) 


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

def challenger
  perform_request(api_url('league/challenger')).map { |l| League.new l }
end

#entries_by_team(team_id) ⇒ Array

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

Parameters:

  • (String)

Returns:

  • (Array) 


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

def entries_by_team team_id
  perform_request(api_url("league/by-team/#{team_id}/entry")).map { |e| LeagueEntry.new e }
end

#get(summoner_id) ⇒ Array

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

Parameters:

  • (String)

Returns:

  • (Array) 


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

def get summoner_id
  perform_request(api_url("league/by-summoner/#{summoner_id}")).map {|l| League.new l}
end

#get_entries(summoner_id) ⇒ Array

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

Parameters:

  • (String)

Returns:

  • (Array) 


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

def get_entries summoner_id
  perform_request(api_url("league/by-summoner/#{summoner_id}/entry")).map { |e| LeagueEntry.new e }
end