zendesk_api 3.1.1 → 4.0.0.pre.1

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

@@ -0,0 +1,72 @@
+require "faraday/response"
+
+module ZendeskAPI
+  module Middleware
+    module Response
+      # @private
+      class ZendeskRequestEvent < Faraday::Middleware
+        def initialize(app, options = {})
+          super(app)
+          @instrumentation = options[:instrumentation]
+          @logger = options[:logger]
+        end
+
+        def call(env)
+          return @app.call(env) unless instrumentation
+
+          start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          @app.call(env).on_complete do |response_env|
+            stop_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+            begin
+              instrument_request(response_env, start_time, stop_time)
+              instrument_rate_limit(response_env)
+            rescue => e
+              logger&.debug("Instrumentation failed: #{e.message}")
+            end
+          end
+        end
+
+        private
+
+        attr_reader :instrumentation, :logger
+
+        def instrument_request(response_env, start_time, stop_time)
+          duration_ms = (stop_time - start_time) * 1000.0
+
+          payload = {
+            duration: duration_ms,
+            endpoint: response_env[:url]&.path,
+            method: response_env[:method],
+            status: response_env[:status]
+          }
+
+          instrumentation.instrument("zendesk.request", payload)
+        end
+
+        def instrument_rate_limit(response_env)
+          status = response_env[:status]
+          return unless status && status < 500
+
+          headers = response_env[:response_headers]
+          remaining, limit, reset = headers&.values_at(
+            "X-Rate-Limit-Remaining",
+            "X-Rate-Limit",
+            "X-Rate-Limit-Reset"
+          )
+          return if [remaining, limit, reset].all?(&:nil?)
+
+          payload = {
+            endpoint: response_env[:url]&.path,
+            status: status,
+            remaining: remaining,
+            limit: limit,
+            reset: reset
+          }
+
+          instrumentation.instrument("zendesk.rate_limit", payload)
+        end
+      end
+    end
+  end
+end

data/lib/zendesk_api/pagination.rb

@@ -6,7 +6,7 @@ module ZendeskAPI
       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
+      alias_method :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
@@ -49,7 +49,7 @@ module ZendeskAPI
       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) }
+        @options.page = {size: @options_per_page_was || DEFAULT_PAGE_SIZE}
       end
 
       # CBP requests look like: `/resources?page[size]=100`
@@ -92,7 +92,7 @@ module ZendeskAPI
         @options.page.merge!(
           before: body["meta"]["before_cursor"],
           after: body["meta"]["after_cursor"]
-                            )
+        )
       end
     end
   end

data/lib/zendesk_api/resource.rb

@@ -1,9 +1,9 @@
-require 'zendesk_api/helpers'
-require 'zendesk_api/trackie'
-require 'zendesk_api/actions'
-require 'zendesk_api/association'
-require 'zendesk_api/associations'
-require 'zendesk_api/verbs'
+require_relative "helpers"
+require_relative "trackie"
+require_relative "actions"
+require_relative "association"
+require_relative "associations"
+require_relative "verbs"
 
 # See docs: https://developer.zendesk.com/api-reference/
 module ZendeskAPI
@@ -34,7 +34,7 @@ module ZendeskAPI
         [@namespace, resource_name].compact.join("/")
       end
 
-      alias :model_key :resource_name
+      alias_method :model_key, :resource_name
 
       def namespace(namespace)
         @namespace = namespace
@@ -64,7 +64,7 @@ module ZendeskAPI
     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)
+      @association = attributes.delete(:association) || Association.new(class: self.class)
       @global_params = attributes.delete(:global) || {}
       @client = client
       @attributes = ZendeskAPI::Trackie.new(attributes)
@@ -76,19 +76,11 @@ module ZendeskAPI
       @attributes.clear_changes unless new_record?
     end
 
-    def self.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
-
     # Passes the method onto the attributes hash.
     # If the attributes are nested (e.g. { :tickets => { :id => 1 } }), passes the method onto the nested hash.
-    def method_missing(*args, &block)
+    def method_missing(*args, &)
       raise NoMethodError, ":save is not defined" if args.first.to_sym == :save
-      @attributes.send(*args, &block)
+      @attributes.send(*args, &)
     end
 
     def respond_to_missing?(method, include_private = false)
@@ -127,7 +119,6 @@ module ZendeskAPI
     def to_s
       "#{self.class.singular_resource_name}: #{attributes.inspect}"
     end
-    alias :inspect :to_s
 
     # Compares resources by class and id. If id is nil, then by object_id
     def ==(other)
@@ -140,19 +131,19 @@ module ZendeskAPI
       return id == other if other.is_a?(Integer)
 
       warn "Trying to compare #{other.class} to a Resource
-        from #{caller.first}"
+        from #{caller(1..1).first}"
     end
-    alias :eql :==
+    alias_method :eql, :==
 
     # @private
     def inspect
       "#<#{self.class.name} #{@attributes.to_hash.inspect}>"
     end
 
-    alias :to_param :attributes
+    alias_method :to_param, :attributes
 
     def attributes_for_save
-      { self.class.singular_resource_name.to_sym => attribute_changes }
+      {self.class.singular_resource_name.to_sym => attribute_changes}
     end
 
     private
@@ -167,6 +158,7 @@ module ZendeskAPI
   # Indexable resource
   class DataResource < Data
     attr_accessor :error, :error_message
+
     extend Verbs
 
     def self.cbp_path_regexes
@@ -205,7 +197,7 @@ module ZendeskAPI
 
   class SingularResource < Resource
     def attributes_for_save
-      { self.class.resource_name.to_sym => attribute_changes }
+      {self.class.resource_name.to_sym => attribute_changes}
     end
   end