zendesk_api 1.37.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c5a2ced45e0201f6f9a45e5b8f7cf6951ca92c15ce893283c2289d0b260dc77
-  data.tar.gz: 31fa7566865e7191f49dadf6a5e01573264f4fc62ddfd4f635f8f7edd4be9ab2
+  metadata.gz: 138f1dab58b3b37d450c4b1dd9200b1c878944b19571f53888b2c4d17a307276
+  data.tar.gz: 24459eda2e613e21be9924ad6bb571e53861f949d6be291f2bec3516cd1e9ad2
 SHA512:
-  metadata.gz: a1b355c67c8126f69f32ff6cd24d03b81b75eec27a0a72044383d0e06a871ba5bd18778119523a013725162048393d7a6bf58f075013e852303255b78bccb73f
-  data.tar.gz: 78ecdd8fd4d2fd889df06aea1ac98df7c68e6f89378f1358594b30853b23b3179f304ee4d87a781bda0047bc1970b8c28dfd147907d74223e28ffceb1676d1b1
+  metadata.gz: 55f26e4b66e457d5e9e634eefa44fc8b50da170ab2d5a5f97d2460daa423da04d7c607bfa626b1ecd7ce56117a1ee410e7213df6717d84a8e4a109392e1611a5
+  data.tar.gz: 0bab4d20e8989a0e1a4f8be708f76ccd462fddec1b880fb360591f9f048d74c5bbd17d20b678290fb6891dcb0fa6755139e5165fb7c7ea28055643abe583efbb

data/lib/zendesk_api/client.rb

@@ -1,5 +1,3 @@
-require 'faraday'
-
 require 'zendesk_api/version'
 require 'zendesk_api/sideloading'
 require 'zendesk_api/configuration'
@@ -26,7 +24,7 @@ module ZendeskAPI
   # The top-level class that handles configuration and connection to the Zendesk API.
   # Can also be used as an accessor to resource collections.
   class Client
-    GZIP_EXCEPTIONS = [:em_http, :httpclient]
+    GZIP_EXCEPTIONS = [:em_http, :httpclient, :httpx]
 
     # @return [Configuration] Config instance
     attr_reader :config
@@ -39,24 +37,25 @@ module ZendeskAPI
     def method_missing(method, *args, &block)
       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)
+        resource_class = resource_class_for(method)
+        raise "Resource for #{method} does not exist" unless resource_class
+        return ZendeskAPI::Collection.new(self, resource_class, options)
       end
 
       @resource_cache[method] ||= { :class => nil, :cache => ZendeskAPI::LRUCache.new }
       if !options.delete(:reload) && (cached = @resource_cache[method][:cache].read(options.hash))
         cached
       else
-        @resource_cache[method][:class] ||= method_as_class(method)
+        @resource_cache[method][:class] ||= resource_class_for(method)
         raise "Resource for #{method} does not exist" unless @resource_cache[method][:class]
         @resource_cache[method][:cache].write(options.hash, ZendeskAPI::Collection.new(self, @resource_cache[method][:class], options))
       end
     end
 
     def respond_to?(method, *args)
-      ((cache = @resource_cache[method]) && cache[:class]) || !method_as_class(method).nil? || super
+      cache = @resource_cache[method]
+      !!(cache.to_h[:class] || resource_class_for(method) || super)
     end
 
     # Returns the current user (aka me)
@@ -100,9 +99,7 @@ module ZendeskAPI
       config.retry = !!config.retry # nil -> false
 
       set_raise_error_when_rated_limited
-
       set_token_auth
-
       set_default_logger
       add_warning_callback
     end
@@ -112,7 +109,6 @@ module ZendeskAPI
     # @return [Faraday::Connection] Faraday connection for the client
     def connection
       @connection ||= build_connection
-      return @connection
     end
 
     # Pushes a callback onto the stack. Callbacks are executed on responses, last in the Faraday middleware stack.
@@ -155,7 +151,6 @@ module ZendeskAPI
         builder.use ZendeskAPI::Middleware::Response::ParseIsoDates
         builder.use ZendeskAPI::Middleware::Response::ParseJson
         builder.use ZendeskAPI::Middleware::Response::SanitizeResponse
-
         adapter = config.adapter || Faraday.default_adapter
 
         unless GZIP_EXCEPTIONS.include?(adapter)
@@ -163,14 +158,7 @@ module ZendeskAPI
           builder.use ZendeskAPI::Middleware::Response::Deflate
         end
 
-        # request
-        if config.access_token && !config.url_based_access_token
-          builder.request(:authorization, "Bearer", config.access_token)
-        elsif config.access_token
-          builder.use ZendeskAPI::Middleware::Request::UrlBasedAccessToken, config.access_token
-        else
-          builder.use Faraday::Request::BasicAuthentication, config.username, config.password
-        end
+        set_authentication(builder, config)
 
         if config.cache
           builder.use ZendeskAPI::Middleware::Request::EtagCache, :cache => config.cache
@@ -181,20 +169,25 @@ module ZendeskAPI
         builder.use ZendeskAPI::Middleware::Request::EncodeJson
 
         # Should always be first in the stack
-        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.retry
+          builder.use ZendeskAPI::Middleware::Request::Retry,
+                      :logger => config.logger,
+                      :retry_codes => config.retry_codes,
+                      :retry_on_exception => config.retry_on_exception
+        end
         if config.raise_error_when_rate_limited
           builder.use ZendeskAPI::Middleware::Request::RaiseRateLimited, :logger => config.logger
         end
 
-        builder.adapter(*adapter)
+        builder.adapter(*adapter, &config.adapter_proc)
       end
     end
 
     private
 
-    def method_as_class(method)
-      klass_as_string = ZendeskAPI::Helpers.modulize_string(Inflection.singular(method.to_s.gsub(/\W/, '')))
-      ZendeskAPI::Association.class_from_namespace(klass_as_string)
+    def resource_class_for(method)
+      resource_name = ZendeskAPI::Helpers.modulize_string(Inflection.singular(method.to_s.gsub(/\W/, '')))
+      ZendeskAPI::Association.class_from_namespace(resource_name)
     end
 
     def check_url
@@ -239,5 +232,16 @@ module ZendeskAPI
         end
       end
     end
+
+    # See https://lostisland.github.io/faraday/middleware/authentication
+    def set_authentication(builder, config)
+      if config.access_token && !config.url_based_access_token
+        builder.request :authorization, "Bearer", config.access_token
+      elsif config.access_token
+        builder.use ZendeskAPI::Middleware::Request::UrlBasedAccessToken, config.access_token
+      else
+        builder.request :authorization, :basic, config.username, config.password
+      end
+    end
   end
 end

data/lib/zendesk_api/collection.rb

@@ -1,12 +1,14 @@
 require 'zendesk_api/resource'
 require 'zendesk_api/resources'
 require 'zendesk_api/search'
+require 'zendesk_api/pagination'
 
 module ZendeskAPI
   # Represents a collection of resources. Lazily loaded, resources aren't
   # actually fetched until explicitly needed (e.g. #each, {#fetch}).
   class Collection
     include ZendeskAPI::Sideloading
+    include Pagination
 
     # Options passed in that are automatically converted from an array to a comma-separated list.
     SPECIALLY_JOINED_PARAMS = [:ids, :only]
@@ -114,30 +116,6 @@ module ZendeskAPI
       @count || -1
     end
 
-    # Changes the per_page option. Returns self, so it can be chained. No execution.
-    # @return [Collection] self
-    def per_page(count)
-      clear_cache if count
-      @options["per_page"] = count
-      self
-    end
-
-    # Changes the page option. Returns self, so it can be chained. No execution.
-    # @return [Collection] self
-    def page(number)
-      clear_cache if number
-      @options["page"] = number
-      self
-    end
-
-    def first_page?
-      !@prev_page
-    end
-
-    def last_page?
-      !@next_page || @next_page == @query
-    end
-
     # Saves all newly created resources stored in this collection.
     # @return [Collection] self
     def save
@@ -186,17 +164,8 @@ module ZendeskAPI
       elsif association && association.options.parent && association.options.parent.new_record?
         return (@resources = [])
       end
-      path_query_link = (@query || path)
-
-      @response = get_response(path_query_link)
-
-      if path_query_link == "search/export"
-        handle_cursor_response(@response.body)
-      else
-        handle_response(@response.body)
-      end
 
-      @resources
+      get_resources(@query || path)
     end
 
     def fetch(*args)
@@ -252,10 +221,12 @@ module ZendeskAPI
     # * If there is a next_page url cached, it executes a fetch on that url and returns the results.
     # * Otherwise, returns an empty array.
     def next
-      if @options["page"]
+      if @options["page"] && !cbp_request?
         clear_cache
-        @options["page"] += 1
+        @options["page"] = @options["page"].to_i + 1
       elsif (@query = @next_page)
+        # Send _only_ url param "?page[after]=token" to get the next page
+        @options.page&.delete("before")
         fetch(true)
       else
         clear_cache
@@ -268,10 +239,12 @@ module ZendeskAPI
     # * If there is a prev_page url cached, it executes a fetch on that url and returns the results.
     # * Otherwise, returns an empty array.
     def prev
-      if @options["page"] && @options["page"] > 1
+      if !cbp_request? && @options["page"].to_i > 1
         clear_cache
         @options["page"] -= 1
       elsif (@query = @prev_page)
+        # Send _only_ url param "?page[before]=token" to get the prev page
+        @options.page&.delete("after")
         fetch(true)
       else
         clear_cache
@@ -326,22 +299,13 @@ module ZendeskAPI
       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"]
-
+      result_key = @resource_class.model_key || "results"
       while link
-        response = get_response_body(link)
+        response = @client.connection.send("get", link).body
 
-        original_response_body["results"] = original_response_body["results"] + response["results"]
+        original_response_body[result_key] = original_response_body[result_key] + response[result_key]
 
         link = response["meta"]["has_more"] ? response["links"]["next"] : nil
       end
@@ -351,14 +315,20 @@ module ZendeskAPI
 
     private
 
-    def set_page_and_count(body)
-      @count = (body["count"] || @resources.size).to_i
-      @next_page, @prev_page = body["next_page"], body["previous_page"]
+    def get_resources(path_query_link)
+      if intentional_obp_request?
+        warn "Offset Based Pagination will be deprecated soon"
+      elsif supports_cbp? && first_cbp_request?
+        # only set cbp options if it's the first request, otherwise the options would be already in place
+        set_cbp_options
+      end
+      @response = get_response(path_query_link)
 
-      if @next_page =~ /page=(\d+)/
-        @options["page"] = $1.to_i - 1
-      elsif @prev_page =~ /page=(\d+)/
-        @options["page"] = $1.to_i + 1
+      # Keep pre-existing behaviour for search/export
+      if path_query_link == "search/export"
+        handle_search_export_response(@response.body)
+      else
+        handle_response(@response.body)
       end
     end
 
@@ -370,13 +340,7 @@ module ZendeskAPI
 
       while (bang ? fetch! : fetch)
         each do |resource|
-          arguments = [resource, @options["page"] || 1]
-
-          if block.arity >= 0
-            arguments = arguments.take(block.arity)
-          end
-
-          block.call(*arguments)
+          block.call(resource, @options["page"] || 1)
         end
 
         last_page? ? break : self.next
@@ -422,7 +386,7 @@ module ZendeskAPI
 
     def get_response(path)
       @error = nil
-      @response = @client.connection.send(@verb || "get", path) do |req|
+      @client.connection.send(@verb || "get", path) do |req|
         opts = @options.delete_if { |_, v| v.nil? }
 
         req.params.merge!(:include => @includes.join(",")) if @includes.any?
@@ -435,36 +399,30 @@ module ZendeskAPI
       end
     end
 
-    def handle_cursor_response(response_body)
-      unless response_body.is_a?(Hash)
-        raise ZendeskAPI::Error::NetworkError, @response.env
-      end
+    def handle_search_export_response(response_body)
+      assert_valid_response_body(response_body)
 
+      # Note this doesn't happen in #handle_response
       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
+      assert_results(results, body)
 
       @resources = results.map do |res|
         wrap_resource(res)
       end
     end
 
+    # For both CBP and OBP
     def handle_response(response_body)
-      unless response_body.is_a?(Hash)
-        raise ZendeskAPI::Error::NetworkError, @response.env
-      end
+      assert_valid_response_body(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
+      assert_results(results, body)
 
       @resources = results.map do |res|
         wrap_resource(res)
@@ -472,6 +430,8 @@ module ZendeskAPI
 
       set_page_and_count(body)
       set_includes(@resources, @includes, body)
+
+      @resources
     end
 
     # Simplified Associations#wrap_resource
@@ -501,9 +461,13 @@ module ZendeskAPI
       to_a.public_send(name, *args, &block)
     end
 
+    # If you call client.tickets.foo - and foo is not an attribute nor an association, it ends up here, as a new collection
     def next_collection(name, *args, &block)
       opts = args.last.is_a?(Hash) ? args.last : {}
-      opts.merge!(:collection_path => @collection_path.dup.push(name))
+      opts.merge!(collection_path: [*@collection_path, name], page: nil)
+      # Why `page: nil`?
+      # when you do client.tickets.fetch followed by client.tickets.foos => the request to /tickets/foos will
+      # have the options page set to whatever the last options were for the tickets collection
       self.class.new(@client, @resource_class, @options.merge(opts))
     end
 
@@ -514,5 +478,16 @@ module ZendeskAPI
     def resource_methods
       @resource_methods ||= @resource_class.singleton_methods(false).map(&:to_sym)
     end
+
+    def assert_valid_response_body(response_body)
+      unless response_body.is_a?(Hash)
+        raise ZendeskAPI::Error::NetworkError, @response.env
+      end
+    end
+
+    def assert_results(results, body)
+      return if results
+      raise ZendeskAPI::Error::ClientError, "Expected #{@resource_class.model_key} or 'results' in response keys: #{body.keys.inspect}"
+    end
   end
 end

data/lib/zendesk_api/configuration.rb

@@ -28,6 +28,9 @@ module ZendeskAPI
     # @return [Symbol] Faraday adapter
     attr_accessor :adapter
 
+    # @return [Proc] Faraday adapter proc
+    attr_accessor :adapter_proc
+
     # @return [Boolean] Whether to allow non-HTTPS connections for development purposes.
     attr_accessor :allow_http
 

data/lib/zendesk_api/error.rb

@@ -33,12 +33,7 @@ module ZendeskAPI
       private
 
       def generate_error_msg(response_body)
-        return unless response_body["description"] || response_body["message"]
-
-        [
-          response_body["description"],
-          response_body["message"]
-        ].compact.join(" - ")
+        response_body.values_at("description", "message", "error", "errors").compact.join(" - ")
       end
     end
 

data/lib/zendesk_api/helpers.rb

@@ -1,6 +1,10 @@
 module ZendeskAPI
   # @private
   module Helpers
+    def self.present?(value)
+      ![nil, false, "", " ", [], {}].include?(value)
+    end
+
     # From https://github.com/rubyworks/facets/blob/master/lib/core/facets/string/modulize.rb
     # Converts a string to module name representation.
     #

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

@@ -6,7 +6,6 @@ module ZendeskAPI
       class EncodeJson < Faraday::Middleware
         CONTENT_TYPE = 'Content-Type'.freeze
         MIME_TYPE = 'application/json'.freeze
-        dependency 'json'
 
         def call(env)
           type = env[:request_headers][CONTENT_TYPE].to_s

data/lib/zendesk_api/middleware/response/callback.rb

@@ -4,7 +4,7 @@ module ZendeskAPI
   module Middleware
     module Response
       # @private
-      class Callback < Faraday::Response::Middleware
+      class Callback < Faraday::Middleware
         def initialize(app, client)
           super(app)
           @client = client

data/lib/zendesk_api/middleware/response/deflate.rb

@@ -5,11 +5,12 @@ module ZendeskAPI
     module Response
       # Faraday middleware to handle content-encoding = inflate
       # @private
-      class Deflate < Faraday::Response::Middleware
+      class Deflate < Faraday::Middleware
         def on_complete(env)
-          if !env.body.strip.empty? && env[:response_headers]['content-encoding'] == "deflate"
-            env.body = Zlib::Inflate.inflate(env.body)
-          end
+          return if env[:response_headers]['content-encoding'] != "deflate"
+          return if env.body.strip.empty?
+
+          env.body = Zlib::Inflate.inflate(env.body)
         end
       end
     end

data/lib/zendesk_api/middleware/response/gzip.rb

@@ -7,11 +7,12 @@ module ZendeskAPI
     # @private
     module Response
       # Faraday middleware to handle content-encoding = gzip
-      class Gzip < Faraday::Response::Middleware
+      class Gzip < Faraday::Middleware
         def on_complete(env)
-          if !env[:body].strip.empty? && env[:response_headers]['content-encoding'] == "gzip"
-            env[:body] = Zlib::GzipReader.new(StringIO.new(env[:body])).read
-          end
+          return if env[:response_headers]['content-encoding'] != "gzip"
+          return if env[:body].force_encoding(Encoding::BINARY).strip.empty?
+
+          env[:body] = Zlib::GzipReader.new(StringIO.new(env[:body])).read
         end
       end
     end

data/lib/zendesk_api/middleware/response/parse_iso_dates.rb

@@ -6,7 +6,7 @@ module ZendeskAPI
     module Response
       # Parse ISO dates from response body
       # @private
-      class ParseIsoDates < Faraday::Response::Middleware
+      class ParseIsoDates < Faraday::Middleware
         def call(env)
           @app.call(env).on_complete do |env|
             parse_dates!(env[:body])

data/lib/zendesk_api/middleware/response/parse_json.rb

@@ -3,9 +3,8 @@ module ZendeskAPI
   module Middleware
     # @private
     module Response
-      class ParseJson < Faraday::Response::Middleware
+      class ParseJson < Faraday::Middleware
         CONTENT_TYPE = 'Content-Type'.freeze
-        dependency 'json'
 
         def on_complete(env)
           type = env[:response_headers][CONTENT_TYPE].to_s

data/lib/zendesk_api/middleware/response/sanitize_response.rb

@@ -1,7 +1,7 @@
 module ZendeskAPI
   module Middleware
     module Response
-      class SanitizeResponse < Faraday::Response::Middleware
+      class SanitizeResponse < Faraday::Middleware
         def on_complete(env)
           env[:body].scrub!('')
         end

data/lib/zendesk_api/pagination.rb

@@ -0,0 +1,99 @@
+module ZendeskAPI
+  class Collection
+    # Contains all methods related to pagination in an attempt to slim down collection.rb
+    module Pagination
+      DEFAULT_PAGE_SIZE = 100
+      def more_results?(response)
+        Helpers.present?(response["meta"]) && response["meta"]["has_more"]
+      end
+      alias has_more_results? more_results? # For backward compatibility with 1.33.0 and 1.34.0
+
+      # Changes the per_page option. Returns self, so it can be chained. No execution.
+      # @return [Collection] self
+      def per_page(count)
+        clear_cache if count
+        @options["per_page"] = count
+        self
+      end
+
+      # Changes the page option. Returns self, so it can be chained. No execution.
+      # @return [Collection] self
+      def page(number)
+        clear_cache if number
+        @options["page"] = number
+        self
+      end
+
+      def first_page?
+        !@prev_page
+      end
+
+      def last_page?
+        !@next_page || @next_page == @query
+      end
+
+      private
+
+      def page_links(body)
+        if body["meta"] && body["links"]
+          [body["links"]["next"], body["links"]["prev"]]
+        else
+          [body["next_page"], body["previous_page"]]
+        end
+      end
+
+      def cbp_response?(body)
+        !!(body["meta"] && body["links"])
+      end
+
+      def set_cbp_options
+        @options_per_page_was = @options.delete("per_page")
+        # Default to CBP by using the page param as a map
+        @options.page = { size: (@options_per_page_was || DEFAULT_PAGE_SIZE) }
+      end
+
+      # CBP requests look like: `/resources?page[size]=100`
+      # OBP requests look like: `/resources?page=2`
+      def cbp_request?
+        @options["page"].is_a?(Hash)
+      end
+
+      def intentional_obp_request?
+        Helpers.present?(@options["page"]) && !cbp_request?
+      end
+
+      def supports_cbp?
+        @resource_class.cbp_path_regexes.any? { |supported_path_regex| path.match?(supported_path_regex) }
+      end
+
+      def first_cbp_request?
+        # @next_page will be nil when making the first cbp request
+        @next_page.nil?
+      end
+
+      def set_page_and_count(body)
+        @count = (body["count"] || @resources.size).to_i
+        @next_page, @prev_page = page_links(body)
+
+        if cbp_response?(body)
+          set_cbp_response_options(body)
+        elsif @next_page =~ /page=(\d+)/
+          @options["page"] = Regexp.last_match(1).to_i - 1
+        elsif @prev_page =~ /page=(\d+)/
+          @options["page"] = Regexp.last_match(1).to_i + 1
+        end
+      end
+
+      def set_cbp_response_options(body)
+        @options.page = {} unless cbp_request?
+        # the line above means an intentional CBP request where page[size] is passed on the query
+        # this is to cater for CBP responses where we don't specify page[size] but the endpoint
+        # responds CBP by default. i.e  `client.trigger_categories.fetch`
+        @options.page.merge!(
+          before: body["meta"]["before_cursor"],
+          after: body["meta"]["after_cursor"]
+                            )
+      end
+    end
+  end
+end

data/lib/zendesk_api/resource.rb

@@ -39,6 +39,14 @@ module ZendeskAPI
       def namespace(namespace)
         @namespace = namespace
       end
+
+      def new_from_response(client, response, includes = nil)
+        new(client).tap do |resource|
+          resource.handle_response(response)
+          resource.set_includes(resource, includes, response.body) if includes
+          resource.attributes.clear_changes
+        end
+      end
     end
 
     # @return [Hash] The resource's attributes
@@ -123,19 +131,16 @@ module ZendeskAPI
 
     # Compares resources by class and id. If id is nil, then by object_id
     def ==(other)
+      return false unless other
+
       return true if other.object_id == object_id
 
-      if other && !(other.is_a?(Data) || other.is_a?(Integer))
-        warn "Trying to compare #{other.class} to a Resource from #{caller.first}"
-      end
+      return other.id && (other.id == id) if other.is_a?(Data)
 
-      if other.is_a?(Data)
-        other.id && other.id == id
-      elsif other.is_a?(Integer)
-        id == other
-      else
-        false
-      end
+      return id == other if other.is_a?(Integer)
+
+      warn "Trying to compare #{other.class} to a Resource
+        from #{caller.first}"
     end
     alias :eql :==
 
@@ -163,6 +168,10 @@ module ZendeskAPI
   class DataResource < Data
     attr_accessor :error, :error_message
     extend Verbs
+
+    def self.cbp_path_regexes
+      []
+    end
   end
 
   # Represents a resource that can only GET

data/lib/zendesk_api/resources.rb

@@ -16,6 +16,58 @@ module ZendeskAPI
 
   class CustomRole < DataResource; end
 
+  class WorkItem < Resource; end
+
+  class Channel < Resource
+    def work_items
+      @work_items ||= attributes.fetch('relationships', {}).fetch('work_items', {}).fetch('data', []).map do |work_item_attributes|
+        WorkItem.new(@client, work_item_attributes)
+      end
+    end
+  end
+
+  # client.agent_availabilities.fetch
+  # client.agent_availabilities.find 20401208368
+  # both return consistently - ZendeskAPI::AgentAvailability
+  class AgentAvailability < DataResource
+    def self.model_key
+      "data"
+    end
+
+    def initialize(client, attributes = {})
+      nested_attributes = attributes.delete('attributes')
+      super(client, attributes.merge(nested_attributes))
+    end
+
+    def self.find(client, id)
+      attributes = client.connection.get("#{resource_path}/#{id}").body.fetch(model_key, {})
+      new(client, attributes)
+    end
+
+    #  Examples:
+    #  ZendeskAPI::AgentAvailability.search(client, { channel_status: 'support:online' })
+    #  ZendeskAPI::AgentAvailability.search(client, { agent_status_id: 1 })
+    #  Just pass a hash that includes the key and value you want to search for, it gets turned into a query string
+    #  on the format of filter[key]=value
+    #  Returns a collection of AgentAvailability objects
+    def self.search(client, args_hash)
+      query_string = args_hash.map { |k, v| "filter[#{k}]=#{v}" }.join("&")
+      client.connection.get("#{resource_path}?#{query_string}").body.fetch(model_key, []).map do |attributes|
+        new(client, attributes)
+      end
+    end
+
+    def channels
+      @channels ||= begin
+        channel_attributes_array = @client.connection.get(attributes['links']['self']).body.fetch('included')
+        channel_attributes_array.map do |channel_attributes|
+          nested_attributes = channel_attributes.delete('attributes')
+          Channel.new(@client, channel_attributes.merge(nested_attributes))
+        end
+      end
+    end
+  end
+
   class Role < DataResource
     def to_param
       name
@@ -24,6 +76,10 @@ module ZendeskAPI
 
   class Topic < Resource
     class << self
+      def cbp_path_regexes
+        [%r{^community/topics$}]
+      end
+
       def resource_path
         "community/topics"
       end
@@ -83,6 +139,10 @@ module ZendeskAPI
     def attributes_for_save
       { self.class.resource_name => [id] }
     end
+
+    def self.cbp_path_regexes
+      [/^tags$/]
+    end
   end
 
   class Attachment < ReadResource
@@ -152,9 +212,17 @@ module ZendeskAPI
     def self.incremental_export(client, start_time)
       ZendeskAPI::Collection.new(client, self, :path => "incremental/organizations?start_time=#{start_time.to_i}")
     end
+
+    def self.cbp_path_regexes
+      [/^organizations$/]
+    end
   end
 
   class Brand < Resource
+    def self.cbp_path_regexes
+      [/^brands$/]
+    end
+
     def destroy!
       self.active = false
       save!
@@ -180,6 +248,10 @@ module ZendeskAPI
 
     has User
     has Organization
+
+    def self.cbp_path_regexes
+      [%r{^organizations/\d+/subscriptions$}]
+    end
   end
 
   class Category < Resource
@@ -228,6 +300,18 @@ module ZendeskAPI
     has_many Vote
     class Translation < Resource; end
     has_many Translation
+    class Label < DataResource
+      include Read
+      include Create
+      include Destroy
+
+      def destroy!
+        super do |req|
+          req.path = path
+        end
+      end
+    end
+    has_many Label
   end
 
   class TopicSubscription < Resource
@@ -246,15 +330,19 @@ module ZendeskAPI
   end
 
   class Topic < Resource
-    has_many :subscriptions, :class => TopicSubscription, :inline => true
-    has_many Tag, :extend => Tag::Update, :inline => :create
+    has_many :subscriptions, class: TopicSubscription, inline: true
+    has_many Tag, extend: Tag::Update, inline: :create
     has_many Attachment
-    has_many :uploads, :class => Attachment, :inline => true
+    has_many :uploads, class: Attachment, inline: true
   end
 
   class Activity < Resource
     has User
     has :actor, :class => User
+
+    def self.cbp_path_regexes
+      [/^activities$/]
+    end
   end
 
   class Setting < UpdateResource
@@ -306,7 +394,7 @@ module ZendeskAPI
     class Comment < DataResource
       include Save
 
-      has_many :uploads, :class => Attachment, :inline => true
+      has_many :uploads, class: Attachment, inline: true
       has :author, :class => User
 
       def save
@@ -337,10 +425,18 @@ module ZendeskAPI
     namespace 'portal'
   end
 
-  class TicketField < Resource; end
+  class TicketField < Resource
+    def self.cbp_path_regexes
+      [/^ticket_fields$/]
+    end
+  end
 
   class TicketMetric < DataResource
     include Read
+
+    def self.cbp_path_regexes
+      [/^ticket_metrics$/]
+    end
   end
 
   class TicketRelated < DataResource; end
@@ -348,7 +444,7 @@ module ZendeskAPI
   class TicketEvent < DataResource
     class Event < Data; end
 
-    has_many :child_events, :class => Event
+    has_many :child_events, class: Event
     has Ticket
     has :updater, :class => User
 
@@ -366,6 +462,10 @@ module ZendeskAPI
     extend UpdateMany
     extend DestroyMany
 
+    def self.cbp_path_regexes
+      [/^tickets$/, %r{organizations/\d+/tickets}, %r{users/\d+/tickets/requested}]
+    end
+
     # 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
@@ -384,13 +484,17 @@ module ZendeskAPI
       has :author, :class => User
 
       has_many Event
+
+      def self.cbp_path_regexes
+        [%r{^tickets/\d+/audits$}]
+      end
     end
 
     class Comment < DataResource
       include Save
 
-      has_many :uploads, :class => Attachment, :inline => true
-      has :author, :class => User
+      has_many :uploads, class: Attachment, inline: true
+      has :author, class: User
 
       def save
         if new_record?
@@ -417,35 +521,35 @@ module ZendeskAPI
     has :submitter, :class => User
     has :assignee, :class => User
 
-    has_many :collaborators, :class => User, :inline => true, :extend => (Module.new do
+    has_many :collaborators, class: User, inline: true, extend: (Module.new do
       def to_param
         map(&:id)
       end
     end)
 
     has_many Audit
-    has :metrics, :class => TicketMetric
+    has :metrics, class: TicketMetric
     has Group
     has Organization
     has Brand
-    has :related, :class => TicketRelated
+    has :related, class: TicketRelated
 
-    has Comment, :inline => true
+    has Comment, inline: true
     has_many Comment
 
-    has :last_comment, :class => Comment, :inline => true
-    has_many :last_comments, :class => Comment, :inline => true
+    has :last_comment, class: Comment, inline: true
+    has_many :last_comments, class: Comment, inline: true
 
-    has_many Tag, :extend => Tag::Update, :inline => :create
+    has_many Tag, extend: Tag::Update, inline: :create
 
-    has_many :incidents, :class => Ticket
+    has_many :incidents, class: Ticket
 
     # Gets a incremental export of tickets from the start_time until now.
     # @param [Client] client The {Client} object to be used
     # @param [Integer] start_time The start_time parameter
     # @return [Collection] Collection of {Ticket}
     def self.incremental_export(client, start_time)
-      ZendeskAPI::Collection.new(client, self, :path => "incremental/tickets?start_time=#{start_time.to_i}")
+      ZendeskAPI::Collection.new(client, self, path: "incremental/tickets?start_time=#{start_time.to_i}")
     end
 
     # Imports a ticket through the imports/tickets endpoint using save!
@@ -454,7 +558,7 @@ module ZendeskAPI
     # @return [Ticket] Created object or nil
     def self.import!(client, attributes)
       new(client, attributes).tap do |ticket|
-        ticket.save!(:path => "imports/tickets")
+        ticket.save!(path: "imports/tickets")
       end
     end
 
@@ -464,7 +568,7 @@ module ZendeskAPI
     # @return [Ticket] Created object or nil
     def self.import(client, attributes)
       ticket = new(client, attributes)
-      return unless ticket.save(:path => "imports/tickets")
+      return unless ticket.save(path: "imports/tickets")
       ticket
     end
   end
@@ -474,6 +578,10 @@ module ZendeskAPI
 
     # Recovers this suspended ticket to an actual ticket
     put :recover
+
+    def self.cbp_path_regexes
+      [/^suspended_tickets$/]
+    end
   end
 
   class DeletedTicket < ReadResource
@@ -483,6 +591,10 @@ module ZendeskAPI
     # Restores this previously deleted ticket to an actual ticket
     put :restore
     put :restore_many
+
+    def self.cbp_path_regexes
+      [/^deleted_tickets$/]
+    end
   end
 
   class UserViewRow < DataResource
@@ -498,9 +610,9 @@ module ZendeskAPI
     # @internal Optional columns
 
     has Group
-    has :assignee, :class => User
-    has :requester, :class => User
-    has :submitter, :class => User
+    has :assignee, class: User
+    has :requester, class: User
+    has :submitter, class: User
     has Organization
 
     def self.model_key
@@ -580,6 +692,10 @@ module ZendeskAPI
     def self.preview(client, options = {})
       Collection.new(client, ViewRow, options.merge(:path => "views/preview", :verb => :post))
     end
+
+    def self.cbp_path_regexes
+      [/^views$/]
+    end
   end
 
   class Trigger < Rule
@@ -587,6 +703,10 @@ module ZendeskAPI
     include Actions
 
     has :execution, :class => RuleExecution
+
+    def self.cbp_path_regexes
+      [/^triggers$/, %r{^triggers/active$}]
+    end
   end
 
   class Automation < Rule
@@ -594,6 +714,10 @@ module ZendeskAPI
     include Actions
 
     has :execution, :class => RuleExecution
+
+    def self.cbp_path_regexes
+      [/^automations$/]
+    end
   end
 
   class Macro < Rule
@@ -601,6 +725,10 @@ module ZendeskAPI
 
     has :execution, :class => RuleExecution
 
+    def self.cbp_path_regexes
+      [/^macros$/]
+    end
+
     # Returns the update to a ticket that happens when a macro will be applied.
     # @param [Ticket] ticket Optional {Ticket} to apply this macro to.
     # @raise [Faraday::ClientError] Raised for any non-200 response.
@@ -636,6 +764,18 @@ module ZendeskAPI
 
     has User
     has Group
+
+    def self.cbp_path_regexes
+      [%r{^groups/\d+/memberships$}]
+    end
+  end
+
+  class Group < Resource
+    has_many :memberships, class: GroupMembership, path: "memberships"
+
+    def self.cbp_path_regexes
+      [/^groups$/, %r{^groups/assignable$}]
+    end
   end
 
   class User < Resource
@@ -660,6 +800,10 @@ module ZendeskAPI
       put :request_verification
     end
 
+    def self.cbp_path_regexes
+      [/^users$/, %r{^organizations/\d+/users$}]
+    end
+
     any :password
 
     # Set a user's password
@@ -777,6 +921,10 @@ module ZendeskAPI
     def self.singular_resource_name
       "client"
     end
+
+    def self.cbp_path_regexes
+      [%r{^oauth/clients$}]
+    end
   end
 
   class OauthToken < ReadResource

data/lib/zendesk_api/search.rb

@@ -25,6 +25,10 @@ module ZendeskAPI
       (klass || Result).new(client, attributes)
     end
 
+    def self.cbp_path_regexes
+      []
+    end
+
     class Result < Data; end
 
     class << self

data/lib/zendesk_api/verbs.rb

@@ -44,14 +44,12 @@ module ZendeskAPI
           end
 
           define_method method do |*method_args|
-            begin
-              send("#{method}!", *method_args)
-            rescue ZendeskAPI::Error::RecordInvalid => e
-              @errors = e.errors
-              false
-            rescue ZendeskAPI::Error::ClientError
-              false
-            end
+            send("#{method}!", *method_args)
+          rescue ZendeskAPI::Error::RecordInvalid => e
+            @errors = e.errors
+            false
+          rescue ZendeskAPI::Error::ClientError
+            false
           end
         end
       end

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "1.37.0"
+  VERSION = "3.1.1"
 end

data/lib/zendesk_api.rb

@@ -1,4 +1,8 @@
 module ZendeskAPI; end
 
+require 'faraday'
+require 'faraday/multipart'
+
+require 'zendesk_api/helpers'
 require 'zendesk_api/core_ext/inflection'
 require 'zendesk_api/client'

metadata

@@ -1,36 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 1.37.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Steven Davidovitz
 - Michael Grosser
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-07 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-    - - "<"
+    - - ">"
       - !ruby/object:Gem::Version
         version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
-    - - "<"
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +136,7 @@ files:
 - lib/zendesk_api/middleware/response/parse_json.rb
 - lib/zendesk_api/middleware/response/raise_error.rb
 - lib/zendesk_api/middleware/response/sanitize_response.rb
+- lib/zendesk_api/pagination.rb
 - lib/zendesk_api/resource.rb
 - lib/zendesk_api/resources.rb
 - lib/zendesk_api/search.rb
@@ -144,11 +153,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.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
+  changelog_uri: https://github.com/zendesk/zendesk_api_client_rb/blob/v3.1.1/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/3.1.1
+  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v3.1.1
   wiki_uri: https://github.com/zendesk/zendesk_api_client_rb/wiki
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -156,15 +165,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.5.16
+signing_key: 
 specification_version: 4
 summary: Zendesk REST API Client
 test_files: []