atlas_rb 1.27.3 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57da54874f04fe2d2b07757c8c062fe5a4e95aae8d843de69ed7bd53158b8122
-  data.tar.gz: af25098d8000917fac7e65121fc575dd38460ed23c2515e6309d2d230c9389ce
+  metadata.gz: c3b06407e57e241d5ddcd1a8ebef36efbe6c3e5c778e4d6fbdd09826694a8716
+  data.tar.gz: 3164c9a3a4a67944846a5fe81af5eda1095a757210db01bed15eafb6fb2ea369
 SHA512:
-  metadata.gz: 228ce5a5c9c2746628bea89760fd5b623d017a3511e2d8f59ce22401aa58499a2e82500da0fd76ba12dacd5e3d5fd772694f717b7312e98b0c2b8fec43c94ca2
-  data.tar.gz: 3b92e9cf2b59e766276a7654fa2769d5339b9b511f146aa429692b8f7d84dfa3a96b5575659b6ee923d64bc3b08bc1291f8245de75922b419ba9b276629a7043
+  metadata.gz: ca3e4e74dce382bf33b72d9a294779576249ac3f949e6821647dd9a79bbb50b6cf5719c98198263ceae99c4412fb5ff0a77ec568a44bd19bca8ac6833d1f6eb2
+  data.tar.gz: 32ebc73d97471c1fb8419bd4c2b2e9f61b0a81780b0f0cc842edad6c7adddcdb3e100e8c66119c8198b0afaadb23c306e909d8d1a8463aedd99a9bf2a8788beb

data/.version

@@ -1 +1 @@
-1.27.3
+1.28.0

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## 1.28.0
+
+Requires an Atlas that stores the preview image's size and placeholder (0.6.234
+or later). An older Atlas ignores the new keys.
+
+### Added — the preview's size and placeholder on `Resource.set_thumbnails`
+
+`preview_width:`, `preview_height:` and `preview_placeholder:` ride the PATCH
+body beside `preview:`. Each is optional, and a `nil` is not sent. Atlas writes
+them only with a `preview` URI and clears them when a `preview` arrives without
+them, so pass them on every preview write. A malformed value, or one sent
+without `preview`, raises `ResourceError` with status 422 and an `error` code.
+
+`Work.find`, `Collection.find` and `Community.find` return the three keys
+beside `"preview"`, each `nil` when Atlas holds none.
+
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    atlas_rb (1.27.3)
+    atlas_rb (1.28.0)
       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.1)
+      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/lib/atlas_rb/collection.rb

@@ -32,6 +32,9 @@ module AtlasRb
     #   omitted.
     # @return [Hash, nil] the `"collection"` object, already unwrapped from the
     #   JSON response, or `nil` when the Collection does not exist (`404`).
+    #   The preview image rides beside it: `"preview"` is its URI, and
+    #   `"preview_width"`, `"preview_height"` and `"preview_placeholder"` (base64
+    #   of a ~16px-wide JPEG) describe it. Each is `nil` when Atlas holds none.
     # @raise [AtlasRb::ResourceError] on any non-2xx other than `404` / `410` (e.g. an
     #   auth/validation error envelope), carrying Atlas's status + body.
     #

data/lib/atlas_rb/community.rb

@@ -30,6 +30,9 @@ module AtlasRb
     #   omitted.
     # @return [Hash, nil] the `"community"` object from the JSON response,
     #   already unwrapped, or `nil` when the Community does not exist (`404`).
+    #   The preview image rides beside it: `"preview"` is its URI, and
+    #   `"preview_width"`, `"preview_height"` and `"preview_placeholder"` (base64
+    #   of a ~16px-wide JPEG) describe it. Each is `nil` when Atlas holds none.
     # @raise [AtlasRb::ResourceError] on any non-2xx other than `404` / `410` (e.g. an
     #   auth/validation error envelope), carrying Atlas's status + body.
     #

data/lib/atlas_rb/resource_writes.rb

@@ -136,19 +136,39 @@ module AtlasRb
     #
     # Only the URIs you pass are upserted; an omitted key is left untouched.
     #
+    # The preview's size and placeholder are written only with `preview`, and
+    # Atlas answers `422` for one sent without it. A `preview` sent without them
+    # clears the stored ones, so pass them on every preview write.
+    #
     # @param id [String] the resource's NOID.
     # @param thumbnail [String, nil] IIIF URI for the ~85² thumbnail.
     # @param thumbnail_2x [String, nil] IIIF URI for the ~170² 2x thumbnail.
     # @param preview [String, nil] IIIF URI for the ~500w preview image.
+    # @param preview_width [Integer, nil] pixel width of the image `preview`
+    #   serves. Send it with `preview_height`.
+    # @param preview_height [Integer, nil] pixel height of the image `preview`
+    #   serves. Send it with `preview_width`.
+    # @param preview_placeholder [String, nil] base64 of a ~16px-wide JPEG of
+    #   that image, at most 2048 characters. The bytes only, not a data URI.
     # @param nuid [String, nil] optional acting user's NUID.
     # @param on_behalf_of [String, nil] optional NUID for the `On-Behalf-Of`
     #   header.
     # @return [AtlasRb::Mash] the resource, unwrapped from its type key.
     # @raise [AtlasRb::NotFoundError] on `404` — the write did not happen.
     # @raise [AtlasRb::StaleResourceError] on an optimistic-lock conflict.
-    # @raise [AtlasRb::ResourceError] on any other non-2xx.
-    def self.set_thumbnails(id, thumbnail: nil, thumbnail_2x: nil, preview: nil, nuid: nil, on_behalf_of: nil)
-      body = { thumbnail: thumbnail, thumbnail_2x: thumbnail_2x, preview: preview }.compact
+    # @raise [AtlasRb::ResourceError] on any other non-2xx, including the `422`
+    #   whose `error` names a malformed size or placeholder.
+    #
+    # @example A preview with its size and placeholder
+    #   AtlasRb::Resource.set_thumbnails("w-789", preview: uri,
+    #                                    preview_width: 500, preview_height: 375,
+    #                                    preview_placeholder: Base64.strict_encode64(tiny_jpeg))
+    def self.set_thumbnails(id, thumbnail: nil, thumbnail_2x: nil, preview: nil,
+                            preview_width: nil, preview_height: nil, preview_placeholder: nil,
+                            nuid: nil, on_behalf_of: nil)
+      body = { thumbnail: thumbnail, thumbnail_2x: thumbnail_2x, preview: preview,
+               preview_width: preview_width, preview_height: preview_height,
+               preview_placeholder: preview_placeholder }.compact
       unwrap(write_resource(
                connection({}, nuid, on_behalf_of: on_behalf_of)
                  .patch('/resources/' + id + '/thumbnails', JSON.dump(body))

data/lib/atlas_rb/work.rb

@@ -29,6 +29,9 @@ module AtlasRb
     #   {AtlasRb.config}.default_on_behalf_of when omitted.
     # @return [Hash, nil] the `"work"` object, already unwrapped from the JSON
     #   response, or `nil` when the Work does not exist (`404`).
+    #   The preview image rides beside it: `"preview"` is its URI, and
+    #   `"preview_width"`, `"preview_height"` and `"preview_placeholder"` (base64
+    #   of a ~16px-wide JPEG) describe it. Each is `nil` when Atlas holds none.
     # @raise [AtlasRb::ResourceError] on any non-2xx other than `404` / `410` (e.g. an
     #   auth/validation error envelope), carrying Atlas's status + body.
     #
@@ -512,6 +515,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.3
+  version: 1.28.0
 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: []