bigcommerce 0.10.0 → 1.0.0.beta

data/lib/bigcommerce/resources/products/product_image.rb

@@ -0,0 +1,31 @@
+# Product Image
+# Images associated with a product.
+# https://developer.bigcommerce.com/api/stores/v2/products/images
+
+module Bigcommerce
+  class ProductImage < Resource
+    include Bigcommerce::SubresourceActions.new uri: 'products/%d/images/%d'
+
+    property :id
+    property :count
+    property :product_id
+    property :image_file
+    property :is_thumbnail
+    property :sort_order
+    property :zoom_url
+    property :thumbnail_url
+    property :standard_url
+    property :tiny_url
+    property :is_sample
+    property :description
+    property :date_created
+
+    def self.count(product_id)
+      get "products/#{product_id}/images/count"
+    end
+
+    def self.count_all
+      get 'products/images/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/products/product_option.rb

@@ -0,0 +1,17 @@
+# Product Option
+# Options associated directly with a product.
+# https://developer.bigcommerce.com/api/stores/v2/products/options
+
+module Bigcommerce
+  class ProductOption < Resource
+    include Bigcommerce::SubresourceActions.new(
+      uri: 'products/%d/options/%d',
+      disable: [:create, :update, :destroy, :destroy_all])
+
+    property :id
+    property :option_id
+    property :display_name
+    property :sort_order
+    property :is_required
+  end
+end

data/lib/bigcommerce/resources/products/product_review.rb

@@ -0,0 +1,22 @@
+# Product Review
+# Options associated directly with a product.
+# https://developer.bigcommerce.com/api/stores/v2/products/reviews
+
+module Bigcommerce
+  class ProductReview < Resource
+    include Bigcommerce::Request.new 'products/%d/reviews'
+
+    property :id
+    property :product_id
+    property :author
+    property :date_created
+    property :rating
+    property :title
+    property :review
+    property :status
+
+    def self.all(product_id)
+      get path.build(product_id)
+    end
+  end
+end

data/lib/bigcommerce/resources/products/product_rule.rb

@@ -0,0 +1,31 @@
+# Product Rule
+# Rules that modify the default behaviour of products.
+# https://developer.bigcommerce.com/api/stores/v2/products/rules
+
+module Bigcommerce
+  class ProductRule < Resource
+    include Bigcommerce::SubresourceActions.new uri: 'products/%d/rules/%d'
+
+    property :id
+    property :count
+    property :product_id
+    property :sort_order
+    property :is_enabled
+    property :is_stop
+    property :price_adjuster
+    property :weight_adjuster
+    property :is_purchasing_disabled
+    property :purchasing_disabled_message
+    property :is_purchasing_hidden
+    property :image_file
+    property :conditions
+
+    def self.count(product_id)
+      get "products/#{product_id}/rules/count"
+    end
+
+    def self.count_all
+      get 'products/rules/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/products/product_video.rb

@@ -0,0 +1,24 @@
+# Product Video
+# Embedded videos displayed on product listings.
+# https://developer.bigcommerce.com/api/stores/v2/products/videos
+
+module Bigcommerce
+  class ProductVideo < Resource
+    include Bigcommerce::SubresourceActions.new uri: 'products/%d/videos/%s'
+
+    property :id
+    property :product_id
+    property :count
+    property :url
+    property :sort_order
+    property :name
+
+    def self.count(product_id)
+      get "products/#{product_id}/videos/count"
+    end
+
+    def self.count_all
+      get 'products/videos/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/products/sku.rb

@@ -0,0 +1,29 @@
+# SKU
+# Stock Keeping Unit identifiers associated with products.
+# https://developer.bigcommerce.com/api/stores/v2/products/skus
+
+module Bigcommerce
+  class Sku < Resource
+    include Bigcommerce::SubresourceActions.new uri: 'products/%d/skus/%d'
+
+    property :id
+    property :product_id
+    property :sku
+    property :cost_price
+    property :count
+    property :upc
+    property :inventory_level
+    property :intentory_warning_level
+    property :bin_picking_number
+    property :options
+    property :inventory_warning_level
+
+    def self.count_all
+      get 'products/skus/count'
+    end
+
+    def self.count(product_id)
+      get "products/#{product_id}/skus/count"
+    end
+  end
+end

data/lib/bigcommerce/resources/resource.rb

@@ -0,0 +1,10 @@
+require 'bigcommerce/request'
+require 'bigcommerce/resource_actions'
+require 'bigcommerce/subresource_actions'
+
+module Bigcommerce
+  class Resource < Hashie::Trash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IgnoreUndeclared
+  end
+end

data/lib/bigcommerce/resources/shipping/shipping_method.rb

@@ -0,0 +1,15 @@
+# Shipping Method
+# List of enabled shipping methods.
+# https://developer.bigcommerce.com/api/stores/v2/shipping/methods
+
+module Bigcommerce
+  class ShippingMethod < Resource
+    include Bigcommerce::ResourceActions.new(
+      uri: 'shipping/methods/%d',
+      disable: [:create, :update, :destroy, :destroy_all])
+
+    property :id
+    property :name
+    property :method_name
+  end
+end

data/lib/bigcommerce/resources/store/store_information.rb

@@ -0,0 +1,37 @@
+# Store Information
+# Metadata that describes the store.
+# https://developer.bigcommerce.com/api/stores/v2/store_information
+
+module Bigcommerce
+  class StoreInfo < Resource
+    include Bigcommerce::Request.new 'store'
+
+    property :id
+    property :domain
+    property :name
+    property :address
+    property :phone
+    property :admin_email
+    property :order_email
+    property :language
+    property :currency
+    property :currency_symbol
+    property :decimal_separator
+    property :thousands_separator
+    property :decimal_places
+    property :dimension_decimal_places
+    property :dimension_decimal_token
+    property :dimension_thousands_token
+    property :currency_symbol_location
+    property :is_price_entered_with_tax
+    property :active_comparison_modules
+    property :weight_units
+    property :dimension_units
+    property :plan_name
+    property :logo
+
+    def self.info
+      get path.build
+    end
+  end
+end

data/lib/bigcommerce/resources/system/time.rb

@@ -0,0 +1,15 @@
+# Time
+# Timestamp ping to check the system status.
+# https://developer.bigcommerce.com/api/stores/v2/time
+
+module Bigcommerce
+  class System < Resource
+    include Bigcommerce::Request.new 'time'
+
+    property :time
+
+    def self.time
+      get path.build
+    end
+  end
+end

data/lib/bigcommerce/resources/tax/tax_class.rb

@@ -0,0 +1,15 @@
+# Tax Class
+# Tax classes are used to apply different tax rates for specific types
+# of products and orders.
+# https://developer.bigcommerce.com/api/stores/v2/tax_classes
+
+module Bigcommerce
+  class TaxClass < Resource
+    include Bigcommerce::ResourceActions.new(
+      uri: 'tax_classes/%d',
+      disable: [:create, :update, :destroy, :destroy_all])
+
+    property :id
+    property :name
+  end
+end

data/lib/bigcommerce/resources/webhooks/webhook.rb

@@ -0,0 +1,22 @@
+# Webhook
+# Register and manage webhooks that connect events from a store to
+# external URLs.
+# https://developer.bigcommerce.com/api/stores/v2/webhooks
+
+module Bigcommerce
+  class Webhook < Resource
+    include Bigcommerce::ResourceActions.new(
+      uri: 'hooks/%d',
+      disable: [:destroy_all])
+
+    property :id
+    property :client_id
+    property :store_hash
+    property :scope
+    property :destination
+    property :headers
+    property :is_active
+    property :created_at
+    property :update_at
+  end
+end

data/lib/bigcommerce/subresource_actions.rb

@@ -0,0 +1,43 @@
+module Bigcommerce
+  class SubresourceActions < ResourceActions
+    def included(base)
+      base.send(:include, Request.new(options[:uri]))
+      base.extend(ClassMethods)
+      options[:disable_methods] ||= []
+      methods = ClassMethods.public_instance_methods & options[:disable_methods]
+      methods.each { |name| base.send(:remove_method, name) }
+    end
+
+    module ClassMethods
+      def all(parent_id, params = {})
+        fail ArgumentError if parent_id.nil?
+        get path.build(parent_id), params
+      end
+
+      def find(parent_id, resource_id)
+        fail ArgumentError if [parent_id, resource_id].any?(&:nil?)
+        get path.build([parent_id, resource_id])
+      end
+
+      def create(parent_id, params)
+        fail ArgumentError if parent_id.nil?
+        post path.build(parent_id), params
+      end
+
+      def update(parent_id, resource_id, params)
+        fail ArgumentError if [parent_id, resource_id].any?(&:nil?)
+        put path.build([parent_id, resource_id]), params
+      end
+
+      def destroy(parent_id, resource_id)
+        fail ArgumentError if [parent_id, resource_id].any?(&:nil?)
+        delete path.build([parent_id, resource_id])
+      end
+
+      def destroy_all(parent_id)
+        fail ArgumentError if parent_id.nil?
+        delete path.build(parent_id)
+      end
+    end
+  end
+end

data/lib/bigcommerce/version.rb

@@ -1,6 +1,3 @@
 module Bigcommerce
-  major = 0
-  minor = 10
-  patch = 0
-  VERSION = [major, minor, patch].join('.') unless defined? Bigcommerce::VERSION
+  VERSION = '1.0.0.beta'
 end

data/spec/bigcommerce/bigcommerce_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Bigcommerce do
+  let(:middleware) do
+    api.instance_variable_get('@builder').instance_variable_get('@handlers')
+  end
+
+  it 'should return a faraday object when configured' do
+    Bigcommerce.configure do |config|
+      config.url = 'http://foobar.com'
+      config.auth = 'legacy'
+      config.api_key = '214789175'
+      config.username = 'admin'
+    end
+    expect(Bigcommerce.api).to be_a_kind_of(Faraday::Connection)
+  end
+
+  describe '.build_connection' do
+    context 'when using legacy' do
+      let(:api) do
+        Bigcommerce.configure do |config|
+          config.url = 'http://foobar.com'
+          config.auth = 'legacy'
+          config.api_key = '214789175'
+          config.username = 'admin'
+        end
+      end
+
+      it 'should have the correct auth middleware' do
+        expect(middleware).to include(Faraday::Request::BasicAuthentication)
+      end
+    end
+
+    context 'when not using legacy' do
+      let(:api) do
+        Bigcommerce.configure do |config|
+          config.access_token = 'jksdgkjbhksjdb'
+          config.client_id = 'negskjgdjkbg'
+        end
+      end
+
+      it 'should have the correct auth middleware' do
+        expect(middleware).to include(Bigcommerce::Middleware::Auth)
+      end
+    end
+  end
+
+  describe 'multiple configurations' do
+    it 'should use the configuration for the most recently defined' do
+      Bigcommerce.configure do |config|
+        config.access_token = 'jksdgkjbhksjdb'
+        config.client_id = 'negskjgdjkbg'
+      end
+
+      Bigcommerce.configure do |config|
+        config.url = 'http://foobar.com'
+        config.auth = 'legacy'
+        config.api_key = '214789175'
+        config.username = 'admin'
+      end
+
+      expect(Bigcommerce.api.instance_variable_get('@builder')
+                .instance_variable_get('@handlers'))
+                .to include(Faraday::Request::BasicAuthentication)
+
+      Bigcommerce.configure do |config|
+        config.access_token = 'jksdgkjbhksjdb'
+        config.client_id = 'negskjgdjkbg'
+      end
+
+      expect(Bigcommerce.api.instance_variable_get('@builder')
+                .instance_variable_get('@handlers'))
+                .to include(Bigcommerce::Middleware::Auth)
+    end
+  end
+end

data/spec/bigcommerce/unit/actions_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+
+describe Bigcommerce::ResourceActions do
+  before do
+    module Bigcommerce
+      class DummyClass
+        include ResourceActions.new(uri: 'http://foo.bar/%d')
+      end
+    end
+    @klass = Bigcommerce::DummyClass
+  end
+
+  let(:params) do
+    { page: 1 }
+  end
+
+  it 'should have options' do
+    mod = Bigcommerce::ResourceActions.new(
+      uri: 'http://foo.bar',
+      disable: [:find,:all]
+    )
+    options = {
+      uri: 'http://foo.bar',
+      disable: [:find,:all]
+    }
+    expect(mod._options).to eq options
+  end
+
+  describe '.all' do
+    it 'should make a get request to the correct route with query params' do
+      expect(@klass).to receive(:get).with('http://foo.bar', page: 1)
+      @klass.all(params)
+    end
+
+    it 'should make a get request to the correct route' do
+      expect(@klass).to receive(:get).with('http://foo.bar', {})
+      params.delete(:params)
+      @klass.all
+    end
+  end
+
+  describe '.find' do
+    it 'should make a get request to the correct route' do
+      expect(@klass).to receive(:get).with('http://foo.bar/1')
+      @klass.find(1)
+    end
+  end
+
+  describe '.create' do
+    it 'should make a post request to the correct route with params' do
+      expect(@klass).to receive(:post).with('http://foo.bar', page: 1)
+      @klass.create(params)
+    end
+  end
+
+  describe '.update' do
+    it 'should make a put request to the correct route with params' do
+      expect(@klass).to receive(:put).with('http://foo.bar/1', page: 1)
+      @klass.update(1, params)
+    end
+  end
+
+  describe '.destroy' do
+    it 'should make a delete request to the correct route with params' do
+      expect(@klass).to receive(:delete).with('http://foo.bar/1')
+      @klass.destroy(1)
+    end
+  end
+
+  describe '.destroy_all' do
+    it 'should make a delete request to the correct route with params' do
+      expect(@klass).to receive(:delete).with('http://foo.bar')
+      @klass.destroy_all
+    end
+  end
+end
+
+describe Bigcommerce::SubresourceActions do
+  before do
+    module Bigcommerce
+      class DummyClass
+        include SubresourceActions.new(uri: 'http://foo.bar/%d/%d')
+      end
+    end
+    @klass = Bigcommerce::DummyClass
+  end
+
+  let(:params) do
+    { page: 1 }
+  end
+
+  it 'should have options' do
+    mod = Bigcommerce::SubresourceActions.new(
+      uri: 'http://foo.bar',
+      disable: [:find,:all]
+    )
+    options = {
+      uri: 'http://foo.bar',
+      disable: [:find,:all]
+    }
+    expect(mod._options).to eq options
+  end
+
+  describe '.all' do
+    it 'should make a get request to the correct route with query params' do
+      expect(@klass).to receive(:get).with('http://foo.bar/1', page: 1)
+      @klass.all(1, params)
+    end
+
+    it 'should make a get request to the correct route' do
+      expect(@klass).to receive(:get).with('http://foo.bar/1', {})
+      params.delete(:params)
+      @klass.all(1)
+    end
+  end
+
+  describe '.find' do
+    it 'should make a get request to the correct route' do
+      expect(@klass).to receive(:get).with('http://foo.bar/1/2')
+      @klass.find(1,2)
+    end
+  end
+
+  describe '.create' do
+    it 'should make a post request to the correct route with params' do
+      expect(@klass).to receive(:post).with('http://foo.bar/1', page: 1)
+      @klass.create(1, params)
+    end
+  end
+
+  describe '.update' do
+    it 'should make a put request to the correct route with params' do
+      expect(@klass).to receive(:put).with('http://foo.bar/1/2', page: 1)
+      @klass.update(1, 2, params)
+    end
+  end
+
+  describe '.destroy' do
+    it 'should make a delete request to the correct route with params' do
+      expect(@klass).to receive(:delete).with('http://foo.bar/1/2')
+      @klass.destroy(1, 2)
+    end
+  end
+
+  describe '.destroy_all' do
+    it 'should make a delete request to the correct route with params' do
+      expect(@klass).to receive(:delete).with('http://foo.bar/1')
+      @klass.destroy_all(1)
+    end
+  end
+end