atlas_rb 0.0.94 → 0.0.97

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed41f31beac084721efa710b8ed828897ee1634ce3dd399171180e7ed9cb7111
-  data.tar.gz: 66066b767f77db9265294fdf019c2e35dd6b795de3f9c0b5509affeb9f11e39f
+  metadata.gz: 9b6ef40045a79aa04b9ca98e80e92a456ae933f5cbad55772d7de9c73786480d
+  data.tar.gz: 23c2f7a59045c1e1d7ec268fcaa2f47578f12e1a4ff4d7e21ab16a983e8c501b
 SHA512:
-  metadata.gz: 9bffda9eb2af9d591e28c245ee041375d4e0dc0d884c26a86caf6fc1433c4dad1534a5e804f18a7b4b9a69cb03f1d679d96df7358d66c59357ad3830d5c5c04e
-  data.tar.gz: 53fd40e34d0ea636d3b987f9739f364bb9528453f3514b2bb107dcc8db29ddaa28fbbe2380c330a77478c2c574ecb39e76ca6259998217fe896fe11f32255df8
+  metadata.gz: 743d6f4b3e107a41597faca5108f7bfaefc2fae92c0efbc3ea2668cbd043206f104f095f87b722bd90bb23a95b3d2de0f90d549ffade362d4e1ee983163b8c90
+  data.tar.gz: 64bbc84b852c22d6d4894b1f59e2809ada532d8fc31790eccd2615756ac7c11905608e589a981940bfb1d6beaccd75bc4f3ba801c0e4fc6c1665dc9f7ffd53ba

data/.version

@@ -1 +1 @@
-0.0.94
+0.0.97

data/Gemfile.lock

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

data/README.md

@@ -123,7 +123,7 @@ work       = AtlasRb::Work.create(collection.id,      "/tmp/work-mods.xml")
 blob = AtlasRb::Blob.create(work.id, "/tmp/upload.tmp", "thesis.pdf")
 
 # 3. List everything attached to the work.
-AtlasRb::Work.files(work.id)
+AtlasRb::Work.assets(work.id)
 
 # 4. Stream the binary back without buffering it in memory.
 File.open("out.pdf", "wb") do |f|

data/lib/atlas_rb/collection.rb

@@ -125,7 +125,12 @@ module AtlasRb
       AtlasRb::Mash.new(JSON.parse(multipart({}).patch(ROUTE + id, payload)&.body))
     end
 
-    # Patch individual metadata fields without uploading a full MODS document.
+    # Patch individual descriptive-metadata fields without uploading a
+    # full MODS document.
+    #
+    # Scoped to user-authored descriptive metadata only. Programmatic
+    # writes of machine-set Delegate URIs (thumbnails) have their own
+    # purpose-specific endpoint — see {.set_thumbnails}.
     #
     # @param id [String] the Collection ID.
     # @param values [Hash] field-level metadata updates.
@@ -137,6 +142,33 @@ module AtlasRb
       AtlasRb::Mash.new(JSON.parse(connection({ metadata: values }).patch(ROUTE + id)&.body))
     end
 
+    # Attach the three thumbnail/preview Delegate URIs to a Collection.
+    #
+    # Collection-level mirror of {Work.set_thumbnails}. Atlas dispatches
+    # each non-blank URI to its matching Delegate role
+    # (`thumbnail_image` / `thumbnail_image_2x` / `preview_image`) via
+    # `DelegateUpdater`. Missing keys are left untouched.
+    #
+    # @param id [String] the Collection ID.
+    # @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.
+    # @return [AtlasRb::Mash] the parsed JSON response.
+    #
+    # @example
+    #   AtlasRb::Collection.set_thumbnails(
+    #     "col-456",
+    #     thumbnail:    "https://iiif.example.edu/iiif/3/c.jp2/full/!85,85/0/default.jpg",
+    #     thumbnail_2x: "https://iiif.example.edu/iiif/3/c.jp2/full/!170,170/0/default.jpg",
+    #     preview:      "https://iiif.example.edu/iiif/3/c.jp2/full/500,/0/default.jpg"
+    #   )
+    def self.set_thumbnails(id, thumbnail: nil, thumbnail_2x: nil, preview: nil)
+      body = { thumbnail: thumbnail, thumbnail_2x: thumbnail_2x, preview: preview }.compact
+      AtlasRb::Mash.new(JSON.parse(
+        connection({}).patch(ROUTE + id + '/thumbnails', JSON.dump(body))&.body
+      ))
+    end
+
     # Fetch the Collection's MODS representation in the requested format.
     #
     # @param id [String] the Collection ID.

data/lib/atlas_rb/community.rb

@@ -130,7 +130,12 @@ module AtlasRb
       AtlasRb::Mash.new(JSON.parse(multipart({}).patch(ROUTE + id, payload)&.body))
     end
 
-    # Patch individual metadata fields without uploading a full MODS document.
+    # Patch individual descriptive-metadata fields without uploading a
+    # full MODS document.
+    #
+    # Scoped to user-authored descriptive metadata only. Programmatic
+    # writes of machine-set Delegate URIs (thumbnails) have their own
+    # purpose-specific endpoint — see {.set_thumbnails}.
     #
     # @param id [String] the Community ID.
     # @param values [Hash] field-level metadata updates (shape determined by
@@ -143,6 +148,33 @@ module AtlasRb
       AtlasRb::Mash.new(JSON.parse(connection({ metadata: values }).patch(ROUTE + id)&.body))
     end
 
+    # Attach the three thumbnail/preview Delegate URIs to a Community.
+    #
+    # Community-level mirror of {Work.set_thumbnails}. Atlas dispatches
+    # each non-blank URI to its matching Delegate role
+    # (`thumbnail_image` / `thumbnail_image_2x` / `preview_image`) via
+    # `DelegateUpdater`. Missing keys are left untouched.
+    #
+    # @param id [String] the Community ID.
+    # @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.
+    # @return [AtlasRb::Mash] the parsed JSON response.
+    #
+    # @example
+    #   AtlasRb::Community.set_thumbnails(
+    #     "c-123",
+    #     thumbnail:    "https://iiif.example.edu/iiif/3/m.jp2/full/!85,85/0/default.jpg",
+    #     thumbnail_2x: "https://iiif.example.edu/iiif/3/m.jp2/full/!170,170/0/default.jpg",
+    #     preview:      "https://iiif.example.edu/iiif/3/m.jp2/full/500,/0/default.jpg"
+    #   )
+    def self.set_thumbnails(id, thumbnail: nil, thumbnail_2x: nil, preview: nil)
+      body = { thumbnail: thumbnail, thumbnail_2x: thumbnail_2x, preview: preview }.compact
+      AtlasRb::Mash.new(JSON.parse(
+        connection({}).patch(ROUTE + id + '/thumbnails', JSON.dump(body))&.body
+      ))
+    end
+
     # Fetch the Community's MODS representation in the requested format.
     #
     # @param id [String] the Community ID.

data/lib/atlas_rb/work.rb

@@ -177,7 +177,13 @@ module AtlasRb
       AtlasRb::Mash.new(JSON.parse(multipart({}).patch(ROUTE + id, payload)&.body))
     end
 
-    # Patch individual metadata fields without uploading a full MODS document.
+    # Patch individual descriptive-metadata fields without uploading a
+    # full MODS document.
+    #
+    # Scoped to user-authored descriptive metadata only. Programmatic
+    # writes of machine-set Delegate URIs (thumbnails, image
+    # derivatives) have their own purpose-specific endpoints — see
+    # {.set_thumbnails} and {.set_image_derivatives}.
     #
     # @param id [String] the Work ID.
     # @param values [Hash] field-level metadata updates.
@@ -189,6 +195,64 @@ module AtlasRb
       AtlasRb::Mash.new(JSON.parse(connection({ metadata: values }).patch(ROUTE + id)&.body))
     end
 
+    # Attach the three thumbnail/preview Delegate URIs to a Work.
+    #
+    # Purpose-specific PATCH for the `thumbnail_image` /
+    # `thumbnail_image_2x` / `preview_image` Delegate roles. Atlas
+    # dispatches each URI to its matching role via `DelegateUpdater`.
+    # Distinct from {.metadata} — these are machine-set IIIF URIs, not
+    # user-authored descriptive content. Missing keys are left
+    # untouched server-side; only the URIs you pass are upserted.
+    #
+    # @param id [String] the Work ID.
+    # @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.
+    # @return [AtlasRb::Mash] the parsed JSON response.
+    #
+    # @example
+    #   AtlasRb::Work.set_thumbnails(
+    #     "w-789",
+    #     thumbnail:    "https://iiif.example.edu/iiif/3/abc.jp2/full/!85,85/0/default.jpg",
+    #     thumbnail_2x: "https://iiif.example.edu/iiif/3/abc.jp2/full/!170,170/0/default.jpg",
+    #     preview:      "https://iiif.example.edu/iiif/3/abc.jp2/full/500,/0/default.jpg"
+    #   )
+    def self.set_thumbnails(id, thumbnail: nil, thumbnail_2x: nil, preview: nil)
+      body = { thumbnail: thumbnail, thumbnail_2x: thumbnail_2x, preview: preview }.compact
+      AtlasRb::Mash.new(JSON.parse(
+        connection({}).patch(ROUTE + id + '/thumbnails', JSON.dump(body))&.body
+      ))
+    end
+
+    # Attach the three image-derivative Delegate URIs to a Work.
+    #
+    # Sibling of {.set_thumbnails} for the `small_image` /
+    # `medium_image` / `large_image` Delegate roles. Atlas dispatches
+    # each URI to its matching role via `DelegateUpdater`. The
+    # resulting Delegates are downloadable and surface through
+    # {.assets} for the downloads UI. Missing keys are left untouched
+    # server-side; only the URIs you pass are upserted.
+    #
+    # @param id [String] the Work ID.
+    # @param small [String, nil] IIIF URI for the small derivative.
+    # @param medium [String, nil] IIIF URI for the medium derivative.
+    # @param large [String, nil] IIIF URI for the large derivative.
+    # @return [AtlasRb::Mash] the parsed JSON response.
+    #
+    # @example
+    #   AtlasRb::Work.set_image_derivatives(
+    #     "w-789",
+    #     small:  "https://iiif.example.edu/iiif/3/abc.jp2/full/800,/0/default.jpg",
+    #     medium: "https://iiif.example.edu/iiif/3/abc.jp2/full/1600,/0/default.jpg",
+    #     large:  "https://iiif.example.edu/iiif/3/abc.jp2/full/full/0/default.jpg"
+    #   )
+    def self.set_image_derivatives(id, small: nil, medium: nil, large: nil)
+      body = { small: small, medium: medium, large: large }.compact
+      AtlasRb::Mash.new(JSON.parse(
+        connection({}).patch(ROUTE + id + '/image_derivatives', JSON.dump(body))&.body
+      ))
+    end
+
     # List the assets attached to a Work — {Blob}s and {Delegate}s alike.
     #
     # Useful for building download UIs — the response includes enough to
@@ -208,11 +272,6 @@ module AtlasRb
       JSON.parse(connection({}).get(ROUTE + id + '/assets')&.body).map { |entry| AtlasRb::Mash.new(entry) }
     end
 
-    # @deprecated Use {.assets} instead. Will be removed in the next release.
-    def self.files(id)
-      assets(id)
-    end
-
     # Fetch the Work's MODS representation in the requested format.
     #
     # @param id [String] the Work ID.

metadata

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