bigcommerce 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 699fc230ea09d9242c9cbfb7e1d2183891127627
-  data.tar.gz: 94e9e4eeb4a9b8cdf53ff2bd26f78612d8457d25
+SHA256:
+  metadata.gz: 91c155920d961947d4e7a2184fa2ffad660590d636bd70723d9eec87d4709f3b
+  data.tar.gz: dc8618135e2e88f8b2fa39954179d24ff56f435fa50185f4dd85baceb11684ef
 SHA512:
-  metadata.gz: 131581aaa53a9933c978f7649530128857e7a46e467c091b77effc27828ca895388bc78edfdd0cf5bb58bb14f8041a55417b90f52af98aab82480c3748563cc0
-  data.tar.gz: 88d65c0fa84ad4d4968e58b7780eaac14408d5ad123eafe1c1b158c04822ade1007cbf3c460c95235765efdb548baa0c34a4778b9a60283b8f45c4efa07479a1
+  metadata.gz: d3790b83072b92e5477bcdf2dffe1d13ca0da2beb501706dac775307701b68efc39c5168852309990f5255501d87c8178674820b0e6072ffe4208b439081ec2a
+  data.tar.gz: 411c3da75158d702890e5f764e44e708dabf2a713880f36af0283a40b05fff5b158eeea016a39b9253f1429dbb7322ec8c8737963696c3671fa960b65bcb394d

data/README.md

@@ -1,10 +1,12 @@
 # BigCommerce API Ruby
 
 [![Gem Version](https://badge.fury.io/rb/bigcommerce.svg)](https://rubygems.org/gems/bigcommerce)
-[![Build Status](https://travis-ci.org/bigcommerce/bigcommerce-api-ruby.svg?branch=master)](https://travis-ci.org/bigcommerce/bigcommerce-api-ruby)
-[![Dependency Status](https://gemnasium.com/bigcommerce/bigcommerce-api-ruby.svg?travis)](https://gemnasium.com/bigcommerce/bigcommerce-api-ruby)
+[![CircleCI](https://circleci.com/gh/bigcommerce/bigcommerce-api-ruby/tree/master.svg?style=svg)](https://circleci.com/gh/bigcommerce/bigcommerce-api-ruby/tree/master)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/d1ba1b74a2a74a26e8b4/test_coverage)](https://codeclimate.com/github/bigcommerce/bigcommerce-api-ruby/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d1ba1b74a2a74a26e8b4/maintainability)](https://codeclimate.com/github/bigcommerce/bigcommerce-api-ruby/maintainability)
 
-This is the official BigCommerce API client to support our Stores API. You can find more information about becoming a BigCommerce developer here: [developer.bigcommerce.com](http://developer.bigcommerce.com).
+This is the official BigCommerce API client to support our Stores API. You can find more information about becoming a 
+BigCommerce developer here: [developer.bigcommerce.com](http://developer.bigcommerce.com).
 
 
 ## Installation
@@ -17,22 +19,26 @@ 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.
+
+- Ruby 2.7.5 or newer (Ruby 3.0+ is preferred)
 
 ## 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 +48,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 +66,9 @@ 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 +81,8 @@ 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 +99,27 @@ 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 +138,24 @@ 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 
+CLIs (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, 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 +173,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']
@@ -160,3 +190,6 @@ Bigcommerce::System.raw_request(:get, 'time', connection: connection_legacy)
 
 ## Contributing
 See [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## License
+See [LICENSE.md](LICENSE.md)

data/bigcommerce.gemspec

@@ -1,26 +1,26 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('lib', __dir__))
 require 'bigcommerce/version'
 
 Gem::Specification.new do |s|
   s.name = 'bigcommerce'
   s.version = Bigcommerce::VERSION
   s.platform = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.7.5'
   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
+  s.metadata['rubygems_mfa_required'] = 'true'
 
   s.require_paths = ['lib']
   s.files = Dir['README.md', 'lib/**/*', 'bigcommerce.gemspec']
 
-  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 'hashie', '~> 3.4'
+  s.add_dependency 'faraday', '~> 1.1.0'
+  s.add_dependency 'faraday_middleware', '~> 1.0'
+  s.add_dependency 'hashie', '>= 3.4', '~> 4'
+  s.add_dependency 'jwt', '>= 1.5.4', '~> 2'
 end

data/lib/bigcommerce/config.rb

@@ -1,14 +1,28 @@
+# frozen_string_literal: true
+
 module Bigcommerce
   class Config < Hashie::Mash
+    BC_API_ENDPOINT_ENV_KEY = 'BC_API_ENDPOINT'
     DEFAULTS = {
       base_url: 'https://api.bigcommerce.com'
     }.freeze
 
+    ##
+    # @return [String]
+    #
     def api_url
       return url if auth == 'legacy'
 
-      base = ENV['BC_API_ENDPOINT'].to_s.empty? ? DEFAULTS[:base_url] : ENV['BC_API_ENDPOINT']
-      "#{base}/stores/#{store_hash}/v2"
+      "#{base_url}/stores/#{store_hash}/v2"
+    end
+
+    private
+
+    ##
+    # @return [String]
+    #
+    def base_url
+      ENV[BC_API_ENDPOINT_ENV_KEY].to_s.empty? ? DEFAULTS[:base_url] : ENV.fetch(BC_API_ENDPOINT_ENV_KEY, nil)
     end
   end
 end

data/lib/bigcommerce/connection.rb

@@ -1,22 +1,27 @@
+# frozen_string_literal: true
+
 module Bigcommerce
   module Connection
+    LEGACY_AUTH_MODE = 'legacy'
     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
-        if config.auth == 'legacy'
+        if config.auth == LEGACY_AUTH_MODE
           conn.use Faraday::Request::BasicAuthentication, config.username, config.api_key
         else
           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

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Bigcommerce
   class HttpError < StandardError
     attr_accessor :response_headers
+
     def initialize(headers)
       @response_headers = headers
+      super()
     end
   end
 
@@ -39,19 +43,17 @@ module Bigcommerce
       509 => Bigcommerce::BandwidthLimitExceeded
     }.freeze
 
+    X_RETRY_AFTER_HEADER_KEY = 'x-retry-after'
+
     def throw_http_exception!(code, env)
-      return unless ERRORS.keys.include? code
-      response_headers = {}
-      unless env.body.empty?
-        response_headers = begin
-          JSON.parse(env.body, symbolize_names: true)
-        rescue
-          {}
-        end
-      end
-      unless env[:response_headers] && env[:response_headers]['X-Retry-After'].nil?
-        response_headers[:retry_after] = env[:response_headers]['X-Retry-After'].to_i
+      return unless ERRORS.key?(code)
+
+      response_headers = Faraday::Utils::Headers.new(env.response_headers)
+
+      unless response_headers[X_RETRY_AFTER_HEADER_KEY].nil?
+        response_headers[:retry_after] = response_headers[X_RETRY_AFTER_HEADER_KEY].to_i
       end
+
       raise ERRORS[code].new(response_headers), env.body
     end
   end

data/lib/bigcommerce/middleware/auth.rb

@@ -1,14 +1,20 @@
+# frozen_string_literal: true
+
 module Bigcommerce
   module Middleware
     class Auth < Faraday::Middleware
+      X_AUTH_CLIENT_HEADER = 'X-Auth-Client'
+      X_AUTH_TOKEN_HEADER = 'X-Auth-Token'
+
       def initialize(app, options = {})
         @app = app
         @options = options
+        super(app)
       end
 
       def call(env)
-        env[:request_headers]['X-Auth-Client'] = @options[:client_id]
-        env[:request_headers]['X-Auth-Token'] = @options[:access_token]
+        env[:request_headers][X_AUTH_CLIENT_HEADER] = @options[:client_id]
+        env[:request_headers][X_AUTH_TOKEN_HEADER] = @options[:access_token]
         @app.call env
       end
     end

data/lib/bigcommerce/middleware/http_exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bigcommerce/exception'
 
 module Bigcommerce

data/lib/bigcommerce/path_builder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Bigcommerce
+  class PathBuilder
+    # @!attribute [r] uri
+    #   @return [String] The URI of the path to build
+    attr_reader :uri
+
+    ##
+    # @param [String] 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
+    #
+    # @param [Array] keys
+    # @return [String]
+    #
+    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
+
+    ##
+    # @return [String]
+    #
+    def to_s
+      @uri
+    end
+  end
+end

data/lib/bigcommerce/request.rb

@@ -1,42 +1,17 @@
+# frozen_string_literal: true
+
 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
+      super()
     end
 
     def included(base)
       base.extend ClassMethods
-      path_builder = PathBuilder.new @uri
+      path_builder = ::Bigcommerce::PathBuilder.new(@uri)
       base.define_singleton_method :path do
         path_builder
       end
@@ -79,8 +54,13 @@ module Bigcommerce
         end
       end
 
+      ##
+      # @return [Hash]
+      # @return [Array]
+      #
       def parse(json)
         return [] if json.empty?
+
         JSON.parse(json, symbolize_names: true)
       end
     end

data/lib/bigcommerce/resource_actions.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module Bigcommerce
   class ResourceActions < Module
+    # @!attribute [r] options
+    #   @return [Hash] Options passed to this module
     attr_reader :options
 
     def initialize(options = {})
@@ -9,6 +13,7 @@ module Bigcommerce
           mod.options
         end
       end
+      super()
     end
 
     def included(base)
@@ -26,6 +31,7 @@ module Bigcommerce
 
       def find(resource_id, params = {})
         raise ArgumentError if resource_id.nil?
+
         get path.build(resource_id), params
       end
 
@@ -35,11 +41,13 @@ module Bigcommerce
 
       def update(resource_id, params = {})
         raise ArgumentError if resource_id.nil?
+
         put path.build(resource_id), params
       end
 
       def destroy(resource_id, params = {})
         raise ArgumentError if resource_id.nil?
+
         delete path.build(resource_id), params
       end
 

data/lib/bigcommerce/resources/content/blog_post.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Blog Post
 # Content entries in the store's blog.
 # https://developer.bigcommerce.com/api/stores/v2/blog/posts

data/lib/bigcommerce/resources/content/blog_tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Blog Tag
 # Index of tags used on the store's blog.
 # https://developer.bigcommerce.com/api/stores/v2/blog/tags

data/lib/bigcommerce/resources/content/redirect.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Redirect
 # Redirects are used to create custom URL paths that map to resources on the
 # storefront (such as products, categories, brands, etc.) or manually defined

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

@@ -1,3 +1,8 @@
+# frozen_string_literal: true
+
+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 +27,27 @@ 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, redirect_to: '/')
+      payload = {
+        'iss' => config.client_id,
+        'iat' => Time.now.to_i,
+        'jti' => SecureRandom.uuid,
+        'operation' => 'customer_login',
+        'store_hash' => config.store_hash,
+        'customer_id' => id,
+        'redirect_to' => redirect_to
+      }
+
+      JWT.encode(payload, config.client_secret, 'HS256', { typ: 'JWT' })
+    end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Customer Address
 # Postal addresses belonging to a customer.
 # https://developer.bigcommerce.com/api/stores/v2/customers/addresses

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Customer Group
 # Groups of customers who share the same level of access and discounts
 # at a store.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Country
 # Countries and territories, identified by their ISO 3166 country codes.
 # https://developer.bigcommerce.com/api/stores/v2/countries
@@ -6,7 +8,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # State
 # States and subdivisions belonging to countries.
 # https://developer.bigcommerce.com/api/stores/v2/countries/states
@@ -6,7 +8,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/marketing/banner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Banner
 # HTML element on webpages to advertise discounts or other content relevant to shoppers.
 # https://developer.bigcommerce.com/api/stores/v2/banners

data/lib/bigcommerce/resources/marketing/coupon.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Coupon
 # Category or product discounts that can be applied to orders for customers
 # who enter a given code.

data/lib/bigcommerce/resources/marketing/gift_certificates.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Gift Certificates
 # Code that can be applied by customers to their order to provide full or partial payment.
 # https://developer.bigcommerce.com/api/stores/v2/gift_certificates

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Order
 # Purchases from a store.
 # https://developer.bigcommerce.com/api/stores/v2/orders
@@ -67,6 +69,14 @@ module Bigcommerce
     property :shipping_cost_tax_class_id
     property :wrapping_cost_tax_class_id
     property :count
+    property :cart_id
+    property :channel_id
+    property :custom_status
+    property :external_id
+    property :external_merchant_id
+    property :store_default_currency_code
+    property :store_default_to_transactional_exchange_rate
+    property :tax_provider_id
 
     def self.count(params = {})
       get 'orders/count', params

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Order Coupon
 # Coupons applied to an order.
 # https://developer.bigcommerce.com/api/stores/v2/orders/coupons
@@ -6,7 +8,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Order Message
 # Messages associated with an order.
 # https://developer.bigcommerce.com/api/stores/v2/orders/messages
@@ -6,7 +8,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Order Product
 # Product line items associated with an order.
 # https://developer.bigcommerce.com/api/stores/v2/orders/products
@@ -6,7 +8,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Order Shipping Addresses
 # Shipping addresses associated with an order.
 # https://developer.bigcommerce.com/api/stores/v2/orders/shipping_addresses
@@ -6,7 +8,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Order Status
 # Statuses that can be assigned to orders. Each status represents a state in
 # the fulfilment workflow.
@@ -7,7 +9,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Order Shipping Addresses
 # Shipping addresses associated with an order.
 # https://developer.bigcommerce.com/api/stores/v2/orders/shipping_addresses
@@ -6,7 +8,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/orders/shipment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Order Shipment
 # Shipping package consignments tracked from an order.
 # https://developer.bigcommerce.com/api/stores/v2/orders/shipments

data/lib/bigcommerce/resources/payments/payment_method.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Payment Method
 # Enabled payment methods.
 # https://developer.bigcommerce.com/api/stores/v2/payments/methods

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Brand
 # Brand facets for identifying and categorising products according
 # to their manufacturer or company metonym.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Bulk Pricing Rule
 # Bulk pricing rules applied to a product.
 # https://developer.bigcommerce.com/api/stores/v2/products/discount_rules

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Category
 # Index of hierarchical categories used to organise and group products.
 # https://developer.bigcommerce.com/api/stores/v2/categories

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Configurable Field
 # Configurable fields associated with a product.
 # https://developer.bigcommerce.com/api/stores/v2/products/configurable_fields
@@ -6,7 +8,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/custom_field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Custom Field
 # Custom fields associated with a product.
 # https://developer.bigcommerce.com/api/stores/v2/products/custom_fields

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Google Product Search Mapping
 # Google Product Search mappings for a product.
 # https://developer.bigcommerce.com/api/stores/v2/products/googleproductsearch

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Option
 # Shared attributes that control value facets on a product.
 # https://developer.bigcommerce.com/api/stores/v2/options

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Option Set
 # A reusable set of option facets that can be applied to products.
 # https://developer.bigcommerce.com/api/stores/v2/options_sets

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Option Set Option
 # Options belonging to an option set.
 # https://developer.bigcommerce.com/api/stores/v2/option_sets/options

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Option Value
 # Values that can be selected for an option.
 # https://developer.bigcommerce.com/api/stores/v2/options/values

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Product
 # Catalog of saleable items in the store.
 # https://developer.bigcommerce.com/api/stores/v2/products

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Product Image
 # Images associated with a product.
 # https://developer.bigcommerce.com/api/stores/v2/products/images

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Product Option
 # Options associated directly with a product.
 # https://developer.bigcommerce.com/api/stores/v2/products/options
@@ -6,7 +8,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/products/product_review.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Product Review
 # Options associated directly with a product.
 # https://developer.bigcommerce.com/api/stores/v2/products/reviews

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Product Rule
 # Rules that modify the default behaviour of products.
 # https://developer.bigcommerce.com/api/stores/v2/products/rules

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Product Video
 # Embedded videos displayed on product listings.
 # https://developer.bigcommerce.com/api/stores/v2/products/videos

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # SKU
 # Stock Keeping Unit identifiers associated with products.
 # https://developer.bigcommerce.com/api/stores/v2/products/skus

data/lib/bigcommerce/resources/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bigcommerce/request'
 require 'bigcommerce/resource_actions'
 require 'bigcommerce/subresource_actions'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Shipping Method
 # List of enabled shipping methods.
 # https://developer.bigcommerce.com/api/stores/v2/shipping/methods
@@ -6,7 +8,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/store/store_information.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Store Information
 # Metadata that describes the store.
 # https://developer.bigcommerce.com/api/stores/v2/store_information

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Time
 # Timestamp ping to check the system status.
 # https://developer.bigcommerce.com/api/stores/v2/time

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Tax Class
 # Tax classes are used to apply different tax rates for specific types
 # of products and orders.
@@ -7,7 +9,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/resources/webhooks/webhook.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Webhook
 # Register and manage webhooks that connect events from a store to
 # external URLs.

data/lib/bigcommerce/subresource_actions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bigcommerce
   class SubresourceActions < ResourceActions
     def included(base)
@@ -11,31 +13,37 @@ module Bigcommerce
     module ClassMethods
       def all(parent_id, params = {})
         raise ArgumentError if parent_id.nil?
+
         get path.build(parent_id), params
       end
 
       def find(parent_id, resource_id, params = {})
         raise ArgumentError if [parent_id, resource_id].any?(&:nil?)
+
         get path.build([parent_id, resource_id]), params
       end
 
       def create(parent_id, params = {})
         raise ArgumentError if parent_id.nil?
+
         post path.build(parent_id), params
       end
 
       def update(parent_id, resource_id, params = {})
         raise ArgumentError if [parent_id, resource_id].any?(&:nil?)
+
         put path.build([parent_id, resource_id]), params
       end
 
       def destroy(parent_id, resource_id, params = {})
         raise ArgumentError if [parent_id, resource_id].any?(&:nil?)
+
         delete path.build([parent_id, resource_id]), params
       end
 
       def destroy_all(parent_id, params = {})
         raise ArgumentError if parent_id.nil?
+
         delete path.build(parent_id), params
       end
     end

data/lib/bigcommerce/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bigcommerce
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'
 end

data/lib/bigcommerce.rb

@@ -1,21 +1,29 @@
+# frozen_string_literal: true
+
 require 'hashie'
 require 'faraday_middleware'
-require 'bigcommerce/version'
-require 'bigcommerce/config'
-require 'bigcommerce/connection'
-require 'bigcommerce/middleware/auth'
-require 'bigcommerce/middleware/http_exception'
-require 'bigcommerce/resources/resource'
+require_relative 'bigcommerce/version'
+require_relative 'bigcommerce/config'
+require_relative 'bigcommerce/connection'
+require_relative 'bigcommerce/path_builder'
+require_relative 'bigcommerce/middleware/auth'
+require_relative 'bigcommerce/middleware/http_exception'
+require_relative 'bigcommerce/resources/resource'
 
 module Bigcommerce
   resources = File.join(File.dirname(__FILE__), 'bigcommerce', 'resources', '**', '*.rb')
-  Dir.glob(resources, &method(:require))
+  Dir.glob(resources).sort.each { |r| require r }
 
   class << self
+    # @!attribute [r] api
+    #   @return [::Faraday::Connection]
     attr_reader :api
+    # @!attribute [r] config
+    #   @return [::Bigcommerce::Config]
+    attr_reader :config
 
-    def configure
-      @config = Bigcommerce::Config.new.tap { |h| yield(h) }
+    def configure(&block)
+      @config = Bigcommerce::Config.new.tap(&block)
       @api = Bigcommerce::Connection.build(@config)
     end
   end

metadata

@@ -1,87 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: bigcommerce
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
-- Patrick Edelman
-autorequire: 
+- BigCommerce Engineering
 bindir: bin
 cert_chain: []
-date: 2016-06-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.4
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '2'
 description: Ruby client library for the BigCommerce API
-email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -94,6 +90,7 @@ files:
 - lib/bigcommerce/exception.rb
 - lib/bigcommerce/middleware/auth.rb
 - lib/bigcommerce/middleware/http_exception.rb
+- lib/bigcommerce/path_builder.rb
 - lib/bigcommerce/request.rb
 - lib/bigcommerce/resource_actions.rb
 - lib/bigcommerce/resources/content/blog_post.rb
@@ -144,8 +141,8 @@ files:
 homepage: https://github.com/bigcommerce/bigcommerce-api-ruby
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -153,16 +150,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.7.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby client library for the BigCommerce API
 test_files: []