Merge pull request #523 from zendesk/RED-1558-update-supports

v1.38.0.rc2 Drop support for Ruby 2.6

Author: ecoologic

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @zendesk/redback

.github/workflows/main.yml

@@ -15,12 +15,11 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - "2.6"
           - "2.7"
           - "3.0"
           - "3.1"
           - "3.2"
-          - "jruby-9.3"
+          - "jruby-9.4"
     steps:
       - name: Checkout code
         uses: zendesk/checkout@v2

.gitignore

@@ -4,5 +4,6 @@ spec/fixtures/credentials.yml
 coverage/**
 .yardoc/**
 Gemfile.lock
+.ruby-version
 vendor/bundle/**
 pkg/**

.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   DisplayCopNames: true
   Exclude:
     - .git/**/*
@@ -13,11 +13,11 @@ Layout/EndAlignment:
   EnforcedStyleAlignWith: variable
 
 # Align the elements of a hash literal if they span more than one line.
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedLastArgumentHashStyle: ignore_implicit
 
 # Align the parameters of a method call if they span more than one line.
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation
 
 # Checks the indentation of hanging closing parentheses.

.rubocop_todo.yml

@@ -28,10 +28,13 @@ Gemspec/OrderedDependencies:
 # SupportedHashRocketStyles: key, separator, table
 # SupportedColonStyles: key, separator, table
 # SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/AlignHash:
+Layout/HashAlignment:
   Exclude:
     - 'spec/live/user_view_spec.rb'
 
+Layout/LineLength:
+  Max: 160
+
 # Offense count: 17
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
@@ -106,7 +109,7 @@ Lint/DuplicateMethods:
     - 'lib/zendesk_api/resource.rb'
 
 # Offense count: 3
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Exclude:
     - 'Rakefile'
     - 'spec/core/collection_spec.rb'
@@ -138,7 +141,7 @@ Lint/ShadowingOuterLocalVariable:
 
 # Offense count: 10
 # Cop supports --auto-correct.
-Lint/StringConversionInInterpolation:
+Lint/RedundantStringCoercion:
   Exclude:
     - 'lib/zendesk_api/middleware/response/logger.rb'
     - 'spec/live/macro_spec.rb'
@@ -192,26 +195,6 @@ Naming/PredicateName:
     - 'spec/**/*'
     - 'lib/zendesk_api/associations.rb'
 
-# Offense count: 1
-Performance/Caller:
-  Exclude:
-    - 'lib/zendesk_api/resource.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Performance/RedundantBlockCall:
-  Exclude:
-    - 'lib/zendesk_api/collection.rb'
-
-# Offense count: 10
-# Cop supports --auto-correct.
-# Configuration parameters: MaxKeyValuePairs.
-Performance/RedundantMerge:
-  Exclude:
-    - 'lib/zendesk_api/associations.rb'
-    - 'lib/zendesk_api/collection.rb'
-    - 'spec/macros/resource_macros.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 Security/YAMLLoad:

.ruby-version

@@ -0,0 +1 @@
+2.7.6

CHANGELOG.md

@@ -2,16 +2,26 @@
 
 ## Unreleased
 
-## v1.38.0 (rc2)
+- Upcoming changes
+
+## v1.38.0 (rc2 - BREAKING!)
 
-- Add `Label` resource for Articles
 - Add support for Faraday 2.0
-- Drop support for Faraday 1 (BREAKING)
-- Add JRuby 9.3 to CI
+- Add `Label` resource for Articles
 - Add Ruby 3.2 to CI
-- Drop support for JRuby 9.1, see https://github.com/zendesk/zendesk_api_client_rb/runs/8110095881
-- Drop support for JRuby 9.2, see https://github.com/zendesk/zendesk_api_client_rb/runs/8110151024
-- Drop support for 2.6, not supported by Faraday 2.0
+- Add JRuby 9.4 to CI
+- Drop support for Faraday 1
+- Remove 2.6 from CI
+- Remove JRuby 9.1 from CI, see https://github.com/zendesk/zendesk_api_client_rb/runs/8110095881
+- Remove JRuby 9.2 from CI, see https://github.com/zendesk/zendesk_api_client_rb/runs/8110151024
+
+**Note:**
+
+It is possible that the SDK will work okay in Ruby 2.6, but we do not guarantee it, and also support will not be provided on any issues.
+
+We will continue to support Ruby 2.7 owing to the large set of developers still on Ruby 2. The support will end by Jan 2024.
+
+We strongly recommend everyone to consider moving to Ruby 3 at the earliest.
 
 ## v1.37.0
 

Gemfile

@@ -8,7 +8,7 @@ gem "yard"
 gem "json", ">= 2.3.0", platforms: :ruby
 gem "scrub_rb"
 
-gem "rubocop", "~> 0.64.0", require: false
+gem "rubocop", "~> 0.79.0", require: false # Handling of Ruby 2.7 syntax
 
 group :test do
   gem "webmock"

lib/zendesk_api/client.rb

@@ -170,7 +170,12 @@ def build_connection
         builder.use ZendeskAPI::Middleware::Request::EncodeJson
 
         # Should always be first in the stack
-        builder.use ZendeskAPI::Middleware::Request::Retry, :logger => config.logger, :retry_codes => config.retry_codes, :retry_on_exception => config.retry_on_exception if config.retry
+        if config.retry
+          builder.use ZendeskAPI::Middleware::Request::Retry,
+                      :logger => config.logger,
+                      :retry_codes => config.retry_codes,
+                      :retry_on_exception => config.retry_on_exception
+        end
         if config.raise_error_when_rate_limited
           builder.use ZendeskAPI::Middleware::Request::RaiseRateLimited, :logger => config.logger
         end

spec/core/bulk_actions_spec.rb

@@ -33,7 +33,7 @@
 
     it 'calls the create_many endpoint' do
       assert_requested(:post, %r{bulk_test_resources/create_many},
-        :body => json(:bulk_test_resources => attributes)
+                       :body => json(:bulk_test_resources => attributes)
       )
     end
 
@@ -57,7 +57,7 @@
 
         it 'calls the update_many endpoint' do
           assert_requested(:put, %r{bulk_test_resources/update_many\?ids=1,2,3$},
-            :body => json(:bulk_test_resource => attributes)
+                           :body => json(:bulk_test_resource => attributes)
           )
         end
 
@@ -77,7 +77,7 @@
 
         it 'calls the update_many endpoint' do
           assert_requested(:put, %r{bulk_test_resources/update_many$},
-            :body => json(:bulk_test_resources => attributes)
+                           :body => json(:bulk_test_resources => attributes)
           )
         end
 
@@ -107,7 +107,7 @@
         subject
 
         assert_requested(:post, %r{bulk_test_resources/create_or_update_many$},
-          :body => json(:bulk_test_resources => attributes)
+                         :body => json(:bulk_test_resources => attributes)
         )
       end