atlas_rb 1.8.8 → 1.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 790f093dac74f6f06ec40f1be385888d0acb3123901f2056b39996ab8050e1ef
-  data.tar.gz: 5137778cc466b711c9862ab661d849b795142429b3507cc3e4a2549c8ccf7813
+  metadata.gz: 1fd50831467b065989eb0ec39af5f96b87622c5d0e161e0e6a5bdef61764505a
+  data.tar.gz: 55c36e14086a0fab3776771c797af98c9a431cca3f0b09f14ffac478ab58067c
 SHA512:
-  metadata.gz: f3244e997c783521e0a86b49cdfe2cd471ad744cca7399d4497d2a250102bb3c51f3f92c6d54b17d6137171baa355fe9f4ff42464565641efbb7fc7e83e489c3
-  data.tar.gz: 676ec01145ceb6773fa6ed13eda23a40949ef1ccaf7e984576fd00988169bdd19ae1710dc7f06f72b48f48165224aa57b585e1d9bdcd74c64038f58cb96f4b05
+  metadata.gz: 7aea8252388df4686a31174ca154b7e76da1d97dd16a8509f773bd2b918dfb282ccb93960f5138b0581df9d32d20c45a0f8cf4a1475dda787468644e1d83cdbd
+  data.tar.gz: 25e3ecf9a7cc353645a8a1ad76700523bba185895fcf1df13b9b098549a45287fb3a9c41abb0eefa559f5e1d8b4c8c4b81b7c16e5e418f4cee39e5f0d554dc56

data/.version

@@ -1 +1 @@
-1.8.8
+1.8.9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    atlas_rb (1.8.8)
+    atlas_rb (1.8.9)
       faraday (~> 2.7)
       faraday-follow_redirects (~> 0.3.0)
       faraday-multipart (~> 1)

data/lib/atlas_rb/resource.rb

@@ -88,6 +88,52 @@ module AtlasRb
       ).map { |node| AtlasRb::Mash.new(node) }
     end
 
+    # Every Work beneath a resource, at any depth — the structural counterpart
+    # to {Compilation.contents}. Wraps `GET /resources/<id>/descendant_works`,
+    # which flattens the resource's full descendant subtree to the Works it
+    # contains, gated to what the caller may read and paginated Solr-side. Gives
+    # a Collection the flatten-to-Works capability a Set already has, so a bulk
+    # export (e.g. hyperion) pages one gated, fast call family instead of the
+    # client-side `children → find_many → recurse` walk.
+    #
+    # Returns the same digest shape as {find_many} / {Compilation.contents}
+    # (`{ "id", "noid", "klass", "title", "thumbnail" }`) under a `"works"` key,
+    # plus a `"pagination"` envelope (`total` / `page` / `per_page` / `pages`).
+    # Membership is **structural** (`a_member_of`) only; pass
+    # `include_linked: true` to also surface linked members
+    # (`a_linked_member_of`). Restricted Works never appear for a caller who may
+    # not read them; tombstoned Works are dropped.
+    #
+    # @param id [String] an Atlas resource ID (subtree root; any type).
+    # @param page [Integer, nil] 1-based page (default 1 server-side).
+    # @param per_page [Integer, nil] page size (server default 25, capped 100).
+    # @param include_linked [Boolean, nil] also include linked members when
+    #   truthy; structural-only by default.
+    # @param nuid [String, nil] optional acting user's NUID. On the relay-signing
+    #   path it is signed into the assertion `sub`; on the BYO-JWT (`ATLAS_JWT`)
+    #   path it is ignored (identity lives in the token).
+    # @param on_behalf_of [String, nil] optional NUID for the `On-Behalf-Of`
+    #   header. Falls through to {AtlasRb.config}.default_on_behalf_of when omitted.
+    # @return [AtlasRb::Mash, nil] the parsed envelope, with a `"works"` digest
+    #   array and a `"pagination"` block; `nil` when the id resolves to nothing
+    #   (`404`).
+    #
+    # @example Page a Collection's whole subtree of Works
+    #   result = AtlasRb::Resource.descendant_works("col-456", per_page: 100)
+    #   result["works"].map { |w| w["noid"] }
+    #   result.dig("pagination", "pages")
+    def self.descendant_works(id, page: nil, per_page: nil, include_linked: nil, nuid: nil, on_behalf_of: nil)
+      params = {}
+      params[:page]           = page           if page
+      params[:per_page]       = per_page       if per_page
+      params[:include_linked] = include_linked unless include_linked.nil?
+      resp = connection(params, nuid, on_behalf_of: on_behalf_of)
+             .get('/resources/' + id + '/descendant_works')
+      return nil if resp.status == 404
+
+      AtlasRb::Mash.new(JSON.parse(resp.body))
+    end
+
     # Validate a MODS XML document against Atlas's schema *without* persisting it.
     #
     # Useful for surfacing validation errors in UIs before the user commits.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atlas_rb
 version: !ruby/object:Gem::Version
-  version: 1.8.8
+  version: 1.8.9
 platform: ruby
 authors:
 - David Cliff
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-07-05 00:00:00.000000000 Z
+date: 2026-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday