Add pagination support for specific commands.

Add pagination support for specific commands to allow for list ALL the
resources they are associated with. They do NOT allow for the end user
to specify a limit/page size at this time. This is meant as an interim
fix to allow for users with large numbers of clusters, team, team
members and networks to be able list them all at one time.

Author: abrightwell

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Fixed
+- Pagination limit on `cb list`, `cb network list`, `cb team list` and
+  `cb team_member list`.
 
 ## [3.6.1] - 2024-11-05
 ### Added

src/client/client.cr

@@ -3,6 +3,7 @@ require "json"
 require "log"
 require "promise"
 require "../ext/stdlib_ext"
+require "./pagination"
 
 module CB
   class Client

src/client/cluster.cr

@@ -21,9 +21,28 @@ module CB
       result
     end
 
+    struct ClusterListResponse
+      include JSON::Serializable
+      pagination_properties
+      property clusters : Array(CB::Model::Cluster) = [] of CB::Model::Cluster
+    end
+
     def get_clusters(team_id)
-      resp = get "clusters?order_field=name&team_id=#{team_id}&limit=200"
-      Array(CB::Model::Cluster).from_json resp.body, root: "clusters"
+      clusters : Array(CB::Model::Cluster) = [] of CB::Model::Cluster
+      query_params = Hash(String, String | Array(String)).new.tap do |params|
+        params["team_id"] = team_id.to_s
+        params["order_field"] = "name"
+      end
+
+      loop do
+        resp = get "clusters?#{HTTP::Params.encode(query_params)}"
+        data = ClusterListResponse.from_json resp.body
+        clusters.concat(data.clusters)
+        break unless data.has_more
+        query_params["cursor"] = data.next_cursor.to_s
+      end
+
+      clusters
     end
 
     # Retrieve the cluster by id or by name.

src/client/network.cr

@@ -15,17 +15,31 @@ module CB
       CB::Model::Network.from_json resp.body
     end
 
+    struct NetworkListResponse
+      include JSON::Serializable
+      pagination_properties
+      property networks : Array(CB::Model::Network)
+    end
+
     # Get all networks for a team.
     #
     # https://crunchybridgeapi.docs.apiary.io/#reference/0/networks/list-networks
     def get_networks(team : Identifier?)
-      resp = if team
-               team_id = team.eid? ? team.to_s : get_team_by_name(team).id
-               get "networks?team_id=#{team_id}"
-             else
-               get "networks"
-             end
-      Array(CB::Model::Network).from_json resp.body, root: "networks"
+      networks = [] of CB::Model::Network
+      query_params = Hash(String, String | Array(String)).new.tap do |params|
+        params["order_field"] = "id"
+        params["team_id"] = team.eid? ? team.to_s : get_team_by_name(team).id if team
+      end
+
+      loop do
+        resp = get "networks?#{HTTP::Params.encode(query_params)}"
+        data = NetworkListResponse.from_json resp.body
+        networks.concat(data.networks)
+        break unless data.has_more
+        query_params["cursor"] = data.next_cursor.to_s
+      end
+
+      networks
     end
 
     def get_networks(teams : Array(CB::Model::Team))

src/client/pagination.cr

@@ -0,0 +1,4 @@
+macro pagination_properties
+  property has_more : Bool = false
+  property next_cursor : String? = nil
+end

src/client/team.cr

@@ -10,12 +10,30 @@ module CB
       CB::Model::Team.from_json resp.body
     end
 
+    struct TeamListResponse
+      include JSON::Serializable
+      pagination_properties
+      property teams : Array(CB::Model::Team)
+    end
+
     # List available teams.
     #
     # https://crunchybridgeapi.docs.apiary.io/#reference/0/teams/list-teams
     def get_teams
-      resp = get "teams?order_field=name"
-      Array(CB::Model::Team).from_json resp.body, root: "teams"
+      teams = [] of CB::Model::Team
+      query_params = Hash(String, String | Array(String)).new.tap do |params|
+        params["order_field"] = "name"
+      end
+
+      loop do
+        resp = get "teams?#{HTTP::Params.encode(query_params)}"
+        data = TeamListResponse.from_json resp.body
+        teams.concat(data.teams)
+        break unless data.has_more
+        query_params["cursor"] = data.next_cursor.to_s
+      end
+
+      teams
     end
 
     # Update a team.

src/client/team_member.cr

@@ -13,12 +13,30 @@ module CB
       CB::Model::TeamMember.from_json resp.body
     end
 
+    struct TeamMemberListResponse
+      include JSON::Serializable
+      pagination_properties
+      property team_members : Array(CB::Model::TeamMember)
+    end
+
     # List the memebers of a team.
     #
     # https://crunchybridgeapi.docs.apiary.io/#reference/0/teamsteamidmembers/list-team-members
     def list_team_members(team_id)
-      resp = get "teams/#{team_id}/members"
-      Array(CB::Model::TeamMember).from_json resp.body, root: "team_members"
+      team_members = [] of CB::Model::TeamMember
+      query_params = Hash(String, String | Array(String)).new.tap do |params|
+        params["order_field"] = "email"
+      end
+
+      loop do
+        resp = get "teams/#{team_id}/members?#{HTTP::Params.encode(query_params)}"
+        data = TeamMemberListResponse.from_json resp.body
+        team_members.concat(data.team_members)
+        break unless data.has_more
+        query_params["cursor"] = data.next_cursor.to_s
+      end
+
+      team_members
     end
 
     # Retrieve details about a team member.