bigcommerce 0.10.0 → 1.0.0.beta

data/examples/products/product_review.rb

@@ -0,0 +1,12 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+@product = Bigcommerce::Product.all[0]
+
+# List product reviews
+puts Bigcommerce::ProductReview.all(@product.id)

data/examples/products/product_rule.rb

@@ -0,0 +1,54 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+@product = Bigcommerce::Product.all[0]
+
+# List product rules
+@product_rules = Bigcommerce::ProductRule.all(@product.id)
+puts @product_rules
+
+# Get a count of product rules
+puts Bigcommerce::ProductRule.count(@product.id)
+
+# Get a count of all product rules for all products
+puts Bigcommerce::ProductRule.count_all
+
+# Create a product rule
+@product_rule = Bigcommerce::ProductRule.create(
+  @product.id,
+  conditions: [
+    {
+      product_option_id: 95,
+      option_value_id: 13,
+      sku_id: nil
+    }
+  ]
+)
+puts @product_rule
+
+# Get a product rule
+puts Bigcommerce::ProductRule.find(@product.id, @product_rule.id)
+
+# Update a product rule
+puts Bigcommerce::ProductRule.update(
+  @product.id,
+  @product_rule.id,
+  conditions: [
+    {
+      product_option_id: 95,
+      option_value_id: 12,
+      sku_id: nil
+    }
+  ]
+)
+
+# Delete a product rule
+puts Bigcommerce::ProductRule.destroy(@product.id, @product_rule.id)
+
+# Delete all product rules
+# puts Bigcommerce::ProductRule.destroy_all(@product.id)

data/examples/products/product_video.rb

@@ -0,0 +1,45 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+@product = Bigcommerce::Product.all[0]
+
+# Create a product video
+@product_video = Bigcommerce::ProductVideo.create(
+  @product.id,
+  url: 'https://www.youtube.com/watch?v=T9RFb8xXZlk'
+)
+puts @product_video
+
+# List product videos
+@product_videos = Bigcommerce::ProductVideo.all(@product.id)
+puts @product_videos
+
+# Get a count of product videos
+puts Bigcommerce::ProductVideo.count(@product.id)
+
+# Get a count of all product videos for all products
+puts Bigcommerce::ProductVideo.count_all
+
+# Get a product video
+puts Bigcommerce::ProductVideo.find(@product.id, @product_video.id)
+
+# Update a product video
+# TODO
+# puts Bigcommerce::ProductVideo.update(
+# @product.id,
+# @product_video.id,
+# url: 'https://www.youtube.com/watch?v=LXgTp40Y3zo'
+# )
+
+# Delete a product video
+# TODO
+# puts Bigcommerce::ProductVideo.destroy(@product.id, product_video.id)
+
+# Delete all product videos
+# TODO
+# puts Bigcommerce::ProductVideo.destroy_all(@product.id)

data/examples/products/sku.rb

@@ -0,0 +1,48 @@
+require 'bigcommerce'
+require 'securerandom'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+@product = Bigcommerce::Product.all[0]
+
+# Create a product sku
+@sku = Bigcommerce::Sku.create(
+  @product.id,
+  sku: SecureRandom.hex,
+  options: [
+    product_option_id: 95,
+    option_value_id: 10
+  ]
+)
+puts @sku
+
+# List product skus
+@skus = Bigcommerce::Sku.all(@product.id)
+puts @skus
+
+# Get a count of product skus
+puts Bigcommerce::Sku.count
+
+# Get a product sku
+puts Bigcommerce::Sku.find(@product.id, @sku.id)
+
+# Update a product sku
+puts Bigcommerce::Sku.update(
+  @product.id,
+  @sku.id,
+  sku: SecureRandom.hex,
+  options: [
+    product_option_id: 95,
+    option_value_id: 7
+  ]
+)
+
+# Delete a product image
+puts Bigcommerce::Sku.destroy(@product.id, @sku.id)
+
+# Delete all product skus
+# puts Bigcommerce::Sku.destroy_all(@product.id)

data/examples/shipping/shipping_method.rb

@@ -0,0 +1,13 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List shipping methods
+puts Bigcommerce::ShippingMethod.all
+
+# Get a shipping method
+puts Bigcommerce::ShippingMethod.find(1)

data/examples/store/store_info.rb

@@ -0,0 +1,10 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# Get store information
+puts Bigcommerce::StoreInfo.info

data/examples/system/time.rb

@@ -0,0 +1,10 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# Get current server time
+puts Bigcommerce::System.time

data/examples/tax/tax_class.rb

@@ -0,0 +1,13 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List tax classes
+puts Bigcommerce::TaxClass.all
+
+# Get a tax classes
+puts Bigcommerce::TaxClass.find(1)

data/examples/webhooks/webhook.rb

@@ -0,0 +1,29 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List all webhooks
+puts Bigcommerce::Webhook.all
+
+# Get a webhook
+puts Bigcommerce::Webhook.find(1)
+
+# Create a webhook
+@webhook = Bigcommerce::Webhook.create(
+  scope: 'store/order/*',
+  destination: 'https://app.example.com/orders'
+)
+
+# Update a webhook
+puts Bigcommerce::Webhook.update(
+  @webhook.id,
+  scope: 'store/order/*',
+  destination: 'https://app.example.com/products'
+)
+
+# Delete a webhook
+puts Bigcommerce::Webhook.destroy(@webhook.id)

data/lib/bigcommerce.rb

@@ -1,9 +1,51 @@
-require "cgi"
-require "json"
-require 'rest-client'
-require "uri"
-require 'bigcommerce/api'
-require 'bigcommerce/connection'
+require 'hashie'
+require 'faraday_middleware'
 require 'bigcommerce/version'
-require 'bigcommerce/resource'
-require 'bigcommerce/product'
+require 'bigcommerce/middleware/auth'
+require 'bigcommerce/middleware/http_exception'
+require 'bigcommerce/resources/resource'
+
+module Bigcommerce
+  resources = File.join(File.dirname(__FILE__), 'bigcommerce', 'resources', '**', '*.rb')
+  Dir.glob(resources, &method(:require))
+
+  DEFAULTS = {
+    base_url: 'https://api.bigcommerce.com'
+  }
+
+  HEADERS = {
+    'accept' => 'application/json',
+    'content-type' => 'application/json',
+    'user-agent' => 'bigcommerce-api-ruby'
+  }
+
+  class << self
+    attr_reader :api
+    attr_accessor :api_limit
+
+    def configure
+      config = Hashie::Mash.new
+      yield(config)
+      ssl_options = config.ssl if config.auth == 'legacy'
+
+      @api = Faraday.new(url: build_url(config), ssl: ssl_options) do |conn|
+        conn.request :json
+        conn.headers = HEADERS
+        if config.auth == 'legacy'
+          conn.use Faraday::Request::BasicAuthentication, config.username, config.api_key
+        else
+          conn.use Bigcommerce::Middleware::Auth, config
+        end
+        conn.use Bigcommerce::Middleware::HttpException
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def build_url(config)
+      return config.url if config.auth == 'legacy'
+
+      base = ENV['BC_API_ENDPOINT'].nil? ? DEFAULTS[:base_url] : ENV['BC_API_ENDPOINT']
+      "#{base}/stores/#{config.store_hash}/v2"
+    end
+  end
+end

data/lib/bigcommerce/exception.rb

@@ -0,0 +1,51 @@
+module Bigcommerce
+  class HttpError < StandardError
+    attr_accessor :response_headers
+    def initialize(headers)
+      @response_headers = headers
+    end
+  end
+
+  class BadRequest             < HttpError; end
+  class Unauthorized           < HttpError; end
+  class Forbidden              < HttpError; end
+  class NotFound               < HttpError; end
+  class MethodNotAllowed       < HttpError; end
+  class NotAccepted            < HttpError; end
+  class TimeOut                < HttpError; end
+  class ResourceConflict       < HttpError; end
+  class TooManyRequests        < HttpError; end
+  class InternalServerError    < HttpError; end
+  class BadGateway             < HttpError; end
+  class ServiceUnavailable     < HttpError; end
+  class GatewayTimeout         < HttpError; end
+  class BandwidthLimitExceeded < HttpError; end
+
+  module HttpErrors
+    ERRORS = {
+      400 => Bigcommerce::BadRequest,
+      401 => Bigcommerce::Unauthorized,
+      403 => Bigcommerce::Forbidden,
+      404 => Bigcommerce::NotFound,
+      405 => Bigcommerce::MethodNotAllowed,
+      406 => Bigcommerce::NotAccepted,
+      408 => Bigcommerce::TimeOut,
+      409 => Bigcommerce::ResourceConflict,
+      429 => Bigcommerce::TooManyRequests,
+      500 => Bigcommerce::InternalServerError,
+      502 => Bigcommerce::BadGateway,
+      503 => Bigcommerce::ServiceUnavailable,
+      504 => Bigcommerce::GatewayTimeout,
+      509 => Bigcommerce::BandwidthLimitExceeded
+    }
+
+    def throw_http_exception!(code, env)
+      return unless ERRORS.keys.include? code
+      error_hash = env.body.empty? ? {} : JSON.parse(env.body, symbolize_names: true)
+      unless env[:response_headers]['X-Retry-After'].nil?
+        error_hash[:retry_after] = env[:response_headers]['X-Retry-After'].to_i
+      end
+      fail ERRORS[code].new(error_hash), env.body
+    end
+  end
+end

data/lib/bigcommerce/middleware/auth.rb

@@ -0,0 +1,16 @@
+module Bigcommerce
+  module Middleware
+    class Auth < Faraday::Middleware
+      def initialize(app, options = {})
+        @app = app
+        @options = options
+      end
+
+      def call(env)
+        env[:request_headers]['X-Auth-Client'] = @options[:client_id]
+        env[:request_headers]['X-Auth-Token'] = @options[:access_token]
+        @app.call env
+      end
+    end
+  end
+end

data/lib/bigcommerce/middleware/http_exception.rb

@@ -0,0 +1,14 @@
+require 'bigcommerce/exception'
+
+module Bigcommerce
+  module Middleware
+    class HttpException < Faraday::Response::Middleware
+      include Bigcommerce::HttpErrors
+
+      def on_complete(env)
+        throw_http_exception! env[:status].to_i, env
+        env
+      end
+    end
+  end
+end

data/lib/bigcommerce/request.rb

@@ -0,0 +1,89 @@
+require 'json'
+
+module Bigcommerce
+  class PathBuilder
+    attr_reader :uri
+
+    def initialize(uri)
+      @uri = uri
+    end
+
+    # This takes the @uri and inserts the keys to form a path.
+    # To start we make sure that for nil/numeric values, we wrap those into an
+    # array. We then scan the string for %d and %s to find the number of times
+    # we possibly need to insert keys into the URI. Next, we check the size of
+    # the keys array, if the keys size is less than the number of possible keys
+    # in the URI, we will remove the trailing %d or %s, then remove the
+    # trailing /. We then pass the keys into the uri to form the path.
+    # ex. foo/%d/bar/%d => foo/1/bar/2
+    def build(keys = [])
+      keys = [] if keys.nil?
+      keys = [keys] if keys.is_a? Numeric
+      ids = uri.scan('%d').count + uri.scan('%s').count
+      str = ids > keys.size ? uri.chomp('%d').chomp('%s').chomp('/') : uri
+      (str % keys).chomp('/')
+    end
+
+    def to_s
+      @uri
+    end
+  end
+
+  class Request < Module
+    def initialize(uri)
+      @uri = uri
+    end
+
+    def included(base)
+      base.extend ClassMethods
+      path_builder = PathBuilder.new @uri
+      base.define_singleton_method :path do
+        path_builder
+      end
+    end
+
+    module ClassMethods
+      def get(path, params = nil)
+        response = raw_request(:get, path, params)
+        build_response_object response
+      end
+
+      def delete(path)
+        response = raw_request(:delete, path)
+        response.body
+      end
+
+      def post(path, params)
+        response = raw_request(:post, path, params)
+        build_response_object response
+      end
+
+      def put(path, params)
+        response = raw_request(:put, path, params)
+        build_response_object response
+      end
+
+      def raw_request(method, path, params = nil)
+        response = Bigcommerce.api.send(method, path.to_s, params)
+        Bigcommerce.api_limit = response.headers['X-BC-ApiLimit-Remaining']
+        response
+      end
+
+      private
+
+      def build_response_object(response)
+        json = parse response.body
+        if json.is_a? Array
+          json.map { |obj| new obj }
+        else
+          new json
+        end
+      end
+
+      def parse(json)
+        return [] if json.empty?
+        JSON.parse(json, symbolize_names: true)
+      end
+    end
+  end
+end