atlas_rb 1.22.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 547ea9704ea6c2845a7573bd9518cca8d96b3a65eb3792642e3944f99ae1853a
-  data.tar.gz: 6c3754d4d4a6c509599e66c9062268b3c30c1b967a536b0231249a0010567c19
+  metadata.gz: 6c096f45a9cfbbd11efce0d0d79f193341ff5d77081f920580ca20e1621423f1
+  data.tar.gz: 885250be775307675bb65533467f33edd8630e70a4dc8c249b1bd06d7ba26e2f
 SHA512:
-  metadata.gz: b259694bf763b09743fc3c64fcd7f612202dec0249f35a8f3c1e211007235425de0c8d1f4c6235a5c9d3256022adb87cfffa9a43275eb25e29f2051579cc128e
-  data.tar.gz: 8e09316edfca23f4d966ca9c4e49d7d410711241e420fa0c4f01dfa1541c66d07907e6263640b1749b2b19203709441d3282f494b5526218c583116cc19b24e5
+  metadata.gz: 2d20b72fafff966ece826ff60782ebb33dad8826390ce682e663409affa982350fbfad3a1e1206c850a96f850b619a7964116c4bc8ef2377d2b4fc471726eb07
+  data.tar.gz: e8e92d11281fadf833efb1eaff9b3d41e65662202981bc4837c68adf00761c789d9aa42d82a8081caa3f010bbc455a57a4cf051458c5ebea0fa382f80f5b51bb

data/.version

@@ -1 +1 @@
-1.22.0
+1.24.0

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # Changelog
 
+## 1.24.0
+
+These bindings need Atlas 0.6.213 or later.
+
+### Added — `reason:` on `Resource.tombstone`
+
+```ruby
+AtlasRb::Resource.tombstone(work_id, reason: "Removed from view by legal order", nuid: admin_nuid)
+```
+
+The library's withdrawal policy requires a note saying why an object was
+removed, and fixes its wording. `reason:` must be one of the policy's five
+notes, word for word. Atlas answers `422` with `invalid_reason` for any other
+value, and the call returns that raw response as before. The note carries no
+date: read `tombstoned_at` for that.
+
+Community, Collection, Work and FileSet reads return the note as
+`tombstone_reason`, including the `410` body of a tombstoned read. A restore
+clears it. Omit the keyword to tombstone with no note, as before.
+
+## 1.23.0
+
+These bindings need Atlas 0.6.212 or later.
+
+### Added — `Work.withdrawn_assets`, the listing a Restore needs
+
+```ruby
+AtlasRb::Work.withdrawn_assets(work_id, nuid: admin_nuid).each do |asset|
+  AtlasRb::Admin::Resource.restore(asset.file_set, nuid: admin_nuid)
+end
+```
+
+A FileSet withdrawn with `Resource.tombstone` drops out of `Work.assets` and
+`Work.file_sets`, so nothing listed it. This read lists the assets of a Work's
+withdrawn FileSets, in the `Work.assets` shape plus the FileSet's
+`tombstoned_at` and `tombstoned_by`. Atlas allows it for the admin and
+devolved-admin tiers; anyone else gets a `403`, which raises `ResourceError`. A
+missing Work returns `nil`.
+
+### Documented — `file_set` on every `Work.assets` and `Work.file_sets` entry
+
+Each asset entry carries the NOID of the FileSet it is listed under. That is
+the id `Resource.tombstone` and `Admin::Resource.restore` take, so a caller no
+longer needs `Blob.ancestry` to find it. No reader change.
+
 ## 1.22.0
 
 These bindings need Atlas 0.6.211 or later.

data/Gemfile.lock

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

data/README.md

@@ -543,7 +543,7 @@ write. The whole surface:
 | `Resource.set_permissions(id, acl)` | `PATCH /resources/{id}/permissions` |
 | `Resource.set_thumbnails(id, thumbnail:, thumbnail_2x:, preview:)` | `PATCH /resources/{id}/thumbnails` |
 | `Resource.reparent(id, parent_id)` | `PATCH /resources/{id}/parent` |
-| `Resource.tombstone(id)` | `POST /resources/{id}/tombstone` |
+| `Resource.tombstone(id, reason:)` | `POST /resources/{id}/tombstone` |
 | `Admin::Resource.restore(id)` | `POST /resources/{id}/restore` |
 | `Admin::Resource.destroy(id, confirm: :i_understand)` | `DELETE /resources/{id}` |
 

data/lib/atlas_rb/resource_writes.rb

@@ -144,14 +144,23 @@ module AtlasRb
     # {Work.file_sets}. Atlas refuses a FileSet from anyone outside the admin and
     # devolved-admin tiers with `403`, even a user who can edit the Work.
     #
+    # `reason:` records why the resource was removed (Atlas 0.6.213 or later).
+    # It must be one of the removal notes the library's withdrawal policy
+    # allows, word for word; Atlas answers `422` with `invalid_reason` for any
+    # other value. The note carries no date: read `tombstoned_at` for that.
+    # The resource returns it as `tombstone_reason`, and a restore clears it.
+    #
     # @param id [String] the resource's NOID.
+    # @param reason [String, nil] one of the policy's removal notes, or `nil`
+    #   for none.
     # @param nuid [String, nil] the acting user's NUID, stamped on the resource
     #   as `tombstoned_by`.
     # @param on_behalf_of [String, nil] optional NUID for the `On-Behalf-Of`
     #   header.
     # @return [Faraday::Response] the raw response — read `status` yourself.
-    def self.tombstone(id, nuid: nil, on_behalf_of: nil)
-      connection({}, nuid, on_behalf_of: on_behalf_of).post('/resources/' + id + '/tombstone')
+    def self.tombstone(id, reason: nil, nuid: nil, on_behalf_of: nil)
+      connection({}, nuid, on_behalf_of: on_behalf_of)
+        .post('/resources/' + id + '/tombstone', { reason: reason }.compact.to_json)
     end
 
     # Atlas answers a write with the resource under its type key, matching what

data/lib/atlas_rb/work.rb

@@ -440,7 +440,11 @@ module AtlasRb
     # A Blob entry also carries `language` and `track_label`, set by {Blob.create}
     # and {Blob.update} for a caption or other text track and `nil` otherwise
     # (Atlas 0.6.211 or later). A FileSet withdrawn with {Resource.tombstone}
-    # drops out of this listing and {.file_sets}.
+    # drops out of this listing and {.file_sets}; {.withdrawn_assets} lists it.
+    #
+    # Every entry carries `file_set`, the NOID of the FileSet it is listed
+    # under (Atlas 0.6.212 or later). That is the id {Resource.tombstone} and
+    # {Admin::Resource.restore} take to withdraw or restore the file.
     #
     # @param id [String] the Work ID.
     # @param nuid [String, nil] optional acting user's NUID. On the relay-signing
@@ -465,6 +469,44 @@ module AtlasRb
       end
     end
 
+    # List the assets of a Work's withdrawn FileSets, so they can be restored.
+    #
+    # Wraps `GET /works/<id>/withdrawn_assets` (Atlas 0.6.212 or later). A
+    # FileSet withdrawn with {Resource.tombstone} drops out of {.assets} and
+    # {.file_sets}; this is the listing that still names it. Each entry has the
+    # {.assets} shape, including `file_set` (the id to pass to
+    # {Admin::Resource.restore}), plus the FileSet's `tombstoned_at` and
+    # `tombstoned_by`.
+    #
+    # Atlas allows it for the admin and devolved-admin tiers only, the same
+    # tiers that may tombstone and restore a FileSet.
+    #
+    # @param id [String] the Work ID.
+    # @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 [Array<AtlasRb::Mash>, nil] one entry per asset of a withdrawn
+    #   FileSet; `[]` when nothing is withdrawn.
+    #
+    #   `nil` when Atlas answers `404` — nothing is there to read, or, with a
+    #   misconfigured `ATLAS_URL`, the route is not Atlas's at all.
+    # @raise [AtlasRb::ResourceError] on any non-2xx other than `404` / `410`
+    #   (a `403` for a caller below the delegate tier, a `5xx`, a proxy's
+    #   `503`), carrying Atlas's status and body so the failure is attributable
+    #   at the boundary.
+    # @example Offer Restore for a removed caption
+    #   AtlasRb::Work.withdrawn_assets("w-789", nuid: admin_nuid).each do |a|
+    #     AtlasRb::Admin::Resource.restore(a.file_set, nuid: admin_nuid)
+    #   end
+    def self.withdrawn_assets(id, nuid: nil, on_behalf_of: nil)
+      read_body(connection({}, nuid, on_behalf_of: on_behalf_of).get(ROUTE + id + '/withdrawn_assets')) do |body|
+        body.map { |entry| AtlasRb::Mash.new(entry) }
+      end
+    end
+
     # List a Work's page FileSets in order, each with its assets.
     #
     # Wraps `GET /works/<id>/file_sets` — the ordered, grouped sibling of
@@ -473,7 +515,7 @@ module AtlasRb
     # (`null`-position) FileSets last; metadata and derivative-container
     # FileSets are excluded as entries. Each entry nests its downloadable
     # assets — the page's content Blobs plus any per-page IIIF Delegates —
-    # in the same polymorphic shape {.assets} returns.
+    # in the same polymorphic shape {.assets} returns, `file_set` included.
     #
     # This is the read a IIIF Presentation manifest assembler needs: the
     # response is **unpaginated** by design, so the whole page sequence

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atlas_rb
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.24.0
 platform: ruby
 authors:
 - David Cliff
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-29 00:00:00.000000000 Z
+date: 2026-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday