atlas_rb 0.0.88 → 0.0.91

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32ee794eeaed7d20594470df3855ba0d970c9c80e4f4bf8ce2f930e287a56f26
-  data.tar.gz: b1dd7c4007aa3353d5bcc21a2f4022b33f4986e28ed144a92c541cddd194b801
+  metadata.gz: aa8cb5bbcea60e8d4d85a3a8f3f71ec7e798a811221a53292f9481ab844f6047
+  data.tar.gz: 9d72d547fe715ba4c9cf168652b61606b3354ab1a7d929e221d9d7691be01db9
 SHA512:
-  metadata.gz: 6a61eb2b1217fa42f19bb37673e8244cd6544976446cf8f85657b25d928cebbc0c763b6e660984f71037c669f3638dd6a4657788cc628ed68e18cb52a0d99ccc
-  data.tar.gz: b721b72a80318001ce3e2e770dbc592665c1bad510c9db157bef04dcfc5b706978306ecc9dacec902817116c9b4127694769eb6c7b4d22763ee476bc76084d5a
+  metadata.gz: 951c36792f8fa9c3f767da1bea737df2165211402ca8c22577925c96c0af81bdaa24cdf77343d6d515625627550a5cebb4e02267e59e0e54ce2cb391e9000e52
+  data.tar.gz: 19e89a98c99c0819bcd3558ef27131c75a2510c57f318c9fe596a82b18abe866f24b1b69610a417f7d47b456de4dd275c88338bbacd43be8d3114e8993237582

data/.version

@@ -1 +1 @@
-0.0.88
+0.0.91

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    atlas_rb (0.0.88)
+    atlas_rb (0.0.91)
       faraday (~> 2.7)
       faraday-follow_redirects (~> 0.3.0)
       faraday-multipart (~> 1)
@@ -23,7 +23,7 @@ GEM
       net-http (~> 0.5)
     hashie (5.1.0)
       logger
-    json (2.19.4)
+    json (2.19.5)
     logger (1.7.0)
     multipart-post (2.4.1)
     net-http (0.9.1)

data/lib/atlas_rb/collection.rb

@@ -60,6 +60,41 @@ module AtlasRb
       connection({}).delete(ROUTE + id)
     end
 
+    # Tombstone (withdraw) a Collection.
+    #
+    # The Collection remains in Atlas storage but is marked as withdrawn:
+    # search and show pages return a withdrawn stub for every user. Atlas
+    # rejects the request with `422 has_live_children` if the Collection
+    # still has live (non-tombstoned) Works.
+    #
+    # @param id [String] the Collection ID.
+    # @param nuid [String] the acting user's NUID, stamped on the resource
+    #   as `tombstoned_by` for audit purposes.
+    # @return [Faraday::Response] the raw response. `200`/`204` on success;
+    #   `422` with `{"code":"has_live_children"}` if the Collection is not empty.
+    #
+    # @example
+    #   AtlasRb::Collection.tombstone("col-456", nuid: "000000002")
+    def self.tombstone(id, nuid:)
+      connection({}, nuid).post(ROUTE + id + '/tombstone')
+    end
+
+    # Restore a previously tombstoned Collection.
+    #
+    # **Operator-only.** Restoration is intentionally not exposed in any
+    # end-user UI; call this from a Rails console session (or a future
+    # admin panel) when the library has decided an object should come back.
+    #
+    # @param id [String] the Collection ID.
+    # @param nuid [String] the acting user's NUID.
+    # @return [Faraday::Response] the raw response.
+    #
+    # @example Operator restoring from `bundle exec rails console`
+    #   AtlasRb::Collection.restore("col-456", nuid: "000000002")
+    def self.restore(id, nuid:)
+      connection({}, nuid).post(ROUTE + id + '/restore')
+    end
+
     # List the Works in a Collection.
     #
     # The endpoint returns just the noids; resolve each through

data/lib/atlas_rb/community.rb

@@ -64,6 +64,41 @@ module AtlasRb
       connection({}).delete(ROUTE + id)
     end
 
+    # Tombstone (withdraw) a Community.
+    #
+    # The Community remains in Atlas storage but is marked as withdrawn:
+    # search and show pages return a withdrawn stub for every user. Atlas
+    # rejects the request with `422 has_live_children` if the Community
+    # still has live (non-tombstoned) members.
+    #
+    # @param id [String] the Community ID.
+    # @param nuid [String] the acting user's NUID, stamped on the resource
+    #   as `tombstoned_by` for audit purposes.
+    # @return [Faraday::Response] the raw response. `200`/`204` on success;
+    #   `422` with `{"code":"has_live_children"}` if the Community is not empty.
+    #
+    # @example
+    #   AtlasRb::Community.tombstone("c-123", nuid: "000000002")
+    def self.tombstone(id, nuid:)
+      connection({}, nuid).post(ROUTE + id + '/tombstone')
+    end
+
+    # Restore a previously tombstoned Community.
+    #
+    # **Operator-only.** Restoration is intentionally not exposed in any
+    # end-user UI; call this from a Rails console session (or a future
+    # admin panel) when the library has decided an object should come back.
+    #
+    # @param id [String] the Community ID.
+    # @param nuid [String] the acting user's NUID.
+    # @return [Faraday::Response] the raw response.
+    #
+    # @example Operator restoring from `bundle exec rails console`
+    #   AtlasRb::Community.restore("c-123", nuid: "000000002")
+    def self.restore(id, nuid:)
+      connection({}, nuid).post(ROUTE + id + '/restore')
+    end
+
     # List the immediate children (sub-Communities and Collections) of a Community.
     #
     # The endpoint returns just the noids; resolve each through

data/lib/atlas_rb/faraday_helper.rb

@@ -29,14 +29,16 @@ module AtlasRb
     # @example Fetching a community
     #   AtlasRb::Community.connection({}).get('/communities/abc123')
     def connection(params, nuid=nil)
+      headers = {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{ENV.fetch("ATLAS_TOKEN", nil)}"
+      }
+      headers["User"] = "NUID #{nuid}" if nuid
+
       Faraday.new(
         url: ENV.fetch("ATLAS_URL", nil),
         params: params,
-        headers: {
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{ENV.fetch("ATLAS_TOKEN", nil)}",
-          "User" => "NUID #{nuid}"
-        }
+        headers: headers
       ) do |f|
         f.response :follow_redirects
         f.adapter Faraday.default_adapter
@@ -62,12 +64,14 @@ module AtlasRb
     #   }
     #   AtlasRb::Blob.multipart({}).post('/files/', payload)
     def multipart(nuid=nil)
+      headers = {
+        "Authorization" => "Bearer #{ENV.fetch("ATLAS_TOKEN", nil)}"
+      }
+      headers["User"] = "NUID #{nuid}" if nuid
+
       Faraday.new(
         url: ENV.fetch("ATLAS_URL", nil),
-        headers: {
-          "Authorization" => "Bearer #{ENV.fetch("ATLAS_TOKEN", nil)}",
-          "User" => "NUID #{nuid}"
-        }
+        headers: headers
       ) do |f|
         f.request :multipart
         f.request :url_encoded

data/lib/atlas_rb/user.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module AtlasRb
+  # System-user binding for Atlas's find-or-create + group-replace endpoint.
+  #
+  # Used by Cerberus on its SSO callback: given an NUID and the IdP-asserted
+  # group set, find-or-create the matching User row and replace its groups
+  # with the supplied array (full replace, not merge — the IdP's assertion
+  # is authoritative).
+  #
+  # The endpoint is system-only; {.find_or_create} sends bearer-token auth
+  # and no `User:` header. Atlas returns 403 if any `User:` header is
+  # present.
+  class User
+    extend AtlasRb::FaradayHelper
+
+    # Find-or-create the User keyed on NUID and replace its groups.
+    #
+    # Idempotent on `nuid`. Authoritative on `groups`.
+    #
+    # @param nuid [String] the Northeastern University ID.
+    # @param groups [Array<String>] full group set; replaces, not merges.
+    # @param name [String, nil] forwarded if the caller (e.g. Cerberus's
+    #   SSO callback) has it; Atlas treats this field as optional.
+    # @param email [String, nil] forwarded if available; optional in Atlas.
+    # @return [AtlasRb::Mash] the resulting User record (`id`, `nuid`,
+    #   `name`, `email`, `role`, `groups`).
+    #
+    # @example From Cerberus's SSO callback
+    #   AtlasRb::User.find_or_create(nuid: "001234567",
+    #                                groups: ["northeastern:staff",
+    #                                         "drs:editors"],
+    #                                name: "Jane Doe",
+    #                                email: "j.doe@example.edu")
+    def self.find_or_create(nuid:, groups:, name: nil, email: nil)
+      body = { groups: groups }
+      body[:name] = name if name
+      body[:email] = email if email
+
+      response = connection({}).put("/users/by_nuid/#{nuid}", body.to_json)
+      AtlasRb::Mash.new(JSON.parse(response.body))["user"]
+    end
+  end
+end

data/lib/atlas_rb/work.rb

@@ -63,6 +63,41 @@ module AtlasRb
       connection({}).delete(ROUTE + id)
     end
 
+    # Tombstone (withdraw) a Work.
+    #
+    # The Work remains in Atlas storage along with its FileSets and Blobs,
+    # but is marked as withdrawn: search and show pages return a withdrawn
+    # stub for every user. Unlike Communities and Collections, Works are
+    # always tombstoneable regardless of how many files they hold — the
+    # FileSets and Blobs ride along.
+    #
+    # @param id [String] the Work ID.
+    # @param nuid [String] the acting user's NUID, stamped on the resource
+    #   as `tombstoned_by` for audit purposes.
+    # @return [Faraday::Response] the raw response.
+    #
+    # @example
+    #   AtlasRb::Work.tombstone("w-789", nuid: "000000002")
+    def self.tombstone(id, nuid:)
+      connection({}, nuid).post(ROUTE + id + '/tombstone')
+    end
+
+    # Restore a previously tombstoned Work.
+    #
+    # **Operator-only.** Restoration is intentionally not exposed in any
+    # end-user UI; call this from a Rails console session (or a future
+    # admin panel) when the library has decided an object should come back.
+    #
+    # @param id [String] the Work ID.
+    # @param nuid [String] the acting user's NUID.
+    # @return [Faraday::Response] the raw response.
+    #
+    # @example Operator restoring from `bundle exec rails console`
+    #   AtlasRb::Work.restore("w-789", nuid: "000000002")
+    def self.restore(id, nuid:)
+      connection({}, nuid).post(ROUTE + id + '/restore')
+    end
+
     # Replace a Work's metadata by uploading a MODS XML document.
     #
     # @param id [String] the Work ID.

data/lib/atlas_rb.rb

@@ -13,6 +13,7 @@ require_relative "atlas_rb/collection"
 require_relative "atlas_rb/work"
 require_relative "atlas_rb/file_set"
 require_relative "atlas_rb/blob"
+require_relative "atlas_rb/user"
 
 # Ruby client for the Atlas API — Northeastern University's institutional
 # digital repository.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atlas_rb
 version: !ruby/object:Gem::Version
-  version: 0.0.88
+  version: 0.0.91
 platform: ruby
 authors:
 - David Cliff
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-27 00:00:00.000000000 Z
+date: 2026-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -122,6 +122,7 @@ files:
 - lib/atlas_rb/file_set.rb
 - lib/atlas_rb/mash.rb
 - lib/atlas_rb/resource.rb
+- lib/atlas_rb/user.rb
 - lib/atlas_rb/version.rb
 - lib/atlas_rb/work.rb
 - sig/atlas_rb.rbs