atlas_rb 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 195a3c85a8653e6835bb472b7cda45847e254057075694e37ecfa779efe2dd39
-  data.tar.gz: ea58c157df06abcfa8d3f4c6b18fd00e5f87892a8b4231b526ac3e60a8e13510
+  metadata.gz: 93e0688ad6097a3b6a36ed26db8c19d3416cb3c59beb3d95dd3cff61c6cdd176
+  data.tar.gz: 1af0ff155d288412bd6ab8a95fc50da55cfccd02d605b5bae1cf28cebdf33973
 SHA512:
-  metadata.gz: 2782eeb3e29454728e68e85144ba5046dd86d9b2ff58eea1cfd704bf2ce03e70f81e977a5b9ad5ffe4091d69d99225746ed2076e875891f358308038983cbfe6
-  data.tar.gz: 8dc180f51b17ffdb1feec818445573ec9c25eab3ee4e4245e9afb31f564a14dfbc93db40e3bd174a078e89f31bd57c240eb85b17f69828494ebaab3c0f23f9f4
+  metadata.gz: 44c8582605f238861c424a769fd4e788e08189edd969f3974d113a938f54ecce522e143ec0418cd813de958c1cbb6d9cd44b4796b6b9c190629af49a1d0417e9
+  data.tar.gz: 8ad34a6b44d4472ba300f8ef7b6c9f30d5d8674f0f69f7711e094d202ba07f2b428607b463ce8261e21e2fa5bbcbca865da9de3fb3af8e28d6e8906810037a12

data/.version

@@ -1 +1 @@
-1.1.2
+1.2.0

data/CHANGELOG.md

@@ -1,5 +1,48 @@
 # Changelog
 
+## 1.2.0
+
+### Added — Tree/DAG foundation bindings
+
+Thin Faraday mirrors for the two membership mutations Atlas shipped as
+part of the DRS "Tree/DAG foundation" (re-parenting and linked members).
+No client-side logic — the gem mirrors Atlas's wire and never queries
+Solr.
+
+- **`AtlasRb::Collection.reparent(id, new_parent_id, nuid: nil, on_behalf_of: nil)`**
+- **`AtlasRb::Community.reparent(id, new_parent_id, nuid: nil, on_behalf_of: nil)`**
+- **`AtlasRb::Work.reparent(id, new_collection_id, nuid: nil, on_behalf_of: nil)`**
+
+  Bind `PATCH /<type>/:id/parent` with a `{ parent_id }` body, moving a
+  resource to a new structural parent. Mirrors `create`'s single-parent-id
+  shape and returns the updated resource (same shape as `find`), reflecting
+  the new `a_member_of`. `Community.reparent` accepts `new_parent_id: nil`
+  to promote a Community to the top of the tree — the same way
+  `Community.create(nil)` makes a top-level Community; a `nil` destination
+  is rejected by Atlas for Works and Collections. Atlas enforces the
+  structural rules (type, cycle, tombstone) server-side and synchronously
+  cascades the ancestry index over descendants, surfacing violations as
+  `422`. The Work re-parent endpoint is included — Atlas shipped it (the
+  plan had flagged it as optional). All three endpoints use the shared
+  `parent_id` body key, including the Work one (not `collection_id`).
+
+- **`AtlasRb::Work.linked_members(id, nuid: nil, on_behalf_of: nil)`** —
+  `GET /works/:id/linked_members`.
+- **`AtlasRb::Work.add_linked_member(work_id, collection_id, nuid: nil, on_behalf_of: nil)`** —
+  `POST /works/:id/linked_members` with a `{ collection_id }` body.
+- **`AtlasRb::Work.remove_linked_member(work_id, collection_id, nuid: nil, on_behalf_of: nil)`** —
+  `DELETE /works/:id/linked_members/:collection_id` (Collection as a path
+  segment).
+
+  The DAG overlay: a Work has one structural parent (`a_member_of`) but
+  may additionally be a *linked* member of any number of other Collections
+  (`a_linked_member_of`). These manage that overlay without moving the
+  Work. All three return the Work's current linked Collection noids as a
+  bare array (mirroring `Collection.children`); the two mutations return
+  the list *after* the change, so no follow-up GET is needed.
+
+  Cerberus consumes these from the re-parent and "add to collection" UI.
+
 ## 1.1.1
 
 ### Added

data/Gemfile.lock

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

data/README.md

@@ -205,6 +205,47 @@ result["events"].first["action"] # => "update"
 Authorization errors (`401` / `403`) are not caught here — they surface as
 raw Faraday responses for the calling application's rescue layer.
 
+### Re-parenting
+
+`reparent` moves a resource to a new structural parent, binding Atlas's
+`PATCH /<type>/:id/parent` endpoint. It mirrors `create`'s "single parent
+id" shape and returns the updated resource (same shape as `find`), so the
+caller sees the new `a_member_of` without a follow-up GET. Atlas enforces
+the structural rules (type, cycle, tombstone guards) server-side and
+synchronously cascades the ancestry index over descendants; rule
+violations come back as `422`.
+
+```ruby
+AtlasRb::Collection.reparent("col-456", "c-999")  # move collection to community c-999
+AtlasRb::Work.reparent("w-789", "col-999")         # move work to collection col-999
+AtlasRb::Community.reparent("c-123", "c-999")      # nest community under c-999
+AtlasRb::Community.reparent("c-123", nil)          # promote community to top of tree
+```
+
+Only `Community.reparent` accepts a `nil` destination (move to the top of
+the tree) — the same way `Community.create(nil)` makes a top-level
+community. A `nil` destination for a Work or Collection is rejected by
+Atlas.
+
+### Linked members (the DAG overlay)
+
+A Work has exactly one structural parent (`a_member_of`, set by `create` /
+`reparent`) but may additionally be a *linked* member of any number of
+other Collections (`a_linked_member_of`). The linked-member bindings on
+`Work` manage that overlay without ever moving the Work:
+
+```ruby
+AtlasRb::Work.linked_members("w-789")                 # => ["col-456", "col-457"]
+AtlasRb::Work.add_linked_member("w-789", "col-456")    # => ["col-456"]  (updated list)
+AtlasRb::Work.remove_linked_member("w-789", "col-456") # => []           (updated list)
+```
+
+All three return the Work's current linked Collection noids as a bare
+array (mirroring `Collection.children`); the two mutations return the list
+*after* the change, so no follow-up `linked_members` GET is needed.
+Resolving those Collections' full contents is a Cerberus/Solr concern —
+this gem never queries the index.
+
 ## End-to-end example
 
 JSON responses come back as `AtlasRb::Mash` (a `Hashie::Mash` subclass), so

data/lib/atlas_rb/collection.rb

@@ -65,6 +65,39 @@ module AtlasRb
       find(result["id"], nuid: nuid, on_behalf_of: on_behalf_of)
     end
 
+    # Move a Collection to a different parent Community.
+    #
+    # Wraps `PATCH /collections/<id>/parent` with a `parent_id` of the new
+    # Community. Atlas re-parents the Collection and synchronously cascades
+    # the ancestry index over its Works; the structural rules (type, cycle,
+    # tombstone guards) are enforced server-side and surface as a `422`.
+    #
+    # Mirrors {.create}'s "single parent id" shape — same kwarg threading,
+    # the only difference is the verb and that the Collection already exists.
+    #
+    # @param id [String] the Collection ID to move.
+    # @param new_parent_id [String] the destination Community ID.
+    # @param nuid [String, nil] optional acting user's NUID, forwarded as the
+    #   `User:` header. Required for cerberus-token requests; legacy bearer
+    #   tokens still resolve without it.
+    # @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 [Hash] the updated `"collection"` object, already unwrapped —
+    #   the same shape {.find} returns, reflecting the new `a_member_of`.
+    # @raise [AtlasRb::StaleResourceError] if Atlas reports an optimistic-lock
+    #   conflict that exhausted its internal retry budget (HTTP 409 with
+    #   `error: "stale_resource"`).
+    #
+    # @example
+    #   AtlasRb::Collection.reparent("col-456", "c-999")
+    def self.reparent(id, new_parent_id, nuid: nil, on_behalf_of: nil)
+      AtlasRb::Mash.new(JSON.parse(
+        connection({ parent_id: new_parent_id }, nuid, on_behalf_of: on_behalf_of)
+          .patch(ROUTE + id + '/parent')&.body
+      ))["collection"]
+    end
+
     # Tombstone (withdraw) a Collection.
     #
     # The Collection remains in Atlas storage but is marked as withdrawn:

data/lib/atlas_rb/community.rb

@@ -69,6 +69,45 @@ module AtlasRb
       find(result["id"], nuid: nuid, on_behalf_of: on_behalf_of)
     end
 
+    # Move a Community to a different parent Community — or to the top of the
+    # tree.
+    #
+    # Wraps `PATCH /communities/<id>/parent` with a `parent_id` of the new
+    # parent Community. Pass `new_parent_id = nil` to promote the Community to
+    # a top-level node (no parent) — mirroring how {.create} treats a `nil`
+    # `id`; the gem omits the blank param and Atlas reads it as "move to top".
+    # Atlas re-parents the Community and synchronously cascades the ancestry
+    # index over its descendant Collections and Works; the structural rules
+    # (cycle, tombstone guards) are enforced server-side and surface as a
+    # `422`.
+    #
+    # @param id [String] the Community ID to move.
+    # @param new_parent_id [String, nil] the destination Community ID, or
+    #   `nil` to move the Community to the top of the tree.
+    # @param nuid [String, nil] optional acting user's NUID, forwarded as the
+    #   `User:` header. Required for cerberus-token requests; legacy bearer
+    #   tokens still resolve without it.
+    # @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 [Hash] the updated `"community"` object, already unwrapped —
+    #   the same shape {.find} returns, reflecting the new `a_member_of`.
+    # @raise [AtlasRb::StaleResourceError] if Atlas reports an optimistic-lock
+    #   conflict that exhausted its internal retry budget (HTTP 409 with
+    #   `error: "stale_resource"`).
+    #
+    # @example Move under another Community
+    #   AtlasRb::Community.reparent("c-123", "c-999")
+    #
+    # @example Promote to a top-level Community
+    #   AtlasRb::Community.reparent("c-123", nil)
+    def self.reparent(id, new_parent_id, nuid: nil, on_behalf_of: nil)
+      AtlasRb::Mash.new(JSON.parse(
+        connection({ parent_id: new_parent_id }, nuid, on_behalf_of: on_behalf_of)
+          .patch(ROUTE + id + '/parent')&.body
+      ))["community"]
+    end
+
     # Tombstone (withdraw) a Community.
     #
     # The Community remains in Atlas storage but is marked as withdrawn:

data/lib/atlas_rb/work.rb

@@ -129,6 +129,43 @@ module AtlasRb
       find(result["id"], nuid: nuid, on_behalf_of: on_behalf_of)
     end
 
+    # Move a Work to a different parent Collection.
+    #
+    # Wraps `PATCH /works/<id>/parent` with a `parent_id` of the new
+    # Collection. This changes the Work's single **structural** home
+    # (`a_member_of`) — distinct from {.add_linked_member}, which adds an
+    # additional *linked* membership without moving the Work. Atlas
+    # re-parents the Work and synchronously updates its ancestry index; the
+    # structural rules (type, cycle, tombstone guards) are enforced
+    # server-side and surface as a `422`.
+    #
+    # **Note**: like {.create}, the destination here is a **Collection**, but
+    # the underlying request still uses the shared `parent_id` body key (not
+    # `collection_id`) — every re-parent endpoint posts `{ parent_id }`.
+    #
+    # @param id [String] the Work ID to move.
+    # @param new_collection_id [String] the destination Collection ID.
+    # @param nuid [String, nil] optional acting user's NUID, forwarded as the
+    #   `User:` header. Required for cerberus-token requests; legacy bearer
+    #   tokens still resolve without it.
+    # @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 [Hash] the updated `"work"` object, already unwrapped — the
+    #   same shape {.find} returns, reflecting the new `a_member_of`.
+    # @raise [AtlasRb::StaleResourceError] if Atlas reports an optimistic-lock
+    #   conflict that exhausted its internal retry budget (HTTP 409 with
+    #   `error: "stale_resource"`).
+    #
+    # @example
+    #   AtlasRb::Work.reparent("w-789", "col-999")
+    def self.reparent(id, new_collection_id, nuid: nil, on_behalf_of: nil)
+      AtlasRb::Mash.new(JSON.parse(
+        connection({ parent_id: new_collection_id }, nuid, on_behalf_of: on_behalf_of)
+          .patch(ROUTE + id + '/parent')&.body
+      ))["work"]
+    end
+
     # Tombstone (withdraw) a Work.
     #
     # The Work remains in Atlas storage along with its FileSets and Blobs,
@@ -349,5 +386,101 @@ module AtlasRb
         ROUTE + id + '/mods' + (kind.present? ? ".#{kind}" : '')
         )&.body
     end
+
+    # List the Collections a Work is a *linked* member of.
+    #
+    # Wraps `GET /works/<id>/linked_members`. Linked membership is the DAG
+    # overlay — a Work has exactly one structural parent (`a_member_of`, set
+    # by {.create} / {.reparent}) but may additionally appear in any number
+    # of other Collections as a linked member (`a_linked_member_of`). This
+    # returns just those linked Collection noids; the structural parent is
+    # not included.
+    #
+    # @param id [String] the Work ID.
+    # @param nuid [String, nil] optional acting user's NUID, forwarded as the
+    #   `User:` header. Required for cerberus-token requests; legacy bearer
+    #   tokens still resolve without it.
+    # @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<String>] linked Collection noids (possibly empty). The
+    #   shape mirrors {Collection.children} — a bare array of ids, not an
+    #   envelope.
+    #
+    # @example
+    #   AtlasRb::Work.linked_members("w-789")
+    #   # => ["col-456", "col-457"]
+    def self.linked_members(id, nuid: nil, on_behalf_of: nil)
+      JSON.parse(
+        connection({}, nuid, on_behalf_of: on_behalf_of).get(ROUTE + id + '/linked_members')&.body
+      )
+    end
+
+    # Add a linked membership: surface a Work in an additional Collection.
+    #
+    # Wraps `POST /works/<id>/linked_members` with a `collection_id` body.
+    # This does **not** move the Work — its structural parent (`a_member_of`)
+    # is untouched; the Collection is added to `a_linked_member_of`. Atlas
+    # enforces two-sided authorization (edit on the Work *and* the target
+    # Collection) and the structural guards, surfacing failures as a `422`.
+    # Permissions are never changed by this call.
+    #
+    # @param work_id [String] the Work ID.
+    # @param collection_id [String] the Collection to link the Work into.
+    # @param nuid [String, nil] optional acting user's NUID, forwarded as the
+    #   `User:` header. Required for cerberus-token requests; legacy bearer
+    #   tokens still resolve without it.
+    # @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<String>] the Work's full set of linked Collection noids
+    #   *after* the add — the affected sub-resource, so no follow-up
+    #   {.linked_members} GET is needed.
+    # @raise [AtlasRb::StaleResourceError] if Atlas reports an optimistic-lock
+    #   conflict that exhausted its internal retry budget (HTTP 409 with
+    #   `error: "stale_resource"`).
+    #
+    # @example
+    #   AtlasRb::Work.add_linked_member("w-789", "col-456")
+    #   # => ["col-456"]
+    def self.add_linked_member(work_id, collection_id, nuid: nil, on_behalf_of: nil)
+      JSON.parse(
+        connection({ collection_id: collection_id }, nuid, on_behalf_of: on_behalf_of)
+          .post(ROUTE + work_id + '/linked_members')&.body
+      )
+    end
+
+    # Remove a linked membership: drop a Work from an additional Collection.
+    #
+    # Wraps `DELETE /works/<id>/linked_members/<collection_id>` — the
+    # Collection is passed as a path segment, not a body. This removes the
+    # Collection from the Work's `a_linked_member_of`; the structural parent
+    # (`a_member_of`) is untouched. Atlas enforces the same two-sided
+    # authorization as {.add_linked_member}. Removing a link that does not
+    # exist is a server-side concern; this binding simply forwards the call.
+    #
+    # @param work_id [String] the Work ID.
+    # @param collection_id [String] the linked Collection to remove.
+    # @param nuid [String, nil] optional acting user's NUID, forwarded as the
+    #   `User:` header. Required for cerberus-token requests; legacy bearer
+    #   tokens still resolve without it.
+    # @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<String>] the Work's remaining linked Collection noids
+    #   *after* the removal (possibly empty).
+    # @raise [AtlasRb::StaleResourceError] if Atlas reports an optimistic-lock
+    #   conflict that exhausted its internal retry budget (HTTP 409 with
+    #   `error: "stale_resource"`).
+    #
+    # @example
+    #   AtlasRb::Work.remove_linked_member("w-789", "col-456")
+    #   # => []
+    def self.remove_linked_member(work_id, collection_id, nuid: nil, on_behalf_of: nil)
+      JSON.parse(
+        connection({}, nuid, on_behalf_of: on_behalf_of)
+          .delete(ROUTE + work_id + '/linked_members/' + collection_id)&.body
+      )
+    end
   end
 end

metadata

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