kessel-sdk 1.9.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da1042aa3891283007d9fd0691e9abafc77e90c35e30e50ffc6cbac5269707cd
-  data.tar.gz: 6dc8b95b250b2761b2a6efb717ad3ea5f8f5e291dbc2a1657829a0ab9928eaf3
+  metadata.gz: 136206dbccfc87a36252fa0b635f195d00ebc861f9d26c3a35095403257e971c
+  data.tar.gz: 6e1366c5ed2fc78316fd7804f4ff31ac59819817e919fda84e689c7c8023f980
 SHA512:
-  metadata.gz: 677a6982ae2894af54d645a6f383fe7d788558895063f7c155cea67331fe691af449e3edc3a83606aac884e552dec727fe9a025d327a8d79dced3f531b75562e
-  data.tar.gz: 6548b0ecee560d968a9b46b2dee7823fdc641b3c21e8058a33b89b11ba31fbf3096fef234643763c5a8a1e8d4f8beed7fb91d4e1f36422151b151ada73885a4e
+  metadata.gz: 2c015adbcbf6838b582f598b31d7860d31541c4adeb622c60877399b67ae797a516f603185640890f6c711311e0ff9f09ef0968153219b9dddcc070bb75acfeb
+  data.tar.gz: 4967035e1789c864e4197e5e6ffcbf7bfe6e2d47dc24b2c1a4823b83e198171f043f0ceb0f9bee4cbbc5ae5f495882c2654b6d6e08989a4cc15fae5de3513a96

data/README.md

@@ -196,6 +196,10 @@ end
 
 ### List Workspaces (Streaming with Auto-Pagination)
 
+The `list_workspaces` helper automatically paginates through all workspaces
+a subject can access. Continuation tokens are handled internally, meaning you never
+need to manage them yourself.
+
 ```ruby
 include Kessel::Inventory::V1beta2
 include Kessel::RBAC::V2
@@ -204,11 +208,20 @@ client = KesselInventoryService::ClientBuilder.new('localhost:9000')
                                               .insecure
                                               .build
 
-list_workspaces(client, principal_subject('alice', 'redhat'), 'view_document').each do |response|
-  puts response
+subject = principal_subject("alice", "redhat")
+consistency = Kessel::Inventory::V1beta2::Consistency.new(minimize_latency: true)
+
+# Lazy iteration (constant memory)
+list_workspaces(client, subject, "viewer", consistency: consistency).each do |response|
+  puts response.object.resource_id
 end
+
+# Materialise into an Array
+all_workspaces = list_workspaces(client, subject, "viewer", consistency: consistency).to_a
 ```
 
+See [`examples/list_workspaces.rb`](./examples/list_workspaces.rb) for a complete working example.
+
 ### Available Services (V1beta2)
 
 The primary service is **`KesselInventoryService`** with these RPCs:

data/lib/kessel/rbac/v2.rb

@@ -22,7 +22,30 @@ module Kessel
         fetch_workspace(rbac_base_endpoint, org_id, 'root', auth: auth, http_client: http_client)
       end
 
-      def list_workspaces(inventory, subject, relation, continuation_token = nil)
+      # Lists all workspaces that a subject has a specific relation to.
+      #
+      # Pagination is handled automatically -- continuation tokens are managed
+      # internally. The returned +Enumerator+ is lazy; each page is fetched
+      # only when the next element is requested.
+      #
+      # @param inventory [Object] the inventory service client stub
+      # @param subject [SubjectReference] the subject to check permissions for
+      # @param relation [String] the relationship type (e.g. "member", "admin", "viewer")
+      # @param continuation_token [String, nil] optional token to resume listing
+      # @param consistency [Consistency, nil] optional consistency requirements for each request
+      # @return [Enumerator] a lazy enumerator of +StreamedListObjectsResponse+ objects
+      #
+      # @example Lazy iteration (constant memory)
+      #   consistency = Kessel::Inventory::V1beta2::Consistency.new(minimize_latency: true)
+      #   list_workspaces(inventory, subject, "viewer", consistency: consistency).each do |response|
+      #     puts response.object.resource_id
+      #   end
+      #
+      # @example Materialise into an Array (eager, all results in memory)
+      #   consistency = Kessel::Inventory::V1beta2::Consistency.new(minimize_latency: true)
+      #   all_workspaces = list_workspaces(inventory, subject, "viewer", consistency: consistency).to_a
+      #
+      def list_workspaces(inventory, subject, relation, continuation_token = nil, consistency: nil)
         Enumerator.new do |yielder|
           loop do
             request = StreamedListObjectsRequest.new(
@@ -32,7 +55,8 @@ module Kessel
               pagination: RequestPagination.new(
                 limit: DEFAULT_PAGE_LIMIT,
                 continuation_token: continuation_token
-              )
+              ),
+              consistency: consistency
             )
 
             has_responses = false

data/lib/kessel/version.rb

@@ -2,6 +2,6 @@
 
 module Kessel
   module Inventory
-    VERSION = '1.9.1'
+    VERSION = '1.10.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kessel-sdk
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.10.0
 platform: ruby
 authors:
 - Project Kessel