small refactoring and remove a few hash rockets

Author: fbvilela

lib/zendesk_api/collection.rb

@@ -8,7 +8,7 @@ module ZendeskAPI
   # actually fetched until explicitly needed (e.g. #each, {#fetch}).
   class Collection
     include ZendeskAPI::Sideloading
-    include ZendeskAPI::Pagination
+    include Pagination
 
     # Options passed in that are automatically converted from an array to a comma-separated list.
     SPECIALLY_JOINED_PARAMS = [:ids, :only]
@@ -198,6 +198,16 @@ def all(start_page = @options["page"], &block)
       _all(start_page, &block)
     end
 
+    def each_page!(*args, &block)
+      warn "ZendeskAPI::Collection#each_page! is deprecated, please use ZendeskAPI::Collection#all!"
+      all!(*args, &block)
+    end
+
+    def each_page(*args, &block)
+      warn "ZendeskAPI::Collection#each_page is deprecated, please use ZendeskAPI::Collection#all"
+      all(*args, &block)
+    end
+
     # Replaces the current (loaded or not) resources with the passed in collection
     # @option collection [Array] The collection to replace this one with
     # @raise [ArgumentError] if any resources passed in don't belong in this collection

lib/zendesk_api/pagination.rb

@@ -1,107 +1,99 @@
 module ZendeskAPI
-  # 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
-
-    def each_page!(*args, &block)
-      warn "ZendeskAPI::Collection#each_page! is deprecated, please use ZendeskAPI::Collection#all!"
-      all!(*args, &block)
-    end
-
-    def each_page(*args, &block)
-      warn "ZendeskAPI::Collection#each_page is deprecated, please use ZendeskAPI::Collection#all"
-      all(*args, &block)
-    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
+  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
+      # 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 first_page?
+        !@prev_page
+      end
 
-    def last_page?
-      !@next_page || @next_page == @query
-    end
+      def last_page?
+        !@next_page || @next_page == @query
+      end
 
-    private
+      private
 
-    def page_links(body)
-      if body["meta"] && body["links"]
-        [body["links"]["next"], body["links"]["prev"]]
-      else
-        [body["next_page"], body["previous_page"]]
+      def page_links(body)
+        if body["meta"] && body["links"]
+          [body["links"]["next"], body["links"]["prev"]]
+        else
+          [body["next_page"], body["previous_page"]]
+        end
       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
+      def cbp_response?(body)
+        !!(body["meta"] && body["links"])
+      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 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
 
-    def intentional_obp_request?
-      Helpers.present?(@options["page"]) && !cbp_request?
-    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 supports_cbp?
-      @resource_class.cbp_path_regexes.any? { |supported_path_regex| path.match?(supported_path_regex) }
-    end
+      def intentional_obp_request?
+        Helpers.present?(@options["page"]) && !cbp_request?
+      end
 
-    def first_cbp_request?
-      # @next_page will be nil when making the first cbp request
-      @next_page.nil?
-    end
+      def supports_cbp?
+        @resource_class.cbp_path_regexes.any? { |supported_path_regex| path.match?(supported_path_regex) }
+      end
 
-    def set_page_and_count(body)
-      @count = (body["count"] || @resources.size).to_i
-      @next_page, @prev_page = page_links(body)
+      def first_cbp_request?
+        # @next_page will be nil when making the first cbp request
+        @next_page.nil?
+      end
 
-      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
+      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
-    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"]
-                           )
+      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

lib/zendesk_api/resources.rb

@@ -266,10 +266,10 @@ def path(options = {})
   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
@@ -326,7 +326,7 @@ class Request < Resource
     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
@@ -368,7 +368,7 @@ class TicketRelated < DataResource; end
   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
 
@@ -413,8 +413,8 @@ class Event < Data
     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?
@@ -441,35 +441,35 @@ class << self
     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!
@@ -478,7 +478,7 @@ def self.incremental_export(client, start_time)
     # @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
 
@@ -488,7 +488,7 @@ def self.import!(client, attributes)
     # @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
@@ -522,9 +522,9 @@ class ViewRow < DataResource
     # @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
@@ -671,7 +671,7 @@ def self.cbp_path_regexes
   end
 
   class Group < Resource
-    has_many :memberships, :class => GroupMembership, :path => "memberships"
+    has_many :memberships, class: GroupMembership, path: "memberships"
 
     def self.cbp_path_regexes
       [/groups$/, %r{groups/assignable$}]