taric 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af5a3fbf7f3ce947a8d074935d86c42bcec230a0
-  data.tar.gz: 123007565b2acd2dd52d31e41cb53e327242b840
+  metadata.gz: 29900a7fab3608cd9c692b69817f666747e39136
+  data.tar.gz: e2f22660390cb82bc490f51422bb517eef746e93
 SHA512:
-  metadata.gz: a4b22562e2dbd547266f99e9512169b9641aec212d9da8815fb2ccc56464bbc032c251a8118cd07889f15f60027e30175b3948c9a952d52e972699b10e110700
-  data.tar.gz: fb14c6ebda12d959f448a4346d9b36757a0000efd9a3f8bdf44b2b19bd33fd66d21cc19de1dfce49d990f17875da07bb6223ffbf54e255345b12b480b7ccbe02
+  metadata.gz: d128b14efc299f1fa07bb383fb32a4b6f0e4d56fa61b9a7a975a259c382aa9d0714d5035faca5797872beac100879b54d93d7f30c3c016813153b1ef4665984c
+  data.tar.gz: b409f0486bc7968488ab4368aefc315aa113682c919bc122bc7bf8bf8fca69691636c3803d486f44e6d13bb87e4ab8cc675b80b1b7ba4d86c849c9b11b90a9dc

data/README.md

@@ -62,14 +62,14 @@ There are a couple of ways to set the API key:
 
 > "Functional and stylish."
 
-Once the key is set, you can use `Taric.client(:region)` to get a client instance for the specified region.
+Once the key is set, you can use `Taric.client(region: region_code)` to get a client instance for the specified region.
 
 ```ruby
 # North America
-client = Taric.client(:na)
+client = Taric.client(region: :na)
 
-# Korea
-client = Taric.client(:kr)
+# Korea, using String arg
+client = Taric.client(region: 'kr')
 ```
 
 ### Champion

data/lib/taric.rb

@@ -9,14 +9,37 @@ module Taric
   class << self
     attr_accessor :configuration
 
-    def client(region: :na, config: @configuration ||= Taric::Configuration.new)
-      Taric::Client.new(api_key: config.api_key,
-                        region: region,
+    # Creates a [Taric::Client], the main interface to the LoL API. If the api_key is provided
+    # in .configure!, then only the region needs to be set. If .configure! is used, but a different
+    # api_key is provided, then the latter takes precedence.
+    #
+    # @see Taric::Client::REGION_ENDPOINT_INFO
+    # @param region [Symbol] region code, also accepts [String], default is :na
+    # @param api_key [String] rito API key
+    # @param config [Taric::Configuration] configuration options. If not provided, then defaults will be used.
+    #
+    # @return [Taric::Client]
+    #
+    # @example
+    #   # With .configure! (preferred)
+    #   Taric.configure! do |config|
+    #     config.api_key = 'your-rito-api-key'
+    #   end
+    #
+    #   client = Taric.client(region: :na)
+    #
+    #   # With arbitrary key.
+    #   client = Taric.client(region: :na, api_key: 'your-rito-key')
+    def client(region: :na, api_key: nil, config: @configuration ||= Taric::Configuration.new)
+      Taric::Client.new(api_key: api_key || config.api_key,
+                        region: region.is_a?(String) ? region.to_sym : region,
                         requestor: config.requestor.(connection(config)),
                         response_handler: config.response_handler)
     end
 
-    # Sets global configuration.
+    # Sets global configuration. Should only be called once in a process (e.g. Rails initializer)
+    #
+    # @see Taric::Configuration
     #
     # @example
     #   Taric.configure! do |config|
@@ -28,7 +51,7 @@ module Taric
     end
 
     # Resets global configuration.
-    #
+    # @see Taric::Configuration
     def reset!
       @configuration = Taric::Configuration.new
     end

data/lib/taric/client.rb

@@ -18,12 +18,18 @@ module Taric
         pbe: {region: 'pbe'.freeze, platform_id: 'PBE1', host: 'pbe.api.pvp.net'}
     }.freeze
 
+    REGION_ENDPOINT_STRING_KEYS = REGION_ENDPOINT_INFO.keys.map(&:to_s).freeze
+
     # @param api_key [String] rito api key
     # @param region [Symbol] region code
     # @param requestor [Proc] lambda that will accept a url and return a [Faraday::Response]
     # @param response_handler [Proc] lambda that accepts [Faraday::Response] and handles it
     #
     def initialize(api_key:, region:, requestor:, response_handler:)
+      raise ArgumentError, 'api_key cannot be nil' if api_key.nil?
+      raise ArgumentError, 'region cannot be nil' if region.nil?
+      raise ArgumentError, "#{region} is not a valid region, #{REGION_ENDPOINT_STRING_KEYS}" if REGION_ENDPOINT_INFO[region].nil?
+
       @api_key = api_key
       @region = region
       @requestor = requestor

data/lib/taric/configuration.rb

@@ -11,7 +11,7 @@ module Taric
     }
 
     def initialize(options = {})
-      @api_key = options.fetch(:api_key, ENV.fetch('RIOT_API_KEY'.freeze, 'KeyNotSetButUsingThisForTest'.freeze))
+      @api_key = options.fetch(:api_key, ENV.fetch('RIOT_API_KEY'.freeze, nil))
       @format = options.fetch(:format, :json)
       @user_agent = options.fetch(:user_agent, 'Taric Gem')
       @adapter = options.fetch(:adapter, :typhoeus)

data/lib/taric/connection.rb

@@ -1,4 +1,4 @@
-require 'faraday_middleware'
+require 'faraday_middleware/parse_oj'
 
 module Taric
   module Connection
@@ -8,9 +8,7 @@ module Taric
       }.merge(config.connection_opts)
 
       Faraday::Connection.new(options) do |conn|
-        #conn.use FaradayMiddleware::Mashify
-        #conn.response :raise_error
-        conn.response :json, :content_type => /\bjson$/
+        conn.response :oj, :content_type => /\bjson$/
         conn.adapter config.adapter
       end
     end

data/lib/taric/version.rb

@@ -1,3 +1,3 @@
 module Taric
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/taric.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'typhoeus', "~> 0.3"
   spec.add_runtime_dependency 'memoist', '~> 0.11'
   spec.add_runtime_dependency('addressable', '~> 2.3')
+  spec.add_runtime_dependency('oj', '~> 2.12')
   spec.add_runtime_dependency('faraday_middleware', '~> 0.9')
-  spec.add_runtime_dependency('hashie',  '~> 3.4')
-  spec.add_runtime_dependency('multi_json',  '~> 1.1')
+  spec.add_runtime_dependency('faraday_middleware-parse_oj', '~> 0.3.0')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taric
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Joseph Yi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2015-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,47 +143,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '2.12'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: faraday_middleware-parse_oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.3.0
 description: An outrageous Riot Games LoL API Client
 email:
 - dissonance@gmail.com