Merge pull request #177 from j05h/ruby-3.2-support

j05h · web-flow · commit c8ed62cbd512 · 2024-03-26T09:14:36.000-05:00
Add support for Ruby 3.2
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -7,12 +7,6 @@ orbs:
 defaults: &defaults
   notify_failure: false
 
-ruby_2_6_defaults: &ruby_2_6_defaults
-  <<: *defaults
-  e:
-    name: ruby/ruby
-    ruby-version: '2.6'
-
 ruby_2_7_defaults: &ruby_2_7_defaults
   <<: *defaults
   e:
@@ -31,21 +25,14 @@ ruby_3_1_defaults: &ruby_3_1_defaults
     name: ruby/ruby
     ruby-version: '3.1'
 
+ruby_3_2_defaults: &ruby_3_2_defaults
+  <<: *defaults
+  e:
+    name: ruby/ruby
+    ruby-version: '3.2'
+
 workflows:
   version: 2
-  ruby_2_6:
-    jobs:
-      - ruby/bundle-audit:
-          <<: *ruby_2_6_defaults
-          name: ruby-2_6-bundle_audit
-      - ruby/rubocop:
-          <<: *ruby_2_6_defaults
-          name: ruby-2_6-rubocop
-      - ruby/rspec-unit:
-          <<: *ruby_2_6_defaults
-          name: ruby-2_6-rspec_unit
-          db: false
-          code-climate: false
   ruby_2_7:
     jobs:
       - ruby/bundle-audit:
@@ -84,3 +71,16 @@ workflows:
           name: ruby-3_1-rspec_unit
           db: false
           code-climate: false
+  ruby_3_2:
+    jobs:
+      - ruby/bundle-audit:
+          <<: *ruby_3_2_defaults
+          name: ruby-3_2-bundle_audit
+      - ruby/rubocop:
+          <<: *ruby_3_2_defaults
+          name: ruby-3_2-rubocop
+      - ruby/rspec-unit:
+          <<: *ruby_3_2_defaults
+          name: ruby-3_2-rspec_unit
+          db: false
+          code-climate: false
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   NewCops: enable
   SuggestExtensions: false
   Exclude:
@@ -30,10 +30,5 @@ Style/FormatStringToken:
 Naming/VariableNumber:
   Enabled: false
 
-########################################################################################################################
-# TO FIX
-########################################################################################################################
-
-# we should deprecate Ruby < 2.7 support ASAP
 Gemspec/RequiredRubyVersion:
-  Enabled: false
+  Enabled: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 Your contribution here.
 
 * [#000](https://github.com/bigcommerce/bigcommerce-api-ruby/pull/000): Brief description here. - [@username](https://github.com/username).
+* [#174](https://github.com/bigcommerce/bigcommerce-api-ruby/pull/174): Drop support for ruby 2.6; Add support for Ruby 3.2 - [@j05h](https://github.com/j05h).
 
 ## 1.0.2
 
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -27,8 +27,7 @@ git checkout -b my-feature-branch
 Ensure that you can build the project and run tests.
 
 ```
-bundle install
-bundle exec rake
+bin/setup
 ```
 
 #### Installing the gem locally (useful to run examples)
@@ -86,7 +85,8 @@ git push origin my-feature-branch
 
 #### Make a Pull Request
 
-Go to https://github.com/contributor/bigcommerce-api-ruby and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+Go to https://github.com/contributor/bigcommerce-api-ruby and select your feature branch. Click the 'Pull Request'
+button and fill out the form. Pull requests are usually reviewed within a few days.
 
 #### Rebase
 
@@ -115,4 +115,5 @@ git push origin my-feature-branch -f
 
 #### Check on Your Pull Request
 
-Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+Go back to your pull request after a few minutes and see whether it passed muster with CircleCI. Everything should
+look green, otherwise fix issues and amend your commit as described above.
diff --git a/Gemfile b/Gemfile
@@ -3,3 +3,14 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'bundler'
+gem 'bundler-audit', '~> 0.6'
+gem 'dotenv', '>= 2.0'
+gem 'pry', '>= 0.12'
+gem 'rake', '>= 12.0'
+gem 'rspec', '~> 3.8'
+gem 'rspec_junit_formatter', '~> 0.4'
+gem 'rubocop', '~> 1.0'
+gem 'rubocop-performance', '>= 1.5'
+gem 'simplecov', '~> 0.15'
diff --git a/README.md b/README.md
@@ -5,7 +5,8 @@
 [![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
@@ -23,18 +24,21 @@ gem 'bigcommerce', '~> 1.0'
 
 ## Requirements
 
-- Ruby 2.0.0 or newer (Ruby 2.7+ is preferred)
+- Ruby 2.7.5 or newer (Ruby 3.0+ is preferred)
 
 ## 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).
+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 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.
+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)__
 
@@ -62,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 on which to authenticate.
+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|
@@ -75,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 might 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|
@@ -95,7 +102,8 @@ 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 client secret.
+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.
@@ -110,7 +118,8 @@ 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://developer.bigcommerce.com/api).
 
 Example:
 
@@ -129,11 +138,16 @@ Bigcommerce::System.time
 
 ### Thread Safety
 
-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:
+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 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.
+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 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.
+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
 
diff --git a/RELEASING.md b/RELEASING.md
@@ -1,6 +1,7 @@
 # Releasing Bigcommerce API Client
 
-There're no particular rules about when to release the Bigcommerce API client. Release bug fixes frequently, features not so frequently, and breaking API changes rarely.
+There are no particular rules about when to release the Bigcommerce API client. Release bug fixes frequently, features
+not so frequently, and breaking API changes rarely.
 
 ### Before A Release
 
@@ -11,7 +12,8 @@ bundle install
 bundle exec rake
 ```
 
-This will ensure both style and that all the specs pass locally. Next, check that the last build succeeded in [CircleCI](https://app.circleci.com/pipelines/github/bigcommerce/bigcommerce-api-ruby) for all supported platforms.
+This will ensure both style and that all the specs pass locally. Next, check that the last build succeeded 
+in [CircleCI](https://app.circleci.com/pipelines/github/bigcommerce/bigcommerce-api-ruby) for all supported platforms.
 
 Increment the version, modify [lib/bigcommerce/version.rb](lib/bigcommerce/version.rb).
 
diff --git a/bigcommerce.gemspec b/bigcommerce.gemspec
@@ -7,7 +7,7 @@ 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 = ['BigCommerce Engineering']
@@ -19,17 +19,6 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   s.files = Dir['README.md', 'lib/**/*', 'bigcommerce.gemspec']
 
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'bundler-audit', '~> 0.6'
-  s.add_development_dependency 'dotenv', '>= 2.0'
-  s.add_development_dependency 'pry', '>= 0.12'
-  s.add_development_dependency 'rake', '>= 12.0'
-  s.add_development_dependency 'rspec', '~> 3.8'
-  s.add_development_dependency 'rspec_junit_formatter', '~> 0.4'
-  s.add_development_dependency 'rubocop', '~> 1.0'
-  s.add_development_dependency 'rubocop-performance', '>= 1.5'
-  s.add_development_dependency 'simplecov', '~> 0.15'
-
   s.add_dependency 'faraday', '~> 1.1.0'
   s.add_dependency 'faraday_middleware', '~> 1.0'
   s.add_dependency 'hashie', '>= 3.4', '~> 4'
diff --git a/bin/setup b/bin/setup
@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+bundle exec rspec -p
+bundle exec rubocop -P
+bundle audit update
+bundle audit
diff --git a/lib/bigcommerce/version.rb b/lib/bigcommerce/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bigcommerce
-  VERSION = '1.0.2'
+  VERSION = '1.1.0.pre'
 end
