ruby-lol 0.12.2 → 1.0.0

data/.travis.yml

@@ -1,4 +1,4 @@
-rvm: 2.2.5
+rvm: 2.4
 services: redis-server
 addons:
     code_climate:

data/lib/lol/champion_mastery_request.rb

@@ -1,68 +1,40 @@
 module Lol
+  # Bindings for the Champion Mastery API.
+  #
+  # See: https://developer.riotgames.com/api-methods/#champion-mastery-v3
   class ChampionMasteryRequest < Request
-    # Returns the supported API Version. ChampionMastery end point is not
-    # versioned, so just return v1.0 anyway
-    # @return [String] v1.0 (ChampionMastery end point is not versioned)
-    def self.api_version
-      'v1.0'
+    # @!visibility private
+    def api_base_path
+      "/lol/champion-mastery/#{api_version}"
     end
 
-    # Retrieve champion mastery information for a specific champion
-    # @param [FixNum] player_id id of player
-    # @param [FixNum] champion_id id of champion
-    # @return [ChampionMastery] champion mastery information
-    def champion player_id, champion_id
-      url = "player/#{player_id}/champion/#{champion_id}"
-      result = perform_request(api_url(url))
-
-      ChampionMastery.new(result)
-    end
-
-    # Retrieve champion mastery information for all champion
-    # @param [FixNum] player_id id of player
-    # @return [Array] array of champion mastery information
-    def champions player_id
-      url = "player/#{player_id}/champions"
-      result = perform_request(api_url(url))
-      result.map { |c| ChampionMastery.new(c) }
-    end
-
-    # Get a player's total champion mastery score, which is sum of individual champion mastery levels
-    # @param [FixNum] player_id id of player
-    # @return [FixNum] Players mastery score
-    def score player_id
-      url = "player/#{player_id}/score"
-      perform_request(api_url(url)).to_i
-    end
-
-    # Get specified number of top champion mastery entries sorted by number of champion points descending
-    # @param [FixNum] player_id id of player
-    # @option options [Fixnum] :count the number of mastery scores to get. Defaults to 3
-    # @return [Array] array of champion mastery information, sorted by number of champion points descending
-    def top_champions player_id, options = {}
-      if options.keys.select { |k| k.to_sym != :count }.any?
-        raise ArgumentError, 'Only :count is allowed as extra parameter'
-      end
-      url = "player/#{player_id}/topchampions"
-      url = api_url(url, options)
-      result = perform_request(url)
-      result.map { |c| ChampionMastery.new(c) }
+    # Get a player's total champion mastery score, which is the sum of individual champion mastery levels
+    #
+    # See: https://developer.riotgames.com/api-methods/#champion-mastery-v3/GET_getDynamicModelScore
+    # @param [Integer] summoner_id Summoner ID associated with the player
+    # @return [Integer] Player's total champion master score
+    def total_score summoner_id:
+      perform_request api_url "scores/by-summoner/#{summoner_id}"
     end
 
-    # Returns a full url for an API call
-    # @param path [String] API path to call
-    # @return [String] full fledged url
-    def api_url path, params = {}
-      url = "#{api_base_url}/championmastery/location/#{region_to_platform(region)}/#{path}"
-      "#{url}?#{api_query_string params}"
+    # Get all champion mastery entries sorted by number of champion points descending
+    #
+    # See: https://developer.riotgames.com/api-methods/#champion-mastery-v3/GET_getAllChampionMasteries
+    # @param [Integer] summoner_id Summoner ID associated with the player
+    # @return [Array<Lol::DynamicModel>] Champion Masteries
+    def all summoner_id:
+      result = perform_request api_url "champion-masteries/by-summoner/#{summoner_id}"
+      result.map { |c| DynamicModel.new c }
     end
 
-    private
-
-    #A hash mapping a region to the platform, since the ChampionMastery endpoint uses a platform and not a region
-    def region_to_platform(region)
-      { br: 'BR1', eune: 'EUN1', euw: 'EUW1', jp: 'JP1', kr: 'KR1', lan: 'LA1', las: 'LA2',
-        na: 'NA1', oce: 'OC1', ru: 'RU', tr: 'TR1' }[region.to_sym]
+    # Get a champion mastery by player ID and champion ID
+    #
+    # See: https://developer.riotgames.com/api-methods/#champion-mastery-v3/GET_getDynamicModel
+    # @param [Integer] summoner_id Summoner ID associated with the player
+    # @return [Lol::DynamicModel] Champion Mastery
+    def find champion_id, summoner_id:
+      result = perform_request api_url "champion-masteries/by-summoner/#{summoner_id}/by-champion/#{champion_id}"
+      DynamicModel.new result
     end
   end
 end

data/lib/lol/champion_request.rb

@@ -1,30 +1,26 @@
 module Lol
+  # Bindings for the Champion API.
+  #
+  # See: https://developer.riotgames.com/api-methods/#champion-v3
   class ChampionRequest < Request
-    # Returns the supported API Version
-    # @return [String] the supported api version
-    def self.api_version
-      "v1.2"
-    end
-
     # Retrieve all champions
-    # @param [Hash] options the options to pass to the call
-    # @option options [Fixnum] :id the champion to get. If nil gets all champions
-    # @option options [Boolean] :free_to_play filters for free to play champions
-    # @return [Array] an array of champions
-    def get options = {}
-
-      champion_id = options.delete :id
-      free_to_play = options.delete(:free_to_play) ? true : false
-
-      url = champion_id ? "champion/#{champion_id}" : "champion"
-      result = perform_request(api_url(url, "freeToPlay" => free_to_play))
-
-      if champion_id
-        Champion.new(result)
-      else
-        result["champions"].map {|c| Champion.new(c)}
-      end
+    #
+    # See: https://developer.riotgames.com/api-methods/#champion-v3/GET_getChampions
+    # @param free_to_play [Boolean] filter param to retrieve only free to play champions
+    # @return [Array<Lol::DynamicModel>] an array of champions
+    def all free_to_play: false
+      result = perform_request api_url("champions", "freeToPlay" => free_to_play)
+      result["champions"].map { |c| DynamicModel.new c }
     end
 
+    # Retrieve champion by ID
+    #
+    # See: https://developer.riotgames.com/api-methods/#champion-v3/GET_getChampionsById
+    # @param id [Integer] id of the champion to get
+    # @return [Lol::DynamicModel] the found champion
+    def find id
+      result = perform_request api_url "champions/#{id}"
+      DynamicModel.new result
+    end
   end
 end

data/lib/lol/client.rb

@@ -10,7 +10,7 @@ module Lol
     attr_reader :api_key
 
     # @!attribute [r] ttl
-    # @return [Fixnum] the ttl on cached requests
+    # @return [Integer] the ttl on cached requests
     attr_reader :ttl
 
     # @return [ChampionRequest]
@@ -23,34 +23,29 @@ module Lol
       @champion_mastery_request ||= ChampionMasteryRequest.new(api_key, region, cache_store)
     end
 
-    # @return [GameRequest]
-    def game
-      @game_request ||= GameRequest.new(api_key, region, cache_store)
-    end
-
     # @return [MatchRequest]
     def match
       @match_request ||= MatchRequest.new(api_key, region, cache_store)
     end
 
-    # @return [MatchListRequest]
-    def match_list
-      @match_history_request ||= MatchListRequest.new(api_key, region, cache_store)
+    # @return [LeagueRequest]
+    def league
+      @league_request ||= LeagueRequest.new(api_key, region, cache_store)
     end
 
-    # @return [StatsRequest]
-    def stats
-      @stats_request ||= StatsRequest.new(api_key, region, cache_store)
+    # @return [RunesRequest]
+    def runes
+      @runes_request ||= RunesRequest.new(api_key, region, cache_store)
     end
 
-    # @return [LeagueRequest]
-    def league
-      @league_request ||= LeagueRequest.new(api_key, region, cache_store)
+    # @return [MasteriesRequest]
+    def masteries
+      @masteries_request ||= MasteriesRequest.new(api_key, region, cache_store)
     end
 
-    # @return [TeamRequest]
-    def team
-      @team_request ||= TeamRequest.new(api_key, region, cache_store)
+    # @return [SpectatorRequest]
+    def spectator
+      @spectator_request ||= SpectatorRequest.new(api_key, region, cache_store)
     end
 
     # @return [SummonerRequest]
@@ -65,7 +60,7 @@ module Lol
 
     # @return [LolStatusRequest]
     def lol_status
-      @lol_status ||= LolStatusRequest.new(region, cache_store)
+      @lol_status ||= LolStatusRequest.new(api_key, region, cache_store)
     end
 
     # @return [CurrentGameRequest]
@@ -80,7 +75,7 @@ module Lol
 
     # @return [TournamentProviderRequest]
     def tournament
-      @tournament ||= TournamentProviderRequest.new(api_key, region, cache_store)
+      @tournament ||= TournamentRequest.new(api_key, region, cache_store)
     end
 
     # Initializes a Lol::Client
@@ -88,7 +83,7 @@ module Lol
     # @param options [Hash]
     # @option options [String] :region ("EUW") The region on which the requests will be made
     # @option options [String] :redis the redis url to use for caching
-    # @option options [Fixnum] :ttl (900) the cache ttl
+    # @option options [Integer] :ttl (900) the cache ttl
     # @return [Lol::Client]
     def initialize api_key, options = {}
       @api_key = api_key

data/lib/lol/dynamic_model.rb

@@ -6,8 +6,11 @@ module Lol
   # - nested generation ({a: {}}) results in DynamicModel(a: DynamicModel)
   # - parsing of date/time when property name ends with _at or _date and the value is a number
   class DynamicModel < OpenStruct
+    attr_reader :raw
+
     def initialize(hash={})
       raise ArgumentError, 'An hash is required as parameter' unless hash.is_a? Hash
+      @raw = hash
       @table = {}
       @hash_table = {}
 
@@ -26,6 +29,12 @@ module Lol
       @table.as_json
     end
 
+    protected
+
+    def class_for_property property
+      self.class
+    end
+
     private
 
     def date_key? key
@@ -33,10 +42,10 @@ module Lol
     end
 
     def set_property key, v
-      if date_key?(key) && v.is_a?(Fixnum)
+      if date_key?(key) && v.is_a?(Integer)
         @table[key.to_sym] = @hash_table[key.to_sym] = value_to_date v
       else
-        @table[key.to_sym] = convert_object v
+        @table[key.to_sym] = convert_object v, property: key.to_sym
         @hash_table[key.to_sym] = v
       end
     end
@@ -45,11 +54,11 @@ module Lol
       Time.at(v / 1000)
     end
 
-    def convert_object obj
+    def convert_object obj, property:
       if obj.is_a? Hash
-        self.class.new obj
+        class_for_property(property).new obj
       elsif obj.respond_to?(:map)
-        obj.map { |o| convert_object o }
+        obj.map { |o| convert_object o, property: property }
       else
         obj
       end

data/lib/lol/featured_game_list.rb

@@ -0,0 +1,15 @@
+module Lol
+  # List of featured games
+  #
+  # Each contained featured game is represented through {DynamicModel}
+  class FeaturedGameList < Array
+    # The suggested interval to wait before requesting FeaturedGames again
+    # @return [Integer]
+    attr_reader :client_refresh_interval
+
+    def initialize data
+      @client_refresh_interval = data['clientRefreshInterval']
+      super data['gameList'].map { |g| DynamicModel.new g }
+    end
+  end
+end

data/lib/lol/league_request.rb

@@ -1,62 +1,41 @@
 module Lol
+  # Bindings for the League API.
+  #
+  # See: https://developer.riotgames.com/api-methods/#league-v3
   class LeagueRequest < Request
-    # Returns the supported API Version
-    # @return [String] the supported api version
-    def self.api_version
-      "v2.5"
+    # @!visibility private
+    def api_base_path
+      "/lol/league/#{api_version}"
     end
 
-    # Retrieves leagues data for summoner, including leagues for all of summoner's teams
-    # @param [Array<String>]
-    # @return Hash{String => Array<League>}
-    def get(*summoner_ids)
-      perform_league_request("league/by-summoner/#{summoner_ids.join(",")}")
+    # Get the challenger league for a given queue
+    # @param [String] queue Queue identifier. See the list of game constants (developer.riotgames.com/game-constants.html) for the available queue identifiers
+    # @return [DynamicModel] Challenger league
+    def find_challenger queue: 'RANKED_SOLO_5x5'
+      DynamicModel.new perform_request api_url "challengerleagues/by-queue/#{queue}"
     end
 
-    # Retrieves leagues entry data for summoner, including league entries for all of summoner's teams
-    # @param [Array<String>]
-    # @return Hash{String => Array<League>}
-    # TODO: Change name to entries?
-    def get_entries(*summoner_ids)
-      perform_league_request("league/by-summoner/#{summoner_ids.join(',')}/entry")
+    # Get the master league for a given queue
+    # @param [String] queue Queue identifier. See the list of game constants (developer.riotgames.com/game-constants.html) for the available queue identifiers
+    # @return [DynamicModel] lMaster league
+    def find_master queue: 'RANKED_SOLO_5x5'
+      DynamicModel.new perform_request api_url "masterleagues/by-queue/#{queue}"
     end
 
-    # Retrieves leagues data for team
-    # @param [Array<String>]
-    # @return Hash{String => Array<League>}
-    def by_team(*team_ids)
-      perform_league_request("league/by-team/#{team_ids.join(',')}")
+    # Get leagues in all queues for a given summoner ID
+    # @param [Integer] summoner_id Summoner ID associated with the player
+    # @return [Array<DynamicModel>] List of leagues summoner is participating in
+    def summoner_leagues summoner_id:
+      result = perform_request api_url "leagues/by-summoner/#{summoner_id}"
+      result.map { |c| DynamicModel.new c }
     end
 
-    # Retrieves leagues entry data for team
-    # @param [Array<String>]
-    # @return Hash{String => Array<League>}
-    # TODO: Change name to?
-    def entries_by_team(*team_ids)
-      perform_league_request("league/by-team/#{team_ids.join(',')}/entry")
+    # Get league positions in all queues for a given summoner ID
+    # @param [Integer] summoner_id Summoner ID associated with the player
+    # @return [Array<DynamicModel>] list of league positions
+    def summoner_positions summoner_id:
+      result = perform_request api_url "positions/by-summoner/#{summoner_id}"
+      result.map { |c| DynamicModel.new c }
     end
-
-    # Retrieves challenger tier leagues
-    # @param [String] game queue type
-    # @return [League]
-    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
-
-    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
-
-  private
-
-    def perform_league_request(partial_url)
-      url = api_url(partial_url)
-      perform_request(url).each_with_object({}) do |(summoner_id, leagues), entries_hash|
-        entries_hash[summoner_id] = leagues.map(&League.method(:new))
-      end
-    end
-
   end
 end

data/lib/lol/lol_status_request.rb

@@ -1,34 +1,17 @@
 module Lol
+  # Bindings for the Status API.
+  #
+  # See: https://developer.riotgames.com/api-methods/#lol-status-v3
   class LolStatusRequest < Request
-
-    def self.api_version
-      "v1.0"
-    end
-
-    def initialize region = nil, cache_store = {}
-      super nil, region, cache_store
+    # @!visibility private
+    def api_base_path
+      "/lol/status/#{self.class.api_version}"
     end
 
-    # Returns a list of each shard status
-    # This special call works against all regions
-    # @return [Array] an array of DynamicModel representing the response
-    def shards
-      perform_request(api_url('shards')).map do |shard_data|
-        DynamicModel.new shard_data
-      end
-    end
-
-    # Returns a detailed status of the current shard
+    # Get League of Legends status for the given shard
     # @return [DynamicModel]
-    def current_shard
-      shard_data = perform_request(api_url('shards', region))
-      DynamicModel.new shard_data
-    end
-
-    def api_url path, params = {}
-      "http://status.leagueoflegends.com/#{path}".tap do |url|
-        url << "/#{params}" unless params.empty?
-      end
+    def shard_data
+      DynamicModel.new perform_request api_url "shard-data"
     end
   end
 end

data/lib/lol/masteries_request.rb

@@ -0,0 +1,14 @@
+module Lol
+  # Bindings for the Masteries API.
+  #
+  # See: https://developer.riotgames.com/api-methods/#masteries-v3
+  class MasteriesRequest < Request
+    # Get mastery pages for a given summoner ID
+    # @param [Integer] summoner_id Summoner ID
+    # @return [Array<DynamicModel>] Mastery pages
+    def by_summoner_id summoner_id
+      result = perform_request api_url "masteries/by-summoner/#{summoner_id}"
+      result["pages"].map { |p| DynamicModel.new p }
+    end
+  end
+end