bigcommerce 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 699fc230ea09d9242c9cbfb7e1d2183891127627
-  data.tar.gz: 94e9e4eeb4a9b8cdf53ff2bd26f78612d8457d25
+  metadata.gz: f89e22fe6e4042c5231912f0594eccc6e20cf2d2
+  data.tar.gz: e72dc04e6ea9894c47740882e89edfc14ceb84ae
 SHA512:
-  metadata.gz: 131581aaa53a9933c978f7649530128857e7a46e467c091b77effc27828ca895388bc78edfdd0cf5bb58bb14f8041a55417b90f52af98aab82480c3748563cc0
-  data.tar.gz: 88d65c0fa84ad4d4968e58b7780eaac14408d5ad123eafe1c1b158c04822ade1007cbf3c460c95235765efdb548baa0c34a4778b9a60283b8f45c4efa07479a1
+  metadata.gz: ab56f2ab83b837201fc23c4e749633b47702a0ef48d081854b14ce220760f130675200a1513f2a8ba516419a2cf44b2e2da120289ab458130de333e5756f8077
+  data.tar.gz: b35e6c9009776ad58a0565d8d8785de254dfba5f1cadd10980c8c133d7fa70038485008c15bbcd6cf9f5f11f8e886b940c45ce269cb8e9a51e995207a70a53c9

data/README.md

@@ -17,22 +17,22 @@ gem install bigcommerce
 You can also add it to your Gemfile.
 
 ```rb
-gem 'bigcommerce', '~> 1.0.0'
+gem 'bigcommerce', '~> 1.0'
 ```
 
 ## Requirements
 - Ruby 2.0.0 or newer. Please refer to the `.travis.yml` to see which versions we officially support.
 
 ## Getting Started
-In order to make requests to our API, you must register as a developer and have your credentials ready. 
+To make requests to our API, you must register as a developer and have your credentials ready.
 
-Its also very important to note that for the OAuth authentication mechanism, the resources you have acccess to depend on the scopes which your application has been granted by the merchant. For more information about the Store API scopes, see: [OAuth Scopes](https://developer.bigcommerce.com/api/scopes).
+Also very important: For the OAuth authentication mechanism, the resources to which you have acccess depend on the scopes that the merchant has granted to your application. For more information about Store API scopes, see: [OAuth Scopes](https://developer.bigcommerce.com/api/scopes).
 
 ## Authentication
-We currently have two different authentication schemes you can use depending on your use case.
+We currently have two different authentication schemes that you can select, depending on your use case.
 
 ### OAuth
-OAuth apps can be submitted to [BigCommerce App Store](https://www.bigcommerce.com/apps), allowing other merchants to install it in their BigCommerce store.
+OAuth apps can be submitted to [BigCommerce App Store](https://www.bigcommerce.com/apps), allowing other merchants to install these apps in their BigCommerce stores.
 
 __[More Information](https://developer.bigcommerce.com/api/using-oauth-intro)__
 
@@ -42,11 +42,11 @@ To develop a custom integration for one store, your app needs to use Basic Authe
 __[More Information](https://developer.bigcommerce.com/api/legacy/basic-auth)__
 
 ## Configuration
-In order to authenticate the API client, you will need to configure the client like the following.
+To authenticate your API client, you will need to configure the client like the following examples.
 
 ### OAuth App
 
-- ```client_id```: Obtained from the "My Apps" section on the [developer portal](http://developer.bigcommerce.com).
+- ```client_id```: Obtained from the on the BigCommerce [Developer Portal's](http://developer.bigcommerce.com) "My Apps" section.
 - ```access_token```: Obtained after a token exchange in the auth callback.
 - ```store_hash```: Also obtained after the token exchange.
 
@@ -60,7 +60,7 @@ end
 
 ### Basic Authentication (Legacy)
 
-To get all the basic auth credentials, simply visit your store admin page and navigate to the `Advanced Settings > Legacy API Settings`. Once there, you can create a new legacy api account to authenticate with.
+To get all the basic auth credentials, simply visit your store admin page, and navigate to the `Advanced Settings` > `Legacy API Settings`. Once there, you can create a new legacy API account on which to authenticate.
 
 ```rb
 Bigcommerce.configure do |config|
@@ -73,7 +73,7 @@ end
 
 __SSL Configuration__
 
-If you are using your own self-signed certificate, you can pass SSL options to Faraday. This is not required, but may be useful in special edge cases.
+If you are using your own, self-signed, certificate, you can pass SSL options to Faraday. This is not required, but might be useful in special edge cases.
 
 ```rb
 Bigcommerce.configure do |config|
@@ -90,11 +90,25 @@ end
 For more information about configuring SSL with Faraday, please see the following:
 
 - [Faraday SSL example](https://gist.github.com/mislav/938183)
-- [Setting up SSL certificates](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates)
+- [Faraday: Setting up SSL certificates](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates)
 
+### Customer Login API
+If you want to generate tokens for storefront login using the Customer Login API, you need to configure your app's client secret.
+
+- ```store_hash```: The store hash of the store you are operating against.
+- ```client_id```: Obtained from the on the BigCommerce [Developer Portal's](http://developer.bigcommerce.com) "My Apps" section.
+- ```client_secret```: Obtained from the on the BigCommerce [Developer Portal's](http://developer.bigcommerce.com) "My Apps" section.
+
+```rb
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.client_secret = ENV['BC_CLIENT_SECRET']
+end
+```
 
 ## Usage
-For full examples on using the API client, please see the [examples folder](examples) and refer to the [developer documentation](https://developer.bigcommerce.com/api).
+For full examples of using the API client, please see the [examples folder](examples) and refer to BigCommerce's [developer documentation](https://developer.bigcommerce.com/api).
 
 Example:
 
@@ -113,19 +127,19 @@ Bigcommerce::System.time
 
 ### Thread Safety
 
-The `Bigcommerce.configure` method is NOT thread safe. This mechanism is designed for applications or cli where thread safety is not a concern. If you need to guarantee thread safety, we support another mechanism to make threadsafe API requests.
+The `Bigcommerce.configure` method is NOT thread-safe. This mechanism is designed for applications or CLI's (command-line interfaces) where thread safety is not a concern. If you need to guarantee thread safety, we support this alternative mechanism to make thread-safe API requests:
 
-Rather then setting up a single `connection` for all API requests, you will want to construct a new connection for each thread. If you can make sure that each of these connections is stored in a thread safe manner, you can pass the `connection` as you query the resource.
+Rather then setting up a single `connection` for all API requests, you would construct a new connection for each thread. If you can ensure that each of these connections is stored in a thread-safe manner, you can pass the `connection` as you query the resource.
 
-This connection is nothing more than a `Faraday::Connection` so if you want to write your own, or use your own adapers, you can feel free. Please refer to the [connection class](https://github.com/bigcommerce/bigcommerce-api-ruby/blob/master/lib/bigcommerce/connection.rb) for more details.
+This connection is nothing more than a `Faraday::Connection` – so if you want to write your own, or to use your own adapters, you can feel free. Please refer to this gem's [connection class](https://github.com/bigcommerce/bigcommerce-api-ruby/blob/master/lib/bigcommerce/connection.rb) for more details.
 
 ##### OAuth
 
 ```rb
 connection = Bigcommerce::Connection.build(
   Bigcommerce::Config.new(
-    store_hash: ENV['BC_STORE_HASH'], 
-    client_id: ENV['BC_CLIENT_ID'], 
+    store_hash: ENV['BC_STORE_HASH'],
+    client_id: ENV['BC_CLIENT_ID'],
     access_token: ENV['BC_ACCESS_TOKEN']
   )
 )
@@ -143,7 +157,7 @@ Bigcommerce::System.raw_request(:get, 'time', connection: connection)
 ```rb
 connection_legacy = Bigcommerce::Connection.build(
   Bigcommerce::Config.new(
-    auth: 'legacy', 
+    auth: 'legacy',
     url: ENV['BC_API_ENDPOINT_LEGACY'],
     username: ENV['BC_USERNAME'],
     api_key: ENV['BC_API_KEY']

data/bigcommerce.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0.0'
   s.license = 'MIT'
 
-  s.authors = ['Patrick Edelman']
+  s.authors = ['BigCommerce Engineering']
   s.homepage = 'https://github.com/bigcommerce/bigcommerce-api-ruby'
   s.summary = 'Ruby client library for the BigCommerce API'
   s.description = s.summary
@@ -20,7 +20,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
 
-  s.add_dependency 'faraday', '~> 0.9'
-  s.add_dependency 'faraday_middleware', '~> 0.10.0'
+  s.add_dependency 'faraday', '~> 0.11'
+  s.add_dependency 'faraday_middleware', '~> 0.11'
   s.add_dependency 'hashie', '~> 3.4'
+  s.add_dependency 'jwt', '~> 1.5.4'
 end

data/lib/bigcommerce.rb

@@ -12,7 +12,7 @@ module Bigcommerce
   Dir.glob(resources, &method(:require))
 
   class << self
-    attr_reader :api
+    attr_reader :api, :config
 
     def configure
       @config = Bigcommerce::Config.new.tap { |h| yield(h) }

data/lib/bigcommerce/connection.rb

@@ -3,11 +3,12 @@ module Bigcommerce
     HEADERS = {
       'accept' => 'application/json',
       'content-type' => 'application/json',
-      'user-agent' => 'bigcommerce-api-ruby'
+      'user-agent' => 'bigcommerce-api-ruby',
+      'accept-encoding' => 'gzip'
     }.freeze
 
     def self.build(config)
-      ssl_options = config.ssl if config.auth == 'legacy'
+      ssl_options = config.ssl || {}
       Faraday.new(url: config.api_url, ssl: ssl_options) do |conn|
         conn.request :json
         conn.headers = HEADERS
@@ -17,6 +18,7 @@ module Bigcommerce
           conn.use Bigcommerce::Middleware::Auth, config
         end
         conn.use Bigcommerce::Middleware::HttpException
+        conn.use FaradayMiddleware::Gzip
         conn.adapter Faraday.default_adapter
       end
     end

data/lib/bigcommerce/exception.rb

@@ -45,7 +45,7 @@ module Bigcommerce
       unless env.body.empty?
         response_headers = begin
           JSON.parse(env.body, symbolize_names: true)
-        rescue
+        rescue StandardError
           {}
         end
       end

data/lib/bigcommerce/resources/customers/customer.rb

@@ -1,3 +1,6 @@
+require 'jwt'
+require 'securerandom'
+
 # Customer
 # Identity and account details for customers shopping at a Bigcommerce store.
 # https://developer.bigcommerce.com/api/stores/v2/customers
@@ -22,9 +25,26 @@ module Bigcommerce
     property :notes
     property :addresses
     property :tax_exempt_category
+    property :accepts_marketing
 
     def self.count(params = {})
       get 'customers/count', params
     end
+
+    # Generate a token that can be used to log the customer into the storefront.
+    # This requires your app to have the store_v2_customers_login scope and to
+    # be installed in the store.
+    def login_token(config: Bigcommerce.config)
+      payload = {
+        'iss' => config.client_id,
+        'iat' => Time.now.to_i,
+        'jti' => SecureRandom.uuid,
+        'operation' => 'customer_login',
+        'store_hash' => config.store_hash,
+        'customer_id' => id
+      }
+
+      JWT.encode(payload, config.client_secret, 'HS256')
+    end
   end
 end

data/lib/bigcommerce/resources/geography/country.rb

@@ -6,7 +6,7 @@ module Bigcommerce
   class Country < Resource
     include Bigcommerce::ResourceActions.new(
       uri: 'countries/%d',
-      disable: [:create, :update, :destroy, :destroy_all]
+      disable: %i[create update destroy destroy_all]
     )
 
     property :id

data/lib/bigcommerce/resources/geography/state.rb

@@ -6,7 +6,7 @@ module Bigcommerce
   class State < Resource
     include Bigcommerce::SubresourceActions.new(
       uri: 'countries/%d/states/%d',
-      disable: [:create, :update, :destroy, :destroy_all]
+      disable: %i[create update destroy destroy_all]
     )
 
     property :id

data/lib/bigcommerce/resources/orders/order_coupon.rb

@@ -6,7 +6,7 @@ module Bigcommerce
   class OrderCoupon < Resource
     include Bigcommerce::SubresourceActions.new(
       uri: 'orders/%d/coupons/%d',
-      disable: [:create, :update, :destroy, :destroy_all]
+      disable: %i[create update destroy destroy_all]
     )
 
     property :id

data/lib/bigcommerce/resources/orders/order_message.rb

@@ -6,7 +6,7 @@ module Bigcommerce
   class OrderMessage < Resource
     include Bigcommerce::SubresourceActions.new(
       uri: 'orders/%d/messages/%d',
-      disable: [:create, :update, :destroy, :destroy_all]
+      disable: %i[create update destroy destroy_all]
     )
 
     property :id

data/lib/bigcommerce/resources/orders/order_product.rb

@@ -6,7 +6,7 @@ module Bigcommerce
   class OrderProduct < Resource
     include Bigcommerce::SubresourceActions.new(
       uri: 'orders/%d/products/%d',
-      disable: [:create, :update, :destroy, :destroy_all]
+      disable: %i[create update destroy destroy_all]
     )
 
     property :id

data/lib/bigcommerce/resources/orders/order_shipping_address.rb

@@ -6,7 +6,7 @@ module Bigcommerce
   class OrderShippingAddress < Resource
     include Bigcommerce::SubresourceActions.new(
       uri: 'orders/%d/shipping_addresses/%d',
-      disable: [:create, :update, :destroy, :destroy_all]
+      disable: %i[create update destroy destroy_all]
     )
 
     property :id

data/lib/bigcommerce/resources/orders/order_status.rb

@@ -7,7 +7,7 @@ module Bigcommerce
   class OrderStatus < Resource
     include Bigcommerce::ResourceActions.new(
       uri: 'order_statuses/%d',
-      disable: [:create, :update, :destroy, :destroy_all]
+      disable: %i[create update destroy destroy_all]
     )
 
     property :id

data/lib/bigcommerce/resources/orders/order_tax.rb

@@ -6,7 +6,7 @@ module Bigcommerce
   class OrderTax < Resource
     include Bigcommerce::SubresourceActions.new(
       uri: 'orders/%d/taxes/%d',
-      disable: [:create, :update, :destroy, :destroy_all]
+      disable: %i[create update destroy destroy_all]
     )
 
     property :id

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

@@ -6,7 +6,7 @@ module Bigcommerce
   class ConfigurableField < Resource
     include Bigcommerce::SubresourceActions.new(
       uri: 'products/%d/configurable_fields/%d',
-      disable: [:create, :update]
+      disable: %i[create update]
     )
 
     property :id

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

@@ -6,7 +6,7 @@ module Bigcommerce
   class ProductOption < Resource
     include Bigcommerce::SubresourceActions.new(
       uri: 'products/%d/options/%d',
-      disable: [:create, :update, :destroy, :destroy_all]
+      disable: %i[create update destroy destroy_all]
     )
 
     property :id

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

@@ -6,7 +6,7 @@ module Bigcommerce
   class ShippingMethod < Resource
     include Bigcommerce::ResourceActions.new(
       uri: 'shipping/methods/%d',
-      disable: [:create, :update, :destroy, :destroy_all]
+      disable: %i[create update destroy destroy_all]
     )
 
     property :id

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

@@ -7,7 +7,7 @@ module Bigcommerce
   class TaxClass < Resource
     include Bigcommerce::ResourceActions.new(
       uri: 'tax_classes/%d',
-      disable: [:create, :update, :destroy, :destroy_all]
+      disable: %i[create update destroy destroy_all]
     )
 
     property :id

data/lib/bigcommerce/version.rb

@@ -1,3 +1,3 @@
 module Bigcommerce
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bigcommerce
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
-- Patrick Edelman
+- BigCommerce Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-24 00:00:00.000000000 Z
+date: 2017-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.4
 description: Ruby client library for the BigCommerce API
 email: 
 executables: []
@@ -161,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Ruby client library for the BigCommerce API