iiif_print 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4050e3e2e6c79d5d93bc63e2801f75bb13a7a1985dc2729ead3c0a15c4855075
-  data.tar.gz: b0d627fa5b6d190d0fbdae66e2db116e77eb74bf3473630c008a61dd794ed600
+  metadata.gz: d1fb1a28565daaa498895ea28019b1a5d9cb16e01558872b4840e19ab002fb07
+  data.tar.gz: 76a5d7afeda6cb264d2a77e31ff0e60be1c8d2a416917907a4d848e3b8975e63
 SHA512:
-  metadata.gz: c9f52bc069331756409eae5f67b878b2801c46d14e44fa36804faed750cfb2c07c5159015e5e236c084b0dcf8e0d2412d2d907905c43a07feba068c475761160
-  data.tar.gz: 7f58c71b8f933df6cec597f766494091a3c33fcd4734a14118ee7213d80262d52ebd3196b452267136913dfcba3a614fbc81dfbf7399edacb44687a6defa7876
+  metadata.gz: '08d25b39fccf79fe3b147b35dd8eb7fff99ac9d66bb91426ea4c1b98a16009b539f48283850225725f8ebd1d62876f3d30ff61508722f09def19eb02b67f4b63'
+  data.tar.gz: ef3c25dca1cdc1ab648d90ec303ad56df9a26fc6df4358e610154634eccd934b64295d99c2611fd454b8321d761f7aca9bcde4263495ac2fdfc58cca8447bc61

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /app/samvera/hyrax-webapp
   specs:
-    iiif_print (3.1.0)
+    iiif_print (3.1.1)
       blacklight_iiif_search (>= 1.0, < 3.0)
       derivative-rodeo (~> 0.5)
       hyrax (>= 2.5, < 6)
@@ -76,19 +76,23 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.8.9)
+    addressable (2.9.0)
       public_suffix (>= 2.0.2, < 8.0)
     almond-rails (0.3.0)
       rails (>= 4.2)
+    anonymous_loader (0.1.2)
+      version_gem (~> 1.1, >= 1.1.13)
     arel (9.0.0)
     ast (2.4.2)
+    auth-sanitizer (0.2.2)
+      version_gem (~> 1.1, >= 1.1.10)
     autoprefixer-rails (10.4.16.0)
       execjs (~> 2)
     awesome_nested_set (3.9.0)
       activerecord (>= 4.0.0, < 8.2)
     aws-eventstream (1.4.0)
-    aws-partitions (1.1222.0)
-    aws-sdk-core (3.243.0)
+    aws-partitions (1.1262.0)
+    aws-sdk-core (3.252.0)
       aws-eventstream (~> 1, >= 1.3.0)
       aws-partitions (~> 1, >= 1.992.0)
       aws-sigv4 (~> 1.9)
@@ -96,15 +100,15 @@ GEM
       bigdecimal
       jmespath (~> 1, >= 1.6.1)
       logger
-    aws-sdk-kms (1.122.0)
-      aws-sdk-core (~> 3, >= 3.241.4)
+    aws-sdk-kms (1.129.0)
+      aws-sdk-core (~> 3, >= 3.248.0)
       aws-sigv4 (~> 1.5)
-    aws-sdk-s3 (1.215.0)
-      aws-sdk-core (~> 3, >= 3.243.0)
+    aws-sdk-s3 (1.226.0)
+      aws-sdk-core (~> 3, >= 3.248.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.5)
-    aws-sdk-sqs (1.111.0)
-      aws-sdk-core (~> 3, >= 3.241.4)
+    aws-sdk-sqs (1.116.0)
+      aws-sdk-core (~> 3, >= 3.248.0)
       aws-sigv4 (~> 1.5)
     aws-sigv4 (1.12.1)
       aws-eventstream (~> 1, >= 1.0.2)
@@ -118,7 +122,7 @@ GEM
       i18n
     bcrypt (3.1.21)
     benchmark (0.3.0)
-    bigdecimal (4.0.1)
+    bigdecimal (4.1.2)
     bindex (0.8.1)
     bixby (5.0.2)
       rubocop (= 1.28.2)
@@ -300,8 +304,9 @@ GEM
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
     erubi (1.12.0)
-    ethon (0.15.0)
+    ethon (0.18.0)
       ffi (>= 1.15.0)
+      logger
     execjs (2.9.1)
     factory_bot (4.11.1)
       activesupport (>= 3.0.0)
@@ -495,7 +500,7 @@ GEM
     json-schema (6.2.0)
       addressable (~> 2.8)
       bigdecimal (>= 3.1, < 5)
-    jwt (2.10.2)
+    jwt (2.10.3)
       base64
     kaminari (1.2.2)
       activesupport (>= 4.1.0)
@@ -584,7 +589,7 @@ GEM
     mime-types (3.7.0)
       logger
       mime-types-data (~> 3.2025, >= 3.2025.0507)
-    mime-types-data (3.2026.0303)
+    mime-types-data (3.2026.0414)
     mini_magick (4.13.2)
     mini_mime (1.1.5)
     mini_portile2 (2.8.5)
@@ -616,13 +621,16 @@ GEM
     nokogiri (1.15.5)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    oauth (1.1.3)
+    oauth (1.1.7)
+      auth-sanitizer (~> 0.2, >= 0.2.1)
       base64 (~> 0.1)
-      oauth-tty (~> 1.0, >= 1.0.6)
-      snaky_hash (~> 2.0)
-      version_gem (~> 1.1, >= 1.1.9)
-    oauth-tty (1.0.6)
-      version_gem (~> 1.1, >= 1.1.9)
+      oauth-tty (~> 1.0, >= 1.0.10)
+      snaky_hash (~> 2.0, >= 2.0.5)
+      version_gem (~> 1.1, >= 1.1.12)
+    oauth-tty (1.0.12)
+      anonymous_loader (~> 0.1, >= 0.1.1)
+      auth-sanitizer (~> 0.2, >= 0.2.2)
+      version_gem (~> 1.1, >= 1.1.12)
     oauth2 (1.4.11)
       faraday (>= 0.17.3, < 3.0)
       jwt (>= 1.0, < 3.0)
@@ -882,7 +890,7 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     slop (4.10.1)
-    snaky_hash (2.0.3)
+    snaky_hash (2.0.6)
       hashie (>= 0.1.0, < 6)
       version_gem (>= 1.1.8, < 3)
     solargraph (0.48.0)
@@ -955,8 +963,8 @@ GEM
       actionpack (>= 3.1)
       jquery-rails
       railties (>= 3.1)
-    typhoeus (1.5.0)
-      ethon (>= 0.9.0, < 0.16.0)
+    typhoeus (1.6.0)
+      ethon (>= 0.18.0)
     tzinfo (1.2.11)
       thread_safe (~> 0.1)
     uber (0.1.0)
@@ -979,7 +987,7 @@ GEM
       rdf-vocab
       reform (~> 2.2)
       reform-rails
-    version_gem (1.1.9)
+    version_gem (1.1.13)
     warden (1.2.9)
       rack (>= 2.0.9)
     web-console (3.7.0)

data/README.md

@@ -121,16 +121,50 @@ We created IiifPrint with an assumption of ActiveFedora.  However, as Hyrax now
 
 ### IIIF URL configuration
 
-If you set `EXTERNAL_IIIF_URL` in your environment, IiifPrint will use that URL as the root for your IIIF URLs. It will also switch from using the file set ID to using the file's checksum hex digest as the identifier. In Wings/Fedora mode the digest is stored as a `urn:sha1:HEX` string; in Valkyrie mode it is stored as a plain hex string — IiifPrint handles both automatically.
+If you set `EXTERNAL_IIIF_URL` in your environment, IiifPrint will use that URL as the root for your IIIF URLs and will build the IIIF identifier from the file's storage key rather than its Hyrax file set ID.
 
-This enables using serverless_iiif or Cantaloupe (referred to as the service) by pointing the service to the same S3 bucket that the repository writes uploaded files to. By setting it up that way you do not need the service to connect to Fedora or Hyrax at all — both natively support connecting to an S3 bucket to retrieve file content.
+This enables using serverless-iiif or Cantaloupe by pointing the service directly at the same S3 bucket the repository writes uploaded files to — no Fedora or Hyrax connection required.
 
-If your S3 bucket organises files under a folder prefix (e.g. a `staging/` or `production/` subfolder), set `IIIF_S3_FOLDER_PREFIX` to that prefix. IiifPrint will prepend it to the digest identifier and percent-encode the separator so the combined value is a single IIIF path segment:
+#### How the identifier is chosen
+
+The identifier depends on your persistence layer:
+
+**Valkyrie storage (e.g. Shrine + S3)**
+
+IiifPrint indexes a `storage_file_identifier` on each FileSet at ingest time. This is the storage backend's native key with its protocol prefix stripped — for example `shrine://file_set_id/uuid` becomes `file_set_id/uuid`, which is the S3 object key. This approach works with any Valkyrie storage adapter that writes to S3.
+
+Your IIIF service (serverless-iiif, Cantaloupe, etc.) must be configured to resolve identifiers as S3 object keys against the same bucket. For serverless-iiif this means setting `resolver_template` to `"%s"` so the identifier is used as-is.
+
+After enabling `EXTERNAL_IIIF_URL`, existing FileSets must be reindexed so their `storage_file_identifier` is populated in Solr. Until then the presenter falls back to the checksum digest (see below).
+
+**Wings/Fedora (ActiveFedora)**
+
+IiifPrint uses the file's checksum hex digest as the identifier. Fedora stores files in S3 using the SHA-1 digest as the object key, and stores the digest in Solr as `urn:sha1:HEX`; IiifPrint strips the `urn:sha1:` prefix automatically. No special resolver configuration is needed.
+
+**Fallback**
+
+If no `storage_file_identifier` is indexed for a FileSet (e.g. before reindexing, or on ActiveFedora), IiifPrint falls back to the checksum hex digest.
+
+#### Folder prefix
+
+If your S3 bucket organises files under a subfolder (e.g. `staging/` or `production/`), set `IIIF_S3_FOLDER_PREFIX` to that prefix. IiifPrint prepends it to the identifier and percent-encodes the separator so the combined value is a single IIIF path segment:
 
 ```
 EXTERNAL_IIIF_URL=https://iiif.example.org
 IIIF_S3_FOLDER_PREFIX=staging
-# → identifier used: staging%2F<hex-digest>
+# Valkyrie:  → identifier used: staging%2F<file_set_id/uuid>
+# Fedora:    → identifier used: staging%2F<sha1-hex>
+```
+
+#### Configuration via initializer
+
+These can also be set in `config/initializers/iiif_print.rb` instead of environment variables:
+
+```ruby
+IiifPrint.config do |config|
+  config.external_iiif_url     = 'https://iiif.example.org'
+  config.iiif_s3_folder_prefix = 'staging'
+end
 ```
 
 ### Model level configurations

data/app/indexers/concerns/iiif_print/file_set_indexer_decorator.rb

@@ -23,6 +23,7 @@ module IiifPrint
       # index for full text search
       solr_doc['all_text_tsimv'] = solr_doc['all_text_timv'] = all_text(object)
       solr_doc['digest_ssim'] = find_checksum(object)
+      solr_doc['storage_file_identifier_ss'] = find_storage_file_identifier(object)
     end
 
     def image?(object)
@@ -44,6 +45,15 @@ module IiifPrint
       digest.to_s
     end
 
+    def find_storage_file_identifier(object)
+      file = object.try(:original_file)
+      return unless file.is_a?(Hyrax::FileMetadata)
+      identifier = file.file_identifier.to_s
+      # Strip whatever protocol prefix the storage backend adds (e.g. shrine://, disk://)
+      # leaving the backend-specific path/key.
+      identifier.sub(%r{\A\w+://}, '').presence
+    end
+
     def all_text(object)
       file = object.original_file
       return unless file

data/app/models/concerns/iiif_print/solr_document_decorator.rb

@@ -50,6 +50,7 @@ SolrDocument.prepend(IiifPrint::SolrDocumentDecorator)
 SolrDocument.attribute :is_child, Hyrax::SolrDocument::Metadata::Solr::String, 'is_child_bsi'
 SolrDocument.attribute :split_from_pdf_id, Hyrax::SolrDocument::Metadata::Solr::String, 'split_from_pdf_id_ssi'
 SolrDocument.attribute :digest, Hyrax::SolrDocument::Metadata::Solr::String, 'digest_ssim'
+SolrDocument.attribute :storage_file_identifier, Hyrax::SolrDocument::Metadata::Solr::String, 'storage_file_identifier_ss'
 
 # @note These properties came from the newspaper_works gem.  They are configurable.
 SolrDocument.class_attribute :iiif_print_solr_field_names, default: %w[alternative_title genre

data/app/presenters/iiif_print/external_iiif_display_image_presenter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+require 'cgi'
+
+module IiifPrint
+  # Presenter for FileSets when an external IIIF server is configured.
+  # Returned by IiifManifestPresenter.for when IiifPrint.config.external_iiif_url is set.
+  # Overrides only the three methods that control URL construction.
+  class ExternalIiifDisplayImagePresenter < Hyrax::IiifManifestPresenter::DisplayImagePresenter
+    def display_image_url(_base_url = nil)
+      url_builder = Hyrax.config.iiif_image_url_builder
+      args = [latest_file_id, IiifPrint.config.external_iiif_url, Hyrax.config.iiif_image_size_default]
+      args << image_format(alpha_channels) if url_builder.arity == 4
+      url_builder.call(*args).gsub(%r{images/}, '')
+    end
+
+    def iiif_endpoint(_file_id = nil, _base_url: nil)
+      IIIFManifest::IIIFEndpoint.new(
+        File.join(IiifPrint.config.external_iiif_url, latest_file_id),
+        profile: Hyrax.config.iiif_image_compliance_level_uri
+      )
+    end
+
+    private
+
+    def latest_file_id
+      @latest_file_id ||= begin
+        hex = model.storage_file_identifier || digest_hex
+        return nil if hex.blank?
+
+        prefix = IiifPrint.config.iiif_s3_folder_prefix.presence
+        prefix ? CGI.escape("#{prefix}/#{hex}") : CGI.escape(hex)
+      end
+    end
+  end
+end

data/app/presenters/iiif_print/iiif_manifest_presenter/display_image_presenter_decorator.rb

@@ -1,109 +1,44 @@
-require 'cgi'
-
-# mixin to provide URL for IIIF Content Search service
 module IiifPrint
   module IiifManifestPresenter
-    # OVERRIDE: Hyrax v3.x
     module DisplayImagePresenterDecorator
-      extend ActiveSupport::Concern
-      # Extending the presenter to the base url which includes the protocol.
-      # We need the base url to render the facet links and normalize the interface.
+      # Hyrax defines attr_writer :hostname but not the reader; we add the full accessor.
       attr_accessor :base_url
 
-      # Extending this class because there is an #ability= but not #ability and this definition
-      # mirrors the Hyrax::IiifManifestPresenter#ability.
-      def ability
-        @ability ||= NullAbility.new
-      end
-
-      def display_image
-        return nil unless latest_file_id
-        return nil unless model.image?
-        return nil unless IiifPrint.config.default_iiif_manifest_version == 2
-
-        IIIFManifest::DisplayImage
-          .new(display_image_url(hostname),
-            format: image_format(alpha_channels),
-            width: width,
-            height: height,
-            iiif_endpoint: iiif_endpoint(latest_file_id, base_url: hostname))
-      end
-
-      # OVERRIDE: IIIF Hyrax AV v0.2 #display_content for prez 3 manifests
-      def display_content
-        return nil unless latest_file_id
-        return super unless model.image?
-
-        IIIFManifest::V3::DisplayContent
-          .new(display_image_url(hostname),
-            format: image_format(alpha_channels),
-            width: width,
-            height: height,
-            type: 'Image',
-            iiif_endpoint: iiif_endpoint(latest_file_id, base_url: hostname))
-      end
-
-      def display_image_url(base_url)
-        if ENV['EXTERNAL_IIIF_URL'].present?
-          # At the moment we are only concerned about Hyrax's default image url builder
-          iiif_image_url_builder(url_builder: Hyrax.config.iiif_image_url_builder)
-        else
-          super
-        end
-      end
+      # The three methods below are defined directly on DisplayImagePresenter in recent Hyrax.
+      # We keep them here as fallbacks for older Hyrax versions via `super rescue NoMethodError`:
+      #   - Recent Hyrax: super succeeds silently, no deprecation noise.
+      #   - Older Hyrax:  super raises NoMethodError, deprecation fires, fallback value returned.
+      # These fallbacks will be removed in the next major version of iiif_print.
 
-      def iiif_endpoint(file_id, base_url: request.base_url)
-        if ENV['EXTERNAL_IIIF_URL'].present?
-          IIIFManifest::IIIFEndpoint.new(
-            File.join(ENV['EXTERNAL_IIIF_URL'], file_id),
-            profile: Hyrax.config.iiif_image_compliance_level_uri
-          )
-        else
-          super
-        end
+      def ability
+        super
+      rescue NoMethodError
+        Deprecation.warn(self.class,
+          "IiifPrint is providing #ability as a fallback for older Hyrax versions. " \
+          "This fallback will be removed in the next major iiif_print version — " \
+          "please upgrade to a version of Hyrax that defines this method on DisplayImagePresenter.")
+        @ability ||= Hyrax::IiifManifestPresenter::NullAbility.new
       end
 
       def hostname
+        super
+      rescue NoMethodError
+        Deprecation.warn(self.class,
+          "IiifPrint is providing #hostname as a fallback for older Hyrax versions. " \
+          "This fallback will be removed in the next major iiif_print version — " \
+          "please upgrade to a version of Hyrax that defines this method on DisplayImagePresenter.")
         @hostname || 'localhost'
       end
 
-      ##
-      # @return [Boolean] false
       def work?
+        super
+      rescue NoMethodError
+        Deprecation.warn(self.class,
+          "IiifPrint is providing #work? as a fallback for older Hyrax versions. " \
+          "This fallback will be removed in the next major iiif_print version — " \
+          "please upgrade to a version of Hyrax that defines this method on DisplayImagePresenter.")
         false
       end
-
-      private
-
-      def latest_file_id
-        if ENV['EXTERNAL_IIIF_URL'].present?
-          external_latest_file_id
-        else
-          super
-        end
-      end
-
-      def external_latest_file_id
-        hex = digest_hex
-        return nil if hex.blank?
-
-        prefix = ENV['IIIF_S3_FOLDER_PREFIX'].presence
-        return hex unless prefix
-
-        CGI.escape("#{prefix}/#{hex}")
-      end
-
-      def iiif_image_url_builder(url_builder:)
-        args = [
-          latest_file_id,
-          ENV['EXTERNAL_IIIF_URL'],
-          Hyrax.config.iiif_image_size_default
-        ]
-        # In Hyrax 3, Hyrax.config.iiif_image_url_builder takes an additional argument
-        args << image_format(alpha_channels) if url_builder.arity == 4
-
-        url_builder.call(*args).gsub(%r{images/}, '')
-      end
     end
   end
 end

data/app/presenters/iiif_print/iiif_manifest_presenter_decorator.rb

@@ -32,4 +32,18 @@ module IiifPrint
     end
   end
 end
+
+module IiifPrint
+  # Overrides the .for factory to return ExternalIiifDisplayImagePresenter for FileSets
+  # when an external IIIF server is configured, instead of the default DisplayImagePresenter.
+  module IiifManifestPresenterFactoryDecorator
+    def for(model)
+      return super unless model.file_set? && IiifPrint.config.external_iiif_url.present?
+
+      IiifPrint::ExternalIiifDisplayImagePresenter.new(model)
+    end
+  end
+end
+
 Hyrax::IiifManifestPresenter.prepend(IiifPrint::IiifManifestPresenterDecorator)
+Hyrax::IiifManifestPresenter.singleton_class.prepend(IiifPrint::IiifManifestPresenterFactoryDecorator)

data/lib/iiif_print/configuration.rb

@@ -134,6 +134,16 @@ module IiifPrint
       @default_iiif_manifest_version.presence || 2
     end
 
+    attr_writer :external_iiif_url
+    def external_iiif_url
+      @external_iiif_url || ENV['EXTERNAL_IIIF_URL']
+    end
+
+    attr_writer :iiif_s3_folder_prefix
+    def iiif_s3_folder_prefix
+      @iiif_s3_folder_prefix || ENV['IIIF_S3_FOLDER_PREFIX']
+    end
+
     attr_writer :metadata_fields
     # rubocop:disable Metrics/MethodLength
     # @api private

data/lib/iiif_print/version.rb

@@ -1,3 +1,3 @@
 module IiifPrint
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.1.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iiif_print
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Sean Upton
@@ -14,7 +14,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-16 00:00:00.000000000 Z
+date: 2026-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight_iiif_search
@@ -380,6 +380,7 @@ files:
 - app/models/iiif_print/iiif_search_response_decorator.rb
 - app/models/iiif_print/ingest_file_relation.rb
 - app/models/iiif_print/pending_relationship.rb
+- app/presenters/iiif_print/external_iiif_display_image_presenter.rb
 - app/presenters/iiif_print/file_set_presenter_decorator.rb
 - app/presenters/iiif_print/iiif_manifest_presenter/display_image_presenter_decorator.rb
 - app/presenters/iiif_print/iiif_manifest_presenter_decorator.rb