bigcommerce-oauth-api 1.1.1 → 1.1.2

data/spec/bigcommerce_oauth_api/client_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'bigcommerce-oauth-api/client'
+require 'bigcommerce-oauth-api/error'
+
+module BigcommerceOAuthAPI
+  describe BigcommerceOAuthAPI::Client do
+    before do
+      @client = BigcommerceOAuthAPI::Client.new(:store_hash => 'TEST_STORE',
+                                                :client_id => 'SECRET_ID',
+                                                :access_token => 'SECRET_TOKEN')
+    end
+
+    describe 'when using with_api_methods' do
+      context 'and one of those actions would overwrite a defined method' do
+        it 'raises MethodAlreadyDefinedError' do
+          # The required client attempts to overwrite the 'post' method which is used to make HTTP POST requests
+          expect {
+            require 'support/method_already_defined_client'
+          }.to raise_error(BigcommerceOAuthAPI::MethodAlreadyDefinedError, "Method already defined: 'post'")
+        end
+      end
+
+      context 'and two api definitions would define methods with the same name' do
+        it 'raises MethodAlreadyDefinedError' do
+          # The required client has duplicate api definitions
+          expect {
+            require 'support/duplicate_api_definition_client'
+          }.to raise_error(BigcommerceOAuthAPI::MethodAlreadyDefinedError, "Method already defined: 'states'")
+        end
+      end
+    end
+
+    describe '.time' do
+      it 'returns the server time' do
+        stub_get(@client, 'time').
+            to_return(:headers => { :content_type => "application/#{@client.format}" })
+        @client.time
+        expect(a_get(@client, 'time').
+                   with(:headers => {'X-Auth-Client' => 'SECRET_ID',
+                                     'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+      end
+    end
+
+    describe '.store_information' do
+      it 'returns the store information' do
+        stub_get(@client, 'store').
+            to_return(:headers => { :content_type => "application/#{@client.format}" })
+        @client.store_information
+        expect(a_get(@client, 'store').
+                   with(:headers => {'X-Auth-Client' => 'SECRET_ID',
+                                     'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+      end
+    end
+
+    describe '.product_googleproductsearch' do
+      it 'returns the google product search mappings for a product' do
+        product_id = 10
+        stub_get(@client, "products/#{product_id}/googleproductsearch").
+            to_return(:headers => { :content_type => "application/#{@client.format}" })
+        @client.product_googleproductsearch(product_id)
+        expect(a_get(@client, "products/#{product_id}/googleproductsearch").
+                   with(:headers => {'X-Auth-Client' => 'SECRET_ID',
+                                     'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+      end
+    end
+
+  end
+end

data/spec/bigcommerce_oauth_api/configuration_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'bigcommerce-oauth-api/configuration'
+
+module BigcommerceOAuthAPI
+  describe BigcommerceOAuthAPI::Configuration do
+    after do
+      BigcommerceOAuthAPI.reset
+    end
+
+    describe '.configure' do
+      BigcommerceOAuthAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
+        it "should set the #{key}" do
+          BigcommerceOAuthAPI.configure do |config|
+            config.send("#{key}=", key)
+            expect(BigcommerceOAuthAPI.send(key)).to eql(key)
+          end
+        end
+      end
+    end
+
+    BigcommerceOAuthAPI::Configuration::VALID_OPTIONS_KEYS.each do |key|
+      describe ".#{key}" do
+        it 'should reutrn the default value' do
+          expect(BigcommerceOAuthAPI.send(key)).to eql(BigcommerceOAuthAPI::Configuration.const_get("DEFAULT_#{key.upcase}"))
+        end
+      end
+    end
+  end
+end

data/spec/bigcommerce_oauth_api/request_spec.rb

@@ -0,0 +1,23 @@
+require 'bigcommerce-oauth-api/request'
+require 'bigcommerce-oauth-api/client'
+
+describe BigcommerceOAuthAPI::Request do
+  describe '#get' do
+    context 'given a path and set of options' do
+      it 'should perform HTTP GET with OAuth headers' do
+        client = BigcommerceOAuthAPI::Client.new(
+            :store_hash => 'TEST_STORE',
+            :client_id => 'SECRET_ID',
+            :access_token => 'SECRET_TOKEN')
+        path = '/awesome/1/path/1'
+        url = client.send(:connection).build_url(path).to_s
+        stub_request(:get, url).to_return(:status => 200, :body => '', :headers => {})
+
+        client.get(path, {})
+        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

data/spec/bigcommerce_oauth_api/resource_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'bigcommerce-oauth-api/resource'
+
+module BigcommerceOAuthAPI
+  describe BigcommerceOAuthAPI::Resource do
+    context 'when initialized with a hash' do
+      let(:instance) do
+        described_class.new({ a: 'foo', b: 'bar', c: { foo: 'bar'} })
+      end
+
+      it 'responds to the methods corresponding to the hash keys' do
+        expect(instance.respond_to?(:a)).to eql(true)
+        expect(instance.respond_to?(:b)).to eql(true)
+        expect(instance.respond_to?(:c)).to eql(true)
+      end
+
+      it 'returns the correct values when accessing through methods' do
+        expect(instance.a).to eql('foo')
+        expect(instance.b).to eql('bar')
+        expect(instance.c).to be_a Resource
+        expect(instance.c['foo']).to eql('bar')
+        expect(instance.c[:foo]).to eql('bar')
+        expect(instance.c.foo).to eql('bar')
+      end
+    end
+
+    context 'when initialized with a deeply nested hash' do
+      let(:instance) do
+        described_class.new({a: { b: { c: { d: 'e' } } } })
+      end
+
+      it 'responds to both methods and keys on all level' do
+        expect(instance.respond_to?(:a)).to eql(true)
+        expect(instance.a.respond_to?(:b)).to eql(true)
+        expect(instance.a.b.respond_to?(:c)).to eql(true)
+        expect(instance.a.b.c.respond_to?(:d)).to eql(true)
+        expect(instance[:a][:b][:c][:d]).to eql('e')
+        expect(instance['a']['b']['c']['d']).to eql('e')
+        expect(instance.a.b.c.d).to eql('e')
+      end
+    end
+  end
+end

data/spec/faraday/response_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'bigcommerce-oauth-api'
+
+describe Faraday::Response do
+  before do
+    @client = BigcommerceOAuthAPI::Client.new(:store_hash => 'TEST_STORE',
+                                              :client_id => 'SECRET_ID',
+                                              :access_token => 'SECRET_TOKEN')
+  end
+
+  {
+      400 => BigcommerceOAuthAPI::BadRequest,
+      404 => BigcommerceOAuthAPI::NotFound,
+      429 => BigcommerceOAuthAPI::TooManyRequests,
+      500 => BigcommerceOAuthAPI::InternalServerError,
+      502 => BigcommerceOAuthAPI::BadGateway
+  }.each do |status, exception|
+    context "when HTTP status is #{status}" do
+      before do
+        stub_get(@client, 'products/1337').to_return(:body => '', :status => status)
+      end
+
+      it "should raise #{exception.name} error" do
+        expect{ @client.product(1337) }.to raise_error(exception)
+      end
+    end
+  end
+
+  context 'when the api limit is hit' do
+    it 'raises a TooManyRequests error' do
+      stub_get(@client, 'products').
+          to_return(:body => '', :status => 429, :headers => { 'X-Retry-After' => 15 })
+      expect{ @client.products }.to raise_error(BigcommerceOAuthAPI::TooManyRequests, '15')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+require 'simplecov'
+require 'simplecov-rcov'
+require 'codeclimate-test-reporter'
+
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::RcovFormatter,
+    CodeClimate::TestReporter::Formatter
+  ]
+  add_group('BigcommerceOAuthAPI', 'lib/bigcommerce-oauth-api')
+  add_group('Faraday', 'lib/faraday')
+  add_group('Specs', 'spec')
+end
+
+require 'bigcommerce-oauth-api'
+
+require 'rspec'
+require 'webmock/rspec'
+RSpec.configure do |config|
+  config.include WebMock::API
+end
+
+WebMock.disable_net_connect!(:allow => 'codeclimate.com')
+
+def stub_get(client, path)
+  stub_request(:get, "#{client.endpoint}/#{client.store_hash}/v2/#{path}")
+end
+
+def stub_post(client, path)
+  stub_request(:post, "#{client.endpoint}/#{client.store_hash}/v2/#{path}")
+end
+
+def stub_put(client, path)
+  stub_request(:put, "#{client.endpoint}/#{client.store_hash}/v2/#{path}")
+end
+
+def stub_delete(client, path)
+  stub_request(:delete, "#{client.endpoint}/#{client.store_hash}/v2/#{path}")
+end
+
+def a_get(client, path)
+  a_request(:get, "#{client.endpoint}/#{client.store_hash}/v2/#{path}")
+end
+
+def a_post(client, path)
+  a_request(:post, "#{client.endpoint}/#{client.store_hash}/v2/#{path}")
+end
+
+def a_put(client, path)
+  a_request(:put, "#{client.endpoint}/#{client.store_hash}/v2/#{path}")
+end
+
+def a_delete(client, path)
+  a_request(:delete, "#{client.endpoint}/#{client.store_hash}/v2/#{path}")
+end

data/spec/support/duplicate_api_definition_client.rb

@@ -0,0 +1,7 @@
+require 'bigcommerce-oauth-api'
+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

data/spec/support/method_already_defined_client.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bigcommerce-oauth-api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Christian Orthmann
@@ -133,7 +133,35 @@ email: christian.orthmann@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bigcommerce-oauth-api.gemspec
+- lib/bigcommerce-oauth-api.rb
+- lib/bigcommerce-oauth-api/api.rb
+- lib/bigcommerce-oauth-api/base.rb
+- lib/bigcommerce-oauth-api/client.rb
+- lib/bigcommerce-oauth-api/configuration.rb
+- lib/bigcommerce-oauth-api/connection.rb
+- lib/bigcommerce-oauth-api/error.rb
+- lib/bigcommerce-oauth-api/request.rb
+- lib/bigcommerce-oauth-api/resource.rb
+- lib/bigcommerce-oauth-api/version.rb
+- lib/faraday/raise_http_exception.rb
+- spec/bigcommerce_oauth_api/api_spec.rb
+- spec/bigcommerce_oauth_api/client/client_module_spec.rb
+- spec/bigcommerce_oauth_api/client/client_nested_module_spec.rb
+- spec/bigcommerce_oauth_api/client_spec.rb
+- spec/bigcommerce_oauth_api/configuration_spec.rb
+- spec/bigcommerce_oauth_api/request_spec.rb
+- spec/bigcommerce_oauth_api/resource_spec.rb
+- spec/faraday/response_spec.rb
+- spec/spec_helper.rb
+- spec/support/duplicate_api_definition_client.rb
+- spec/support/method_already_defined_client.rb
 homepage: http://rubygems.org/gems/bigcommerce-oauth-api
 licenses:
 - MIT