bigcommerce-oauth-api 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdf5b9ddfbfad7c95f914d01e772122c59363ebf
-  data.tar.gz: 53309df2bcfad86dcb8f1ecafc88e22499314f89
+  metadata.gz: 8f37e6586189acbb81bc21f656d3f1b5a8e3e749
+  data.tar.gz: 53fff46f665e6862d78893f1f693087194389cdc
 SHA512:
-  metadata.gz: 80a2d871dd59031976c08e65572705e583a0d552ebf02de3467f7fe333fe216904488ede52b947ee3760a2a5c592d031300e01e46c4b6ac0bf8882cb88e31986
-  data.tar.gz: e5c66453f20d4ec5fc7e1a0cdb3ab675976d264ffd9c5b14b8e2ba69a2e9d757866b4d0bbf1804f2f747c0e7ded23b345edea319a1c9c00e5d7ad1d3ac13eacd
+  metadata.gz: 4154e91d65cc889f90a1bcbf757f54c61eb7e1e176dc2423808ec7a06cc43eb9223cdc237d3294714923e1e415c31d7a65fae2abbf48f170f2aa8fcf7f963f27
+  data.tar.gz: ed15ab36620add81872f55736405e0abaa5981ea15e6f5ff411cad34b335d9d056fc6e85fd52881240fa869cfda5a7bf0636335d9d80b88e7722a38e8332ccfa

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### 1.2.1 (2015-05-14)
+
+Features:
+
+    - added support for 'If-Modified-Since' requests.
+
+Bugfixes:
+
+    - PUT/POST as json with content-type headers.
+
 ### 1.2.0 (2015-04-19)
 
 Features:

data/README.md

@@ -52,6 +52,8 @@ api = BigcommerceOAuthAPI::Client.new(
                                 )
 ```
 
+Starting from v1.2.1 `bigcommerce-oauth-api` supports the `If-Modified-Since` header described on https://developer.bigcommerce.com/api/req-headers. As all other configurations, the header can be set with both module and instance configuration using the key `if_modified_since`.
+
 Using the API
 -------------
 It is recommended to use the Omniref documentation as a method reference in combination the official api documentation.

data/bigcommerce-oauth-api.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/bigcommerce-oauth-api/version', __FILE__)
 Gem::Specification.new do |s|
   s.name        = 'bigcommerce-oauth-api'
   s.version     = BigcommerceOAuthAPI::VERSION.dup
-  s.date        = '2015-04-19'
+  s.date        = '2015-05-14'
   s.summary     = "Ruby client library for Bigcommerce APIs with OAuth and basic authentication support"
   s.description = "Connect Ruby applications to Bigcommerce APIs through OAuth or basic authentication"
   s.authors     = ["Christian Orthmann"]

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

@@ -10,6 +10,7 @@ module BigcommerceOAuthAPI
         :client_id,
         :access_token,
         :format,
+        :if_modified_since,
         # legacy authentication
         :user_name,
         :api_key
@@ -21,6 +22,7 @@ module BigcommerceOAuthAPI
     DEFAULT_ACCESS_TOKEN = nil
     DEFAULT_FORMAT = :json
     DEFAULT_ADAPTER = Faraday.default_adapter
+    DEFAULT_IF_MODIFIED_SINCE = nil
     DEFAULT_USER_NAME = nil
     DEFAULT_API_KEY = nil
 
@@ -37,6 +39,7 @@ module BigcommerceOAuthAPI
       self.client_id = DEFAULT_CLIENT_ID
       self.access_token = DEFAULT_ACCESS_TOKEN
       self.adapter = DEFAULT_ADAPTER
+      self.if_modified_since = DEFAULT_IF_MODIFIED_SINCE
       self.user_name = DEFAULT_USER_NAME
       self.api_key = DEFAULT_API_KEY
     end

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

@@ -11,6 +11,11 @@ module BigcommerceOAuthAPI
           'Accept' => "application/#{format}; charset=utf-8"
         }
       }
+
+      if !if_modified_since.nil?
+        options[:headers]['If-Modified-Since'] = if_modified_since.to_s
+      end
+
       if is_legacy?
         options[:url] = "#{endpoint}/api/v2/"
       else
@@ -20,13 +25,14 @@ module BigcommerceOAuthAPI
       end
 
       Faraday::Connection.new(options) do |connection|
+        connection.request :json
         connection.use Faraday::Request::UrlEncoded
         if is_legacy?
           connection.use Faraday::Request::BasicAuthentication, user_name, api_key
         end
 
         case format.to_s.downcase
-        when 'json' then connection.use Faraday::Response::ParseJson
+        when 'json' then connection.response :json, :content_type => /\bjson$/
         end
         connection.use FaradayMiddleware::RaiseHttpException
         connection.adapter(adapter)

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

@@ -24,14 +24,15 @@ module BigcommerceOAuthAPI
     def request(method, path, options)
       response = connection.send(method) do |request|
         case method
-        when :get, :delete
-          request.url(path, options)
-        when :post, :put
-          request.path = path
-          request.body = options if !options.empty?
+          when :get, :delete
+            request.url(path, options)
+          when :post, :put
+            request.path = path
+            request.body = options if !options.empty?
         end
       end
-      if response.status == 204
+
+      if response.status == 204 || response.status == 304
         nil
       elsif response.body.is_a?(Array)
         response.body.map { |resource| Resource.new(resource) }

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

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

data/spec/bigcommerce_oauth_api/api_spec.rb

@@ -36,6 +36,7 @@ module BigcommerceOAuthAPI
               :access_token => 'd',
               :adapter => 'e',
               :store_hash => 'f',
+              :if_modified_since => 'i',
               :user_name => 'g',
               :api_key => 'h',
           }

data/spec/bigcommerce_oauth_api/request_spec.rb

@@ -17,7 +17,8 @@ describe BigcommerceOAuthAPI::Request do
         path = '/awesome/1/path/1'
         options = { foo: 'bar', bar: { oof: 'rab' } }
         url = @client.send(:connection).build_url(path).to_s
-        stub_request(:get, url).to_return(:status => 200, :body => options.to_json, :headers => {})
+        stub_request(:get, url).to_return(:status => 200, :body => options.to_json, :headers => {
+                                                            content_type: 'application/json' })
 
         expect(@client.get(path, {})).to eql(BigcommerceOAuthAPI::Resource.new(options))
         expect(a_request(:get, url).
@@ -26,11 +27,25 @@ describe BigcommerceOAuthAPI::Request do
       end
     end
 
+    context 'given a request that returns an array' do
+      it 'should parse the response and into an array of resource objects' do
+        path = '/awesome/1/path/1'
+        options = [{ foo: 'bar', bar: { oof: 'rab' } }, { bar: 'bar', bar: { rab: 'rab' } }]
+        url = @client.send(:connection).build_url(path).to_s
+        stub_request(:get, url).to_return(:status => 200, :body => options.to_json, :headers => {
+                                                            content_type: 'application/json' })
+        expect(@client.get(path, {})).to eql(options.map { |entry| BigcommerceOAuthAPI::Resource.new(entry) } )
+        expect(a_request(:get, url).
+                   with(:headers => {'X-Auth-Client' => 'SECRET_ID',
+                                     'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+      end
+    end
+
     context 'given a request that returns no content' do
       it 'returns nil' do
         path = '/awesome/1/path/1'
         url = @client.send(:connection).build_url(path).to_s
-        stub_request(:get, url).to_return(:status => 204, :body => '', :headers => {})
+        stub_request(:get, url).to_return(:status => 204, :body => '', :headers => { content_type: 'application/json' })
 
         expect(@client.get(path, {})).to eql(nil)
         expect(a_request(:get, url).
@@ -40,5 +55,18 @@ describe BigcommerceOAuthAPI::Request do
       end
     end
 
+    context 'given a request that returns not modified' do
+      it 'returns nil' do
+        path = '/awesome/1/path/1'
+        url = @client.send(:connection).build_url(path).to_s
+        stub_request(:get, url).to_return(:status => 304, :body => '', :headers => { content_type: 'application/json' })
+
+        expect(@client.get(path, {})).to be_nil
+        expect(a_request(:get, url).
+                   with(:headers => {'X-Auth-Client' => 'SECRET_ID',
+                                     'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bigcommerce-oauth-api
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Christian Orthmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-19 00:00:00.000000000 Z
+date: 2015-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake