zendesk_api 1.32.0 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9cc4118166019441137ca3a0ddbabd9444b7b32b26ca1f3ed83b9cddb5dea0
-  data.tar.gz: 1fbaf93e103deb403cbcf81cdb031e0461de68ed532ad6abd061d8d7cf6462c8
+  metadata.gz: ac58a5fc63f870e31bd1a7d33ce398aef60c203fc5ec7bba79b1422b81aa3402
+  data.tar.gz: 1a315f8e08e96b2f1d1c20decb998459ec5f7ddc7ee233cb6cdaa7c0374da452
 SHA512:
-  metadata.gz: 51e1b589e97fd42c532ef1225b9c2a0cfeabb6f7560739fad4adde015defc73f3908d4ab2049135ca219d5e210965fc1c6e644914e73ac886fb5b50ad810a7e6
-  data.tar.gz: ef264143b1c4236505bff73e11d846ea4eb6bb27721bc848b6031e641c031f9827d9e32546ba2480bbddd8cf86f84bc6a62e0ff802e3157546d0b0a6c3c9f792
+  metadata.gz: e4021bc4c21f5b0ac9257ef8a8c0ee34e22244865f8737167be27aa057505f240d9c6996d262162cce3734759ac8b93eacf3ab3c9454066976ae1e835e5631fa
+  data.tar.gz: 750d62cb5fc7f404a034ff8c5cc5e3c85c59a5852e4d46d55facb224dcfc7b3f41daf29ab7cb228d06993158108cba7a76ae72c50b0acbf9ee03adcab83e73f6

data/lib/zendesk_api/client.rb

@@ -181,7 +181,7 @@ module ZendeskAPI
         builder.use ZendeskAPI::Middleware::Request::EncodeJson
 
         # Should always be first in the stack
-        builder.use ZendeskAPI::Middleware::Request::Retry, :logger => config.logger if config.retry
+        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.raise_error_when_rate_limited
           builder.use ZendeskAPI::Middleware::Request::RaiseRateLimited, :logger => config.logger
         end

data/lib/zendesk_api/configuration.rb

@@ -45,6 +45,12 @@ module ZendeskAPI
     # @return [Boolean] Whether to use resource_cache or not
     attr_accessor :use_resource_cache
 
+    # specify the server error codes in which you want a retry to be attempted
+    attr_accessor :retry_codes
+
+    # specify if you want a (network layer) exception to elicit a retry
+    attr_accessor :retry_on_exception
+
     def initialize
       @client_options = {}
       @use_resource_cache = true

data/lib/zendesk_api/middleware/request/retry.rb

@@ -1,5 +1,4 @@
 require "faraday/middleware"
-
 module ZendeskAPI
   module Middleware
     # @private
@@ -8,19 +7,37 @@ module ZendeskAPI
       # @private
       class Retry < Faraday::Middleware
         DEFAULT_RETRY_AFTER = 10
-        ERROR_CODES = [429, 503]
+        DEFAULT_ERROR_CODES = [429, 503]
 
         def initialize(app, options = {})
           super(app)
           @logger = options[:logger]
+          @error_codes = options.key?(:retry_codes) && options[:retry_codes] ? options[:retry_codes] : DEFAULT_ERROR_CODES
+          @retry_on_exception = options.key?(:retry_on_exception) && options[:retry_on_exception] ? options[:retry_on_exception] : false
         end
 
         def call(env)
           original_env = env.dup
-          response = @app.call(env)
+          exception_happened = false
+          if @retry_on_exception
+            begin
+              response = @app.call(env)
+            rescue StandardError => e
+              exception_happened = true
+            end
+          else
+            response = @app.call(env)
+          end
+
+          if exception_happened || @error_codes.include?(response.env[:status])
+
+            if exception_happened
+              seconds_left = DEFAULT_RETRY_AFTER.to_i
+              @logger.warn "An exception happened, waiting #{seconds_left} seconds... #{e}" if @logger
+            else
+              seconds_left = (response.env[:response_headers][:retry_after] || DEFAULT_RETRY_AFTER).to_i
+            end
 
-          if ERROR_CODES.include?(response.env[:status])
-            seconds_left = (response.env[:response_headers][:retry_after] || DEFAULT_RETRY_AFTER).to_i
             @logger.warn "You have been rate limited. Retrying in #{seconds_left} seconds..." if @logger
 
             seconds_left.times do |i|

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "1.32.0"
+  VERSION = "1.33.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 1.32.0
+  version: 1.33.0
 platform: ruby
 authors:
 - Steven Davidovitz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2021-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -143,9 +143,9 @@ licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/zendesk/zendesk_api_client_rb/issues
-  changelog_uri: https://github.com/zendesk/zendesk_api_client_rb/blob/v1.32.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/1.32.0
-  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v1.32.0
+  changelog_uri: https://github.com/zendesk/zendesk_api_client_rb/blob/v1.33.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/1.33.0
+  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v1.33.0
   wiki_uri: https://github.com/zendesk/zendesk_api_client_rb/wiki
 post_install_message: 
 rdoc_options: []
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Zendesk REST API Client