atlas_rb 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58d8d5524e43dc1f14f172ea65bc1e78e55826a63c814f2ef517675d07732d08
-  data.tar.gz: 548d4cba38f7a2ef81f210612157ee36a56de6e15b5fcff367b4df1b73fda847
+  metadata.gz: b7340207635a0bb6db21f36e716000082d7d67fa3d62603388656bfe6d829c81
+  data.tar.gz: fbf68dbb0590ce6d05c3f75f6f879bb392dc45dcca488503b3c19ee57b823cb2
 SHA512:
-  metadata.gz: 745c494de1bd2da2a0048e2d3d562961bed6e48058b30da25dcbcdc0f9b2b7f3159c2b831508ac972a968dc6f02ee2a7f0a5cf11b85e2319277d1f200adf51f4
-  data.tar.gz: fe90db7467cdae4726357c2ba6d0d939d50c4174f1a3aa43ee8fd91adea19923fa321f53804fb52ed8db39eab22b578dadc6e542f77d54d1e1177e1effab0c53
+  metadata.gz: 1d07bb66ff2c4c7bf8c5f243fc01afe244e83d1bc53e9734ac22ea7b41990104c538ac53520cf47f4aa55195499ee6a9e0ed81c06fec2afad33b0f4076990bb5
+  data.tar.gz: 46bb9c90c94d5f5e2a3501693e2802ae6dfb84ccc4c5c68c5c99ee34e9c2b86203f20867a94251801f9d28e6d66387779e5f5a48ba3fb25439b257d208b3bbb0

data/.version

@@ -1 +1 @@
-1.11.0
+1.12.0

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 1.12.0
+
+### Changed — index rows arrive flat
+
+Atlas no longer wraps each row of a paginated index in its type name. `GET
+/works` used to hand back `{"work" => {...}}` per row; it now hands back the
+summary itself. The same applies to `/collections`, `/communities`, `/blobs`,
+`/file_sets`, `/people` and `/compilations`. A single resource is still wrapped
+in its type name — only rows inside a named collection changed.
+
+```ruby
+AtlasRb::Work.list(in_progress: true)["works"].map { |row| row["id"] }
+# was: row["work"]["id"]
+```
+
+`Person.list` and `Person.resolve` unwrapped the row for you, so their return
+value is unchanged. `Work.list` and `Compilation.list` return Atlas's envelope
+as-is, so callers reading `row["work"]` or `row["compilation"]` must drop that
+step.
+
+**This release requires Atlas 0.6.158 or newer.** Pairing 1.12.0 with an older
+Atlas makes `Person.list` and `Person.resolve` return rows of nils.
+
+### Fixed — `Work.list` documentation
+
+The envelope was described as matching `Community.children`, which returns a
+bare array of noid strings — a third shape. It carries `works` and
+`pagination`.
+
 ## 1.11.0
 
 ### Added — `Work.associations` / `.associate` / `.disassociate`

data/Gemfile.lock

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

data/lib/atlas_rb/compilation.rb

@@ -89,7 +89,8 @@ module AtlasRb
     #   header. Falls through to {AtlasRb.config}.default_on_behalf_of when
     #   omitted.
     # @return [AtlasRb::Mash] `{ "compilations" => [...], "pagination" => {...} }`.
-    #   Each entry wraps the same `"compilation"` object {.find} returns.
+    #   Each entry in `"compilations"` is a flat Compilation, carrying the
+    #   same keys {.find} returns.
     # @raise [AtlasRb::ForbiddenError] on a cross-owner listing without admin.
     #
     # @example My Sets

data/lib/atlas_rb/person.rb

@@ -55,12 +55,13 @@ module AtlasRb
     #   server-side).
     # @param nuid [String, nil] acting principal.
     # @param on_behalf_of [String, nil] acting-as target.
-    # @return [Array<AtlasRb::Mash>] one unwrapped `"person"` per row on the page.
+    # @return [Array<AtlasRb::Mash>] one Person per row on the page. Returns
+    #   the rows alone; the pagination block is dropped.
     def self.list(page: nil, per_page: nil, nuid: nil, on_behalf_of: nil)
       params = { page: page, per_page: per_page }.compact
       JSON.parse(
         connection(params, nuid, on_behalf_of: on_behalf_of).get(ROUTE)&.body
-      )["people"].map { |entry| AtlasRb::Mash.new(entry["person"]) }
+      )["people"].map { |entry| AtlasRb::Mash.new(entry) }
     end
 
     # Batch-resolve people to their authoritative display_name in one call
@@ -71,12 +72,12 @@ module AtlasRb
     # @param nuids [Array<String>] the NUIDs to resolve.
     # @param nuid [String, nil] acting principal.
     # @param on_behalf_of [String, nil] acting-as target.
-    # @return [Array<AtlasRb::Mash>] one unwrapped `"person"` per resolved NUID
-    #   (each carries `nuid`, `affiliated_community_ids`, and `personal_root_id`).
+    # @return [Array<AtlasRb::Mash>] one Person per resolved NUID (each carries
+    #   `nuid`, `affiliated_community_ids`, and `personal_root_id`).
     def self.resolve(nuids, nuid: nil, on_behalf_of: nil)
       JSON.parse(
         connection({ nuids: Array(nuids).join(",") }, nuid, on_behalf_of: on_behalf_of).get(ROUTE)&.body
-      )["people"].map { |entry| AtlasRb::Mash.new(entry["person"]) }
+      )["people"].map { |entry| AtlasRb::Mash.new(entry) }
     end
 
     # Create a Person. One Person per NUID — a duplicate NUID is a 409.

data/lib/atlas_rb/work.rb

@@ -37,9 +37,9 @@ module AtlasRb
 
     # List Works, paginated.
     #
-    # Wraps `GET /works`. Returns the full pagination envelope rather than a
-    # bare array so callers can page through results — the shape matches
-    # {AtlasRb::Community.children} and {AtlasRb::Collection.children}.
+    # Wraps `GET /works`. Returns the full pagination envelope — `works` plus
+    # `pagination` — rather than a bare array, so callers can page through
+    # results.
     #
     # @param in_progress [Boolean, nil] when set, filter to Works whose
     #   `in_progress` flag matches. Omit (or pass `nil`) for "all works".
@@ -57,8 +57,11 @@ module AtlasRb
     #   header. Falls through to {AtlasRb.config}.default_on_behalf_of when
     #   omitted.
     # @return [AtlasRb::Mash] `{ "works" => [...], "pagination" => {...} }`.
-    #   Each entry in `"works"` is a Work summary (`id`, `title`,
-    #   `description`, `in_progress`, `incomplete`, `incomplete_reason`).
+    #   Each entry in `"works"` is a flat Work summary (`id`, `title`,
+    #   `description`, `in_progress`, `incomplete`, `incomplete_reason`,
+    #   `handle`). `handle` is carried on the summary, not just the detail
+    #   read, so "which Works never minted?" is answerable from one page
+    #   rather than a fetch per row.
     #
     # @example Find stuck deposits
     #   AtlasRb::Work.list(in_progress: true)
@@ -220,11 +223,28 @@ module AtlasRb
     # "stuck" list.
     #
     # Idempotent on the server: calling `complete` on an already-complete
-    # Work is a no-op — Atlas simply re-saves with `in_progress: false`.
+    # Work is a no-op — Atlas re-saves with `in_progress: false`.
     # Atlas does not currently stamp a `completed_by` audit field; the
     # `nuid:` parameter is plumbed through for parity with the other
     # lifecycle bindings and in case Atlas adds completion audit later.
     #
+    # **This call also mints the Work's persistent identifier.** Atlas
+    # registers `<prefix>/<noid>` with its Handle service, pointed at the
+    # public Work page, and records it as `handle` on the Work. Two
+    # consequences for a caller:
+    #
+    # * **Minting can never fail the call.** A handle server that is down,
+    #   slow or unconfigured leaves `handle` null and the Work still
+    #   complete — never a non-2xx. So a `200` does not promise a handle:
+    #   the response body carries the Work, so check `handle` on it rather
+    #   than assuming success minted one.
+    # * **Re-completing is safe.** Atlas mints only when `handle` is empty,
+    #   and the underlying registration is keyed by handle name, so a repeat
+    #   call re-points rather than minting a second identifier.
+    #
+    # A deployment with no handle server configured mints nothing at all,
+    # which is the normal state for a stack brought up without it.
+    #
     # @param id [String] the Work ID.
     # @param nuid [String, nil] optional NUID of the acting user.
     # @param on_behalf_of [String, nil] optional NUID for the `On-Behalf-Of`

metadata

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