atlas_rb 1.6.3 → 1.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63326317e9bb9abcd730807bdfe9870d24685da7fec108474f676198ed1de200
-  data.tar.gz: 16a31a4c9708699c92f4651714594a3ead821a882cc4e958b0ae81a86b0c5146
+  metadata.gz: 19c01cf68a6a94d94dceff16d5e8ea00e147b8db2c6fd51f8d6c1e9b8ec36fac
+  data.tar.gz: 457092385fc63ed58a2c2e871983bfb2a62d2d69448a74c78796d6a6f14506be
 SHA512:
-  metadata.gz: 6236b86dd4a2b0c2c8740fb9479a9584a59fe1303464b7731ae955e0ceb5489e920d7a119d1bac6afb1535933310b7ccecee74d3da6a865a6bdb755a38a9c095
-  data.tar.gz: 0c80e8c9f82b3a05ba5560e703db3da1c1c10ceae61dd95a06c3e8368fa07a503e8a12bcb66d2ae5d0ed398af7386d54943cad754f319ef31dd9669149e8c490
+  metadata.gz: 2008dd0082b8de90ca4016a8a66c378bc88a6a6cc61b44070d9fcf9c9fd13ed5d21f81787dbd1b0131194b8edbd10eaf4904366c5e496452fd689fe2eedab429
+  data.tar.gz: 801b406750972c2dc014c4e202fcb53a2d204e554197c5594015f4dd0c0b60d58839ad6aab8b7c8659399082618483be9bc918543355f06d6a7ad3d125ed7107

data/.version

@@ -1 +1 @@
-1.6.3
+1.6.5

data/Gemfile.lock

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

data/lib/atlas_rb/collection.rb

@@ -44,6 +44,9 @@ module AtlasRb
     # @param xml_path [String, nil] optional path to a MODS XML file used to
     #   seed metadata. When given, the Collection is created and immediately
     #   patched with the metadata in the file.
+    # @param featured [Boolean] mark the Collection as a genre-showcase
+    #   ("Featured") Collection. Defaults to false. Use when provisioning a
+    #   Community's showcase set (loop create + featured: true).
     # @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).
@@ -53,11 +56,11 @@ module AtlasRb
     # @return [Hash] the created Collection payload (post-update if
     #   `xml_path` was supplied).
     #
-    # @example
-    #   AtlasRb::Collection.create("c-123", "/tmp/collection-mods.xml")
-    def self.create(id, xml_path = nil, nuid: nil, on_behalf_of: nil)
+    # @example A featured showcase collection
+    #   AtlasRb::Collection.create("c-123", featured: true)
+    def self.create(id, xml_path = nil, featured: false, nuid: nil, on_behalf_of: nil)
       result = AtlasRb::Mash.new(JSON.parse(
-        connection({ parent_id: id }, nuid, on_behalf_of: on_behalf_of).post(ROUTE)&.body
+        connection({ parent_id: id, featured: featured }, nuid, on_behalf_of: on_behalf_of).post(ROUTE)&.body
       ))["collection"]
       return result unless xml_path.present?
 
@@ -65,6 +68,27 @@ module AtlasRb
       find(result["id"], nuid: nuid, on_behalf_of: on_behalf_of)
     end
 
+    # Toggle the showcase "Featured" flag on an existing Collection.
+    #
+    # A resource-attribute write (not a MODS update), so it does not touch
+    # descriptive metadata. Cerberus reads the projected `featured_bsi` to
+    # badge the Collection in a community's browse.
+    #
+    # @param id [String] the Collection ID.
+    # @param featured [Boolean] the new flag value.
+    # @param nuid [String, nil] optional acting user's NUID.
+    # @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] the updated `"collection"` object, already unwrapped.
+    #
+    # @example
+    #   AtlasRb::Collection.set_featured("col-456", true)
+    def self.set_featured(id, featured, nuid: nil, on_behalf_of: nil)
+      AtlasRb::Mash.new(JSON.parse(
+        connection({ featured: featured }, nuid, on_behalf_of: on_behalf_of).patch(ROUTE + id)&.body
+      ))["collection"]
+    end
+
     # Move a Collection to a different parent Community.
     #
     # Wraps `PATCH /collections/<id>/parent` with a `parent_id` of the new

data/lib/atlas_rb/person.rb

@@ -7,30 +7,51 @@ module AtlasRb
   # `users.name` is frequently wrong and is clobbered on every login), plus
   # community affiliations.
   #
-  # Addressed by NUID, not NOID — the NUID is the correlation key consumers
-  # hold. So the positional `id` argument below is the person's **NUID**, and
-  # the `nuid:` / `on_behalf_of:` keywords keep their usual gem meaning (the
-  # acting principal). The one exception is {.create}, whose `nuid:` keyword is
-  # the *new person's* NUID (matching the gap's signature); the acting principal
-  # there comes from the ambient `AtlasRb.config.default_nuid`.
+  # Addressed by **NOID** (like Work/Collection) — the staff-facing NUID is kept
+  # server-side and never put in a public URL. So the positional `id` argument
+  # below is the person's **NOID**, and the `nuid:` / `on_behalf_of:` keywords
+  # keep their usual gem meaning (the acting principal). NUID stays the key only
+  # for {.create} (one Person per NUID — and there `nuid:` is the *new person's*
+  # NUID, acting principal coming from the ambient `AtlasRb.config.default_nuid`)
+  # and {.resolve} (the server-side name-resolution batch). {.list} is the
+  # NOID-keyed People-index source.
   #
   # Create / update / affiliation writes are :system + admin on the server; a
   # non-privileged caller gets a 403.
   class Person < Resource
     ROUTE = "/people/"
 
-    # Fetch a Person by NUID.
+    # Fetch a Person by NOID.
     #
-    # @param id [String] the person's NUID.
+    # @param id [String] the person's NOID.
     # @param nuid [String, nil] acting principal (signed into the assertion sub).
     # @param on_behalf_of [String, nil] acting-as target.
-    # @return [AtlasRb::Mash] the unwrapped `"person"` object.
+    # @return [AtlasRb::Mash] the unwrapped `"person"` object (carries the
+    #   server-side `nuid` for callers that need it, e.g. depositor gating).
     def self.find(id, nuid: nil, on_behalf_of: nil)
       AtlasRb::Mash.new(JSON.parse(
         connection({}, nuid, on_behalf_of: on_behalf_of).get(ROUTE + id)&.body
       ))["person"]
     end
 
+    # List people — the NOID-keyed People-index source. Returns the page's
+    # Persons (each with `noid`, `display_name`, and the server-side `nuid`), so
+    # a consumer builds the index and profiles entirely through atlas_rb without
+    # routing People through the catalog/Solr or exposing a NUID publicly.
+    #
+    # @param page [Integer, nil] 1-based page (server default when nil).
+    # @param per_page [Integer, nil] page size (server default when nil; capped
+    #   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.
+    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"]) }
+    end
+
     # Batch-resolve people to their authoritative display_name in one call
     # (supersedes the SSO users directory's resolve). Unresolved NUIDs drop.
     #
@@ -64,7 +85,7 @@ module AtlasRb
     # Edit a Person's authority fields. NUID is immutable and not patchable.
     # Only supplied fields are changed.
     #
-    # @param id [String] the person's NUID.
+    # @param id [String] the person's NOID.
     # @param display_name [String, nil]
     # @param bio [String, nil]
     # @param orcid [String, nil]
@@ -81,7 +102,7 @@ module AtlasRb
 
     # Add a community affiliation (idempotent; audited server-side).
     #
-    # @param id [String] the person's NUID.
+    # @param id [String] the person's NOID.
     # @param community_id [String] the community's NOID.
     # @param nuid [String, nil] acting principal.
     # @param on_behalf_of [String, nil] acting-as target.
@@ -96,7 +117,7 @@ module AtlasRb
 
     # Remove a community affiliation (tolerant; audited server-side).
     #
-    # @param id [String] the person's NUID.
+    # @param id [String] the person's NOID.
     # @param community_id [String] the community's NOID.
     # @param nuid [String, nil] acting principal.
     # @param on_behalf_of [String, nil] acting-as target.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: atlas_rb
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.6.5
 platform: ruby
 authors:
 - David Cliff