atlas_rb 1.6.3 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63326317e9bb9abcd730807bdfe9870d24685da7fec108474f676198ed1de200
-  data.tar.gz: 16a31a4c9708699c92f4651714594a3ead821a882cc4e958b0ae81a86b0c5146
+  metadata.gz: 5c1b8b2ec2ef5cadfe63ee85f618f8ef0ce394e9d7cc49637750250594ecd414
+  data.tar.gz: d59e9ac145408d33e00ddcc89f92cee6126b32e5c1959467a042080f14f49bb6
 SHA512:
-  metadata.gz: 6236b86dd4a2b0c2c8740fb9479a9584a59fe1303464b7731ae955e0ceb5489e920d7a119d1bac6afb1535933310b7ccecee74d3da6a865a6bdb755a38a9c095
-  data.tar.gz: 0c80e8c9f82b3a05ba5560e703db3da1c1c10ceae61dd95a06c3e8368fa07a503e8a12bcb66d2ae5d0ed398af7386d54943cad754f319ef31dd9669149e8c490
+  metadata.gz: 42992114ad5685f700294dd0f52d5c55507182d4ae0f907a2077c35a534cb7e8052a5d4a7a266f435ae1964341ca15d28c85688e8ff559ff60eb067c48994a7d
+  data.tar.gz: dc7a7df1a1fba8e4766a47c648c37f85a99244d105ebe6f564f09953fcda29837b111f41e730e871ca20afd032ed9db46dfe7dcd64e41badc550816d8c66f56e

data/.version

@@ -1 +1 @@
-1.6.3
+1.6.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    atlas_rb (1.6.3)
+    atlas_rb (1.6.4)
       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

metadata

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