atlas_rb 1.16.0 → 1.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed32d60a2b3c2a562ee64d095a266c6b45848122ce4d75a0201c6736aeb52c2f
-  data.tar.gz: 229e5722c7b2036e490df5c06a5ad7afe496164fe7105a2ee232b7cb64f5d970
+  metadata.gz: 03b277e8683662db4b0809d548d274bce6e5cd51c64e242f606d0f911237ffe5
+  data.tar.gz: b010988a48817296d3e2ab24ae3ff4e5dcaa68239159e36d19cecfe826d85b64
 SHA512:
-  metadata.gz: e63d081a6b2f67297e95e2feb361ed232e585b3c22a84b68c0d35dd0a816aae1cfca0106613ddc9f097644bd8b02a098285ce48f7ee930126102037c2dff808c
-  data.tar.gz: 70931eed6c2ceaf7fd901a07005df4dec7570a5f90649b0bfb277826f927922bfb3ad30f73a226254d8059fb1c82f4e114e11a4a7977ddd1ff7d7e291e846d8f
+  metadata.gz: 6560e0da51abf54fc2f6de456814022573626b2528e0592f1539f23e29c2106c0d98978dc768cae8e5d305caf3401f83853477d75cd6409806549e87aa8b0fa5
+  data.tar.gz: 3352534d5a2aeb187db42d36c8adf621666612023b36a65fb904b85c0aa9925430f7c897f9b67ce824969c04730b547bfc578ae4c1f3b7da8f064b815e48c4d7

data/.version

@@ -1 +1 @@
-1.16.0
+1.16.1

data/Gemfile.lock

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

data/lib/atlas_rb/collection.rb

@@ -220,6 +220,9 @@ module AtlasRb
     # @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.
+    # @param origin [String, nil] free-text tag naming the surface that made this
+    #   edit (e.g. `"metadata_form"`, `"xml_editor"`). Atlas records it verbatim
+    #   on the audit event; omit it and the event carries no origin.
     # @return [Hash] the parsed JSON response from the patch.
     # @raise [AtlasRb::NotFoundError] if Atlas answers `404` — the id names no such
     #   resource, so the write did not happen.
@@ -228,12 +231,13 @@ module AtlasRb
     #
     # @example
     #   AtlasRb::Collection.update("col-456", "/tmp/collection-mods.xml")
-    def self.update(id, xml_path, nuid: nil, on_behalf_of: nil)
-      payload = { binary: Faraday::Multipart::FilePart.new(File.open(xml_path),
-                                                           "application/xml",
-                                                           File.basename(xml_path)) }
+    #
+    # @example Recording which editing surface made the change
+    #   AtlasRb::Collection.update("col-456", "/tmp/collection-mods.xml", origin: "xml_editor")
+    def self.update(id, xml_path, nuid: nil, on_behalf_of: nil, origin: nil)
       AtlasRb::Mash.new(write_resource(
-        multipart(nuid, on_behalf_of: on_behalf_of).patch(ROUTE + id, payload)
+        multipart(nuid, on_behalf_of: on_behalf_of)
+          .patch(ROUTE + id, mods_upload_payload(xml_path, origin))
       ))
     end
 

data/lib/atlas_rb/community.rb

@@ -199,6 +199,9 @@ module AtlasRb
     # @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.
+    # @param origin [String, nil] free-text tag naming the surface that made this
+    #   edit (e.g. `"metadata_form"`, `"xml_editor"`). Atlas records it verbatim
+    #   on the audit event; omit it and the event carries no origin.
     # @return [Hash] the parsed JSON response from the patch.
     # @raise [AtlasRb::NotFoundError] if Atlas answers `404` — the id names no such
     #   resource, so the write did not happen.
@@ -207,12 +210,13 @@ module AtlasRb
     #
     # @example
     #   AtlasRb::Community.update("c-123", "/tmp/community-mods.xml")
-    def self.update(id, xml_path, nuid: nil, on_behalf_of: nil)
-      payload = { binary: Faraday::Multipart::FilePart.new(File.open(xml_path),
-                                                           "application/xml",
-                                                           File.basename(xml_path)) }
+    #
+    # @example Recording which editing surface made the change
+    #   AtlasRb::Community.update("c-123", "/tmp/community-mods.xml", origin: "xml_editor")
+    def self.update(id, xml_path, nuid: nil, on_behalf_of: nil, origin: nil)
       AtlasRb::Mash.new(write_resource(
-        multipart(nuid, on_behalf_of: on_behalf_of).patch(ROUTE + id, payload)
+        multipart(nuid, on_behalf_of: on_behalf_of)
+          .patch(ROUTE + id, mods_upload_payload(xml_path, origin))
       ))
     end
 

data/lib/atlas_rb/resource.rb

@@ -431,5 +431,29 @@ module AtlasRb
       JSON.parse(resp.body)
     end
     private_class_method :write_resource
+
+    # The multipart body behind {Work.update} / {Collection.update} /
+    # {Community.update}: the MODS document, plus the optional `origin` tag
+    # naming the surface that produced the edit.
+    #
+    # Atlas records `origin` verbatim on the audit event and never branches on
+    # it, so a host names its own surfaces (Cerberus sends `metadata_form`,
+    # `advanced_form`, `xml_editor`). A `nil` origin is left out of the body
+    # entirely rather than sent empty, so the audit event of a host that does
+    # not set one looks exactly like every event recorded before the field
+    # existed.
+    #
+    # @param xml_path [String] path to a MODS XML file on disk.
+    # @param origin [String, nil] the edit-origin tag, or `nil` to send none.
+    # @return [Hash] the multipart payload.
+    # @api private
+    def self.mods_upload_payload(xml_path, origin)
+      payload = { binary: Faraday::Multipart::FilePart.new(File.open(xml_path),
+                                                           "application/xml",
+                                                           File.basename(xml_path)) }
+      payload[:origin] = origin.to_s unless origin.nil? || origin.to_s.empty?
+      payload
+    end
+    private_class_method :mods_upload_payload
   end
 end

data/lib/atlas_rb/work.rb

@@ -358,6 +358,9 @@ module AtlasRb
     # @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.
+    # @param origin [String, nil] free-text tag naming the surface that made this
+    #   edit (e.g. `"metadata_form"`, `"xml_editor"`). Atlas records it verbatim
+    #   on the audit event; omit it and the event carries no origin.
     # @return [Hash] the parsed JSON response from the patch.
     # @raise [AtlasRb::NotFoundError] if Atlas answers `404` — the id names no such
     #   resource, so the write did not happen.
@@ -366,12 +369,13 @@ module AtlasRb
     #
     # @example
     #   AtlasRb::Work.update("w-789", "/tmp/work-mods.xml")
-    def self.update(id, xml_path, nuid: nil, on_behalf_of: nil)
-      payload = { binary: Faraday::Multipart::FilePart.new(File.open(xml_path),
-                                                           "application/xml",
-                                                           File.basename(xml_path)) }
+    #
+    # @example Recording which editing surface made the change
+    #   AtlasRb::Work.update("w-789", "/tmp/work-mods.xml", origin: "xml_editor")
+    def self.update(id, xml_path, nuid: nil, on_behalf_of: nil, origin: nil)
       AtlasRb::Mash.new(write_resource(
-        multipart(nuid, on_behalf_of: on_behalf_of).patch(ROUTE + id, payload)
+        multipart(nuid, on_behalf_of: on_behalf_of)
+          .patch(ROUTE + id, mods_upload_payload(xml_path, origin))
       ))
     end
 

metadata

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