zendesk_api 1.29.0 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 592ae735c6f79aa698f4edcd7328c5774dcffc06c00e2f28b85027586f98a48c
-  data.tar.gz: a86e4f2d88eb2b6a05082ba5bd343942dc645af19dcfbd75d00c1ccf1e8d08fe
+  metadata.gz: ac58a5fc63f870e31bd1a7d33ce398aef60c203fc5ec7bba79b1422b81aa3402
+  data.tar.gz: 1a315f8e08e96b2f1d1c20decb998459ec5f7ddc7ee233cb6cdaa7c0374da452
 SHA512:
-  metadata.gz: b4563b95cd57c46662876c012fcabcee71b35d39d77d93f7e36fe629f46187c001e8c817c06004fb7617c5c1c9191f0c0c8bc40662e15d550cc7721c89341822
-  data.tar.gz: 21ebc067a097717124234eae951a8f7d8e003076e6af8958404b2e26dc0b5b08acdb3c26f1792380441802aee21f23632850338e81bb6657948990d4ddfe5aba
+  metadata.gz: e4021bc4c21f5b0ac9257ef8a8c0ee34e22244865f8737167be27aa057505f240d9c6996d262162cce3734759ac8b93eacf3ab3c9454066976ae1e835e5631fa
+  data.tar.gz: 750d62cb5fc7f404a034ff8c5cc5e3c85c59a5852e4d46d55facb224dcfc7b3f41daf29ab7cb228d06993158108cba7a76ae72c50b0acbf9ee03adcab83e73f6

data/lib/zendesk_api/client.rb

@@ -40,6 +40,11 @@ module ZendeskAPI
       method = method.to_s
       options = args.last.is_a?(Hash) ? args.pop : {}
 
+      unless config.use_resource_cache
+        raise "Resource for #{method} does not exist" unless method_as_class(method)
+        return ZendeskAPI::Collection.new(self, method_as_class(method), options)
+      end
+
       @resource_cache[method] ||= { :class => nil, :cache => ZendeskAPI::LRUCache.new }
       if !options.delete(:reload) && (cached = @resource_cache[method][:cache].read(options.hash))
         cached
@@ -176,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

@@ -42,8 +42,18 @@ module ZendeskAPI
     # @return [ZendeskAPI::LRUCache]
     attr_accessor :cache
 
+    # @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
 
       self.cache = ZendeskAPI::LRUCache.new(1000)
     end

data/lib/zendesk_api/error.rb

@@ -20,7 +20,7 @@ module ZendeskAPI
         super
 
         if response[:body].is_a?(Hash)
-          @errors = response[:body]["details"] || response[:body]["description"]
+          @errors = response[:body]["details"] || generate_error_msg(response[:body])
         end
 
         @errors ||= {}
@@ -29,6 +29,17 @@ module ZendeskAPI
       def to_s
         "#{self.class.name}: #{@errors}"
       end
+
+      private
+
+      def generate_error_msg(response_body)
+        return unless response_body["description"] || response_body["message"]
+
+        [
+          response_body["description"],
+          response_body["message"]
+        ].compact.join(" - ")
+      end
     end
 
     class NetworkError < ClientError; end

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/resources.rb

@@ -10,6 +10,8 @@ module ZendeskAPI
 
   # @internal Begin actual Resource definitions
 
+  class RecipientAddress < Resource; end
+
   class Locale < ReadResource; end
 
   class CustomRole < DataResource; end

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "1.29.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.29.0
+  version: 1.33.0
 platform: ruby
 authors:
 - Steven Davidovitz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-15 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.29.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/1.29.0
-  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v1.29.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