zendesk_api 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6245981abb291dac06ffeb8de8a5b15616ae662af15fa98bbd0602868bee842f
-  data.tar.gz: 07635336cd0ad32a96a936f35b5190fd61bfb21c8ed7a1e49195f5565d0f5126
+  metadata.gz: 6d251a3a7a6b3e5830ef96e225b17cab2955918438ba819e2148fc1e5d233870
+  data.tar.gz: 3ae7a4241ab08f7b83833341368050ea52b8877ae0fdabaed97ed4d7d6054032
 SHA512:
-  metadata.gz: eb77d9d24bcd8749b128d9f99a58f69bb611538b1e1b6b28580599db900aed3db309a4efda05e2edfeafb57de8fa498f3c938db0531e8efe0aaa34566e8fa683
-  data.tar.gz: 3f90c014afafe35b5ca52e7374e97590f245114212c305aff4de5e080c0cb14be754f13e9a7109162c75a50397bd6354c9ea26085bd4170d57f5aef7de244ef2
+  metadata.gz: 11e3c75f505d736d00a6124867fcdd521a9545b7c3d1a60a72f4a0404db33c08048752f0a251513428e14ea909a37eda5a727cbf99ac514eb20106c497ae0ca9
+  data.tar.gz: 41cb490e567057b7b6938670561827401e6a9a8fd244298fd2180dc57af97c3eec129e4c64042f382232165680a998517eab60d0398e249f21c9a38d4d15ab4f

data/lib/zendesk_api/client.rb

@@ -8,6 +8,7 @@ require 'zendesk_api/lru_cache'
 require 'zendesk_api/silent_mash'
 require 'zendesk_api/middleware/request/etag_cache'
 require 'zendesk_api/middleware/request/retry'
+require 'zendesk_api/middleware/request/raise_rate_limited'
 require 'zendesk_api/middleware/request/upload'
 require 'zendesk_api/middleware/request/encode_json'
 require 'zendesk_api/middleware/request/url_based_access_token'
@@ -93,6 +94,8 @@ module ZendeskAPI
 
       config.retry = !!config.retry # nil -> false
 
+      set_raise_error_when_rated_limited
+
       set_token_auth
 
       set_default_logger
@@ -171,7 +174,12 @@ module ZendeskAPI
         builder.use ZendeskAPI::Middleware::Request::Upload
         builder.request :multipart
         builder.use ZendeskAPI::Middleware::Request::EncodeJson
-        builder.use ZendeskAPI::Middleware::Request::Retry, :logger => config.logger if config.retry # Should always be first in the stack
+
+        # Should always be first in the stack
+        builder.use ZendeskAPI::Middleware::Request::Retry, :logger => config.logger if config.retry
+        if config.raise_error_when_rate_limited
+          builder.use ZendeskAPI::Middleware::Request::RaiseRateLimited, :logger => config.logger
+        end
 
         builder.adapter(*adapter)
       end
@@ -190,6 +198,14 @@ module ZendeskAPI
       end
     end
 
+    def set_raise_error_when_rated_limited
+      config.raise_error_when_rate_limited = if config.retry
+        false
+      else
+        !!config.raise_error_when_rate_limited
+      end
+    end
+
     def set_token_auth
       if config.token && !config.password
         config.password = config.token

data/lib/zendesk_api/configuration.rb

@@ -16,6 +16,9 @@ module ZendeskAPI
     # @return [Boolean] Whether to attempt to retry when rate-limited (http status: 429).
     attr_accessor :retry
 
+    # @return [Boolean] Whether to raise error when rate-limited (http status: 429).
+    attr_accessor :raise_error_when_rate_limited
+
     # @return [Logger] Logger to use when logging requests.
     attr_accessor :logger
 

data/lib/zendesk_api/error.rb

@@ -33,5 +33,6 @@ module ZendeskAPI
 
     class NetworkError < ClientError; end
     class RecordNotFound < ClientError; end
+    class RateLimited < ClientError; end
   end
 end

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

@@ -0,0 +1,31 @@
+require 'faraday/middleware'
+require 'zendesk_api/error'
+
+module ZendeskAPI
+  module Middleware
+    # @private
+    module Request
+      # Faraday middleware to handle HTTP Status 429 (rate limiting) / 503 (maintenance)
+      # @private
+      class RaiseRateLimited < Faraday::Middleware
+        ERROR_CODES = [429, 503].freeze
+
+        def initialize(app, options = {})
+          super(app)
+          @logger = options[:logger]
+        end
+
+        def call(env)
+          response = @app.call(env)
+
+          if ERROR_CODES.include?(response.env[:status])
+            @logger.warn 'You have been rate limited. Raising error...' if @logger
+            raise Error::RateLimited.new(env)
+          else
+            response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "1.18.0"
+  VERSION = "1.19.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Steven Davidovitz
@@ -109,6 +109,7 @@ files:
 - lib/zendesk_api/lru_cache.rb
 - lib/zendesk_api/middleware/request/encode_json.rb
 - lib/zendesk_api/middleware/request/etag_cache.rb
+- lib/zendesk_api/middleware/request/raise_rate_limited.rb
 - lib/zendesk_api/middleware/request/retry.rb
 - lib/zendesk_api/middleware/request/upload.rb
 - lib/zendesk_api/middleware/request/url_based_access_token.rb