taric 0.1.14 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b6116b623d0d9921cb1258da918635fec611525
-  data.tar.gz: 552d59aed05e74e5d53a9458fd12d79e07c16246
+  metadata.gz: 0f2141c73d11c661c20fc2d93327ae3627fda562
+  data.tar.gz: a0409ad07a9911debed350002f27db2a5dffa0e7
 SHA512:
-  metadata.gz: 422af6ad1eb78d33049edb70475f30b46b849ed7a41b402a7c547b0aff6c192e3a1579cd283b21b4114a606eab4bf0d772d8bd133b839df2fc87e0180bac5360
-  data.tar.gz: 8b8ac781c7f9028ab92a73cc6ac65e51a0e4df34f89c34f14f4845cdbb32ee6aa3d27fda0d11731df8e2e29f7bd3692158abd2063389e8d5ad8cde880ab1455c
+  metadata.gz: eb93f0e684f289bff8a2cff4504f1888c708e77c125002af15938d812b21ef94729532c61a594499285d11ad91fb5f7caea6e7b3a2292c96caa8024f00145300
+  data.tar.gz: c93ec5b2740a9dcfdba453e65f4dcb46f4f34030eb1c3ff0ecc2e607a284e2464bf2e7769dcecda2e640d3685854ed93e92fe3bf421a3e59c80261257414ee37

data/README.md

@@ -79,6 +79,24 @@ client = Taric.client(region: :na)
 client = Taric.client(region: 'kr')
 ```
 
+Taric also supports parallel HTTP requests via Typhoeus.
+
+```ruby
+# Be sure to include the adapter
+require 'typhoeus/adapters/faraday'
+
+# from regular client...
+client = Taric.client(region: :na)
+
+# ...to parallel mode. Just chain the operation methods
+parallel_client = client.in_parallel.match(id: 1).match(id: 42)
+
+# When you're ready, execute! Note, this clears the operations.
+# By default each response returns a hash with HTTP status
+# and body e.g. {status: 200, body: [1778689691]}
+responses = parallel_client.execute!
+```
+
 ### Champion
 
 ```ruby

data/lib/taric.rb

@@ -1,6 +1,6 @@
 require 'taric/client'
 require 'taric/configuration'
-require 'taric/connection'
+
 require 'taric/version'
 require 'memoist'
 
@@ -32,8 +32,7 @@ module Taric
     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)
+                        config: config)
     end
 
     # Sets global configuration. Should only be called once in a process (e.g. Rails initializer)
@@ -55,7 +54,7 @@ module Taric
       @configuration = Taric::Configuration.new
     end
 
-    include Taric::Connection
+
   end
 
 end

data/lib/taric/client.rb

@@ -1,8 +1,11 @@
 require_relative 'operation/api'
 require 'memoist'
+require_relative 'connection'
 module Taric
   class Client
+    include Taric::Connection
     include Taric::Operation::API
+    attr_reader :api_key, :region, :conn, :config
 
     REGION_ENDPOINT_INFO = {
         br: {region: 'br'.freeze, platform_id: 'BR1'.freeze, host: 'br.api.pvp.net'},
@@ -22,18 +25,23 @@ module Taric
 
     # @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:)
+    # @param config [Configuration] configuration
+    def initialize(api_key:, region:, config:) #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
-      @response_handler = response_handler
+      @config = config
+      @conn = connection(config)
+      # @requestor = requestor
+      # @response_handler = response_handler
+    end
+
+    # Returns a ParallelClient that will execute operations in parallel.
+    # @return [ParallelClient]
+    def in_parallel
+      ParallelClient.new(self)
     end
 
     class << self
@@ -43,8 +51,8 @@ module Taric
       #
       # Sets up and returns hash of api key and region values.
       #
-      # @params api_key [String] rito api key
-      # @params region [Symbol] key for region
+      # @param api_key [String] rito api key
+      # @param 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])
@@ -69,8 +77,38 @@ module Taric
     private
     def response_for(operation, options = {})
       -> url {
-        API_CALL.(url: url, requestor: @requestor, response_handler: @response_handler)
+        API_CALL.(url: url, requestor: @config.requestor.(@conn), response_handler: @config.response_handler)
       }.(self.class.expand_template(api_key: @api_key, region: @region, operation: operation, options: options))
     end
+
+    class ParallelClient
+      include Taric::Operation::API
+      def initialize(parent)
+        @parent = parent
+        @operations = []
+      end
+
+      # Processes all chained requests, clears operations, and returns responses with respect to the operations.
+      #
+      # @return [Array] of operation responses, default is hash with response status and body.
+      #
+      # @example
+      #   client.in_parallel.match(id: 1).match(id: 42).featured_games.execute!
+      #
+      def execute!
+        -> responses {
+          @operations.clear
+          responses
+        }.(API_CALL.(url: @operations, requestor: @parent.config.parallel_requestor.(@parent.conn), response_handler: @parent.config.parallel_response_handler))
+      end
+
+      private
+
+      def response_for(operation, options = {})
+        @operations << @parent.class.expand_template(api_key: @parent.api_key, region: @parent.region, operation: operation, options: options)
+        self
+      end
+
+    end
   end
 end

data/lib/taric/configuration.rb

@@ -1,6 +1,6 @@
 module Taric
   class Configuration
-    attr_accessor :api_key, :format, :user_agent, :connection_opts, :adapter, :region, :requestor, :response_handler
+    attr_accessor :api_key, :format, :user_agent, :connection_opts, :adapter, :region, :requestor, :response_handler, :parallel_requestor, :parallel_response_handler
 
     DEFAULT_REQUESTOR = -> connection, url {
       connection.get url
@@ -10,6 +10,14 @@ module Taric
       response.body
     }
 
+    PARALLEL_REQUESTOR = -> connection, urls {
+      urls.map{|url| connection.get url}
+    }.curry
+
+    PARALLEL_RESPONSE_HANDLER = -> responses {
+      responses.map{|response| {body: response.body, status: response.status}}
+    }
+
     def initialize(options = {})
       @api_key = options.fetch(:api_key, ENV.fetch('RIOT_API_KEY'.freeze, nil))
       @format = options.fetch(:format, :json)
@@ -19,6 +27,8 @@ module Taric
       @connection_opts = options.fetch(:connection_opts, {})
       @requestor = options.fetch(:requestor, DEFAULT_REQUESTOR)
       @response_handler = options.fetch(:response_handler, DEFAULT_RESPONSE_HANDLER)
+      @parallel_requestor = options.fetch(:parallel_requestor, PARALLEL_REQUESTOR)
+      @parallel_response_handler = options.fetch(:parallel_response_handler, PARALLEL_RESPONSE_HANDLER)
     end
   end
 end

data/lib/taric/faraday_middleware/http_exception.rb

@@ -13,6 +13,10 @@ module Taric
 
     class HttpException < Faraday::Response::Middleware
       def call(env)
+        default_request(env) if env.parallel_manager.nil? # might need a better way of detecting this
+      end
+
+      def default_request(env)
         @app.call(env).on_complete do |response|
           case response[:status]
             when 400
@@ -33,7 +37,7 @@ module Taric
               raise Taric::FaradayMiddleware::GatewayTimeout, 'Gateway timeout'
           end
         end
+      end
     end
   end
-end
 end

data/lib/taric/version.rb

@@ -1,3 +1,3 @@
 module Taric
-  VERSION = '0.1.14'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taric
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.2.0
 platform: ruby
 authors:
 - Joseph Yi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -215,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: An outrageous Riot Games LoL API Client