atlas_rb 1.27.2 → 1.27.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bf07fbfa75e57be6651cc352fc2216f8c5e4029a68393018fa14b8e6a34e6aa
-  data.tar.gz: 63d66617e658bc0693c7a07afdf0b38cac2067f464b3ba1e0466b3a8d7d1860e
+  metadata.gz: 98ed27c0812607ce56681c0dd9b3ab4c17fc1224c7e3c36bf0aa5b4deb7527e9
+  data.tar.gz: 401ebcc7d93621d999c2b6441f0e470ee6b68c2081e0eb104e5f059330310004
 SHA512:
-  metadata.gz: 2071b3face694f62a03db93362462bf77381cfdcee77c138ff5a2baabe47f000d94ede673ca1d28f160d0348506a844346f920b71457669bae326769aa9286e3
-  data.tar.gz: 823ca671c648afad8c4a82111d658a691c6bf757e02cb942594c0a1c6afec2a1b6fda628c954ca909497c7168a6384f845fcf4ed229a1f470d5fabb1bac212c8
+  metadata.gz: 604f5e4183097244b9759cbf0caf188abf45ca936a7f9a07f3a476a4cb05dee0aa23f65357114bbdd9525e85d2c6ae746f0dba330f05cc4f3b978ae077778900
+  data.tar.gz: e9d53ba6883acc6decc743d4e480a682918c7f6db19e550e97d5455836a31250a29430ba846df03fab075cd410cff11b6c01ffe257522898c47c9f27d708b723

data/.version

@@ -1 +1 @@
-1.27.2
+1.27.4

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 1.27.4
+
+Requires an Atlas that serves `GET /works/:id/health_check` (0.6.232 or later).
+
+### Added — `AtlasRb::Work.health_check`
+
+Reads a Work's green/yellow/red health grade and the findings behind it, each
+with a severity, a machine-readable code, the NOID it is about and a message.
+Atlas never re-hashes the bytes for this call, so `fixity_checked` is always
+false. Admin and devolved-admin tiers only; anyone else gets a
+`ResourceError` with status 403. `nil` on a 404.
+
+## 1.27.3
+
+### Changed — `Metrics.latency` documentation
+
+Atlas 0.6.227 times each request from the top of its Rack stack, the same span
+as `x-runtime`, rather than the controller action alone. The YARD and README
+now say so. No code changed; against an older Atlas the figures are still
+action-only.
+
 ## 1.27.2
 
 Requires an Atlas that serves `GET /metrics/latency`.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    atlas_rb (1.27.2)
+    atlas_rb (1.27.4)
       faraday (~> 2.7)
       faraday-follow_redirects (~> 0.3.0)
       faraday-multipart (~> 1)
@@ -16,24 +16,24 @@ GEM
     base64 (0.3.0)
     connection_pool (2.5.5)
     diff-lcs (1.6.1)
-    faraday (2.14.4)
-      faraday-net_http (>= 2.0, < 3.5)
+    faraday (2.15.0)
+      faraday-net_http (>= 2.0, < 3.6)
       json
       logger
     faraday-follow_redirects (0.3.0)
       faraday (>= 1, < 3)
     faraday-multipart (1.2.0)
       multipart-post (~> 2.0)
-    faraday-net_http (3.4.4)
+    faraday-net_http (3.5.0)
       net-http (~> 0.5)
     faraday-net_http_persistent (2.3.1)
       faraday (~> 2.5)
       net-http-persistent (>= 4.0.4, < 5)
     faraday-retry (2.4.0)
       faraday (~> 2.0)
-    hashie (5.1.0)
+    hashie (5.2.0)
       logger
-    json (3.0.2)
+    json (3.1.0)
     jwt (2.10.3)
       base64
     logger (1.7.0)

data/README.md

@@ -871,9 +871,11 @@ latency["p95_ms"]         # => 98
 latency["slowest_actions"].first  # => { "action" => "works#mods", "calls" => 912, "p95_ms" => 188 }
 ```
 
-Atlas times each request from when Rails dispatches it until it returns, so
-the figures leave out the network and your own waiting. If you also time your
-Atlas calls, the difference is time spent on your side. The percentiles are
+Atlas times each request from when it enters Atlas's Rack stack until the app
+returns the response, the same span as the `x-runtime` header. The figures
+include time a request waited inside Atlas behind concurrent ones. They leave
+out time queued for a Puma thread, the network, and your own waiting. If you
+also time your Atlas calls, the difference is time spent on your side. The percentiles are
 interpolated from histogram buckets, so they are approximate.
 
 Like `Health.read`, it has a 5-second deadline and no retry. It raises

data/lib/atlas_rb/metrics.rb

@@ -15,11 +15,14 @@ module AtlasRb
 
     # How long Atlas took to serve its own requests (`GET /metrics/latency`).
     #
-    # Measured inside Atlas, from when Rails dispatches the action until it
-    # returns, so it leaves out the network and the caller's own waiting. A
-    # caller that also times its Atlas calls can subtract to see how much of
-    # its wait was its own. The percentiles are interpolated from histogram
-    # buckets, so they are approximate.
+    # Measured inside Atlas, from when a request enters its Rack stack until
+    # the app returns the response — the same span as the `x-runtime` header.
+    # So it includes time a request spent waiting inside Atlas behind
+    # concurrent ones, and leaves out time queued for a Puma thread, the
+    # network, and the caller's own waiting. A caller that also times its
+    # Atlas calls can subtract to see how much of its wait was its own. The
+    # percentiles are interpolated from histogram buckets, so they are
+    # approximate.
     #
     # No retry, and a fresh socket per call: like {AtlasRb::Health.read}, it is
     # polled rarely and should fail fast rather than hide a struggling Atlas.

data/lib/atlas_rb/work.rb

@@ -512,6 +512,48 @@ module AtlasRb
       end
     end
 
+    # Grade a Work's health green, yellow or red.
+    #
+    # Wraps `GET /works/<id>/health_check` (Atlas 0.6.232 or later). `grade` is
+    # `"green"` (viable), `"yellow"` (broken or degraded, nothing lost, so
+    # repairable in place) or `"red"` (bytes missing or corrupt, so it needs a
+    # restore or a re-deposit). Each of `findings` carries `severity`
+    # (`"advisory"`, `"repairable"` or `"fatal"`), a machine-readable `code`,
+    # the `subject` NOID it is about and a `message`. The codes are an open
+    # vocabulary: show one you do not recognise rather than failing on it.
+    #
+    # Atlas never re-hashes the bytes for this call, so `fixity_checked` is
+    # always `false`: a green means nothing is missing, not that the bytes
+    # were verified. Atlas allows it for the admin and devolved-admin tiers
+    # only; edit rights on the Work do not reach it.
+    #
+    # @param id [String] the Work 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).
+    # @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, nil] the report: `noid`, `grade`,
+    #   `fixity_checked` and `findings`.
+    #
+    #   `nil` when Atlas answers `404` — no such Work, or, with a misconfigured
+    #   `ATLAS_URL`, the route is not Atlas's at all.
+    # @raise [AtlasRb::ResourceError] on any non-2xx other than `404` / `410`
+    #   (a `403` for a caller below the delegate tier, a `5xx`, a proxy's
+    #   `503`), carrying Atlas's status and body so the failure is attributable
+    #   at the boundary.
+    # @example Show what needs repair
+    #   report = AtlasRb::Work.health_check("w-789", nuid: admin_nuid)
+    #   report.findings.reject { |f| f.severity == "advisory" }.each do |f|
+    #     puts "#{f.severity} #{f.code}: #{f.message}"
+    #   end
+    def self.health_check(id, nuid: nil, on_behalf_of: nil)
+      read_body(connection({}, nuid, on_behalf_of: on_behalf_of).get("#{ROUTE}#{id}/health_check")) do |body|
+        AtlasRb::Mash.new(body)
+      end
+    end
+
     # List a Work's page FileSets in order, each with its assets.
     #
     # Wraps `GET /works/<id>/file_sets` — the ordered, grouped sibling of

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: atlas_rb
 version: !ruby/object:Gem::Version
-  version: 1.27.2
+  version: 1.27.4
 platform: ruby
 authors:
 - David Cliff
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-10-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -136,7 +135,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description:
 email:
 - david.g.cliff@gmail.com
 executables: []
@@ -191,12 +189,10 @@ files:
 - lib/atlas_rb/version.rb
 - lib/atlas_rb/work.rb
 - sig/atlas_rb.rbs
-homepage:
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'false'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -211,8 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby gem for Atlas API.
 test_files: []