[RED-1821] Cater for endpoints with CBP support #548

fbvilela · 2023-07-26T06:32:02Z

Description

Adding endpoints that support CBP.

spec/live/cbp_support.rb

ecoologic · 2023-07-26T06:38:06Z

spec/live/cbp_support.rb

+    describe '/groups/{id}/memberships' do
+      before do
+        VCR.use_cassette("cbp_group_memberships_all_groups") do
+          @groups = client.groups.fetch


Could we use let instead of instance vars?

https://www.betterspecs.org/#let

Done it ✅

ecoologic · 2023-07-26T06:46:45Z

spec/core/cbp_helper.rb

+        @response_body = collection.response.body
+      end
+    end
+    it 'expects an array with the correct element types' do


Maybe?

Suggested change

it 'expects an array with the correct element types' do

it "returns a list of #{@resource_klass}" do

I think in this context it should be available, you're inside a method....

However, I'm not a fan of extracting whole tests in methods. But I can't verbalize that, so maybe it's a subjective thing. I'm ok with a bit of duplication in the code, or using a list of test params like we do in Go.

The context could also use some more wording.

Done it ✅
also using the described_class var provided by rspec, much nicer

ecoologic · 2023-07-26T06:49:10Z

spec/core/cbp_helper.rb

+def expect_cbp_response_for(collection)
+  context collection.path.to_s, :vcr do
+    before do
+      @resource_klass = collection.instance_variable_get(:@resource_class)


Any way around poking inside the private variables of classes?

yes, this was taken care of

ecoologic · 2023-07-27T01:14:08Z

lib/zendesk_api/collection.rb

@@ -365,7 +365,8 @@ def intentional_obp_request?
    end

    def supports_cbp?
-      @resource_class.const_defined?(:CBP_ACTIONS) && @resource_class.const_get(:CBP_ACTIONS).any? { |supported_path| path.end_with?(supported_path) }
+      @resource_class.const_defined?(:CBP_ACTIONS) &&
+        @resource_class.const_get(:CBP_ACTIONS).any? { |supported_path_regex| path.match?(supported_path_regex) }


if this was a class method in Resource, returning an empty array, this part would simplify to:

@resource_class.cbp_path_regexes.any? { |r| r =~ path }

Note that now if the type of data a method returns changes, likely the name needs to reflect that change.

Done ✅
I created a module for the CBP support code. was that what you were thinking?

no... the idea was to create a method in resource, returning an empty array, and override the method in the specific resources.

I'm ok with what we have but if you're curious we can chat about it 👍

ecoologic

✅ This is great work, see my latest comments and if there's anything you'd like to implement. When you're happy with it, I'm happy too.

ecoologic · 2023-07-31T21:55:46Z

lib/zendesk_api/cbp_support.rb

+      def cbp_path_regexes
+        const_defined?(:CBP_ACTIONS) ? const_get(:CBP_ACTIONS) : []
+      end
+    end


I think this overcomplicates things, too much indirection.

ecoologic · 2023-07-31T23:11:34Z

lib/zendesk_api/resources.rb

@@ -378,7 +382,7 @@ class Ticket < Resource
    extend UpdateMany
    extend DestroyMany

-    CBP_ACTIONS = %w[tickets].freeze
+    CBP_ACTIONS = [/tickets$/].freeze


Suggested change

CBP_ACTIONS = [/tickets$/].freeze

def self.cbp_path_regexes

[/tickets$/].freeze

end

ecoologic · 2023-08-01T04:30:17Z

lib/zendesk_api/collection.rb

-        before: body["meta"]["before_cursor"],
-        after: body["meta"]["after_cursor"]
-                           )
-    end


It's always great to see files get smaller 😄

ecoologic · 2023-08-01T04:31:13Z

lib/zendesk_api/pagination.rb

+    def each_page!(*args, &block)
+      warn "ZendeskAPI::Collection#each_page! is deprecated, please use ZendeskAPI::Collection#all!"
+      all!(*args, &block)
+    end


this (and below) is not pagination logic?

ecoologic · 2023-08-01T04:32:50Z

lib/zendesk_api/pagination.rb

@@ -0,0 +1,107 @@
+module ZendeskAPI
+  # Contains all methods related to pagination in an attempt to slim down collection.rb


Minor: If you wanted to be super-clear about the fact it's only for collection, you could even namespace it by module Collection here. That way, it wouldn't pollute the namespace in ZendeskAPI when it should only be used in Collection.

ecoologic · 2023-08-01T04:34:14Z

lib/zendesk_api/pagination.rb

+                           )
+    end
+  end
+end


Nice! Scrolling through the file you can kinda understand how pagination is handled. 👍

ecoologic · 2023-08-01T04:36:43Z

lib/zendesk_api/pagination.rb

+    def last_page?
+      !@next_page || @next_page == @query
+    end
+


Moving public methods make is a bit harder to follow in case they're called from outside of Collection, but in this case I'm fine with it. 👍

ecoologic · 2023-08-01T04:37:58Z

lib/zendesk_api/resources.rb

+  end
+
+  class Group < Resource
+    has_many :memberships, :class => GroupMembership, :path => "memberships"


Very minor, but why not? 😄

Suggested change

has_many :memberships, :class => GroupMembership, :path => "memberships"

has_many :memberships, class: GroupMembership, path: "memberships"

ecoologic · 2023-08-01T04:41:49Z

spec/live/cbp_support_spec.rb

+
+describe 'Endpoints that support CBP' do
+  describe ZendeskAPI::Group do
+    describe '/groups' do


Minor: I think RSpec is about describing Object#methods. This makes the test suite into documentation. IE: describe "#fetch"

https://www.betterspecs.org/#describe

RSpec.describe ZendeskAPI::Group do subject(:collection) { client.groups } describe '#fetch' do it_behaves_like 'an action that uses CBP' end end

add cbp support for the groups endpoints

6253045

fbvilela force-pushed the fvilela/add-cbp-endpoints branch from 7106a9d to 6253045 Compare July 26, 2023 06:32

fbvilela commented Jul 26, 2023

View reviewed changes

spec/live/cbp_support.rb Outdated Show resolved Hide resolved

ecoologic reviewed Jul 26, 2023

View reviewed changes

ecoologic reviewed Jul 27, 2023

View reviewed changes

ecoologic approved these changes Jul 27, 2023

View reviewed changes

fbvilela marked this pull request as ready for review July 27, 2023 13:18

fbvilela requested a review from a team as a code owner July 27, 2023 13:18

refactor and add cbp support to organizations and its subsriptions

4505ac7

fbvilela force-pushed the fvilela/add-cbp-endpoints branch from a3f0305 to 4505ac7 Compare July 28, 2023 00:27

fbvilela added 2 commits July 28, 2023 12:03

try to fix Rubocop in CI

6636393

improve README and add CBP support for Triggers

94ce86e

ecoologic reviewed Jul 31, 2023

View reviewed changes

fbvilela added 3 commits August 1, 2023 11:15

simplifies how cbp support is implemented by each resource class

6bfbcc6

extract pagination methods into its own module

aa1760e

add info to changelog

51d0610

ecoologic reviewed Aug 1, 2023

View reviewed changes

small refactoring and remove a few hash rockets

df417ff

fbvilela force-pushed the fvilela/add-cbp-endpoints branch from fc3f2eb to df417ff Compare August 1, 2023 05:55

fbvilela merged commit cfc8dc1 into master Aug 1, 2023
7 checks passed

fbvilela deleted the fvilela/add-cbp-endpoints branch August 1, 2023 06:06

ecoologic mentioned this pull request Aug 20, 2023

Doc #537

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RED-1821] Cater for endpoints with CBP support #548

[RED-1821] Cater for endpoints with CBP support #548

fbvilela commented Jul 26, 2023

ecoologic Jul 26, 2023

fbvilela Jul 28, 2023

ecoologic Jul 26, 2023 •

edited

Loading

fbvilela Jul 28, 2023

ecoologic Jul 26, 2023

fbvilela Jul 28, 2023

ecoologic Jul 27, 2023

fbvilela Jul 28, 2023

ecoologic Jul 31, 2023 •

edited

Loading

ecoologic left a comment

ecoologic Jul 31, 2023

ecoologic Jul 31, 2023 •

edited

Loading

ecoologic Aug 1, 2023

ecoologic Aug 1, 2023

ecoologic Aug 1, 2023

ecoologic Aug 1, 2023

ecoologic Aug 1, 2023

ecoologic Aug 1, 2023

ecoologic Aug 1, 2023 •

edited

Loading

	it 'expects an array with the correct element types' do
	it "returns a list of #{@resource_klass}" do

		@@ -0,0 +1,107 @@
		module ZendeskAPI
		# Contains all methods related to pagination in an attempt to slim down collection.rb

	has_many :memberships, :class => GroupMembership, :path => "memberships"
	has_many :memberships, class: GroupMembership, path: "memberships"

[RED-1821] Cater for endpoints with CBP support #548

[RED-1821] Cater for endpoints with CBP support #548

Conversation

fbvilela commented Jul 26, 2023

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ecoologic Jul 26, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ecoologic Jul 31, 2023 • edited Loading

Choose a reason for hiding this comment

ecoologic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ecoologic Jul 31, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ecoologic Aug 1, 2023 • edited Loading

Choose a reason for hiding this comment

ecoologic Jul 26, 2023 •

edited

Loading

ecoologic Jul 31, 2023 •

edited

Loading

ecoologic Jul 31, 2023 •

edited

Loading

ecoologic Aug 1, 2023 •

edited

Loading