taric 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2256ea4d83d6f1dda589d852530b416ca8ef9f76
-  data.tar.gz: e31ea5232da64b236e460d7dd1f5fcee9cf3ec69
+  metadata.gz: 4e7a47c9d9fcc0b6a342967bbcdce1d36df210e3
+  data.tar.gz: 05d90533b37c099998da7b6c9c49926a53049d48
 SHA512:
-  metadata.gz: ee2de0222a67b484325cd4e41ac6e5caf734a851dbf9ed68056973a2970b7e7713581c8e928a1ec4f6a5f2bad345fce3e816c144ee011c02ecc525908fa424e8
-  data.tar.gz: 1f82644f6372b738ac39b44d0b81c724bbfa5fa73e957de46ec411dd098361953f853b550bbc44dfaafa3dd2eb3112c25fe6f06faeab4feb594a4a85546e6897
+  metadata.gz: e15826735122a20bd4bc40aab70f0a6ab792742d11ccd125cea6ffef22be2f888b3b3803798f8cbc3e7f4fc4df24c64b5d62237aad3be7121d88effc054765b3
+  data.tar.gz: 0865f86f099767656b268235feb4cb6c045362114ae3e783c842666f9321f796647113eea68ba188f6ab948b9cc7b4e26143232c576700dae20d156791ba1432

data/lib/taric/client.rb

@@ -4,6 +4,20 @@ module Taric
   class Client
     include Taric::Operation::API
 
+    REGION_ENDPOINT_INFO = {
+        br: {region: 'br'.freeze, platform_id: 'BR1'.freeze, host: 'br.api.pvp.net'},
+        eune: {region: 'eune'.freeze, platform_id: 'EUN1'.freeze, host: 'eune.api.pvp.net'},
+        euw: {region: 'euw'.freeze, platform_id: 'EUW1', host: 'euw.api.pvp.net'},
+        kr: {region: 'kr'.freeze, platform_id: 'KR', host: 'kr.api.pvp.net'},
+        lan: {region: 'lan'.freeze, platform_id: 'LA1', host: 'lan.api.pvp.net'},
+        las: {region: 'las'.freeze, platform_id: 'LA2', host: 'las.api.pvp.net'},
+        na: {region: 'na'.freeze, platform_id: 'NA1', host: 'na.api.pvp.net'},
+        oce: {region: 'oce'.freeze, platform_id: 'OC1', host: 'oce.api.pvp.net'},
+        tr: {region: 'tr'.freeze, platform_id: 'TR1', host: 'tr.api.pvp.net'},
+        ru: {region: 'ru'.freeze, platform_id: 'RU', host: 'ru.api.pvp.net'},
+        pbe: {region: 'pbe'.freeze, platform_id: 'PBE1', host: 'pbe.api.pvp.net'}
+    }.freeze
+
     def initialize(api_key, region, requestor, response_handler)
       @api_key = api_key
       @region = region
@@ -11,21 +25,40 @@ module Taric
       @response_handler = response_handler
     end
 
-    def expand_template(operation, options = {})
-      operation.expand(options.merge(self.class.operation_values(@api_key, @region)))
-    end
-
-    private
-    def response_for(operation, options = {})
-      RESPONSE.(expand_template(operation, options), @requestor, @response_handler)
-    end
-
     class << self
       extend Memoist
-      def operation_values(api_key, region)
-        {api_key: api_key}.merge!(Taric::Operation::API::REGION_ENDPOINT_INFO[region]).freeze
+
+      # @note Memoized
+      #
+      # Sets up and returns hash of api key and region values.
+      #
+      # @params api_key [String] rito api key
+      # @params region [Symbol] key for region
+      # @return [Hash] of api_key and region info
+      def operation_values(api_key:, region:)
+        {api_key: api_key}.merge!(REGION_ENDPOINT_INFO[region])
+      end
+      memoize :operation_values
+
+      # Expands operation template with api_key, region, and option values.
+      #
+      # @param api_key [String] rito api key
+      # @param region [Symbol] key for region
+      # @param operation [Addressable::Template] URI template for operation
+      # @param options [Hash] optional, values for template
+      # @return [Addressable::URI] of expanded template
+      #
+      # @example
+      #   Taric::Client.expand_template(api_key: 'ritokey', region: :na, operation: Taric::Operation::Champion::CHAMPIONS)
+      def expand_template(api_key:, region:, operation:, options: {})
+        operation.expand(options.merge(operation_values(api_key: api_key, region: region)))
       end
     end
 
+    private
+    def response_for(operation, options = {})
+      url = self.class.expand_template(api_key: @api_key, region: @region, operation: operation, options: options)
+      API_CALL.(url: url, requestor: @requestor, response_handler: @response_handler)
+    end
   end
 end

data/lib/taric/connection.rb

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

data/lib/taric/operation/api.rb

@@ -22,21 +22,12 @@ module Taric
       include Taric::Operation::Stats
       include Taric::Operation::Summoner
 
-      REGION_ENDPOINT_INFO = {
-          br: {region: 'br'.freeze, platform_id: 'BR1'.freeze, host: 'br.api.pvp.net'},
-          eune: {region: 'eune'.freeze, platform_id: 'EUN1'.freeze, host: 'eune.api.pvp.net'},
-          euw: {region: 'euw'.freeze, platform_id: 'EUW1', host: 'euw.api.pvp.net'},
-          kr: {region: 'kr'.freeze, platform_id: 'KR', host: 'kr.api.pvp.net'},
-          lan: {region: 'lan'.freeze, platform_id: 'LA1', host: 'lan.api.pvp.net'},
-          las: {region: 'las'.freeze, platform_id: 'LA2', host: 'las.api.pvp.net'},
-          na: {region: 'na'.freeze, platform_id: 'NA1', host: 'na.api.pvp.net'},
-          oce: {region: 'oce'.freeze, platform_id: 'OC1', host: 'oce.api.pvp.net'},
-          tr: {region: 'tr'.freeze, platform_id: 'TR1', host: 'tr.api.pvp.net'},
-          ru: {region: 'ru'.freeze, platform_id: 'RU', host: 'ru.api.pvp.net'},
-          pbe: {region: 'pbe'.freeze, platform_id: 'PBE1', host: 'pbe.api.pvp.net'}
-      }.freeze
-
-      RESPONSE = -> url, requestor, response_handler {
+      # Template for requesting the url and processing the response.
+      #
+      # @param url String
+      # @param requestor Proc (lambda)
+      # @param response_handler Proc (lambda)
+      API_CALL = -> (url:, requestor:, response_handler:) {
         response_handler.(requestor.(url))
       }.curry
 

data/lib/taric/operation/champion.rb

@@ -11,9 +11,9 @@ module Taric
       CHAMPIONS =  Addressable::Template.new("#{CHAMPION_BASE_URL}{?api_key,freeToPlay}")
       CHAMPION_BY_ID = Addressable::Template.new("#{CHAMPION_BASE_URL}/{id}{?api_key}")
 
-      # Returns [Hash] embedding an [Array] of champion data.
+      # Returns champion data.
       #
-      # @see {https://developer.riotgames.com/api/methods#!/958/3290}
+      # @see https://developer.riotgames.com/api/methods#!/958/3290
       # @param free_to_play [Boolean] optional, nil returns all, true or false to filter if they're free to play or not
       # @return [Hash] embedding [Array] of champions keyed off of "champions"
       #
@@ -25,6 +25,14 @@ module Taric
         response_for CHAMPIONS, freeToPlay: free_to_play
       end
 
+      # Returns champion data by id.
+      #
+      # @see https://developer.riotgames.com/api/methods#!/958/3289
+      # @param id [Fixnum] id of champion
+      # @return [Hash] of champion data
+      #
+      # @example
+      #   champion = client.champion(id: 266)
       def champion(id:)
         response_for CHAMPION_BY_ID, id: id
       end

data/lib/taric/operation/current_game.rb

@@ -3,9 +3,9 @@ module Taric
     module CurrentGame
       GAME_INFO = Addressable::Template.new 'https://{host}/observer-mode/rest/consumer/getSpectatorGameInfo/{platform_id}/{summonerId}{?api_key}'
 
-      # Returns [Hash] of game data for summoner id
+      # Returns current game data for summoner id.
       #
-      # @see {https://developer.riotgames.com/api/methods#!/956/3287}
+      # @see https://developer.riotgames.com/api/methods#!/956/3287
       # @param summoner_id [Fixnum] required, id of summoner
       # @return [Hash] of game data for summoner id
       #

data/lib/taric/operation/featured_games.rb

@@ -3,9 +3,9 @@ module Taric
     module FeaturedGames
       FEATURED_GAMES = Addressable::Template.new 'https://{host}/observer-mode/rest/featured{?api_key}'
 
-      # Returns [Hash] of featured games in [Array] keyed by 'gameList'
+      # Returns featured games.
       #
-      # @see {https://developer.riotgames.com/api/methods#!/957/3288}
+      # @see https://developer.riotgames.com/api/methods#!/957/3288
       # @return [Hash] of featured games in [Array] keyed by 'gameList'
       #
       # @example

data/lib/taric/operation/game.rb

@@ -7,9 +7,9 @@ module Taric
       GAME_VERSION = 'v1.3'.freeze
       RECENT = Addressable::Template.new "#{BASE_URL_FN.(GAME_VERSION)}/game/by-summoner/{summonerId}/recent{?api_key}"
 
-      # Returns [Hash] of recent game data for summoner id in an [Array] keyed by 'games'
+      # Returns recent game data for summoner id.
       #
-      # @see {https://developer.riotgames.com/api/methods#!/959/3291}
+      # @see https://developer.riotgames.com/api/methods#!/959/3291
       # @param summoner_id [Fixnum] required, id of summoner
       # @return [Hash] of recent game data for summoner id
       #

data/lib/taric/operation/lol_static_data.rb

@@ -6,7 +6,7 @@ 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}"
+      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}"
@@ -93,6 +93,56 @@ module Taric
           'vars'.freeze
       ].freeze
 
+      # locales mapped to languages
+      LOCALE = {
+          bg_BG: 'Bulgarian (Bulgaria)',
+          cs_CZ: 'Czech (Czech Republic)',
+          de_DE: 'German (Germany)',
+          el_GR: 'Greek (Greece)',
+          en_AU: 'English (Australia)',
+          en_GB: 'English (United Kingdom)',
+          en_PH: 'English (Republic of the Philippines)',
+          en_PL: 'English (Poland)',
+          en_SG: 'English (Singapore)',
+          en_US: 'English (United States)',
+          es_AR: 'Spanish (Argentina)',
+          es_ES: 'Spanish (Spain)',
+          es_MX: 'Spanish (Mexico)',
+          fr_FR: 'French (France)',
+          hu_HU: 'Hungarian (Hungary)',
+          id_ID: 'Indonesian (Indonesia)',
+          it_IT: 'Italian (Italy)',
+          ja_JP: 'Japanese (Japan)',
+          ko_KR: 'Korean (Korea)',
+          nl_NL: 'Dutch (Netherlands)',
+          ms_MY: 'Malay (Malaysia)',
+          pl_PL: 'Polish (Poland)',
+          pt_BR: 'Portuguese (Brazil)',
+          pt_PT: 'Portuguese (Portugal)',
+          ro_RO: 'Romanian (Romania)',
+          ru_RU: 'Russian (Russia)',
+          th_TH: 'Thai (Thailand)',
+          tr_TR: 'Turkish (Turkey)',
+          vn_VN: 'Vietnamese (Viet Nam)',
+          zh_CN: 'Chinese (China)',
+          zh_MY: 'Chinese (Malaysia)',
+          zh_TW: 'Chinese (Taiwan)'
+      }
+
+      LOCALE_KEYS = LOCALE.keys
+
+      # Static champion data
+      #
+      # @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
+      # @param version [String] optional, enforces version of static data, or latest if nil
+      #
+      # @return [Hash] of static champion data
+      #
+      # @example
+      #   champions = client.static_champions
+      #   champions_mapped_by_id = 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

data/lib/taric/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taric
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Joseph Yi
@@ -240,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: An outrageous Riot Games LoL API Client