refactor and add cbp support to organizations and its subsriptions

Author: fbvilela

lib/zendesk_api/cbp_support.rb

@@ -0,0 +1,17 @@
+module ZendeskAPI
+  # Represents the support to Cursor Based Pagination endpoints
+  module CBPSupport
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # Returns the paths that support CBP
+    # @return [Array] of regular expressions
+    # To add CBP support to a resource, add a constant called CBP_ACTIONS. See examples in resources.rb
+    module ClassMethods
+      def cbp_path_regexes
+        const_defined?(:CBP_ACTIONS) ? const_get(:CBP_ACTIONS) : []
+      end
+    end
+  end
+end

lib/zendesk_api/collection.rb

@@ -365,8 +365,7 @@ def intentional_obp_request?
     end
 
     def supports_cbp?
-      @resource_class.const_defined?(:CBP_ACTIONS) &&
-        @resource_class.const_get(:CBP_ACTIONS).any? { |supported_path_regex| path.match?(supported_path_regex) }
+      @resource_class.cbp_path_regexes.any? { |supported_path_regex| path.match?(supported_path_regex) }
     end
 
     def first_cbp_request?

lib/zendesk_api/resource.rb

@@ -4,6 +4,7 @@
 require 'zendesk_api/association'
 require 'zendesk_api/associations'
 require 'zendesk_api/verbs'
+require 'zendesk_api/cbp_support'
 
 # See docs: https://developer.zendesk.com/api-reference/
 module ZendeskAPI
@@ -163,6 +164,7 @@ def attribute_changes
   class DataResource < Data
     attr_accessor :error, :error_message
     extend Verbs
+    include CBPSupport
   end
 
   # Represents a resource that can only GET

lib/zendesk_api/resources.rb

@@ -152,6 +152,8 @@ class Organization < Resource
     def self.incremental_export(client, start_time)
       ZendeskAPI::Collection.new(client, self, :path => "incremental/organizations?start_time=#{start_time.to_i}")
     end
+
+    CBP_ACTIONS = [/organizations$/].freeze
   end
 
   class Brand < Resource
@@ -180,6 +182,8 @@ class OrganizationSubscription < ReadResource
 
     has User
     has Organization
+
+    CBP_ACTIONS = [%r{organizations/\d+/subscriptions$}].freeze
   end
 
   class Category < Resource
@@ -378,7 +382,7 @@ class Ticket < Resource
     extend UpdateMany
     extend DestroyMany
 
-    CBP_ACTIONS = %w[tickets].freeze
+    CBP_ACTIONS = [/tickets$/].freeze
 
     # 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,

lib/zendesk_api/search.rb

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

spec/core/cbp_helper.rb

@@ -0,0 +1,22 @@
+shared_examples 'an endpoint that supports CBP' do
+  let(:collection_fetched) do
+    VCR.use_cassette("cbp_#{described_class}_collection_fetch") do
+      collection.fetch
+      collection
+    end
+  end
+
+  let(:response_body) { collection_fetched.response.body }
+  let(:collection_fetched_results) { collection_fetched.to_a }
+
+  it 'returns a CBP response with all the correct keys' do
+    expect(response_body).to have_key('meta')
+    expect(response_body).to have_key('links')
+    expect(response_body['meta'].keys).to match_array(%w[has_more after_cursor before_cursor])
+    expect(response_body['links'].keys).to match_array(%w[prev next])
+  end
+
+  it "returns a list of #{described_class} objects" do
+    expect(collection_fetched_results).to all(be_a(described_class))
+  end
+end

spec/core/resources/cbp_spec_helper.rb

@@ -0,0 +1,44 @@
+require 'core/spec_helper'
+require 'core/resources/cbp_spec_helper'
+
+describe 'Endpoints that support CBP' do
+  describe ZendeskAPI::Group do
+    describe '/groups' do
+      it_behaves_like 'an endpoint that supports CBP' do
+        let(:collection) { client.groups }
+      end
+    end
+
+    describe '/groups/assignable' do
+      it_behaves_like 'an endpoint that supports CBP' do
+        let(:collection) { client.groups.assignable }
+      end
+    end
+  end
+
+  describe ZendeskAPI::GroupMembership do
+    describe '/groups/:id/memberships' do
+      let(:one_group) { VCR.use_cassette("cbp_group_memberships_all_groups") { client.groups.fetch.last } }
+      it_behaves_like 'an endpoint that supports CBP' do
+        let(:collection) { one_group.memberships }
+      end
+    end
+  end
+
+  describe ZendeskAPI::Organization do
+    describe '/organizations' do
+      it_behaves_like 'an endpoint that supports CBP' do
+        let(:collection) { client.organizations }
+      end
+    end
+  end
+
+  describe ZendeskAPI::OrganizationMembership do
+    describe '/organizations/:id/subscriptions' do
+      let(:one_organization) { VCR.use_cassette("cbp_organization_subscriptions_all_organizations") { client.organizations.fetch.last } }
+      it_behaves_like 'an endpoint that supports CBP' do
+        let(:collection) { one_organization.subscriptions }
+      end
+    end
+  end
+end