bigcommerce-oauth-api 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d21d23bfd3d96f62410526c176eef2430ef75b18
-  data.tar.gz: 68342694e338c0b0442652f273850d30f0351f2f
+  metadata.gz: 7f6019efb2862df605d51ddc295b27fe454155a7
+  data.tar.gz: 5b10eca0204bc2609c58f2f9e5fcbacafe919d98
 SHA512:
-  metadata.gz: f357552ee8681b7e37601bee9e409e4883c96e2d04c6819786f98caeecfa0d25c378c5fb3032703c6a8c936b54d9fd50350fb9b5fd8b1636defa21763a2802bd
-  data.tar.gz: 162da3158b864d16eda398355e1c408b9533f16931d12b7f6445b04b24f50d3c4a32a8f85d34a4f95afa7a06ce7cf841cb07a5d173deddd72170faefaafbd59b
+  metadata.gz: ca140e744fca66c4b14f9b51cdb36c33ae59e470178d56c3dda48acbaab0d346ec6099c532be63113b0ef05632a25c7e5ba4b3600c7cd35fc8edadcf94b10927
+  data.tar.gz: 633316c3b35e61ad303afc1dc18f9c97afce27e0f384369392b1b29fcd113fbf0918d1056b3a2d4b9f27f1c7ae2bf1d81bff6e58f259c287d4a3ad3e2dd5151e

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=documentation
+--backtrace

data/CHANGELOG.md

@@ -0,0 +1,69 @@
+### 1.1.2 (2014-11-04)
+
+Bugfixes:
+
+    - fix broken gemspec
+    - remove Gemfile.lock from git and add it to gitignore
+
+### 1.1.1 (2014-11-04)
+
+Bugfixes:
+
+    - correct lib folder name and adjust require statements
+    - rename repository from bigcommerce-oauth-api-ruby to bugcommerce-oauth-api
+    - update markdown badges
+
+
+### 1.1.0 (2014-11-02)
+
+Features:
+
+    - add product SKU api
+    - add product video api
+    - add product rules api
+    - add product review api
+    - add product option api
+    - add product image api
+    - add option api
+    - add option set api
+    - add option set option api
+    - add option set value api
+    - add googleproductsearch api
+    - add product configurable field api
+    - add category api
+    - add bulk pricing (discount rules) api
+    - add brand api
+    
+    
+### 1.0.3 (2014-11-02)
+
+Bugfixes:
+
+    - Change activesupport dependency to >=3 && <5
+
+### 1.0.2 (2014-11-01)
+
+Features:
+
+    - add blog post api
+    - add blog tag api
+    - add customer api
+    - add customer address api
+    - add customer group api
+    - add geography country api
+    - add geography state api
+    - add marketing coupon api
+    - add order api
+    - add order message api
+    - add order product api
+    - add order shipment api
+    - add order shipping address api
+    - add payment method api
+    - add product api
+    - add product custom field api
+    - add redirect api
+    - add shipping method api
+    - add store api (store information)
+    - add system api (time)
+    - add tax class api
+    - add web hook api

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'codeclimate-test-reporter', require: nil
+end
+
+gemspec

data/README.md

@@ -0,0 +1,180 @@
+bigcommerce-oauth-api
+==========================
+[![Gem Version](https://badge.fury.io/rb/bigcommerce-oauth-api.svg)](http://badge.fury.io/rb/bigcommerce-oauth-api)
+[![Code Climate](https://codeclimate.com/github/corthmann/bigcommerce-oauth-api/badges/gpa.svg)](https://codeclimate.com/github/corthmann/bigcommerce-oauth-api)
+[![Test Coverage](https://codeclimate.com/github/corthmann/bigcommerce-oauth-api/badges/coverage.svg)](https://codeclimate.com/github/corthmann/bigcommerce-oauth-api)
+[![Dependency Status](https://gemnasium.com/corthmann/bigcommerce-oauth-api.svg)](https://gemnasium.com/corthmann/bigcommerce-oauth-api)
+
+This gem provides a wrapper for the Bigcommerce REST API.
+
+Installation
+-------------
+You can install this gem by using the following command:
+```
+gem install bigcommerce-oauth-api
+```
+or by adding the the following line to your Gemfile.
+```
+gem 'bigcommerce-oauth-api'
+```
+
+Configuration
+-------------
+The gem can be configured in two ways. Either by initializing the API with certain options.
+```
+BigcommerceOAuthAPI.configuration do |config|
+    config.store_hash = 'YOU STORE ID'
+    config.client_id = 'YOUR CLIENT ID'
+    config.access_token = 'YOUR OAUTH ACCESS TOKEN'
+end
+```
+
+Or by passing options to a new client instance.
+```
+api = BigcommerceOAuthAPI::Client.new(
+                                :store_hash => 'YOUR STORE ID',
+                                :config.client_id => 'YOUR CLIENT ID',
+                                :config.access_token => 'YOUR OAUTH ACCESS TOKEN'
+                                )
+```
+
+Using the API
+-------------
+Get a list of products:
+```
+products = api.products
+```
+Get orders with order_id >= 100
+```
+orders = api.orders({ min_id: 100 })
+```
+Get the order with id = 101
+```
+order = api.order(101)
+```
+All resource attributes can be accessed both using methods or as a hash with keys as either strings or keys.
+```
+# each of the following lines return the first name listed in the order billing address
+order.billing_address.first_name
+order['billing_address']['first_name']
+order[:billing_address][:first_name]
+```
+Update the name of a customer
+```
+customer = api.update_customer(101, {first_name: 'Christian'})
+```
+Delete an order shipment
+```
+order_id = 101
+shipment_id = 1000
+api.delete_order_shipment(order_id, shipment_id)
+```
+Webhooks
+-------------
+In many applications it is an advantage to receive a callback on events rather than polling information. Such callbacks are commonly called webhooks.
+
+The Bigcommerce API allows you to create webhooks for events you want to respond to - for instance every time an order is created.
+```
+# more information on: https://developer.bigcommerce.com/api/webhooks-getting-started
+new_hook = {
+    scope: "store/order/created",
+    destination: "https://app.example.com/order-callback",
+    is_active: true
+}
+hook = api.create_hook(new_hook)
+```
+After creating the webhook as shown above a callback (POST) will be sent to 'https://app.example.com/order-callback' every time an order is created.
+
+The API also allows you to mange hooks like so:
+```
+# get a list of the webhooks
+hooks = api.hooks
+# get the webhook with id = 1234
+hook_id = 1234
+hook = api.hook(hook_id)
+# delete the webhook with id = 1234
+api.delete_hook(hook_id)
+```
+
+API Support
+-------------
+The following APIs are currently supported:
+
+API | Included from
+--- | ---
+blog post | 1.0.2
+blog tag | 1.0.2
+brand api | 1.1.0
+bulk pricing (discount rules) | 1.1.0
+category | 1.1.0
+customer api | 1.0.2
+customer address | 1.0.2
+customer group | 1.0.2
+geography country | 1.0.2
+geography state | 1.0.2
+marketing coupon | 1.0.2
+option | 1.1.0
+option set | 1.1.0
+option set option | 1.1.0
+option set value | 1.1.0
+order | 1.0.2
+order message | 1.0.2
+order product | 1.0.2
+order shipment | 1.0.2
+order shipping address | 1.0.2
+payment method | 1.0.2
+product | 1.0.2
+product configurable field | 1.1.0
+product custom field | 1.0.2
+product googleproductsearch | 1.1.0
+product image | 1.1.0
+product option | 1.1.0
+product review | 1.1.0
+product rules | 1.1.0
+product video | 1.1.0
+product SKU | 1.1.0
+redirect | 1.0.2
+shipping method api | 1.0.2
+store information | 1.0.2
+system (time) | 1.0.2
+tax class | 1.0.2
+web hook | 1.0.2
+
+Getting an OAuth Access Token
+-------------
+Currently the Bigcommerce API is only focused on making the OAuth API available for 3rd party development through Apps.
+This is quite frustrating especially if you want to use the API to make custom integrations for your webshop.
+
+However, it is actually possible to aquire access tokens without publishing an App for Bigcommerce.
+
+1.  Go to http://developer.bigcommerce.com
+
+2.  Login with the same user as the webshop you want to create a token for.
+
+3.  Go to "My Apps" and create dummy app (maybe call it "Authentication App")
+
+4.  Select the APIs you need and set the Auth Callback Url.
+    * This needs to be a HTTPS Url where you can read incomming GET request
+
+5.  Go to your webshop and click on "Apps"
+
+6.  Select the tab "My Drafts" (which should contain your "Authentication App")
+
+7.  Install the "Authentication App" in your webshop.
+    * This triggers a callback to your "Auth Callback Url" where you receive a code which can be exchanged for a token.
+
+8.  Send a POST request containing the following parameters (to https://login.bigcommerce.com/oauth2/token):
+    * client_id (can be found under "My Apps" at developer.bigcommerce.com
+    * client_secret (can be found under "My Apps" at developer.bigcommerce.com
+    * code (is received in the "Auth Callback")
+    * scope (is received in the "Auth Callback")
+    * grant_type (is always authorization_code)
+    * redirect_uri (your "Auth Callback Url")
+    * context (is "stores/{your store hash / id}")
+
+9.  Done! The response returns your OAuth Access Token.
+
+If you are experiencing problems with the POST call try using the folllowing curl command
+```
+curl --data "[YOUR POST PARAMETERS]" https://login.bigcommerce.com/oauth2/token
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/bigcommerce-oauth-api.gemspec

@@ -0,0 +1,25 @@
+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        = '2014-11-04'
+  s.summary     = "Ruby wrapper for the Bigcommerce REST API using OAuth"
+  s.description = "Connect Ruby applications with the Bigcommerce REST API using OAuth"
+  s.authors     = ["Christian Orthmann"]
+  s.email       = 'christian.orthmann@gmail.com'
+  s.require_path = 'lib'
+  s.files       = `git ls-files`.split("\n") - %w(.rvmrc .gitignore)
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n") - %w(.rvmrc .gitignore)
+  s.homepage    = 'http://rubygems.org/gems/bigcommerce-oauth-api'
+  s.license     = 'MIT'
+
+  s.add_development_dependency('rake', '~> 10')
+  s.add_development_dependency('rspec', '~> 3')
+  s.add_development_dependency('webmock', '~> 1')
+  s.add_development_dependency('simplecov', '~> 0')
+  s.add_development_dependency('simplecov-rcov', '~> 0')
+  s.add_runtime_dependency('faraday', '~> 0')
+  s.add_runtime_dependency('faraday_middleware', '~> 0')
+  s.add_runtime_dependency('activesupport', '>= 3.0.0', '< 5.0.0')
+end

data/lib/bigcommerce-oauth-api.rb

@@ -0,0 +1,11 @@
+require 'bigcommerce-oauth-api/configuration'
+require 'bigcommerce-oauth-api/client'
+require 'bigcommerce-oauth-api/api'
+require 'bigcommerce-oauth-api/client'
+require 'bigcommerce-oauth-api/error'
+require 'bigcommerce-oauth-api/resource'
+
+module BigcommerceOAuthAPI
+  extend Configuration
+
+end

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

@@ -0,0 +1,28 @@
+require 'bigcommerce-oauth-api/connection'
+require 'bigcommerce-oauth-api/request'
+require 'bigcommerce-oauth-api/base'
+
+module BigcommerceOAuthAPI
+  class API < Base
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    def initialize(options = {})
+      merged_options = BigcommerceOAuthAPI.options.merge(options)
+
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+    end
+
+    def config
+      conf = {}
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        conf[key] = send(key)
+      end
+      conf
+    end
+
+    include Connection
+    include Request
+  end
+end

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

@@ -0,0 +1,85 @@
+require 'active_support/inflector'
+require 'bigcommerce-oauth-api/error'
+
+module BigcommerceOAuthAPI
+  class Base
+
+    protected
+
+    def self.with_api_methods(map)
+      map.each do |api, method_description|
+        api_module = method_description[:api_module]
+        api_scope = method_description[:scope]
+        path_prefix = (method_description.has_key?(:prefix_paths) ? "#{method_description[:prefix_paths]}/" : nil)
+        method_prefix = (method_description.has_key?(:prefix_methods) ? "#{method_description[:prefix_methods]}_" : nil)
+        method_description[:methods].each do |method|
+          with_action(method, api_module, api_scope, path_prefix, method_prefix)
+        end
+      end
+    end
+
+    def self.with_action(method, api_module, api_scope, path_prefix = nil, method_prefix = nil)
+      is_nested = api_scope != :self
+      method_name, method_params, has_options = get_method_name_and_params(method, api_module, api_scope, is_nested, method_prefix)
+      method_path = get_method_path(method, api_module, api_scope, is_nested)
+      request_method = get_request_method(method)
+
+      # Ensure that existing methods never are overwritten
+      # Raise an error if it is attempted
+      if self.method_defined?(:"#{method_name}")
+        raise MethodAlreadyDefinedError.new("Method already defined: '#{method_name}'")
+      end
+
+      class_eval %Q{
+        def #{method_name}#{method_params}
+          #{request_method}("#{path_prefix}#{method_path}"#{( has_options ? ', options' : '')})
+        end
+      }
+    end
+
+    def self.get_method_name_and_params(method, api_module, api_scope, is_nested = false, method_prefix = nil)
+      base = (is_nested ? "#{method_prefix}#{api_scope}_#{api_module}": "#{method_prefix}#{api_module}").to_s
+      params_base = "(#{(is_nested ? "#{api_scope}_id, ": '')}"
+      has_options = method != :delete
+      case method
+        when :all
+          return base.pluralize, "#{params_base}options = {})", has_options
+        when :count
+          return "#{base.pluralize}_count", "#{params_base}options = {})", has_options
+        when :select
+          return base, "#{params_base}id, options = {})", has_options
+        when :create
+          return "#{method}_#{base}", "#{params_base}options = {})", has_options
+        when :update
+          return "#{method}_#{base}", "#{params_base}id, options = {})", has_options
+        when :delete
+          return "#{method}_#{base}", "#{params_base}id)", has_options
+      end
+    end
+
+    def self.get_method_path(method, api_module, api_scope, is_nested = false)
+      base = (is_nested ? "#{api_scope.to_s.pluralize}/\#{#{api_scope}_id}/#{api_module}": api_module).to_s.pluralize
+      case method
+        when :all, :create
+          return base
+        when :count
+          return "#{base}/count"
+        when :select, :update, :delete
+          return "#{base}/\#{id}"
+      end
+    end
+
+    def self.get_request_method(method)
+      case method
+        when :all, :count, :select
+          return :get
+        when :create
+          return :post
+        when :update
+          return :put
+        when :delete
+          return :delete
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+require 'bigcommerce-oauth-api/api'
+
+module BigcommerceOAuthAPI
+  class Client < API
+
+    ##
+    # get server time
+    def time
+      get('time')
+    end
+
+    ##
+    # get basic store information
+    def store_information
+      get('store')
+    end
+
+    ##
+    # Gets the Google Product Search mappings for a product.
+    def product_googleproductsearch(product_id, options = {})
+      get("products/#{product_id}/googleproductsearch", options)
+    end
+
+    with_api_methods :blog_post => { api_module: :post, scope: :self, methods: [:all, :select, :create, :update, :delete], prefix_paths: 'blog', prefix_methods: 'blog'},
+                     :blog_tag => { api_module: :tag, scope: :self, methods: [:all], prefix_paths: 'blog', prefix_methods: 'blog'},
+                     :brand => { api_module: :brand, scope: :self, methods: [:all, :select, :create, :update, :delete]},
+                     :category => { api_module: :category, scope: :self, methods: [:all, :select, :create, :update, :delete]},
+                     :customer => { api_module: :customer, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
+                     :customer_address => { api_module: :address, scope: :customer, methods: [:all, :select, :create, :update, :delete]},
+                     :customer_group => { api_module: :customer_group, scope: :self, methods: [:all, :select, :create, :update, :delete]},
+                     :geography_country => { api_module: :country, scope: :self, methods: [:all, :select]},
+                     :geography_state => { api_module: :state, scope: :self, methods: [:all, :select]},
+                     :marketing_coupons => { api_module: :coupon, scope: :self, methods: [:all, :select, :create, :update, :delete]},
+                     :option => { api_module: :option, scope: :self, methods: [:all, :select, :create, :update, :delete]},
+                     :option_set => { api_module: :option_set, scope: :self, methods: [:all, :select, :create, :update, :delete]},
+                     :option_set_option => { api_module: :option, scope: :option_set, methods: [:all, :select, :create, :update, :delete]},
+                     :option_set_value => { api_module: :value, scope: :option_set, methods: [:all, :select, :create, :update, :delete]},
+                     :order => { api_module: :order, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
+                     :order_message => { api_module: :message, scope: :order, methods: [:all, :select]},
+                     :order_product => { api_module: :product, scope: :order, methods: [:all, :select]},
+                     :order_shipment => { api_module: :shipment, scope: :order, methods: [:all, :select, :create, :update, :delete]},
+                     :order_shipping_address => { api_module: :shipping_address, scope: :order, methods: [:all, :select]},
+                     :payment_method => { api_module: :method, scope: :self, methods: [:all], prefix_paths: 'payments', prefix_methods: 'payment'},
+                     :product => { api_module: :product, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
+                     :product_custom_field => { api_module: :custom_field, scope: :product, methods: [:all, :select, :create, :update, :delete]},
+                     :product_discount_rule => { api_module: :discount_rule, scope: :product, methods: [:all, :select, :create, :update, :delete]},
+                     :product_configurable_field => { api_module: :configurable_field, scope: :product, methods: [:all, :select, :delete]},
+                     :product_image => { api_module: :image, scope: :product, methods: [:all, :select, :create, :update, :delete]},
+                     :product_option => { api_module: :option, scope: :product, methods: [:all, :select]},
+                     :product_review => { api_module: :review, scope: :product, methods: [:all]},
+                     :product_rule => { api_module: :rule, scope: :product, methods: [:all, :select, :create, :update, :delete]},
+                     :product_video => { api_module: :video, scope: :product, methods: [:all, :select, :create, :update, :delete]},
+                     :product_sku => { api_module: :sku, scope: :product, methods: [:all, :select, :create, :update, :delete]},
+                     :redirect => { api_module: :redirect, scope: :self, methods: [:all, :select, :create, :update, :delete]},
+                     :shipping_method => { api_module: :method, scope: :self, methods: [:all, :select], prefix_paths: 'shipping', prefix_methods: 'shipping'},
+                     :tax_class => { api_module: :tax_class, scope: :self, methods: [:all, :select]},
+                     :web_hook => { api_module: :hook, scope: :self, methods: [:all, :select, :create, :update, :delete]}
+
+  end
+end