zendesk_api 1.34.0 → 1.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e138461b731cb580a6e11cd2a67a5864e909d13da934cb42623debe9a4fda60
-  data.tar.gz: f3ba385fd7563be3e6cce8afc22576a9fd81cd358cbc70635fdf2a30aee27e5b
+  metadata.gz: 5c5a2ced45e0201f6f9a45e5b8f7cf6951ca92c15ce893283c2289d0b260dc77
+  data.tar.gz: 31fa7566865e7191f49dadf6a5e01573264f4fc62ddfd4f635f8f7edd4be9ab2
 SHA512:
-  metadata.gz: 61c2fcf9df4c4a6ffc77042ee63b0cfc11895619083b5e9d80a7c569aac87478a6aa989f4aa8305c853226e260e64741f536247f9dec58237d333571bd1bf3c0
-  data.tar.gz: 78ee9bb11b950f2abcecd4b792199ffbf7b4cbfe6aef5bb9026dd371bf0f2a27a7b955250f88f9188938ed4e8a51a0310cb225f505fcd75a9cdd2ffcf4c8906c
+  metadata.gz: a1b355c67c8126f69f32ff6cd24d03b81b75eec27a0a72044383d0e06a871ba5bd18778119523a013725162048393d7a6bf58f075013e852303255b78bccb73f
+  data.tar.gz: 78ecdd8fd4d2fd889df06aea1ac98df7c68e6f89378f1358594b30853b23b3179f304ee4d87a781bda0047bc1970b8c28dfd147907d74223e28ffceb1676d1b1

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

@@ -165,7 +165,7 @@ module ZendeskAPI
 
         # request
         if config.access_token && !config.url_based_access_token
-          builder.authorization("Bearer", config.access_token)
+          builder.request(:authorization, "Bearer", config.access_token)
         elsif config.access_token
           builder.use ZendeskAPI::Middleware::Request::UrlBasedAccessToken, config.access_token
         else

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,12 +417,9 @@ 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
 
-    ## Fetch
-
     def get_response(path)
       @error = nil
       @response = @client.connection.send(@verb || "get", path) do |req|
@@ -410,6 +435,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/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/resource.rb

@@ -5,8 +5,9 @@ require 'zendesk_api/association'
 require 'zendesk_api/associations'
 require 'zendesk_api/verbs'
 
+# See docs: https://developer.zendesk.com/api-reference/
 module ZendeskAPI
-  # Represents a resource that only holds data.
+  # Represents an abstract resource that only holds data.
   class Data
     include Associations
 
@@ -54,6 +55,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
@@ -144,10 +146,16 @@ module ZendeskAPI
 
     alias :to_param :attributes
 
+    def attributes_for_save
+      { self.class.singular_resource_name.to_sym => attribute_changes }
+    end
+
     private
 
-    def attributes_for_save
-      { self.class.singular_resource_name.to_sym => attributes.changes }
+    # Send only the changes, for example, if the "status" attriubte
+    # goes from "new" to "new", we don't need to send anything
+    def attribute_changes
+      attributes.changes
     end
   end
 
@@ -177,7 +185,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
@@ -188,7 +196,7 @@ module ZendeskAPI
 
   class SingularResource < Resource
     def attributes_for_save
-      { self.class.resource_name.to_sym => attributes.changes }
+      { self.class.resource_name.to_sym => attribute_changes }
     end
   end
 

data/lib/zendesk_api/resources.rb

@@ -6,6 +6,7 @@ module ZendeskAPI
   class UserRelated < DataResource; end
   class Category < Resource; end
   class OrganizationSubscription < ReadResource; end
+  class CustomStatus < Resource; end
 
   # @internal Begin actual Resource definitions
 
@@ -190,8 +191,10 @@ module ZendeskAPI
 
     class Section < Resource
     end
+    class Translation < Resource; end
 
     has_many Section
+    has_many Translation
   end
 
   class Section < ReadResource
@@ -203,9 +206,14 @@ module ZendeskAPI
 
     has Category
 
+    class Vote < Resource; end
+    class Translation < Resource; end
     class Article < Resource
+      has_many Vote
+      has_many Translation
     end
 
+    has_many Translation
     has_many Article
   end
 
@@ -215,6 +223,11 @@ module ZendeskAPI
         "help_center/articles"
       end
     end
+
+    class Vote < Resource; end
+    has_many Vote
+    class Translation < Resource; end
+    has_many Translation
   end
 
   class TopicSubscription < Resource
@@ -277,40 +290,14 @@ 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
+  class Interval < Resource; 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 Schedule < Resource
+    has_many Interval
 
     class << self
-      def resource_name
-        "search"
-      end
-
-      alias :resource_path :resource_name
-
-      def model_key
-        "results"
+      def resource_path
+        "business_hours/schedules"
       end
     end
   end
@@ -379,6 +366,13 @@ module ZendeskAPI
     extend UpdateMany
     extend DestroyMany
 
+    # Unlike other attributes, "comment" is not a property of the ticket,
+    # but is used as a "comment on save", so it should be kept unchanged,
+    # See https://github.com/zendesk/zendesk_api_client_rb/issues/321
+    def attribute_changes
+      attributes.changes.merge("comment" => attributes["comment"])
+    end
+
     class Audit < DataResource
       class Event < Data
         has :author, :class => User
@@ -796,6 +790,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.34.0"
+  VERSION = "1.37.0"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.37.0
 platform: ruby
 authors:
 - Steven Davidovitz
 - Michael Grosser
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-04 00:00:00.000000000 Z
+date: 2022-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -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,11 +144,11 @@ 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.34.0/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/1.34.0
-  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v1.34.0
+  changelog_uri: https://github.com/zendesk/zendesk_api_client_rb/blob/v1.37.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/1.37.0
+  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v1.37.0
   wiki_uri: https://github.com/zendesk/zendesk_api_client_rb/wiki
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -163,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Zendesk REST API Client
 test_files: []