taric 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e7a47c9d9fcc0b6a342967bbcdce1d36df210e3
-  data.tar.gz: 05d90533b37c099998da7b6c9c49926a53049d48
+  metadata.gz: 5d7d5bd2d82c7a170eb90b471c89dbe128e9a4fe
+  data.tar.gz: 50920d65ad41b29f90f110e5dc94dad9778c0b22
 SHA512:
-  metadata.gz: e15826735122a20bd4bc40aab70f0a6ab792742d11ccd125cea6ffef22be2f888b3b3803798f8cbc3e7f4fc4df24c64b5d62237aad3be7121d88effc054765b3
-  data.tar.gz: 0865f86f099767656b268235feb4cb6c045362114ae3e783c842666f9321f796647113eea68ba188f6ab948b9cc7b4e26143232c576700dae20d156791ba1432
+  metadata.gz: 569901532a3f398f084a33f07adeb48e797a5d01ed4e3cdd339acb18af3bc33587f81fc8eb8d5bfcd2b0d1f0dc61e164931e2ed0cbac481bc6e4ccb4e81da12e
+  data.tar.gz: e91429937212e222b021fd0029daf59f5d605de31cf65a5a6c71018f8fec11e9d7397430ee7f743f710138763eed7a0d523e0c31cfa339c4dcf91d38fca0d498

data/lib/taric/connection.rb

@@ -9,7 +9,7 @@ module Taric
 
       Faraday::Connection.new(options) do |conn|
         #conn.use FaradayMiddleware::Mashify
-        conn.response :raise_error
+        #conn.response :raise_error
         conn.response :json, :content_type => /\bjson$/
         conn.adapter config.adapter
       end

data/lib/taric/operation/api.rb

@@ -6,6 +6,7 @@ require_relative 'league'
 require_relative 'lol_static_data'
 require_relative 'lol_status'
 require_relative 'match'
+require_relative 'match_history'
 require_relative 'stats'
 require_relative 'summoner'
 module Taric
@@ -19,6 +20,7 @@ module Taric
       include Taric::Operation::LolStaticData
       include Taric::Operation::LolStatus
       include Taric::Operation::Match
+      include Taric::Operation::MatchHistory
       include Taric::Operation::Stats
       include Taric::Operation::Summoner
 

data/lib/taric/operation/lol_static_data.rb

@@ -6,20 +6,20 @@ module Taric
       VERSION = 'v1.2'
       BASE_STATIC_URL = "https://global.api.pvp.net/api/lol/static-data/{region}/#{VERSION}"
 
-      STATIC_CHAMPIONS = Addressable::Template.new "#{BASE_STATIC_URL}/champion{?api_key,dataById}"
-      STATIC_CHAMPION = Addressable::Template.new "#{STATIC_CHAMPIONS}/{id}{?api_key}"
-      STATIC_ITEMS = Addressable::Template.new "#{BASE_STATIC_URL}/item{?api_key}"
-      STATIC_ITEM = Addressable::Template.new "#{STATIC_ITEMS}/{id}{?api_key}"
-      STATIC_LANGUAGE_STRINGS = Addressable::Template.new "#{BASE_STATIC_URL}/language-strings{?api_key}"
+      STATIC_CHAMPIONS = Addressable::Template.new "#{BASE_STATIC_URL}/champion{?api_key,dataById,locale,version}"
+      STATIC_CHAMPION = Addressable::Template.new "#{BASE_STATIC_URL}/champion/{id}{?api_key,locale,version}"
+      STATIC_ITEMS = Addressable::Template.new "#{BASE_STATIC_URL}/item{?api_key,itemListData,locale,version}"
+      STATIC_ITEM = Addressable::Template.new "#{BASE_STATIC_URL}/item/{id}{?api_key,itemData,locale,version}"
+      STATIC_LANGUAGE_STRINGS = Addressable::Template.new "#{BASE_STATIC_URL}/language-strings{?api_key,locale,version}"
       STATIC_LANGUAGES = Addressable::Template.new "#{BASE_STATIC_URL}/languages{?api_key}"
       STATIC_MAP = Addressable::Template.new "#{BASE_STATIC_URL}/map{?api_key}"
-      STATIC_MASTERIES = Addressable::Template.new "#{BASE_STATIC_URL}/mastery{?api_key}"
-      STATIC_MASTERY = Addressable::Template.new "#{STATIC_MASTERIES}/{id}{?api_key}"
+      STATIC_MASTERIES = Addressable::Template.new "#{BASE_STATIC_URL}/mastery{?api_key,masteryListData,locale,version}"
+      STATIC_MASTERY = Addressable::Template.new "#{BASE_STATIC_URL}/mastery/{id}{?api_key,masteryData,locale,version}"
       STATIC_REALM = Addressable::Template.new "#{BASE_STATIC_URL}/realm{?api_key}"
-      STATIC_RUNES = Addressable::Template.new "#{BASE_STATIC_URL}/rune{?api_key}"
-      STATIC_RUNE = Addressable::Template.new "#{STATIC_RUNES}/{id}{?api_key}"
-      STATIC_SUMMONER_SPELLS = Addressable::Template.new "#{BASE_STATIC_URL}/summoner-spell{?api_key}"
-      STATIC_SUMMONER_SPELL = Addressable::Template.new "#{STATIC_SUMMONER_SPELLS}/{id}{?api_key}"
+      STATIC_RUNES = Addressable::Template.new "#{BASE_STATIC_URL}/rune{?api_key,runeListData,locale,version}"
+      STATIC_RUNE = Addressable::Template.new "#{BASE_STATIC_URL}/rune/{id}{?api_key,runeData,locale,version}"
+      STATIC_SUMMONER_SPELLS = Addressable::Template.new "#{BASE_STATIC_URL}/summoner-spell{?api_key,spellData,locale,version}"
+      STATIC_SUMMONER_SPELL = Addressable::Template.new "#{BASE_STATIC_URL}/summoner-spell/{id}{?api_key,spellData,locale,version}"
       STATIC_VERSIONS = Addressable::Template.new "#{BASE_STATIC_URL}/versions{?api_key}"
 
       CHAMP_DATA_OPTIONS = [
@@ -131,8 +131,9 @@ module Taric
 
       LOCALE_KEYS = LOCALE.keys
 
-      # Static champion data
+      # Static data for champions
       #
+      # @see https://developer.riotgames.com/api/methods#!/968/3326
       # @param data_by_id [Boolean] optional, if true, champion data keyed to IDs
       # @param champ_data_option [String] optional, filter from [CHAMP_DATA_OPTIONS]
       # @param locale [Symbol] optional, results will be in locale [LOCALE], or default for region if nil
@@ -141,64 +142,130 @@ module Taric
       # @return [Hash] of static champion data
       #
       # @example
+      #   # Defaults
       #   champions = client.static_champions
-      #   champions_mapped_by_id = client.static_champions(data_by_id: true)
+      #   # Mapped by IDs
+      #   champions = client.static_champions(data_by_id: true)
       def static_champions(data_by_id: nil, champ_data_option: nil, locale: nil, version: nil)
         response_for STATIC_CHAMPIONS, {dataById: data_by_id, champData: champ_data_option, locale: locale, version: version}
       end
 
+      # Static data for champion by id
+      #
+      # @see https://developer.riotgames.com/api/methods#!/968/3322
+      # @param id [Fixnum] id of champion
+      # @param champ_data_option [String] optional, filter from [CHAMP_DATA_OPTIONS]
+      # @param locale [Symbol] optional, results will be in locale [LOCALE], or default for region if nil
+      # @param version [String] optional, enforces version of static data, or latest if nil
+      #
+      # @return [Hash] of static champion data
+      #
+      # @example
+      #   champions = client.static_champions(id: 44)
       def static_champion(id:, champ_data_option: nil, locale: nil, version: nil)
         response_for STATIC_CHAMPION, {id: id, champData: champ_data_option, locale: locale, version: version}
       end
 
+      # Static data for items
+      #
+      # @see https://developer.riotgames.com/api/methods#!/968/3314
+      # @param item_data_option [String] optional, filter from [ITEM_DATA_OPTIONS]
+      # @param locale [Symbol] optional, results will be in locale [LOCALE], or default for region if nil
+      # @param version [String] optional, enforces version of static data, or latest if nil
+      #
+      # @return [Hash] of static item data
+      #
+      # @example
+      #   # Defaults
+      #   champions = client.static_items
       def static_items(item_data_option: nil, locale: nil, version: nil)
-        response_for STATIC_ITEMS, {itemListData: item_data_option, locale: locale, version: version,}
+        response_for STATIC_ITEMS, {itemListData: item_data_option, locale: locale, version: version}
       end
 
+      # Static data for item by id
+      #
+      # @see https://developer.riotgames.com/api/methods#!/968/3319
+      # @param id [Fixnum] id of item
+      # @param item_data_option [String] optional, filter from [ITEM_DATA_OPTIONS]
+      # @param locale [Symbol] optional, results will be in locale [LOCALE], or default for region if nil
+      # @param version [String] optional, enforces version of static data, or latest if nil
+      #
+      # @return [Hash] of static item data for id
+      #
+      # @example
+      #   item = client.static_item(id: 2049)
       def static_item(id:, item_data_option: nil, locale: nil, version: nil)
         response_for STATIC_ITEM, {id: id, itemData: item_data_option, locale: locale, version: version}
       end
 
+      # Returns [Hash] of language string data.
+      #
+      # @see https://developer.riotgames.com/api/methods#!/968/3316
+      # @param locale [Symbol] optional, results will be in locale [LOCALE], or default for region if nil
+      # @param version [String] optional, enforces version of static data, or latest if nil
+      # @return [Hash] of language string data
+      # @example
+      #   language_strings = client.static_language_strings
       def static_language_strings(locale: nil, version: nil)
         response_for STATIC_LANGUAGE_STRINGS, {locale: locale, version: version}
       end
 
+      # Returns [Array] of languages.
+      #
+      # @see https://developer.riotgames.com/api/methods#!/968/3324
+      # @return [Array] of languages
+      # @example
+      #   languages = client.static_languages
       def static_languages
         response_for STATIC_LANGUAGES
       end
 
+      # @see https://developer.riotgames.com/api/methods#!/968/3328
       def static_map(locale: nil, version: nil)
         response_for STATIC_MAP, {locale: locale, version: version}
       end
 
+      # @see https://developer.riotgames.com/api/methods#!/968/3317
       def static_masteries(mastery_data_option: nil, locale: nil, version: nil)
         response_for STATIC_MASTERIES, {masteryListData: mastery_data_option, locale: locale, version: version}
       end
 
+      # @see https://developer.riotgames.com/api/methods#!/968/3318
       def static_mastery(id:, mastery_data_option: nil, locale: nil, version: nil)
         response_for STATIC_MASTERY, {id: id, masteryData: mastery_data_option, locale:locale, version: version}
       end
 
+      # @see https://developer.riotgames.com/api/methods#!/968/3325
       def static_realm
         response_for STATIC_REALM
       end
 
+      # @see https://developer.riotgames.com/api/methods#!/968/3315
       def static_runes(rune_data_option: nil, locale: nil, version: nil)
         response_for STATIC_RUNES, {runeListData: rune_data_option, locale: locale, version: version}
       end
 
+      # @see https://developer.riotgames.com/api/methods#!/968/3321
       def static_rune(id:, rune_data_option: nil, locale: nil, version: nil)
         response_for STATIC_RUNE, {id: id, runeData: rune_data_option, locale: locale, version: version}
       end
 
+      # @see https://developer.riotgames.com/api/methods#!/968/3327
       def static_summoner_spells(data_by_id: nil, spell_data_option: nil, locale: nil, version: nil)
         response_for STATIC_SUMMONER_SPELLS, {dataById: data_by_id, spellData: spell_data_option, locale: locale, version: version}
       end
 
+      # @see https://developer.riotgames.com/api/methods#!/968/3320
       def static_summoner_spell(id:, spell_data_option: nil, locale: nil, version: nil)
         response_for STATIC_SUMMONER_SPELL, {id: id, spellData: spell_data_option, locale: locale, version: version}
       end
 
+      # Returns [Array] of static data version numbers.
+      #
+      # @see https://developer.riotgames.com/api/methods#!/968/3323
+      # @return [Array] of version numbers
+      # @example
+      #   versions = client.static_versions
       def static_versions
         response_for STATIC_VERSIONS
       end

data/lib/taric/operation/match.rb

@@ -5,8 +5,13 @@ module Taric
       include Taric::Operation::Base
 
       MATCH_VERSION = 'v2.2'
-      MATCH = Addressable::Template.new "#{BASE_URL_FN.(MATCH_VERSION)}/match/{matchId}"
+      MATCH = Addressable::Template.new "#{BASE_URL_FN.(MATCH_VERSION)}/match/{matchId}{?api_key,includeTimeline}"
 
+      # Match data for id.
+      #
+      # @see https://developer.riotgames.com/api/methods#!/967/3313
+      # @param id [Fixnum] id of match
+      # @param include_timeline [Boolean] optional, true includes timestamps on events
       def match(id:, include_timeline: nil)
         response_for MATCH, {matchId: id, includeTimeline: include_timeline}
       end

data/lib/taric/operation/match_history.rb

@@ -0,0 +1,17 @@
+require_relative 'base'
+module Taric
+  module Operation
+    module MatchHistory
+      include Taric::Operation::Base
+
+      MATCH_HISTORY_VERSION = 'v2.2'
+      MATCH_HISTORY = Addressable::Template.new "#{BASE_URL_FN.(MATCH_HISTORY_VERSION)}/matchhistory/{summonerId}{?api_key,championIds,rankedQueues,beginIndex,endIndex}"
+
+      # @see https://developer.riotgames.com/api/methods#!/966/3312
+      def match_history(summoner_id:, champion_ids: nil, ranked_queues: nil, begin_index: nil, end_index: nil)
+        response_for MATCH_HISTORY,
+                     {summonerId: summoner_id, championIds: champion_ids, rankedQueues: ranked_queues, beginIndex: begin_index, endIndex: end_index}
+      end
+    end
+  end
+end

data/lib/taric/operation/stats.rb

@@ -5,15 +5,17 @@ module Taric
       include Taric::Operation::Base
 
       STATS_VERSION = 'v1.3'.freeze
-      BASE_STATS_URL = Addressable::Template.new "#{BASE_URL_FN.(STATS_VERSION)}/stats/by-summoner/{summonerId}{?api_key}"
-      RANKED = Addressable::Template.new "#{BASE_STATS_URL}/ranked{?api_key}"
-      SUMMARY = Addressable::Template.new "#{BASE_STATS_URL}/summary{?api_key}"
+      BASE_STATS_URL = "#{BASE_URL_FN.(STATS_VERSION)}/stats/by-summoner/{summonerId}"
+      RANKED = Addressable::Template.new "#{BASE_STATS_URL}/ranked{?api_key,season}"
+      SUMMARY = Addressable::Template.new "#{BASE_STATS_URL}/summary{?api_key,season}"
 
-      def ranked(summoner_id: , season: nil)
+      # @see https://developer.riotgames.com/api/methods#!/961/3297
+      def ranked_stats(summoner_id: , season: nil)
         response_for RANKED, {summonerId: summoner_id, season: season}
       end
 
-      def summary(summoner_id: , season: nil)
+      # @see https://developer.riotgames.com/api/methods#!/961/3298
+      def summary_stats(summoner_id: , season: nil)
         response_for SUMMARY, {summonerId: summoner_id, season: season}
       end
     end

data/lib/taric/operation/summoner.rb

@@ -6,8 +6,9 @@ module Taric
       
       VERSION = 'v1.4'
       BASE_SUMMONER_URL = "#{BASE_URL_FN.(VERSION)}/summoner"
-      BY_NAMES =  Addressable::Template.new "#{BASE_SUMMONER_URL}/by-name/{summonerNames}{?api_key}"
       BASE_SUMMONERS_BY_IDS = "#{BASE_SUMMONER_URL}/{summonerIds}"
+
+      SUMMONERS_BY_NAMES =  Addressable::Template.new "#{BASE_SUMMONER_URL}/by-name/{summonerNames}{?api_key}"
       SUMMONERS_BY_IDS = Addressable::Template.new "#{BASE_SUMMONERS_BY_IDS}{?api_key}"
       MASTERIES = Addressable::Template.new "#{BASE_SUMMONERS_BY_IDS}/masteries{?api_key}"
       NAMES = Addressable::Template.new "#{BASE_SUMMONERS_BY_IDS}/name{?api_key}"
@@ -23,7 +24,7 @@ module Taric
       #   summoners = client.summoners_by_name(summoner_names: 'orlyzomg,ipa,dbanksdesign,lzrface,doodiediddle')
       #   summoner = summoners['orlyzomg']
       def summoners_by_names(summoner_names:)
-        response_for BY_NAMES, {summonerNames: summoner_names}
+        response_for SUMMONERS_BY_NAMES, {summonerNames: summoner_names}
       end
 
       # Returns [Hash] of summoner data hashes keyed by summoner ID

data/lib/taric/version.rb

@@ -1,3 +1,3 @@
 module Taric
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taric
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Joseph Yi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -215,6 +215,7 @@ files:
 - lib/taric/operation/lol_static_data.rb
 - lib/taric/operation/lol_status.rb
 - lib/taric/operation/match.rb
+- lib/taric/operation/match_history.rb
 - lib/taric/operation/stats.rb
 - lib/taric/operation/summoner.rb
 - lib/taric/operation/team.rb