Housekeeping 🧹

Author: KaseyCantu

.github/workflows/CI.yaml

@@ -23,8 +23,8 @@ jobs:
         with:
           bundler-cache: true
 
-#      - name: Lint
-#        run: bundle exec rake lint
+      - name: Lint
+        run: bundle exec rake lint
 
       - name: Test
         run: bundle exec rake test

.pryrc

@@ -1,13 +1,14 @@
 # rubocop:disable
 
 # frozen_string_literal: true
+
 # === EDITOR ===
-Pry.editor = "vi"
+Pry.editor = 'vi'
 
 # === COLORS ===
-unless ENV["PRY_BW"]
+unless ENV['PRY_BW']
   Pry.color = true
-  Pry.config.theme = "railscasts"
+  Pry.config.theme = 'railscasts'
 end
 
 # === Listing config ===
@@ -25,7 +26,7 @@ Pry.config.ls.private_method_color = :bright_black
 # awesome_print gem: great syntax colorized printing
 # look at ~/.aprc for more settings for awesome_print
 begin
-  require "awesome_print"
+  require 'awesome_print'
   # The following line enables awesome_print for all pry output,
   # and it also enables paging
   Pry.config.print = proc { |output, value| Pry::Helpers::BaseHelpers.stagger_output("=> #{value.ai}", output) }
@@ -35,7 +36,7 @@ begin
     Formatter.prepend(Module.new do
       def awesome_self(object, type)
         if type == :string && @options[:string_limit] && object.inspect.to_s.length > @options[:string_limit]
-          colorize(object.inspect.to_s[0..@options[:string_limit]] + "...", type)
+          colorize("#{object.inspect.to_s[0..@options[:string_limit]]}...", type)
         else
           super(object, type)
         end
@@ -46,11 +47,11 @@ begin
   AwesomePrint.defaults = {
     string_limit: 80,
     indent: 2,
-    multiline: true,
+    multiline: true
   }
   AwesomePrint.pry!
 rescue err
-  puts "gem install awesome_print  # <-- highly recommended"
+  puts 'gem install awesome_print  # <-- highly recommended'
 end
 
 # rubocop:enable

.rubocop.yml

@@ -1,11 +1,12 @@
 AllCops:
   NewCops: enable # https://docs.rubocop.org/rubocop/1.11/versioning.html#pending-cops
   SuggestExtensions: false
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2.2
   Exclude:
     - bin/**/*
     - tmp/**/*
     - vendor/**/*
+    - test/**/*
     - lib/shipengine/utils/base58.rb
     - !ruby/regexp /(foo|bar|baz)\.rb/
 

Gemfile

@@ -1,35 +1,35 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 group :development do
-  gem "guard"
-  gem "guard-minitest"
-  gem "pry"
-  gem "solargraph", require: false
-  gem "yard"
-  gem "ruby-debug-ide", require: false
-  gem "rubocop-shopify", require: false
-  gem "awesome_print"
-  gem "overcommit"
+  gem 'awesome_print'
+  gem 'guard'
+  gem 'guard-minitest'
+  gem 'overcommit'
+  gem 'pry'
+  gem 'rubocop-shopify', require: false
+  gem 'ruby-debug-ide', require: false
+  gem 'solargraph', require: false
+  gem 'yard'
 end
 
 group :test do
-  gem "minitest"
-  gem "minitest-fail-fast"
-  gem "minitest-focus"
-  gem "minitest-hooks"
-  gem "minitest-line"
-  gem "minitest-tagz"
-  gem "minitest-reporters"
-  gem "simplecov", require: false
-  gem "webmock"
-  gem "spy"
+  gem 'minitest'
+  gem 'minitest-fail-fast'
+  gem 'minitest-focus'
+  gem 'minitest-hooks'
+  gem 'minitest-line'
+  gem 'minitest-reporters'
+  gem 'minitest-tagz'
+  gem 'simplecov', require: false
+  gem 'spy'
+  gem 'webmock'
 end
 
 group :test, :development do
-  gem "rake"
-  gem "rubocop", require: false
+  gem 'rake'
+  gem 'rubocop', require: false
 end
 
 gemspec

Gemfile.lock

@@ -132,8 +132,8 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
-    rubocop-shopify (2.2.0)
-      rubocop (~> 1.18)
+    rubocop-shopify (2.14.0)
+      rubocop (~> 1.51)
     ruby-debug-ide (0.7.2)
       rake (>= 0.8.1)
     ruby-progressbar (1.13.0)

Guardfile

@@ -2,12 +2,12 @@
 
 # More info at https://github.com/guard/guard#readme
 guard :minitest do
-  watch(%r{^lib/(.*)\.rb$}) { "test" } # run all tests if code is modified
+  watch(%r{^lib/(.*)\.rb$}) { 'test' } # run all tests if code is modified
   watch(%r{^test/(.*)_test\.rb$}) # only run specific test file if test is modified
 
   # configuration
-  watch(%r{^test/test_helper\.rb$}) { "test" }
-  watch(%r{^test/test_utility/(.*)\.rb$}) { "test" }
+  watch(%r{^test/test_helper\.rb$}) { 'test' }
+  watch(%r{^test/test_utility/(.*)\.rb$}) { 'test' }
 end
 
 # https://stackoverflow.com/questions/23571163/clear-previous-tests-in-rspec-while-running-new-tests-using-guard

Rakefile

@@ -1,32 +1,32 @@
 # frozen_string_literal: true
 
 begin
-  require "bundler/setup"
+  require 'bundler/setup'
 rescue LoadError
-  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require "rubocop/rake_task"
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'rubocop/rake_task'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs << 'test'
+  t.libs << 'lib'
   t.verbose = true
   t.warning = false
-  t.pattern = "test/**/*_test.rb"
+  t.pattern = 'test/**/*_test.rb'
 end
 
 RuboCop::RakeTask.new(:lint) do |t|
-  t.options = ["--display-cop-names"]
+  t.options = ['--display-cop-names']
 end
 
 RuboCop::RakeTask.new(:fix) do |t|
-  t.options = ["--auto-correct-all"]
+  t.options = ['--auto-correct-all']
 end
 
 task :default do
-  Rake::Task["test"].execute
-  Rake::Task["lint"].execute
+  Rake::Task['test'].execute
+  Rake::Task['lint'].execute
 end

lib/faraday/raise_http_exception.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require "faraday"
+
+require 'faraday'
 # @private
 module FaradayMiddleware
   # @private
@@ -8,10 +9,16 @@ def call(env)
       @app.call(env).on_complete do |response|
         case response[:status].to_i
         when 400, 401, 404, 500, 502, 503, 504
-          raise ShipEngine::Exceptions::ShipEngineError.new(message: error_body(response[:body]), source: error_source(response[:body]),
-            type: error_type(response[:body]), code: error_code(response[:body]), request_id: response[:body]["request_id"], url: response[:url].to_s)
+          raise ShipEngine::Exceptions::ShipEngineError.new(
+            message: error_body(response[:body]),
+            source: error_source(response[:body]),
+            type: error_type(response[:body]),
+            code: error_code(response[:body]),
+            request_id: response[:body]['request_id'],
+            url: response[:url].to_s
+          )
         when 429
-          raise ShipEngine::Exceptions::RateLimitError.new(retries: env.request_headers["Retries"].to_i, source: error_source(response[:body]), request_id: response[:body]["request_id"])
+          raise ShipEngine::Exceptions::RateLimitError.new(retries: env.request_headers['Retries'].to_i, source: error_source(response[:body]), request_id: response[:body]['request_id'])
         end
       end
     end
@@ -23,55 +30,47 @@ def initialize(app)
 
     private
 
-    def error_message_400(response)
+    def error_message_400(response) # rubocop:todo Naming/VariableNumber
       "#{response[:method].to_s.upcase} #{response[:url]}: #{response[:status]}#{error_body(response[:body])}"
     end
 
     def error_body(body)
-      if !body.nil? && !body.empty? && body.is_a?(String)
-        body = ::JSON.parse(body)
-      end
+      body = ::JSON.parse(body) if !body.nil? && !body.empty? && body.is_a?(String)
 
       if body.nil?
         nil
-      elsif body["errors"] && !body["errors"].empty?
-        body["errors"][0]["message"]
+      elsif body['errors'] && !body['errors'].empty?
+        body['errors'][0]['message']
       end
     end
 
     def error_source(body)
-      if !body.nil? && !body.empty? && body.is_a?(String)
-        body = ::JSON.parse(body)
-      end
+      body = ::JSON.parse(body) if !body.nil? && !body.empty? && body.is_a?(String)
 
       if body.nil?
         nil
-      elsif body["errors"] && !body["errors"].empty?
-        body["errors"][0]["error_source"]
+      elsif body['errors'] && !body['errors'].empty?
+        body['errors'][0]['error_source']
       end
     end
 
     def error_type(body)
-      if !body.nil? && !body.empty? && body.is_a?(String)
-        body = ::JSON.parse(body)
-      end
+      body = ::JSON.parse(body) if !body.nil? && !body.empty? && body.is_a?(String)
 
       if body.nil?
         nil
-      elsif body["errors"] && !body["errors"].empty?
-        body["errors"][0]["error_type"]
+      elsif body['errors'] && !body['errors'].empty?
+        body['errors'][0]['error_type']
       end
     end
 
     def error_code(body)
-      if !body.nil? && !body.empty? && body.is_a?(String)
-        body = ::JSON.parse(body)
-      end
+      body = ::JSON.parse(body) if !body.nil? && !body.empty? && body.is_a?(String)
 
       if body.nil?
         nil
-      elsif body["errors"] && !body["errors"].empty?
-        body["errors"][0]["error_code"]
+      elsif body['errors'] && !body['errors'].empty?
+        body['errors'][0]['error_code']
       end
     end
   end

lib/shipengine.rb

@@ -1,27 +1,27 @@
 # frozen_string_literal: true
 
 # for client class
-require "shipengine/internal_client"
-require "shipengine/domain"
-require "shipengine/configuration"
+require 'shipengine/internal_client'
+require 'shipengine/domain'
+require 'shipengine/configuration'
 
 # just for exporting
-require "shipengine/utils/validate"
-require "shipengine/version"
-require "shipengine/constants"
-require "observer"
+require 'shipengine/utils/validate'
+require 'shipengine/version'
+require 'shipengine/constants'
+require 'observer'
 
 module ShipEngine
   class Client
     attr_accessor :configuration
 
     def initialize(api_key, retries: nil, timeout: nil, page_size: nil, base_url: nil)
       @configuration = Configuration.new(
-        api_key: api_key,
-        retries: retries,
-        base_url: base_url,
-        timeout: timeout,
-        page_size: page_size
+        api_key:,
+        retries:,
+        base_url:,
+        timeout:,
+        page_size:
       )
 
       @internal_client = ShipEngine::InternalClient.new(@configuration)
@@ -64,7 +64,7 @@ def validate_addresses(address, config = {})
     #
     # @see https://shipengine.github.io/shipengine-openapi/#operation/list_carriers
     def list_carriers(config: {})
-      @carriers.list_carriers(config: config)
+      @carriers.list_carriers(config:)
     end
 
     # Create label from Rate Id

lib/shipengine/configuration.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module ShipEngine
   class Configuration
     attr_accessor :api_key, :retries, :base_url, :timeout, :page_size
@@ -32,11 +33,11 @@ def merge(config)
     protected
 
     def validate
-      Utils::Validate.str("A ShipEngine API key", @api_key)
-      Utils::Validate.str("Base URL", @base_url)
-      Utils::Validate.non_neg_int("Retries", @retries)
-      Utils::Validate.positive_int("Timeout", @timeout)
-      Utils::Validate.positive_int("Page size", @page_size)
+      Utils::Validate.str('A ShipEngine API key', @api_key)
+      Utils::Validate.str('Base URL', @base_url)
+      Utils::Validate.non_neg_int('Retries', @retries)
+      Utils::Validate.positive_int('Timeout', @timeout)
+      Utils::Validate.positive_int('Page size', @page_size)
     end
   end
 end

lib/shipengine/constants.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require_relative "constants/countries"
-require_relative "constants/base"
+require_relative 'constants/countries'
+require_relative 'constants/base'

lib/shipengine/constants/base.rb

@@ -3,10 +3,10 @@
 module ShipEngine
   module Constants
     # A stub API Key to use in the test suite.
-    API_KEY = "TEST_ycvJAgX6tLB1Awm9WGJmD8mpZ8wXiQ20WhqFowCk32s"
+    API_KEY = 'TEST_ycvJAgX6tLB1Awm9WGJmD8mpZ8wXiQ20WhqFowCk32s'
 
     # The base_url for the ShipEngine SDK - for use in production environment.
-    PROD_URL = "https://api.shipengine.com"
+    PROD_URL = 'https://api.shipengine.com'
 
     # Regex pattern to match a valid *ISO-8601* string with timezone.
     VALID_ISO_STRING = /^(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12][0-9])T(2[0-3]|[01][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?(Z|[+-](?:2[0-3]|[01][0-9]):[0-5][0-9])?$/