taric 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7902c7e824920bcdc9adc4b42f334dbac902fe68
-  data.tar.gz: 30e5b9ef6a135ec72dd44734aa884660064fc3f0
+  metadata.gz: c302de47946d4d5337732907248b9cdf7f45fa6b
+  data.tar.gz: 34cdc8513b9d50a55197e69be960b64d43350635
 SHA512:
-  metadata.gz: 43f68e87d1cffe89e1a40bd4bf6ed7413e3e554800052d1b7690a4fcaff2fc075cdb2b21655f8201cbcbadfc3aa805e279099d4c0c588643053683a5daa7236c
-  data.tar.gz: 1a012bddbce732f14f9ebf8b445e87c1dcc6ed2e0f511346a63fa62929c46db3794f659d544f98b29bed48d3d80f67ddae41b4b3f2dcfda503f2dca0cb451d77
+  metadata.gz: adb304d96a47d9a67ce8ebbe3cbbcfa0b0728ca4b760cce434ed02a84797075d31bb1c5e3e96d66af2442b1eaf75f0bdd16a374f00bfc6e65ed39b809c89e6d9
+  data.tar.gz: 5b14d61f5ec6d887d16658c0a487b698e8571fa403478452089aed7b2a326c13e731f8c0288f00aa2d3e1bb8a4f85d4d5d37b286205fa62c3b09ad1b5fed015d

data/lib/taric.rb

@@ -1,6 +1,6 @@
 require 'taric/client'
 require 'taric/configuration'
-
+require 'taric/constants'
 require 'taric/version'
 require 'memoist'
 

data/lib/taric/client.rb

@@ -23,6 +23,8 @@ module Taric
 
     REGION_ENDPOINT_STRING_KEYS = REGION_ENDPOINT_INFO.keys.map(&:to_s).freeze
 
+    # New instance of Taric::Client.
+    #
     # @param api_key [String] rito api key
     # @param region [Symbol] region code
     # @param config [Configuration] configuration

data/lib/taric/constants.rb

@@ -0,0 +1,14 @@
+module Taric
+  # rankedQueues
+  RANKED_SOLO_5X5 = 'RANKED_SOLO_5x5'.freeze
+  RANKED_TEAM_3X3 = 'RANKED_TEAM_3x3'.freeze
+  RANKED_TEAM_5X5 = 'RANKED_TEAM_5x5'.freeze
+
+  # seasons
+  PRESEASON3 = 'PRESEASON3'.freeze
+  SEASON3 = 'SEASON3'.freeze
+  PRESEASON2014 = 'PRESEASON2014'.freeze
+  SEASON2014 = 'SEASON2014'.freeze
+  PRESEASON2015 = 'PRESEASON2015'.freeze
+  SEASON2015 = 'SEASON2015'.freeze
+end

data/lib/taric/operation/api.rb

@@ -10,6 +10,8 @@ require_relative 'match_list'
 require_relative 'stats'
 require_relative 'summoner'
 require_relative 'team'
+
+# Combines operations of LoL API.
 module Taric
   module Operation
     module API

data/lib/taric/operation/base.rb

@@ -3,6 +3,14 @@ module Taric
     module Base
       BASE_URL_FN = -> version {"https://{host}/api/lol/{region}/#{version}"}
 
+      # Converts [Time] to [Fixnum], or returns argument.
+      #
+      # @param time [Time] Time to convert to epoch.
+      # @return [Fixnum] Time in epoch.
+      def epoch_time(time)
+        return time.to_i if time.instance_of? Time
+        time
+      end
     end
   end
 end

data/lib/taric/operation/league.rb

@@ -13,39 +13,82 @@ module Taric
       LEAGUES_BY_TEAM_IDS = Addressable::Template.new "#{BASE_LEAGUE_URL}/by-team/{teamIds}{?api_key}"
       ENTRIES_BY_TEAM_IDS = Addressable::Template.new "#{BASE_LEAGUE_URL}/by-team/{teamIds}/entry{?api_key}"
       CHALLENGER = Addressable::Template.new "#{BASE_LEAGUE_URL}/challenger{?api_key,type}"
+      MASTER = Addressable::Template.new "#{BASE_LEAGUE_URL}/master{?api_key,type}"
 
       CHALLENGER_QUEUE_TYPES = ['RANKED_SOLO_5x5'.freeze, 'RANKED_TEAM_3x3'.freeze, 'RANKED_TEAM_5x5'.freeze].freeze
+      MASTER_QUEUE_TYPES = CHALLENGER_QUEUE_TYPES
 
-      # @see https://developer.riotgames.com/api/methods#!/936/3241
+      # Leagues by summoner IDs.
+      #
+      # @see https://developer.riotgames.com/api/methods#!/985/3351
+      # @param summoner_ids summoner_ids [String] comma separated list of summoner ids
+      # @return [Hash] leagues keyed by summoner ids
+      #
+      # @example
+      #   result = client.leagues_by_summoner_ids(summoner_ids: '21066,38877656')
+      #   leagues = result['21066']
+      #   entries = first_summoner_leagues.first['entries']
       def leagues_by_summoner_ids(summoner_ids:)
         response_for LEAGUES_BY_SUMMONER_IDS, {summonerIds: summoner_ids}
       end
 
-      # @see https://developer.riotgames.com/api/methods#!/936/3245
+      # League entries by summoner IDs.
+      #
+      # @see https://developer.riotgames.com/api/methods#!/985/3351
+      # @param summoner_ids summoner_ids [String] comma separated list of summoner ids
+      # @return [Hash] league entries keyed by summoner_ids
+      #
+      # @example
+      #   result = client.league_entries_by_summoner_ids(summoner_ids: '21066,38877656')
+      #   entries = result['38877656']
+      #   entry = entries.first
+      #   entry_name = entry['name']
+      #   entry_tier = entry['tier']
       def league_entries_by_summoner_ids(summoner_ids:)
         response_for ENTRIES_BY_SUMMONER_IDS, {summonerIds: summoner_ids}
       end
 
-      # @see https://developer.riotgames.com/api/methods#!/936/3242
+      # Leagues by team IDs.
+      #
+      # @see https://developer.riotgames.com/api/methods#!/985/3352
+      # @param team_ids team_ids [String] comma separated list of team ids
+      # @return [Hash] leagues keyed by team_ids
       def leagues_by_team_ids(team_ids:)
         response_for LEAGUES_BY_TEAM_IDS, {teamIds: team_ids}
       end
 
-      # @see https://developer.riotgames.com/api/methods#!/936/3244
+      # League entries by team IDs.
+      #
+      # @see https://developer.riotgames.com/api/methods#!/985/3355
+      # @param team_ids team_ids [String] comma separated list of team ids
+      # @return [Hash] league entries keyed by team_ids
       def league_entries_by_team_ids(team_ids:)
         response_for ENTRIES_BY_TEAM_IDS, {teamIds: team_ids}
       end
 
-      # Challenger league data for type.
+      # Challenger league data for queue type.
       #
       # @param type [String] required, must be RANKED_SOLO_5x5, RANKED_TEAM_3x3, or RANKED_TEAM_5x5
-      # @see https://developer.riotgames.com/api/methods#!/936/3243
+      # @return [Hash] challenger league data
+      # @see https://developer.riotgames.com/api/methods#!/985/3353
       def challenger(type: )
         raise ArgumentError,
               "Invalid argument: #{type}, arg must be in #{CHALLENGER_QUEUE_TYPES}" unless CHALLENGER_QUEUE_TYPES.include?(type)
 
         response_for CHALLENGER, {type: type}
       end
+
+      # Master league data for queue type.
+      #
+      # @param type [String] required, must be RANKED_SOLO_5x5, RANKED_TEAM_3x3, or RANKED_TEAM_5x5
+      # @return [Hash] master league data
+      # https://developer.riotgames.com/api/methods#!/985/3354
+      def master(type: )
+        raise ArgumentError,
+              "Invalid argument: #{type}, arg must be in #{MASTER_QUEUE_TYPES}" unless MASTER_QUEUE_TYPES.include?(type)
+
+        response_for MASTER, {type: type}
+      end
     end
   end
 end

data/lib/taric/operation/lol_static_data.rb

@@ -220,7 +220,11 @@ module Taric
         response_for STATIC_LANGUAGES
       end
 
+      # Maps availalble.
       # @see https://developer.riotgames.com/api/methods#!/968/3328
+      # @param locale [String] filter by locale
+      # @param version [String] patch version
+      # @return [Hash] of maps available.
       def static_map(locale: nil, version: nil)
         response_for STATIC_MAP, {locale: locale, version: version}
       end

data/lib/taric/operation/match_list.rb

@@ -7,17 +7,20 @@ module Taric
       MATCH_LIST_VERSION = 'v2.2'.freeze
       MATCH_LIST = Addressable::Template.new "#{BASE_URL_FN.(MATCH_LIST_VERSION)}/matchlist/by-summoner/{summonerId}{?api_key,championIds,rankedQueues,seasons,beginTime,endTime,beginIndex,endIndex}"
 
+      # Returns match list for summoner.
+      #
       # @see https://developer.riotgames.com/api/methods#!/1026/3480
       # @param summoner_id [Fixnum] summoner Id
       # @param champion_ids [String] Optional - Comma-separated list of champion IDs to use for fetching games.
       # @param ranked_queues [String] Optional - Comma-separated list of ranked queue types to use for fetching games. Non-ranked queue types will be ignored.
       # @param seasons [String] Optional  - Comma-separated list of seasons to use for fetching games.
-      # @param begin_time [Fixnum] Optional - The begin time in epoch milliseconds to use for fetching games.
-      # @param end_time [Fixnum] Optional - The end time in epoch milliseconds to use for fetching games.
+      # @param begin_time [Fixnum or Time] Optional - The begin time to use for fetching games.
+      # @param end_time [Fixnum or Time] Optional - The end time to use for fetching games.
       def match_list(summoner_id:, champion_ids: nil, ranked_queues: nil, seasons: nil, begin_time: nil, end_time: nil, begin_index: nil, end_index: nil)
         response_for MATCH_LIST,
-                     {summonerId: summoner_id, championIds: champion_ids, rankedQueues: ranked_queues, seasons: seasons, beginTime: begin_time, endTime: end_time, beginIndex: begin_index, endIndex: end_index}
+                     {summonerId: summoner_id, championIds: champion_ids, rankedQueues: ranked_queues, seasons: seasons, beginTime: epoch_time(begin_time), endTime: epoch_time(end_time), beginIndex: begin_index, endIndex: end_index}
       end
+
     end
   end
 end

data/lib/taric/version.rb

@@ -1,3 +1,3 @@
 module Taric
-  VERSION = '0.3.1'
+  VERSION = '0.3.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taric
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Joseph Yi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2015-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,6 +177,7 @@ files:
 - lib/taric/client.rb
 - lib/taric/configuration.rb
 - lib/taric/connection.rb
+- lib/taric/constants.rb
 - lib/taric/faraday_middleware/http_exception.rb
 - lib/taric/operation/api.rb
 - lib/taric/operation/base.rb