zendesk_api 3.0.2 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb7a7899050cd837be40995be562bb7c95a04e7d631a34cdddaa671c1eeca9b3
-  data.tar.gz: c042f01365e91e868c54e7aa5fc1318fc490efa2440093e24df86df6800feaba
+  metadata.gz: 8ecc2ccbe7be3ec6da2b36fdcd7b75004fcecd91a26de63d0bb561dcddff86cc
+  data.tar.gz: c4b7a7d6baa3246d2835251d03d2a7c0fd69961fd2ca3575a7486f3a7adf06f6
 SHA512:
-  metadata.gz: efafbaa0881befe0fd827e9fa465a3f7be19ec566199dd1640f5bba68ec101a6a0eb8b30efe850a08ca5f2adc2004ab809e74ba96eb52b3f8ac2e63f75c07e72
-  data.tar.gz: 6c81354976ef9ce6adf2f6ae084d7a60ae04fd49e10033e5025e5697a1f7adaac9385834f1c22a671e08cb94c3132d5c365a2e2a969b42f3035e301e94ed0a68
+  metadata.gz: 9183c973ac61c198dd69d975c5bc9eb27cc424b47e50027d32c2a462f651b08681925b00fd4686d248b615a80445c34b59273861a164917ea6738b54d04c1a4b
+  data.tar.gz: 980637e5be8ba003774a6fe5fe53dc2a4003ba6e58b933d21aaba66cb9c66eb0dd3f706ac6b2e69740f1c22cfe2a3d4c7301a7cfd313c0753ef3cff7cbc2683b

data/lib/zendesk_api/collection.rb

@@ -225,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
@@ -243,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
@@ -465,7 +465,7 @@ module ZendeskAPI
     def next_collection(name, *args, &block)
       opts = args.last.is_a?(Hash) ? args.last : {}
       opts.merge!(collection_path: [*@collection_path, name], page: nil)
-      # why 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))

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 :==
 

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
@@ -154,11 +162,15 @@ module ZendeskAPI
     end
 
     def self.cbp_path_regexes
-      [/organizations$/]
+      [/^organizations$/]
     end
   end
 
   class Brand < Resource
+    def self.cbp_path_regexes
+      [/^brands$/]
+    end
+
     def destroy!
       self.active = false
       save!
@@ -186,7 +198,7 @@ module ZendeskAPI
     has Organization
 
     def self.cbp_path_regexes
-      [%r{organizations/\d+/subscriptions$}]
+      [%r{^organizations/\d+/subscriptions$}]
     end
   end
 
@@ -275,6 +287,10 @@ module ZendeskAPI
   class Activity < Resource
     has User
     has :actor, :class => User
+
+    def self.cbp_path_regexes
+      [/^activities$/]
+    end
   end
 
   class Setting < UpdateResource
@@ -357,10 +373,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
@@ -387,7 +411,7 @@ module ZendeskAPI
     extend DestroyMany
 
     def self.cbp_path_regexes
-      [/tickets$/]
+      [/^tickets$/, %r{organizations/\d+/tickets}]
     end
 
     # Unlike other attributes, "comment" is not a property of the ticket,
@@ -408,6 +432,10 @@ module ZendeskAPI
       has :author, :class => User
 
       has_many Event
+
+      def self.cbp_path_regexes
+        [%r{^tickets/\d+/audits$}]
+      end
     end
 
     class Comment < DataResource
@@ -498,6 +526,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
@@ -507,6 +539,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
@@ -604,6 +640,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
@@ -613,7 +653,7 @@ module ZendeskAPI
     has :execution, :class => RuleExecution
 
     def self.cbp_path_regexes
-      [/triggers$/, %r{triggers/active$}]
+      [/^triggers$/, %r{^triggers/active$}]
     end
   end
 
@@ -622,6 +662,10 @@ module ZendeskAPI
     include Actions
 
     has :execution, :class => RuleExecution
+
+    def self.cbp_path_regexes
+      [/^automations$/]
+    end
   end
 
   class Macro < Rule
@@ -629,6 +673,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.
@@ -666,7 +714,7 @@ module ZendeskAPI
     has Group
 
     def self.cbp_path_regexes
-      [%r{groups/\d+/memberships$}]
+      [%r{^groups/\d+/memberships$}]
     end
   end
 
@@ -674,7 +722,7 @@ module ZendeskAPI
     has_many :memberships, class: GroupMembership, path: "memberships"
 
     def self.cbp_path_regexes
-      [/groups$/, %r{groups/assignable$}]
+      [/^groups$/, %r{^groups/assignable$}]
     end
   end
 
@@ -700,6 +748,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
@@ -817,6 +869,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/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "3.0.2"
+  VERSION = "3.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.5
 platform: ruby
 authors:
 - Steven Davidovitz
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -153,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.2/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/3.0.2
-  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v3.0.2
+  changelog_uri: https://github.com/zendesk/zendesk_api_client_rb/blob/v3.0.5/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/zendesk_api/3.0.5
+  source_code_uri: https://github.com/zendesk/zendesk_api_client_rb/tree/v3.0.5
   wiki_uri: https://github.com/zendesk/zendesk_api_client_rb/wiki
 post_install_message: 
 rdoc_options: []