zendesk_api 1.31.0 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5effe63f9bf20a2f1609678307075c1469cb10bf73ddf992bac282fe0373643e
-  data.tar.gz: 528b5448a9add09ae4f14dac496dff8753ea6ea80e991f5610d021ec70fa27de
+  metadata.gz: 1cb0a6ce03a083efc37a6f742e90e58955a411ce76c3bfffb78ad5fc61f336b6
+  data.tar.gz: 10d25156b4961da61e2c1b7276ef5a8e4a17664c93d4a24e8f466ec9dc2e85b1
 SHA512:
-  metadata.gz: e8897e7999a22d4c0785696fcfd59310035eb4f654cbbbfbde1b0f4be72defe5a106bf4489c1bef71b4638cfc8d04f0d6866503f47c928c4c9ed7275aa14b77a
-  data.tar.gz: 1a8c38c9297aa2220b9d46909be86bcc2de2572bc11b43a4fa56a4f7ff7bed1516af0eda2a0040fb3e4d8ad8b50c3a8929b420e5dcd7b833c1f4893f44eeb0f1
+  metadata.gz: da965fc1a9d28cb7edafdb82a56a1e73b64930f7706ac32bc9980ee3da415e540362f036c8dd6101b7615ce3781e4cc9e5645780bd83c504c714c60879450dcc
+  data.tar.gz: edbee03ff02ea28e78f88c9e1766d0cccbd0d59b068ae103f80d9c83f10cf734707e96a3341710131f93ffc346066f04a0e3d0200cc9def631cb984285086679

data/lib/zendesk_api/association.rb

@@ -19,13 +19,8 @@ module ZendeskAPI
         nil
       end
 
-      # 1.9+ changed default to search ancestors, added flag to disable behavior.
       def module_defines_class?(mod, klass_as_string)
-        if RUBY_VERSION < '1.9'
-          mod.const_defined?(klass_as_string)
-        else
-          mod.const_defined?(klass_as_string, false)
-        end
+        mod.const_defined?(klass_as_string, false)
       end
     end
 
@@ -58,7 +53,6 @@ module ZendeskAPI
 
       namespace = @options[:class].to_s.split("::")
       namespace[-1] = @options[:class].resource_path
-
       # Remove components without path information
       ignorable_namespace_strings.each { |ns| namespace.delete(ns) }
       has_parent = namespace.size > 1 || (options[:with_parent] && @options.parent)

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
@@ -198,7 +198,7 @@ module ZendeskAPI
     end
 
     def check_url
-      if !config.allow_http && config.url !~ /^https/
+      if !config.allow_http && !config.url.start_with?('https://')
         raise ArgumentError, "zendesk_api is ssl only; url must begin with https://"
       end
     end

data/lib/zendesk_api/collection.rb

@@ -1,5 +1,6 @@
 require 'zendesk_api/resource'
 require 'zendesk_api/resources'
+require 'zendesk_api/search'
 
 module ZendeskAPI
   # Represents a collection of resources. Lazily loaded, resources aren't
@@ -28,7 +29,7 @@ module ZendeskAPI
     # @param [String] resource The resource being collected.
     # @param [Hash] options Any additional options to be passed in.
     def initialize(client, resource, options = {})
-      @client, @resource_class, @resource = client, resource, resource.resource_name
+      @client, @resource_class, @resource = client, resource, resource.resource_path
       @options = SilentMash.new(options)
 
       set_association_from_options
@@ -47,7 +48,7 @@ module ZendeskAPI
     end
 
     # Methods that take a Hash argument
-    methods = %w{create find update update_many destroy}
+    methods = %w{create find update update_many destroy create_or_update}
     methods += methods.map { |method| method + "!" }
     methods.each do |deferrable|
       # Passes arguments and the proper path to the resource class method.
@@ -185,9 +186,15 @@ module ZendeskAPI
       elsif association && association.options.parent && association.options.parent.new_record?
         return (@resources = [])
       end
+      path_query_link = (@query || path)
 
-      @response = get_response(@query || path)
-      handle_response(@response.body)
+      @response = get_response(path_query_link)
+
+      if path_query_link == "search/export"
+        handle_cursor_response(@response.body)
+      else
+        handle_response(@response.body)
+      end
 
       @resources
     end
@@ -248,7 +255,7 @@ module ZendeskAPI
       if @options["page"]
         clear_cache
         @options["page"] += 1
-      elsif @query = @next_page
+      elsif (@query = @next_page)
         fetch(true)
       else
         clear_cache
@@ -264,7 +271,7 @@ module ZendeskAPI
       if @options["page"] && @options["page"] > 1
         clear_cache
         @options["page"] -= 1
-      elsif @query = @prev_page
+      elsif (@query = @prev_page)
         fetch(true)
       else
         clear_cache
@@ -313,12 +320,35 @@ module ZendeskAPI
       end
     end
 
-    alias :to_str :to_s
+    alias to_str to_s
 
     def to_param
       map(&:to_param)
     end
 
+    def more_results?(response)
+      response["meta"].present? && response["results"].present?
+    end
+    alias_method :has_more_results?, :more_results? # For backward compatibility with 1.33.0 and 1.34.0
+
+    def get_response_body(link)
+      @client.connection.send("get", link).body
+    end
+
+    def get_next_page_data(original_response_body)
+      link = original_response_body["links"]["next"]
+
+      while link
+        response = get_response_body(link)
+
+        original_response_body["results"] = original_response_body["results"] + response["results"]
+
+        link = response["meta"]["has_more"] ? response["links"]["next"] : nil
+      end
+
+      original_response_body
+    end
+
     private
 
     def set_page_and_count(body)
@@ -372,8 +402,6 @@ module ZendeskAPI
       result
     end
 
-    ## Initialize
-
     def join_special_params
       # some params use comma-joined strings instead of query-based arrays for multiple values
       @options.each do |k, v|
@@ -389,7 +417,6 @@ module ZendeskAPI
       association_options = { :path => @options.delete(:path) }
       association_options[:path] ||= @collection_path.join("/") if @collection_path
       @association = @options.delete(:association) || Association.new(association_options.merge(:class => @resource_class))
-
       @collection_path ||= [@resource]
     end
 
@@ -410,6 +437,25 @@ module ZendeskAPI
       end
     end
 
+    def handle_cursor_response(response_body)
+      unless response_body.is_a?(Hash)
+        raise ZendeskAPI::Error::NetworkError, @response.env
+      end
+
+      response_body = get_next_page_data(response_body) if more_results?(response_body)
+
+      body = response_body.dup
+      results = body.delete(@resource_class.model_key) || body.delete("results")
+
+      unless results
+        raise ZendeskAPI::Error::ClientError, "Expected #{@resource_class.model_key} or 'results' in response keys: #{body.keys.inspect}"
+      end
+
+      @resources = results.map do |res|
+        wrap_resource(res)
+      end
+    end
+
     def handle_response(response_body)
       unless response_body.is_a?(Hash)
         raise ZendeskAPI::Error::NetworkError, @response.env

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

@@ -2,6 +2,19 @@ module ZendeskAPI
   # @private
   module Helpers
     # From https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/modulize.rb
+    # Converts a string to module name representation.
+    #
+    # This is essentially #camelcase, but it also converts
+    # '/' to '::' which is useful for converting paths to
+    # namespaces.
+    #
+    # Examples
+    #
+    #   "method_name".modulize    #=> "MethodName"
+    #   "method/name".modulize    #=> "Method::Name"
+    #
+    # @param string [string] input, `module/class_name`
+    # @return [string] a string that can become a class, `Module::ClassName`
     def self.modulize_string(string)
       # gsub('__','/').  # why was this ever here?
       string.gsub(/__(.?)/) { "::#{$1.upcase}" }.
@@ -11,6 +24,14 @@ module ZendeskAPI
     end
 
     # From https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/snakecase.rb
+    # Underscore a string such that camelcase, dashes and spaces are
+    # replaced by underscores. This is the reverse of {#camelcase},
+    # albeit not an exact inverse.
+    #
+    #   "SnakeCase".snakecase         #=> "snake_case"
+    #   "Snake-Case".snakecase        #=> "snake_case"
+    #   "Snake Case".snakecase        #=> "snake_case"
+    #   "Snake  -  Case".snakecase    #=> "snake_case"
     def self.snakecase_string(string)
       # gsub(/::/, '/').
       string.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').

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

@@ -6,7 +6,7 @@ require 'zendesk_api/associations'
 require 'zendesk_api/verbs'
 
 module ZendeskAPI
-  # Represents a resource that only holds data.
+  # Represents an abstract resource that only holds data.
   class Data
     include Associations
 
@@ -54,6 +54,7 @@ module ZendeskAPI
     # @param [Hash] attributes The optional attributes that describe the resource
     def initialize(client, attributes = {})
       raise "Expected a Hash for attributes, got #{attributes.inspect}" unless attributes.is_a?(Hash)
+
       @association = attributes.delete(:association) || Association.new(:class => self.class)
       @global_params = attributes.delete(:global) || {}
       @client = client
@@ -177,7 +178,7 @@ module ZendeskAPI
     include Destroy
   end
 
-  # Represents a resource that can CRUD (create, read, update, delete).
+  # Represents an abstract resource that can CRUD (create, read, update, delete).
   class Resource < DataResource
     include Read
     include Create

data/lib/zendesk_api/resources.rb

@@ -5,7 +5,6 @@ module ZendeskAPI
   class User < Resource; end
   class UserRelated < DataResource; end
   class Category < Resource; end
-  class OrganizationMembership < ReadResource; end
   class OrganizationSubscription < ReadResource; end
 
   # @internal Begin actual Resource definitions
@@ -126,6 +125,10 @@ module ZendeskAPI
 
   class OrganizationRelated < DataResource; end
 
+  class OrganizationMembership < ReadResource
+    extend CreateOrUpdate
+  end
+
   class Organization < Resource
     extend CreateMany
     extend CreateOrUpdate
@@ -274,44 +277,6 @@ module ZendeskAPI
     has Group
   end
 
-  class Search
-    class Result < Data; end
-
-    # Creates a search collection
-    def self.search(client, options = {})
-      unless (%w{query external_id} & options.keys.map(&:to_s)).any?
-        warn "you have not specified a query for this search"
-      end
-
-      ZendeskAPI::Collection.new(client, self, options)
-    end
-
-    # Quack like a Resource
-    # Creates the correct resource class from the result_type passed in
-    def self.new(client, attributes)
-      result_type = attributes["result_type"]
-
-      if result_type
-        result_type = ZendeskAPI::Helpers.modulize_string(result_type)
-        klass = ZendeskAPI.const_get(result_type) rescue nil
-      end
-
-      (klass || Result).new(client, attributes)
-    end
-
-    class << self
-      def resource_name
-        "search"
-      end
-
-      alias :resource_path :resource_name
-
-      def model_key
-        "results"
-      end
-    end
-  end
-
   class Request < Resource
     class Comment < DataResource
       include Save
@@ -793,6 +758,11 @@ module ZendeskAPI
 
   class Target < Resource; end
 
+  class Invocation < Resource; end
+  class Webhook < Resource
+    has_many Invocation
+  end
+
   module Voice
     include DataNamespace
 

data/lib/zendesk_api/search.rb

@@ -0,0 +1,51 @@
+# `zendesk_api` gem root
+module ZendeskAPI
+  # A rich factory that returns a class for your searches
+  class Search
+    # Creates a search collection
+    def self.search(client, options = {})
+      if (options.keys.map(&:to_s) & %w[query external_id]).empty?
+        warn "you have not specified a query for this search"
+      end
+
+      ZendeskAPI::Collection.new(client, self, options)
+    end
+
+    # Quack like a Resource
+    # Creates the correct resource class from `attributes[:result_type]`
+    def self.new(client, attributes)
+      present_result_type = (attributes[:result_type] || attributes["result_type"]).to_s
+      result_type = ZendeskAPI::Helpers.modulize_string(present_result_type)
+      klass = begin
+                ZendeskAPI.const_get(result_type)
+              rescue NameError
+                Result
+              end
+
+      (klass || Result).new(client, attributes)
+    end
+
+    class Result < Data; end
+
+    class << self
+      def resource_name
+        "search"
+      end
+      alias resource_path resource_name
+
+      def model_key
+        "results"
+      end
+    end
+  end
+
+  # This will use cursor pagination by default
+  class SearchExport < Search
+    class << self
+      def resource_name
+        "search/export"
+      end
+      alias resource_path resource_name
+    end
+  end
+end

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "1.31.0"
+  VERSION = "1.35.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 1.31.0
+  version: 1.35.0
 platform: ruby
 authors:
 - Steven Davidovitz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -40,7 +40,7 @@ dependencies:
         version: 3.5.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
         version: 3.5.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: inflection
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +130,7 @@ files:
 - lib/zendesk_api/middleware/response/sanitize_response.rb
 - lib/zendesk_api/resource.rb
 - lib/zendesk_api/resources.rb
+- lib/zendesk_api/search.rb
 - lib/zendesk_api/sideloading.rb
 - lib/zendesk_api/silent_mash.rb
 - lib/zendesk_api/track_changes.rb
@@ -143,9 +144,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.31.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/1.31.0
-  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v1.31.0
+  changelog_uri: https://github.com/zendesk/zendesk_api_client_rb/blob/v1.35.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/1.35.0
+  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v1.35.0
   wiki_uri: https://github.com/zendesk/zendesk_api_client_rb/wiki
 post_install_message: 
 rdoc_options: []