bigcommerce-oauth-api 1.2.1 → 1.3.0

data/lib/bigcommerce-oauth-api/configuration.rb

@@ -6,14 +6,19 @@ module BigcommerceOAuthAPI
     VALID_OPTIONS_KEYS = [
         :store_hash,
         :endpoint,
-        :adapter,
         :client_id,
         :access_token,
         :format,
         :if_modified_since,
         # legacy authentication
         :user_name,
-        :api_key
+        :api_key,
+        # connection / faraday
+        :adapter,
+        :timeout,
+        :open_timeout,
+        # library
+        :typecast_to_resource
     ].freeze
 
     DEFAULT_STORE_HASH = nil
@@ -23,8 +28,11 @@ module BigcommerceOAuthAPI
     DEFAULT_FORMAT = :json
     DEFAULT_ADAPTER = Faraday.default_adapter
     DEFAULT_IF_MODIFIED_SINCE = nil
+    DEFAULT_TYPECAST_TO_RESOURCE = true # if set to false then response-objects with be of type Hash.
     DEFAULT_USER_NAME = nil
     DEFAULT_API_KEY = nil
+    DEFAULT_TIMEOUT = 5
+    DEFAULT_OPEN_TIMEOUT = 2
 
     attr_accessor *VALID_OPTIONS_KEYS
 
@@ -40,8 +48,11 @@ module BigcommerceOAuthAPI
       self.access_token = DEFAULT_ACCESS_TOKEN
       self.adapter = DEFAULT_ADAPTER
       self.if_modified_since = DEFAULT_IF_MODIFIED_SINCE
+      self.typecast_to_resource = DEFAULT_TYPECAST_TO_RESOURCE
       self.user_name = DEFAULT_USER_NAME
       self.api_key = DEFAULT_API_KEY
+      self.timeout = DEFAULT_TIMEOUT
+      self.open_timeout = DEFAULT_OPEN_TIMEOUT
     end
 
     def configure
@@ -53,4 +64,4 @@ module BigcommerceOAuthAPI
       Hash[ * VALID_OPTIONS_KEYS.map { |key| [key, send(key)] }.flatten ]
     end
   end
-end
+end

data/lib/bigcommerce-oauth-api/connection.rb

@@ -27,6 +27,9 @@ module BigcommerceOAuthAPI
       Faraday::Connection.new(options) do |connection|
         connection.request :json
         connection.use Faraday::Request::UrlEncoded
+        connection.options.timeout =  timeout # open/read timeout in seconds
+        connection.options.open_timeout = open_timeout # connection open timeout in seconds
+
         if is_legacy?
           connection.use Faraday::Request::BasicAuthentication, user_name, api_key
         end
@@ -39,4 +42,4 @@ module BigcommerceOAuthAPI
       end
     end
   end
-end
+end

data/lib/bigcommerce-oauth-api/error.rb

@@ -50,6 +50,10 @@ module BigcommerceOAuthAPI
   # 507 HTTP
   class InsufficientStorage < Error; end
 
+  # 509 HTTP (deprecated)
+  # Returned to apps using Basic Authentication that have exceeded their rate limits.
+  class BandwidthLimitExceeded < Error; end
+
   # Raised if the client attempts to define an api method that already is defined elsewhere.
   # Specs will catch this type of error since it will be thrown upon initialization.
   class MethodAlreadyDefinedError < Error; end
@@ -57,4 +61,3 @@ module BigcommerceOAuthAPI
   # Raised if the client attempts to use a non-legacy api with a legacy configuration.
   class NonLegacyApi < Error; end
 end
-

data/lib/bigcommerce-oauth-api/request.rb

@@ -32,13 +32,17 @@ module BigcommerceOAuthAPI
         end
       end
 
-      if response.status == 204 || response.status == 304
-        nil
-      elsif response.body.is_a?(Array)
-        response.body.map { |resource| Resource.new(resource) }
+      if typecast_to_resource
+        if response.status == 204 || response.status == 304
+          nil
+        elsif response.body.is_a?(Array)
+          response.body.map! { |resource| Resource.new(resource) }
+        else
+          Resource.new(response.body)
+        end
       else
-        Resource.new(response.body)
+        response.body
       end
     end
   end
-end
+end

data/lib/bigcommerce-oauth-api/resource.rb

@@ -31,9 +31,8 @@ module BigcommerceOAuthAPI
     end
 
     def method_missing(method_sym, *arguments)
-      method_name = method_sym.to_s
-      attribute_name = method_name.gsub(/(\?$)|(=$)/, '')
-      if @attributes.include?(method_name.to_sym)
+      if @attributes.include?(method_sym)
+        attribute_name = method_sym.to_s.gsub(/(\?$)|(=$)/, '')
         self.instance_eval build_attribute_getter(attribute_name)
         send(method_sym, *arguments)
       else
@@ -65,4 +64,4 @@ module BigcommerceOAuthAPI
       var
     end
   end
-end
+end

data/lib/bigcommerce-oauth-api/version.rb

@@ -1,3 +1,3 @@
 module BigcommerceOAuthAPI
-  VERSION = '1.2.1'.freeze
-end
+  VERSION = '1.3.0'.freeze
+end

data/lib/faraday/raise_http_exception.rb

@@ -20,6 +20,7 @@ module FaradayMiddleware
           when 502 then raise BigcommerceOAuthAPI::BadGateway,             response[:body]
           when 503 then raise BigcommerceOAuthAPI::ServiceUnavailable,     response[:body]
           when 507 then raise BigcommerceOAuthAPI::InsufficientStorage,    response[:body]
+          when 509 then raise BigcommerceOAuthAPI::BandwidthLimitExceeded, response[:body]
         end
       end
     end

data/spec/bigcommerce_oauth_api/api_spec.rb

@@ -37,8 +37,11 @@ module BigcommerceOAuthAPI
               :adapter => 'e',
               :store_hash => 'f',
               :if_modified_since => 'i',
+              :typecast_to_resource => 'j',
               :user_name => 'g',
               :api_key => 'h',
+              :timeout => 'k',
+              :open_timeout => 'l'
           }
         end
 
@@ -112,4 +115,4 @@ module BigcommerceOAuthAPI
       end
     end
   end
-end
+end

data/spec/bigcommerce_oauth_api/client/client_module_spec.rb

@@ -208,4 +208,4 @@ describe BigcommerceOAuthAPI::Client do
       end
     end
   end
-end
+end

data/spec/bigcommerce_oauth_api/client/client_nested_module_spec.rb

@@ -231,4 +231,4 @@ describe BigcommerceOAuthAPI::Client do
       end
     end
   end
-end
+end

data/spec/bigcommerce_oauth_api/client_spec.rb

@@ -65,4 +65,4 @@ module BigcommerceOAuthAPI
     end
 
   end
-end
+end

data/spec/bigcommerce_oauth_api/configuration_spec.rb

@@ -26,4 +26,4 @@ module BigcommerceOAuthAPI
       end
     end
   end
-end
+end

data/spec/bigcommerce_oauth_api/request_spec.rb

@@ -69,4 +69,4 @@ describe BigcommerceOAuthAPI::Request do
       end
     end
   end
-end
+end

data/spec/bigcommerce_oauth_api/resource_spec.rb

@@ -40,4 +40,4 @@ module BigcommerceOAuthAPI
       end
     end
   end
-end
+end

data/spec/faraday/response_spec.rb

@@ -23,7 +23,8 @@ describe Faraday::Response do
       501 => BigcommerceOAuthAPI::NotImplemented,
       502 => BigcommerceOAuthAPI::BadGateway,
       503 => BigcommerceOAuthAPI::ServiceUnavailable,
-      507 => BigcommerceOAuthAPI::InsufficientStorage
+      507 => BigcommerceOAuthAPI::InsufficientStorage,
+      509 => BigcommerceOAuthAPI::BandwidthLimitExceeded
   }.each do |status, exception|
     context "when HTTP status is #{status}" do
       before do

data/spec/spec_helper.rb

@@ -62,4 +62,4 @@ end
 
 def a_delete(client, path)
   a_request(:delete, client_request_url(client, path))
-end
+end

data/spec/support/duplicate_api_definition_client.rb

@@ -4,4 +4,4 @@ require 'bigcommerce-oauth-api/api'
 class DuplicateApiDefinitionClient < BigcommerceOAuthAPI::API
   with_api_methods :state => { api_module: :state, scope: :self, methods: [:all, :select]},
                    :geography_state => { api_module: :state, scope: :self, methods: [:all, :select]}
-end
+end

data/spec/support/method_already_defined_client.rb

@@ -3,4 +3,4 @@ require 'bigcommerce-oauth-api/api'
 
 class MethodAlreadyDefinedClient < BigcommerceOAuthAPI::API
   with_api_methods :post => { api_module: :post, scope: :self, methods: [:select]}
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bigcommerce-oauth-api
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Christian Orthmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement