zendesk_api 3.0.1 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1d55a2716fcbc1751d58a23796282e5b5689ac4fe193bdf0e5abc800605c200
-  data.tar.gz: fae9a5e9c62eb4ef7cfd61e01af12b5fd3fbcca709271f2bf00552863a22972c
+  metadata.gz: 8b226059359e4f834ccada53be52fbe72e0d73c26aa045fcfd011bd8afe3c1c2
+  data.tar.gz: c006d69a0b16716c7f093cd5a14454652661d4234f9a515a6a7724f977145c89
 SHA512:
-  metadata.gz: d70b174c454944498d191d962036890c654ae25ed8c6e5a310aaecbc7364b21b203246052b311702fc564ee3be4c00b92f3f6b57ca29367bcb79039bef16cac2
-  data.tar.gz: 702de99c18e0f256f4871a8fa31a588de67d7da46402c8a14f77d97cd1c1f90fdbead7481bdcb26d2e5c6e0176c5e2c739c954b6162808b1b6ff38edc6028864
+  metadata.gz: 9080f2d1cb5c4fae6145c37dfe2fa4e3e81c1bd3afa1d565cd41e350e36b97dff9247c9a5028f3e78e27c1516fe406df80980a21c60b3f716898bcaddb026b0e
+  data.tar.gz: e616e3ee6b1ba647952265b5dad953181eaeb5940d6954d37cfe1934232df7abb4547d8de7cbc22dc9dcceda1d849c6c103fc87f85514cba42e64e2cf48f6c50

data/lib/zendesk_api/client.rb

@@ -37,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)
@@ -184,9 +185,9 @@ module ZendeskAPI
 
     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

data/lib/zendesk_api/collection.rb

@@ -1,14 +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
-    DEFAULT_PAGE_SIZE = 100
-
     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]
@@ -116,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
@@ -249,7 +225,7 @@ module ZendeskAPI
         clear_cache
         @options["page"] = @options["page"].to_i + 1
       elsif (@query = @next_page)
-        # Send _only_ url param "?after=token" to get the next page
+        # Send _only_ url param "?page[after]=token" to get the next page
         @options.page&.delete("before")
         fetch(true)
       else
@@ -267,7 +243,7 @@ module ZendeskAPI
         clear_cache
         @options["page"] -= 1
       elsif (@query = @prev_page)
-        # Send _only_ url param "?before=token" to get the prev page
+        # Send _only_ url param "?page[before]=token" to get the prev page
         @options.page&.delete("after")
         fetch(true)
       else
@@ -323,11 +299,6 @@ module ZendeskAPI
       map(&:to_param)
     end
 
-    def more_results?(response)
-      Helpers.present?(response["meta"]) && response["meta"]["has_more"]
-    end
-    alias_method :has_more_results?, :more_results? # For backward compatibility with 1.33.0 and 1.34.0
-
     def get_next_page_data(original_response_body)
       link = original_response_body["links"]["next"]
       result_key = @resource_class.model_key || "results"
@@ -344,42 +315,14 @@ module ZendeskAPI
 
     private
 
-    def cbp_response?(body)
-      !!(body["meta"] && body["links"])
-    end
-
-    def cbp_request?
-      @options["page"].is_a?(Hash)
-    end
-
-    def intentional_obp_request?
-      Helpers.present?(@options["page"]) && !cbp_request?
-    end
-
-    def should_try_cbp?(path_query_link)
-      not_supported_endpoints = %w[show_many]
-      not_supported_endpoints.none? { |endpoint| path_query_link.end_with?(endpoint) }
-    end
-
     def get_resources(path_query_link)
       if intentional_obp_request?
         warn "Offset Based Pagination will be deprecated soon"
-      elsif @next_page.nil? && should_try_cbp?(path_query_link)
-        @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
-
-      begin
-        # Try CBP first, unless the user explicitly asked for OBP
-        @response = get_response(path_query_link)
-      rescue ZendeskAPI::Error::NetworkError => e
-        raise e if intentional_obp_request?
-        # Fallback to OBP if CBP didn't work, using per_page param
-        @options.per_page = @options_per_page_was
-        @options.page = nil
-        @response = get_response(path_query_link)
+      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)
 
       # Keep pre-existing behaviour for search/export
       if path_query_link == "search/export"
@@ -389,29 +332,6 @@ module ZendeskAPI
       end
     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)
-        # We'll delete the one we don't need in #next or #prev
-        @options["page"]["after"] = body["meta"]["after_cursor"]
-        @options["page"]["before"] = body["meta"]["before_cursor"]
-      elsif @next_page =~ /page=(\d+)/
-        @options["page"] = $1.to_i - 1
-      elsif @prev_page =~ /page=(\d+)/
-        @options["page"] = $1.to_i + 1
-      end
-    end
-
-    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 _all(start_page = @options["page"], bang = false, &block)
       raise(ArgumentError, "must pass a block") unless block
 
@@ -541,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
 

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

@@ -24,6 +24,10 @@ module ZendeskAPI
 
   class Topic < Resource
     class << self
+      def cbp_path_regexes
+        [%r{^community/topics$}]
+      end
+
       def resource_path
         "community/topics"
       end
@@ -83,6 +87,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,6 +160,10 @@ 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
@@ -180,6 +192,10 @@ module ZendeskAPI
 
     has User
     has Organization
+
+    def self.cbp_path_regexes
+      [%r{^organizations/\d+/subscriptions$}]
+    end
   end
 
   class Category < Resource
@@ -258,15 +274,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
@@ -318,7 +338,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
@@ -349,10 +369,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
@@ -360,7 +388,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
 
@@ -378,6 +406,10 @@ module ZendeskAPI
     extend UpdateMany
     extend DestroyMany
 
+    def self.cbp_path_regexes
+      [/^tickets$/]
+    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
@@ -401,8 +433,8 @@ module ZendeskAPI
     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?
@@ -429,35 +461,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!
@@ -466,7 +498,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
 
@@ -476,7 +508,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
@@ -486,6 +518,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
@@ -495,6 +531,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
@@ -510,9 +550,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
@@ -592,6 +632,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
@@ -599,6 +643,10 @@ module ZendeskAPI
     include Actions
 
     has :execution, :class => RuleExecution
+
+    def self.cbp_path_regexes
+      [/^triggers$/, %r{^triggers/active$}]
+    end
   end
 
   class Automation < Rule
@@ -606,6 +654,10 @@ module ZendeskAPI
     include Actions
 
     has :execution, :class => RuleExecution
+
+    def self.cbp_path_regexes
+      [/^automations$/]
+    end
   end
 
   class Macro < Rule
@@ -613,6 +665,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.
@@ -648,6 +704,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
@@ -789,6 +857,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/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "3.0.1"
+  VERSION = "3.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.4
 platform: ruby
 authors:
 - Steven Davidovitz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -136,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
@@ -152,9 +153,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/v3.0.1/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/3.0.1
-  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v3.0.1
+  changelog_uri: https://github.com/zendesk/zendesk_api_client_rb/blob/v3.0.4/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/3.0.4
+  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v3.0.4
   wiki_uri: https://github.com/zendesk/zendesk_api_client_rb/wiki
 post_install_message: 
 rdoc_options: []