atlas_rb 1.8.9 → 1.8.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fd50831467b065989eb0ec39af5f96b87622c5d0e161e0e6a5bdef61764505a
-  data.tar.gz: 55c36e14086a0fab3776771c797af98c9a431cca3f0b09f14ffac478ab58067c
+  metadata.gz: f6edbe1b05256eaab4d296a11f358bb7c7c3f9eaf439be4d48c41e75cfea4951
+  data.tar.gz: 8e042786b3c7636f7ad3676b9086a7db4ecfa8efed7ed1e91ac8ec4153dbb320
 SHA512:
-  metadata.gz: 7aea8252388df4686a31174ca154b7e76da1d97dd16a8509f773bd2b918dfb282ccb93960f5138b0581df9d32d20c45a0f8cf4a1475dda787468644e1d83cdbd
-  data.tar.gz: 25e3ecf9a7cc353645a8a1ad76700523bba185895fcf1df13b9b098549a45287fb3a9c41abb0eefa559f5e1d8b4c8c4b81b7c16e5e418f4cee39e5f0d554dc56
+  metadata.gz: 44832489abc704196a42b92d85304e886cc3951e711ea33980c9357cb515a4f3e674d7c75db989b7de5c7fbdc9ed36dcfc51a5eceb1d697371d3971227a7e5fa
+  data.tar.gz: 45d0ed33989b889a4a2f3ae3c9932b73f85daa3bc7f5ce9e859f7ea304bf97c71195694322e4e78cdcb537e8f50f37cd1b1d1fe6f7c76bc8458f780688e5c143

data/.version

@@ -1 +1 @@
-1.8.9
+1.8.11

data/Gemfile.lock

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

data/lib/atlas_rb/collection.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 module AtlasRb
-  # A grouping of {Work}s within a {Community}.
+  # A grouping of {Work}s and nested {Collection}s, parented by a {Community}
+  # or another Collection.
   #
-  # Collections are the leaf containers in the organizational tree — they hold
-  # Works directly. Every Collection has
-  # exactly one parent Community.
+  # Collections nest, exactly as they did in DRS v1: a Collection holds Works
+  # and/or child Collections, and its own parent may be a Community or a
+  # Collection (Community → Community|Collection, Collection → Collection|Work,
+  # Work → leaf). A consumer that flattens a subtree must recurse into
+  # descendant Collections rather than stopping at direct children.
   #
   # See also: {Community}, {Work}.
   class Collection < Resource
@@ -35,13 +38,13 @@ module AtlasRb
       body && AtlasRb::Mash.new(body)["collection"]
     end
 
-    # Create a new Collection under an existing Community.
+    # Create a new Collection under an existing Community or parent Collection.
     #
-    # **Note**: unlike {Community.create}, the `id` parameter here is the
-    # parent **Community** ID (not a parent Collection ID — Collections do
-    # not nest).
+    # The `id` parameter is the parent's ID — a **Community or a Collection**,
+    # since Collections nest (a Collection may hold child Collections as well as
+    # Works).
     #
-    # @param id [String] the parent Community ID.
+    # @param id [String] the parent Community or Collection ID.
     # @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.
@@ -63,7 +66,7 @@ module AtlasRb
       result = AtlasRb::Mash.new(JSON.parse(
         connection({ parent_id: id, featured: featured }, nuid, on_behalf_of: on_behalf_of).post(ROUTE)&.body
       ))["collection"]
-      return result unless xml_path.present?
+      return result if xml_path.to_s.empty?
 
       update(result["id"], xml_path, nuid: nuid, on_behalf_of: on_behalf_of)
       find(result["id"], nuid: nuid, on_behalf_of: on_behalf_of)
@@ -90,10 +93,10 @@ module AtlasRb
       ))["collection"]
     end
 
-    # Move a Collection to a different parent Community.
+    # Move a Collection to a different parent (Community or Collection).
     #
     # Wraps `PATCH /collections/<id>/parent` with a `parent_id` of the new
-    # Community. Atlas re-parents the Collection and synchronously cascades
+    # parent. 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`.
     #
@@ -101,7 +104,7 @@ module AtlasRb
     # 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 new_parent_id [String] the destination Community or Collection ID.
     # @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).
@@ -274,7 +277,7 @@ module AtlasRb
     def self.mods(id, kind = nil, nuid: nil, on_behalf_of: nil)
       # json default, html, xml
       connection({}, nuid, on_behalf_of: on_behalf_of).get(
-        ROUTE + id + '/mods' + (kind.present? ? ".#{kind}" : '')
+        ROUTE + id + '/mods' + (kind.to_s.empty? ? '' : ".#{kind}")
         )&.body
     end
   end

data/lib/atlas_rb/community.rb

@@ -64,7 +64,7 @@ module AtlasRb
       result = AtlasRb::Mash.new(JSON.parse(
         connection({ parent_id: id }, nuid, on_behalf_of: on_behalf_of).post(ROUTE)&.body
       ))["community"]
-      return result unless xml_path.present?
+      return result if xml_path.to_s.empty?
 
       update(result["id"], xml_path, nuid: nuid, on_behalf_of: on_behalf_of)
       find(result["id"], nuid: nuid, on_behalf_of: on_behalf_of)
@@ -263,7 +263,7 @@ module AtlasRb
     def self.mods(id, kind = nil, nuid: nil, on_behalf_of: nil)
       # json default, html, xml
       connection({}, nuid, on_behalf_of: on_behalf_of).get(
-        ROUTE + id + '/mods' + (kind.present? ? ".#{kind}" : '')
+        ROUTE + id + '/mods' + (kind.to_s.empty? ? '' : ".#{kind}")
         )&.body
     end
   end

data/lib/atlas_rb/faraday_helper.rb

@@ -36,9 +36,28 @@ module AtlasRb
   # If neither a signing key nor `ATLAS_JWT` is configured there is no relay
   # credential, so the transport raises {AtlasRb::ConfigurationError}.
   #
+  # ## Instrumentation
+  #
+  # Every builder brackets its request in an `ActiveSupport::Notifications`
+  # event named **`request.atlas_rb`** (Faraday's `:instrumentation`
+  # middleware, wired as the *outermost* handler so a redirect hop — e.g. the
+  # `/resources/:noid` NOID resolver — folds into one event per logical call
+  # rather than being double-counted). The payload is the Faraday `env`, so a
+  # subscriber reads `payload.method` / `payload.url` and the event's duration.
+  # This lets a host count/time Atlas round-trips (an N+1-over-HTTP detector)
+  # without reaching into gem internals. It is guarded on
+  # `defined?(ActiveSupport::Notifications)`: Rails hosts get the events; the
+  # headless BYO-JWT path (no AS loaded) is unaffected. With no subscriber
+  # attached the emit degrades to a listener lookup + `yield`, so it is safe to
+  # leave in the stack permanently — opt-in lives entirely on the consumer side.
+  #
   # The module is mixed in via `extend`, so its methods become class methods on
   # the host (e.g. `AtlasRb::Work.connection({})`).
   module FaradayHelper
+    # ActiveSupport::Notifications event name emitted per outbound Atlas request.
+    # A dedicated name (not Faraday's default `request.faraday`) so a host that
+    # also uses Faraday for other clients can subscribe to Atlas traffic alone.
+    INSTRUMENTATION_EVENT = "request.atlas_rb"
     # Wire contract Atlas enforces for relay-signing assertions (see Atlas
     # ApplicationController#verify_cerberus_assertion). iss/aud are fixed; the
     # short TTL bounds replay (Atlas allows 30s leeway on exp).
@@ -83,6 +102,7 @@ module AtlasRb
         params: params,
         headers: headers
       ) do |f|
+        instrument(f)
         f.use AtlasRb::Middleware::RaiseOnStaleResource
         f.use AtlasRb::Middleware::RaiseOnResourceError
         f.response :follow_redirects
@@ -123,6 +143,7 @@ module AtlasRb
         url: ENV.fetch("ATLAS_URL", nil),
         headers: headers
       ) do |f|
+        instrument(f)
         f.use AtlasRb::Middleware::RaiseOnStaleResource
         # Translate Atlas's verify-on-ingest 422 (fixity_mismatch /
         # unsupported_digest_algorithm) into a typed FixityMismatchError —
@@ -190,6 +211,7 @@ module AtlasRb
         params: params,
         headers: headers
       ) do |f|
+        instrument(f)
         f.response :follow_redirects
         f.adapter Faraday.default_adapter
       end
@@ -197,6 +219,20 @@ module AtlasRb
 
     private
 
+    # Register Faraday's instrumentation middleware as the OUTERMOST handler so
+    # each logical call emits exactly one {INSTRUMENTATION_EVENT} — a redirect
+    # hop (e.g. the `/resources/:noid` resolver) is bracketed with the request
+    # it redirects to, not counted twice. Guarded on
+    # `defined?(ActiveSupport::Notifications)` because Faraday defaults its
+    # instrumenter to that constant and would `NameError` at build time on the
+    # headless path where ActiveSupport isn't loaded; there, the emit is simply
+    # never wired and the transport is unaffected.
+    def instrument(builder)
+      return unless defined?(ActiveSupport::Notifications)
+
+      builder.request :instrumentation, name: INSTRUMENTATION_EVENT
+    end
+
     # Build the auth + identity headers shared by {#connection} and {#multipart}.
     # Precedence: ATLAS_JWT (BYO-JWT) > relay-signing. The acting nuid /
     # on_behalf_of fall through to the configured `default_nuid` /

data/lib/atlas_rb/resource.rb

@@ -244,7 +244,7 @@ module AtlasRb
     #   end
     def self.mods(id, kind = nil, nuid: nil, on_behalf_of: nil)
       connection({}, nuid, on_behalf_of: on_behalf_of).get(
-        '/resources/' + id + '/mods' + (kind.present? ? ".#{kind}" : '')
+        '/resources/' + id + '/mods' + (kind.to_s.empty? ? '' : ".#{kind}")
       )&.body
     end
 
@@ -320,7 +320,7 @@ module AtlasRb
     def self.mods_version(id, version_id, kind: nil, nuid: nil, on_behalf_of: nil)
       connection({}, nuid, on_behalf_of: on_behalf_of).get(
         '/resources/' + id + '/mods/versions/' + version_id +
-          (kind.present? ? ".#{kind}" : '')
+          (kind.to_s.empty? ? '' : ".#{kind}")
       )&.body
     end
 

data/lib/atlas_rb/version.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module AtlasRb
-  # Current gem version, read from the `.version` file at the repo root at load time.
-  VERSION = File.read(".version").strip
+  # Current gem version, read from the `.version` file at the gem root at load
+  # time. Resolved relative to this file (not the process CWD) so a standalone
+  # consumer — a headless BYO-JWT script run from anywhere — loads the gem's own
+  # version rather than raising ENOENT (or reading some unrelated `.version`).
+  VERSION = File.read(File.expand_path("../../.version", __dir__)).strip
 end

data/lib/atlas_rb/work.rb

@@ -124,7 +124,7 @@ module AtlasRb
         connection(params, nuid,
                    on_behalf_of: on_behalf_of, idempotency_key: idempotency_key).post(ROUTE)&.body
       ))["work"]
-      return result unless xml_path.present?
+      return result if xml_path.to_s.empty?
 
       update(result["id"], xml_path, nuid: nuid, on_behalf_of: on_behalf_of)
       find(result["id"], nuid: nuid, on_behalf_of: on_behalf_of)
@@ -559,7 +559,7 @@ module AtlasRb
     def self.mods(id, kind = nil, nuid: nil, on_behalf_of: nil)
       # json default, html, xml
       connection({}, nuid, on_behalf_of: on_behalf_of).get(
-        ROUTE + id + '/mods' + (kind.present? ? ".#{kind}" : '')
+        ROUTE + id + '/mods' + (kind.to_s.empty? ? '' : ".#{kind}")
         )&.body
     end
 

metadata

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