bigcommerce-oauth-api 1.1.1 → 1.1.2

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

@@ -0,0 +1,46 @@
+require 'faraday'
+
+module BigcommerceOAuthAPI
+  module Configuration
+
+    VALID_OPTIONS_KEYS = [
+        :store_hash,
+        :endpoint,
+        :adapter,
+        :client_id,
+        :access_token,
+        :format
+    ].freeze
+
+    DEFAULT_STORE_HASH = nil
+    DEFAULT_ENDPOINT = 'https://api.bigcommerce.com/stores'.freeze
+    DEFAULT_CLIENT_ID = nil
+    DEFAULT_ACCESS_TOKEN = nil
+    DEFAULT_FORMAT = :json
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.store_hash = DEFAULT_STORE_HASH
+      self.endpoint = DEFAULT_ENDPOINT
+      self.format = DEFAULT_FORMAT
+      self.client_id = DEFAULT_CLIENT_ID
+      self.access_token = DEFAULT_ACCESS_TOKEN
+      self.adapter = DEFAULT_ADAPTER
+    end
+
+    def configure
+      yield self
+    end
+
+    # Return the configuration values set in this module
+    def options
+      Hash[ * VALID_OPTIONS_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each { |f| require f }
+
+module BigcommerceOAuthAPI
+  module Connection
+    private
+
+    def connection
+      options = {
+          :headers => {
+              'Accept' => "application/#{format}; charset=utf-8",
+              'X-Auth-Client' => client_id,
+              'X-Auth-Token' => access_token
+          },
+          :url => "#{endpoint}/#{store_hash}/v2/"
+      }
+
+      Faraday::Connection.new(options) do |connection|
+        connection.use Faraday::Request::UrlEncoded
+        case format.to_s.downcase
+        when 'json' then connection.use Faraday::Response::ParseJson
+        end
+        connection.use FaradayMiddleware::RaiseHttpException
+        connection.adapter(adapter)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module BigcommerceOAuthAPI
+  class Error < StandardError
+    def inspect
+      "#<BigcommerceOAuthAPI::Error: BigcommerceOAuthAPI::Error message=\"#{message}\">"
+    end
+  end
+
+  # 400 HTTP
+  class BadRequest < Error; end
+
+  # 404 HTTP
+  class NotFound < Error; end
+
+  # 429 HTTP
+  class TooManyRequests < Error; end
+
+  # 500 HTTP
+  class InternalServerError < Error; end
+
+  # 502 HTTP
+  class BadGateway < 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
+end

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

@@ -0,0 +1,41 @@
+require 'bigcommerce-oauth-api/resource'
+
+module BigcommerceOAuthAPI
+  module Request
+
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+
+    def put(path, options = {})
+      request(:put, path, options)
+    end
+
+    def delete(path, options = {})
+      request(:delete, path, options)
+    end
+
+    private
+
+    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?
+        end
+      end
+      if response.body.is_a?(Array)
+        response.body.map { |resource| Resource.new(resource) }
+      else
+        Resource.new(response.body)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
+module BigcommerceOAuthAPI
+  class Resource
+    def initialize(attributes)
+      @attributes = HashWithIndifferentAccess.new(attributes)
+    end
+
+    def [](key)
+      @attributes[key.to_sym]
+    end
+
+    def []=(key, value)
+      @attributes[key.to_sym] = value
+    end
+
+    def respond_to?(method_name)
+      super(method_name) ? true : @attributes.include?(method_name.to_s.gsub(/(\?$)|(=$)/, '').to_sym)
+    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)
+        self.instance_eval build_attribute_getter(attribute_name)
+        send(method_sym, *arguments)
+      else
+        super(method_sym, *arguments)
+      end
+    end
+
+    def build_attribute_getter(attribute_name)
+      "def #{attribute_name}
+        if @attributes[:#{attribute_name}] && @attributes[:#{attribute_name}].is_a?(Hash)
+          memoize(:#{attribute_name}) do
+            self.class.new(@attributes[:#{attribute_name}])
+          end
+        else
+          @attributes[:#{attribute_name}]
+        end
+      end"
+    end
+
+    private
+
+    def memoize(name, &block)
+      var = instance_variable_get("@#{name.to_s}") rescue nil
+      if var.nil? && block_given?
+        var = yield
+        instance_variable_set("@#{name.to_s}", var)
+      end
+
+      var
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module BigcommerceOAuthAPI
+  VERSION = '1.1.2'.freeze
+end

data/lib/faraday/raise_http_exception.rb

@@ -0,0 +1,26 @@
+require 'faraday'
+
+module FaradayMiddleware
+  class RaiseHttpException < Faraday::Middleware
+    def call(env)
+      @app.call(env).on_complete do |response|
+        case response[:status].to_i
+        when 400
+          raise BigcommerceOAuthAPI::BadRequest, response[:body]
+        when 404
+          raise BigcommerceOAuthAPI::NotFound, response[:body]
+        when 429
+          raise BigcommerceOAuthAPI::TooManyRequests, response[:response_headers]['X-Retry-After']
+        when 500
+          raise BigcommerceOAuthAPI::InternalServerError, response[:body]
+        when 502
+          raise BigcommerceOAuthAPI::BadGateway, response[:body]
+        end
+      end
+    end
+
+    def initialize(app)
+      super app
+    end
+  end
+end

data/spec/bigcommerce_oauth_api/api_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'bigcommerce-oauth-api/api'
+
+module BigcommerceOAuthAPI
+  describe BigcommerceOAuthAPI::API do
+    before do
+      @keys = BigcommerceOAuthAPI::Configuration::VALID_OPTIONS_KEYS
+    end
+
+    describe 'with module configuration' do
+      before do
+        BigcommerceOAuthAPI.configure do |config|
+          @keys.each do |key|
+            config.send("#{key}=", key)
+          end
+        end
+      end
+
+      after do
+        BigcommerceOAuthAPI.reset
+      end
+
+      it 'should inherit module configuration' do
+        api = described_class.new
+        @keys.each do |key|
+          expect(api.send(key)).to eql(key)
+        end
+      end
+
+      describe 'with class configuration' do
+        before do
+          @config = {
+              :endpoint => 'a',
+              :format => 'b',
+              :client_id => 'c',
+              :access_token => 'd',
+              :adapter => 'e',
+              :store_hash => 'f'
+          }
+        end
+
+        it 'should override module configuration' do
+          api = described_class.new
+          @config.each do |key, value|
+            api.send("#{key}=", value)
+          end
+
+          @keys.each do |key|
+            expect(api.send("#{key}")).to eql(@config[key])
+          end
+        end
+      end
+    end
+  end
+end

data/spec/bigcommerce_oauth_api/client/client_module_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+require 'active_support/inflector'
+require 'bigcommerce-oauth-api'
+require 'bigcommerce-oauth-api/client'
+
+describe BigcommerceOAuthAPI::Client do
+  [
+      { api_module: 'post', methods: [:all, :select, :create, :update, :delete], prefix_paths: 'blog', prefix_methods: 'blog'},
+      { api_module: 'tag', methods: [:all], prefix_paths: 'blog', prefix_methods: 'blog'},
+      { api_module: 'brand', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'category', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'customer', methods: [:all, :select, :create, :update, :delete, :count]},
+      { api_module: 'customer_group', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'country', scope: :self, methods: [:all, :select]},
+      { api_module: 'state', scope: :self, methods: [:all, :select]},
+      { api_module: 'order', methods: [:all, :select, :create, :update, :delete, :count]},
+      { api_module: 'method', methods: [:all], prefix_paths: 'payments', prefix_methods: 'payment'},
+      { api_module: 'option', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'option_set', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'product', methods: [:all, :select, :create, :update, :delete, :count]},
+      { api_module: 'coupon', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'redirect', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'method', methods: [:all, :select], prefix_paths: 'shipping', prefix_methods: 'shipping'},
+      { api_module: 'tax_class', scope: :self, methods: [:all, :select]},
+      { api_module: 'hook', methods: [:all, :select, :create, :update, :delete]},
+  ]. each do |api_description|
+    api_module = api_description[:api_module]
+    api_module_pluralized = api_module.pluralize
+    path_prefix = (api_description.has_key?(:prefix_paths) ? "#{api_description[:prefix_paths]}/" : nil)
+    method_prefix = (api_description.has_key?(:prefix_methods) ? "#{api_description[:prefix_methods]}_" : nil)
+
+    before do
+      @client = BigcommerceOAuthAPI::Client.new(:store_hash => 'TEST_STORE',
+                                                :client_id => 'SECRET_ID',
+                                                :access_token => 'SECRET_TOKEN')
+    end
+
+    if api_description[:methods].include?(:all)
+      describe ".#{method_prefix}#{api_module_pluralized}" do
+        it "should get a list of #{api_module_pluralized}" do
+          stub_get(@client, "#{path_prefix}#{api_module_pluralized}").
+              to_return(:headers => { :content_type => "application/#{@client.format}" })
+          @client.send("#{method_prefix}#{api_module_pluralized}".to_sym)
+          expect(a_get(@client, "#{path_prefix}#{api_module_pluralized}").
+                     with(:headers => {'X-Auth-Client' => 'SECRET_ID',
+                                       'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+        end
+      end
+    end
+
+    if api_description[:methods].include?(:select)
+      describe ".#{method_prefix}#{api_module}" do
+        it "gets the #{api_module} with the given id" do
+          id = 10
+          stub_get(@client, "#{path_prefix}#{api_module_pluralized}/#{id}").
+              to_return(:headers => { :content_type => "application/#{@client.format}" })
+          @client.send("#{method_prefix}#{api_module}".to_sym, id)
+          expect(a_get(@client, "#{path_prefix}#{api_module_pluralized}/#{id}").
+                     with(:headers => {'X-Auth-Client' => 'SECRET_ID',
+                                       'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+        end
+      end
+    end
+
+    if api_description[:methods].include?(:create)
+      describe ".create_#{method_prefix}#{api_module}" do
+        it "creates a #{api_module} with the given attributes" do
+          options = { name: 'A', description: 'B'}
+          stub_post(@client, "#{path_prefix}#{api_module_pluralized}").
+              to_return(:body => options.to_json, :headers => { :content_type => "application/#{@client.format}" })
+          @client.send("create_#{method_prefix}#{api_module}".to_sym, options)
+          expect(a_post(@client, "#{path_prefix}#{api_module_pluralized}").
+                     with(:body => options,
+                          :headers => {'X-Auth-Client' => 'SECRET_ID',
+                                       'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+        end
+      end
+    end
+
+    if api_description[:methods].include?(:update)
+      describe ".update_#{method_prefix}#{api_module}" do
+        it "update the attributes of the #{api_module} with the given id" do
+          id = 10
+          options = { name: 'A', description: 'B'}
+          stub_put(@client, "#{path_prefix}#{api_module_pluralized}/#{id}").
+              with(:body => options).
+              to_return(:body => '', :headers => { :content_type => "application/#{@client.format}" })
+          @client.send("update_#{method_prefix}#{api_module}".to_sym, id, options)
+          expect(a_put(@client, "#{path_prefix}#{api_module_pluralized}/#{id}").
+                     with(:body => options,
+                          :headers => {'X-Auth-Client' => 'SECRET_ID',
+                                       'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+        end
+      end
+    end
+
+    if api_description[:methods].include?(:delete)
+      describe ".delete_#{method_prefix}#{api_module}" do
+        it "deletes the #{api_module} with the given id" do
+          id = 10
+          stub_delete(@client, "#{path_prefix}#{api_module_pluralized}/#{id}").
+              to_return(:headers => { :content_type => "application/#{@client.format}" })
+          @client.send("delete_#{method_prefix}#{api_module}".to_sym, id)
+          expect(a_delete(@client, "#{path_prefix}#{api_module_pluralized}/#{id}").
+                     with(:headers => {'X-Auth-Client' => 'SECRET_ID',
+                                       'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+        end
+      end
+    end
+
+    if api_description[:methods].include?(:count)
+      describe ".#{method_prefix}#{api_module_pluralized}_count" do
+        it "returns the number of #{api_module_pluralized}" do
+          stub_get(@client, "#{path_prefix}#{api_module_pluralized}/count").
+              to_return(:body => '', :headers => { :content_type => "application/#{@client.format}" })
+          @client.send("#{method_prefix}#{api_module_pluralized}_count".to_sym)
+          expect(a_get(@client, "#{path_prefix}#{api_module_pluralized}/count").
+                     with(:headers => {'X-Auth-Client' => 'SECRET_ID',
+                                       'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+        end
+      end
+    end
+  end
+end

data/spec/bigcommerce_oauth_api/client/client_nested_module_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+require 'active_support/inflector'
+require 'bigcommerce-oauth-api'
+require 'bigcommerce-oauth-api/client'
+
+describe BigcommerceOAuthAPI::Client do
+  [
+      { api_module: 'product', api_parent_module: 'order', methods: [:all, :select]},
+      { api_module: 'shipping_address', api_parent_module: 'order', methods: [:all, :select]},
+      { api_module: 'message', api_parent_module: 'order', methods: [:all, :select]},
+      { api_module: 'shipment', api_parent_module: 'order', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'configurable_field', api_parent_module: 'product', methods: [:all, :select, :delete]},
+      { api_module: 'custom_field', api_parent_module: 'product', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'option', api_parent_module: 'option_set', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'value', api_parent_module: 'option_set', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'discount_rule', api_parent_module: 'product', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'image', api_parent_module: 'product', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'option', api_parent_module: 'product', methods: [:all, :select]},
+      { api_module: 'review', api_parent_module: 'product', methods: [:all]},
+      { api_module: 'rule', api_parent_module: 'product', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'video', api_parent_module: 'product', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'sku', api_parent_module: 'product', methods: [:all, :select, :create, :update, :delete]},
+      { api_module: 'address', api_parent_module: 'customer', methods: [:all, :select, :create, :update, :delete]}
+  ]. each do |nested_module|
+    api_parent_module = nested_module[:api_parent_module]
+    api_parent_module_pluralized = nested_module[:api_parent_module].pluralize
+    api_module = nested_module[:api_module]
+    api_module_pluralized = api_module.pluralize
+    path_prefix = (nested_module.has_key?(:prefix_paths) ? "#{nested_module[:prefix_paths]}/" : nil)
+    method_prefix = (nested_module.has_key?(:prefix_methods) ? "#{nested_module[:prefix_methods]}_" : nil)
+
+    before do
+      @client = BigcommerceOAuthAPI::Client.new(:store_hash => 'TEST_STORE',
+                                                :client_id => 'SECRET_ID',
+                                                :access_token => 'SECRET_TOKEN')
+    end
+
+    if nested_module[:methods].include?(:all)
+      describe ".#{method_prefix}#{api_parent_module}_#{api_module_pluralized}" do
+        it "should get a list of #{api_module_pluralized} for the given #{api_parent_module}" do
+          parent_id = 10
+          stub_get(@client, "#{path_prefix}#{api_parent_module_pluralized}/#{parent_id}/#{api_module_pluralized}").
+              to_return(:headers => { :content_type => "application/#{@client.format}" })
+          @client.send("#{method_prefix}#{api_parent_module}_#{api_module_pluralized}".to_sym, parent_id)
+          expect(a_get(@client, "#{path_prefix}#{api_parent_module_pluralized}/#{parent_id}/#{api_module_pluralized}").
+                     with(:headers => {'X-Auth-Client' => 'SECRET_ID',
+                                       'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+        end
+      end
+    end
+
+    if nested_module[:methods].include?(:select)
+      describe ".#{method_prefix}#{api_parent_module}_#{api_module}" do
+        it "gets the #{api_module} with the given id for the given #{api_parent_module}" do
+          id = 10
+          parent_id = 5
+          stub_get(@client, "#{path_prefix}#{api_parent_module_pluralized}/#{parent_id}/#{api_module_pluralized}/#{id}").
+              to_return(:headers => { :content_type => "application/#{@client.format}" })
+          @client.send("#{method_prefix}#{api_parent_module}_#{api_module}".to_sym, parent_id, id)
+          expect(a_get(@client, "#{path_prefix}#{api_parent_module_pluralized}/#{parent_id}/#{api_module_pluralized}/#{id}").
+                     with(:headers => {'X-Auth-Client' => 'SECRET_ID',
+                                       'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+        end
+      end
+    end
+
+    if nested_module[:methods].include?(:create)
+      describe ".create_#{method_prefix}#{api_parent_module}_#{api_module}" do
+        it "creates a #{api_module} with the given attributes for the given #{api_parent_module}" do
+          options = { name: 'A', description: 'B'}
+          parent_id = 5
+          stub_post(@client, "#{path_prefix}#{api_parent_module_pluralized}/#{parent_id}/#{api_module_pluralized}").
+              to_return(:body => options.to_json, :headers => { :content_type => "application/#{@client.format}" })
+          @client.send("create_#{method_prefix}#{api_parent_module}_#{api_module}".to_sym, parent_id, options)
+          expect(a_post(@client, "#{path_prefix}#{api_parent_module_pluralized}/#{parent_id}/#{api_module_pluralized}").
+                     with(:body => options,
+                          :headers => {'X-Auth-Client' => 'SECRET_ID',
+                                       'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+        end
+      end
+    end
+
+    if nested_module[:methods].include?(:update)
+      describe ".update_#{method_prefix}#{api_parent_module}_#{api_module}" do
+        it "update the attributes of the #{api_module} with the given id for the #{api_parent_module}" do
+          id = 10
+          parent_id = 5
+          options = { name: 'A', description: 'B'}
+          stub_put(@client, "#{path_prefix}#{api_parent_module_pluralized}/#{parent_id}/#{api_module_pluralized}/#{id}").
+              with(:body => options).
+              to_return(:body => '', :headers => { :content_type => "application/#{@client.format}" })
+          @client.send("update_#{method_prefix}#{api_parent_module}_#{api_module}".to_sym, parent_id, id, options)
+          expect(a_put(@client, "#{path_prefix}#{api_parent_module_pluralized}/#{parent_id}/#{api_module_pluralized}/#{id}").
+                     with(:body => options,
+                          :headers => {'X-Auth-Client' => 'SECRET_ID',
+                                       'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+        end
+      end
+    end
+
+    if nested_module[:methods].include?(:delete)
+      describe ".delete_#{method_prefix}#{api_parent_module}_#{api_module}" do
+        it "deletes the #{api_module} with the given id for the #{api_parent_module}" do
+          id = 10
+          parent_id = 5
+          stub_delete(@client, "#{path_prefix}#{api_parent_module_pluralized}/#{parent_id}/#{api_module_pluralized}/#{id}").
+              to_return(:headers => { :content_type => "application/#{@client.format}" })
+          @client.send("delete_#{method_prefix}#{api_parent_module}_#{api_module}".to_sym, parent_id, id)
+          expect(a_delete(@client, "#{path_prefix}#{api_parent_module_pluralized}/#{parent_id}/#{api_module_pluralized}/#{id}").
+                     with(:headers => {'X-Auth-Client' => 'SECRET_ID',
+                                       'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+        end
+      end
+    end
+
+    if nested_module[:methods].include?(:count)
+      describe ".#{method_prefix}#{api_module_pluralized}_count" do
+        it "returns the number of #{api_module_pluralized} for the #{api_parent_module}" do
+          parent_id = 5
+          stub_get(@client, "#{path_prefix}#{api_parent_module_pluralized}/#{parent_id}/#{api_module_pluralized}/count").
+              to_return(:body => '', :headers => { :content_type => "application/#{@client.format}" })
+          @client.send("#{method_prefix}#{api_module_pluralized}_count".to_sym)
+          expect(a_get(@client, "#{path_prefix}#{api_parent_module_pluralized}/#{parent_id}/#{api_module_pluralized}/count").
+                     with(:headers => {'X-Auth-Client' => 'SECRET_ID',
+                                       'X-Auth-Token' => 'SECRET_TOKEN'})).to have_been_made
+        end
+      end
+    end
+  end
+end