bigcommerce 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91c155920d961947d4e7a2184fa2ffad660590d636bd70723d9eec87d4709f3b
-  data.tar.gz: dc8618135e2e88f8b2fa39954179d24ff56f435fa50185f4dd85baceb11684ef
+  metadata.gz: b85e649ea8b069cb792e147e901165cd5f81c8975ac434bf0182d369d07f0eb7
+  data.tar.gz: 89e5a3dff01013f56c51bf8aa5eaa3ef21c0af3e8304ccd6b2d72e4315d5117f
 SHA512:
-  metadata.gz: d3790b83072b92e5477bcdf2dffe1d13ca0da2beb501706dac775307701b68efc39c5168852309990f5255501d87c8178674820b0e6072ffe4208b439081ec2a
-  data.tar.gz: 411c3da75158d702890e5f764e44e708dabf2a713880f36af0283a40b05fff5b158eeea016a39b9253f1429dbb7322ec8c8737963696c3671fa960b65bcb394d
+  metadata.gz: c715fd627a137ff3a2a3e18d230bab0eeb0e4622574c123f08391fa483b3f342c34c68d8e05377d4db824997d76aaebaf6cb82145ae209c7658422db4a0e19a9
+  data.tar.gz: 61ed2eaa4b6d5bb724ded917e40a881187523d0cb9df63c87833d2eaa109bc0c165e7bc0510dd5388f5016ea6313454d7947698827a0a9d55b6395780fab60f4

data/README.md

@@ -5,11 +5,11 @@
 [![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 on the [docs site](https://docs.bigcommerce.com).
 
 ## Installation
+
 BigCommerce is available on [RubyGems](https://rubygems.org/gems/bigcommerce).
 
 ```sh
@@ -19,42 +19,41 @@ gem install bigcommerce
 You can also add it to your Gemfile.
 
 ```rb
-gem 'bigcommerce', '~> 1.0'
+gem 'bigcommerce', '~> 2.0'
 ```
 
 ## Requirements
 
-- Ruby 2.7.5 or newer (Ruby 3.0+ is preferred)
+- Ruby 3.2 or newer
 
 ## Getting Started
+
 To make requests to our API, you must register as a developer and have your credentials ready.
 
 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).
+scopes that the merchant has granted to your application. For more information about Store API scopes,
+see: [OAuth Scopes](https://docs.bigcommerce.com/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes).
 
 ## Authentication
+
 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 these apps in their 
-BigCommerce stores.
-
-__[More Information](https://developer.bigcommerce.com/api/using-oauth-intro)__
 
-### Basic Authentication (Legacy)
-To develop a custom integration for one store, your app needs to use Basic Authentication.
+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/legacy/basic-auth)__
+**[More Information](https://docs.bigcommerce.com/developer/docs/overview/api-fundamentals/api-accounts#authentication)**
 
 ## Configuration
+
 To authenticate your API client, you will need to configure the client like the following examples.
 
 ### OAuth App
 
-- ```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.
+- `client_id`: Obtained from the on the BigCommerce [Developer Portal's](https://build.bigcommerce.com) Apps section.
+- `access_token`: Obtained after a token exchange in the auth callback.
+- `store_hash`: Also obtained after the token exchange.
 
 ```rb
 Bigcommerce.configure do |config|
@@ -66,10 +65,9 @@ end
 
 ### Basic Authentication (Legacy)
 
-To get all the basic auth credentials, simply visit your store admin page, and navigate to the 
+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|
   config.auth = 'legacy'
@@ -79,9 +77,9 @@ Bigcommerce.configure do |config|
 end
 ```
 
-__SSL Configuration__
+**SSL Configuration**
 
-If you are using your own, self-signed, certificate, you can pass SSL options to Faraday. This is not required, but 
+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
@@ -102,12 +100,13 @@ For more information about configuring SSL with Faraday, please see the followin
 - [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 
+
+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.
+- `store_hash`: The store hash of the store you are operating against.
+- `client_id`: Obtained from the on the BigCommerce [Developer Portal's](https://build.bigcommerce.com) Apps section.
+- `client_secret`: Obtained from the on the BigCommerce [Developer Portal's](https://build.bigcommerce.com) Apps section.
 
 ```rb
 Bigcommerce.configure do |config|
@@ -118,8 +117,9 @@ end
 ```
 
 ## Usage
-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).
+
+For full examples of using the API client, please see the [examples folder](examples) and refer to
+BigCommerce's [developer documentation](https://docs.bigcommerce.com/).
 
 Example:
 
@@ -138,15 +138,15 @@ Bigcommerce::System.time
 
 ### Thread Safety
 
-The `Bigcommerce.configure` method is NOT thread-safe. This mechanism is designed for applications or 
+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, 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 
+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 to use your own 
+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
@@ -189,7 +189,9 @@ Bigcommerce::System.raw_request(:get, 'time', connection: connection_legacy)
 ```
 
 ## Contributing
+
 See [CONTRIBUTING.md](CONTRIBUTING.md)
 
 ## License
+
 See [LICENSE.md](LICENSE.md)

data/bigcommerce.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.files = Dir['README.md', 'lib/**/*', 'bigcommerce.gemspec']
 
-  s.add_dependency 'faraday', '~> 1.1.0'
-  s.add_dependency 'faraday_middleware', '~> 1.0'
+  s.add_dependency 'faraday', '>= 2.14', '< 3.0'
+  s.add_dependency 'faraday-gzip', '~> 3.0'
   s.add_dependency 'hashie', '>= 3.4', '~> 4'
   s.add_dependency 'jwt', '>= 1.5.4', '~> 2'
 end

data/lib/bigcommerce/connection.rb

@@ -16,12 +16,12 @@ module Bigcommerce
         conn.request :json
         conn.headers = HEADERS
         if config.auth == LEGACY_AUTH_MODE
-          conn.use Faraday::Request::BasicAuthentication, config.username, config.api_key
+          conn.request :authorization, :basic, config.username, config.api_key
         else
           conn.use Bigcommerce::Middleware::Auth, config
         end
+        conn.request :gzip
         conn.use Bigcommerce::Middleware::HttpException
-        conn.use FaradayMiddleware::Gzip
         conn.adapter Faraday.default_adapter
       end
     end

data/lib/bigcommerce/middleware/auth.rb

@@ -6,17 +6,19 @@ module Bigcommerce
       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_HEADER] = @options[:client_id]
-        env[:request_headers][X_AUTH_TOKEN_HEADER] = @options[:access_token]
+        env[:request_headers][X_AUTH_CLIENT_HEADER] = option_value(:client_id)
+        env[:request_headers][X_AUTH_TOKEN_HEADER] = option_value(:access_token)
         @app.call env
       end
+
+      private
+
+      def option_value(key)
+        return @options[key] if @options.key?(key)
+
+        @options[key.to_s]
+      end
     end
   end
 end

data/lib/bigcommerce/middleware/http_exception.rb

@@ -4,9 +4,15 @@ require 'bigcommerce/exception'
 
 module Bigcommerce
   module Middleware
-    class HttpException < Faraday::Response::Middleware
+    class HttpException < Faraday::Middleware
       include Bigcommerce::HttpErrors
 
+      def call(env)
+        @app.call(env).on_complete do |response_env|
+          on_complete(response_env)
+        end
+      end
+
       def on_complete(env)
         throw_http_exception! env[:status].to_i, env
         env

data/lib/bigcommerce/request.rb

@@ -46,7 +46,7 @@ module Bigcommerce
       private
 
       def build_response_object(response)
-        json = parse response.body
+        json = parse(response.body)
         if json.is_a? Array
           json.map { |obj| new obj }
         else

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

@@ -28,6 +28,7 @@ module Bigcommerce
     property :addresses
     property :tax_exempt_category
     property :accepts_marketing
+    property :form_fields
 
     def self.count(params = {})
       get 'customers/count', params

data/lib/bigcommerce/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bigcommerce
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end

data/lib/bigcommerce.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require 'hashie'
-require 'faraday_middleware'
+require 'faraday'
+require 'faraday/gzip'
 require_relative 'bigcommerce/version'
 require_relative 'bigcommerce/config'
 require_relative 'bigcommerce/connection'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bigcommerce
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - BigCommerce Engineering
@@ -13,30 +13,36 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-gzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement