iiif_manifest 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7ea1cecc789123d7b703170f21175f9c1ba0bffb42b304b6f2a6aa60915fa87
-  data.tar.gz: ebfd7b8387200042de0803680797421573e00b6fba6d48c8d30e57ad34b43ca7
+  metadata.gz: 236503bcbcb70254e25c524e682f169846b84eabeb745db6a00593a15f089e43
+  data.tar.gz: e6da2480b7a053c401a5341f8cb2593650ed823d2d6ef62c87ac0dfa32311952
 SHA512:
-  metadata.gz: 3fc57f1933acddeed084c7b70931e425c815f0268fb83b23a38a921b248ca38e6a2f614c02251a9207da1a7ecbbaa8f50febe66c8994718798ad227ced072ba0
-  data.tar.gz: c7068077352a0ee38a3b43aef1d3317e118cb57796c01953e143d1f8395d890847cf830804f292ff7daef1aa5ffcdb969d0c318f4d6dc5e4628a6f8c4fd04642
+  metadata.gz: c2b99506970dad5d2387f0e41bc19a2ce085af1bebc52ca6c253ad224f7bc04fac4768acb81f7a8eacce0bd05193a24f4a335a72c0bfc8c53b8ed4c541de5b13
+  data.tar.gz: 8fe3a36661279c93ded0afcfc05b29386de997aa256979441ad74606e8e0a64644c9e121f2fbccdcd40a491a0e39077862a0389e6d9886f860136c811f260028

data/.circleci/config.yml

@@ -49,12 +49,6 @@ workflows:
       - test:
           name: "ruby2-7"
           ruby_version: "2.7.7"
-      - test:
-          name: "ruby2-6"
-          ruby_version: "2.6.10"
-      - test:
-          name: "ruby2-5"
-          ruby_version: "2.5.9"
 
   nightly:
     triggers:
@@ -80,9 +74,3 @@ workflows:
       - test:
           name: "ruby2-7"
           ruby_version: "2.7.7"
-      - test:
-          name: "ruby2-6"
-          ruby_version: "2.6.10"
-      - test:
-          name: "ruby2-5"
-          ruby_version: "2.5.9"

data/README.md

@@ -36,7 +36,7 @@ Additionally it **_may_** implement `#service` to contain an array of hashes for
 
 Additionally it **_may_** implement `#sequence_rendering` to contain an array of hashes for file downloads to be offered at sequences level. Each hash must contain "@id", "format" (mime type) and "label" (eg. `{ "@id" => "download url", "format" => "application/pdf", "label" => "user friendly label" }`).
 
-Finally, it **_may_** implement `ranges`, which returns an array of objects which represent a table of contents or similar structure, each of which responds to `label`, `ranges`, and `file_set_presenters`.
+Finally, it **_may_** implement `ranges`, which returns an array of objects which represent a table of contents or similar structure, each of which responds to `label`, `ranges`, and `file_set_presenters`. `IIIFManifest::ManifestRange` is provided for this purpose; any object with those three methods will also work.
 
 For example:
 
@@ -94,10 +94,10 @@ For example:
 
     def ranges
       [
-        ManifestRange.new(
+        IIIFManifest::ManifestRange.new(
           label: "Table of Contents",
           ranges: [
-            ManifestRange.new(
+            IIIFManifest::ManifestRange.new(
               label: "Chapter 1",
               file_set_presenters: @pages
             )
@@ -106,15 +106,6 @@ For example:
       ]
     end
   end
-
-  class ManifestRange
-    attr_reader :label, :ranges, :file_set_presenters
-    def initialize(label:, ranges: [], file_set_presenters: [])
-      @label = label
-      @ranges = ranges
-      @file_set_presenters = file_set_presenters
-    end
-  end
 ```
 
 The class that represents the leaf nodes, must implement `#id`. It must also implement `#display_image` which returns an instance of `IIIFManifest::DisplayImage`
@@ -225,7 +216,8 @@ The presentation 3.0 support has been contained to the `V3` namespace. Version 2
   - `#part_of` is supported at leaf node level, to present an array of parent resources available at each leaf node.
   - `#homepage` is supported at leaf node level, to present an array of homepage resources available at each leaf node.
   - `#placeholder_content` which returns an instance of `IIIFManifest::V3::DisplayContent` presents a [`placeholderCanvas`](https://iiif.io/api/presentation/3.0/#placeholdercanvas) at leaf node level
-- DisplayContent may provide `#auth_service` which should return a hash containing a IIIF Authentication service definition (<https://iiif.io/api/auth/1.0/>) that will be included on the content resource.
+  - DisplayContent may provide `#auth_service` which should return a hash containing a IIIF Authentication 1.0 service definition (<https://iiif.io/api/auth/1.0/>) that will be included on the content resource.
+  - DisplayContent may provide `#auth2_service` which should return a hash containing a IIIF Authentication 2.0 service definition (<https://iiif.io/api/auth/2.0/>) that will be included on the content resource.
 
 ## Configuration
 

data/lib/iiif_manifest/manifest_builder/canvas_builder.rb

@@ -35,6 +35,21 @@ module IIIFManifest
       def apply_record_properties
         canvas['@id'] = path
         canvas.label = record.to_s
+        canvas['metadata'] = record.item_metadata if valid_item_metadata?
+      end
+
+      # Validate item_metadata is an array of hashes with label and value
+      # as required keys for each entry
+      #
+      # @return [Boolean]
+      def valid_item_metadata?
+        return false unless record.respond_to?(:item_metadata)
+        metadata = record.item_metadata
+        metadata.is_a?(Array) && metadata.all? do |metadata_field|
+          metadata_field.is_a?(Hash) &&
+            metadata_field['label'].present? &&
+            metadata_field['value'].present?
+        end
       end
 
       def attach_image

data/lib/iiif_manifest/manifest_range.rb

@@ -0,0 +1,11 @@
+module IIIFManifest
+  class ManifestRange
+    attr_reader :label, :ranges, :file_set_presenters
+
+    def initialize(label:, ranges: [], file_set_presenters: [])
+      @label = label
+      @ranges = ranges
+      @file_set_presenters = file_set_presenters
+    end
+  end
+end

data/lib/iiif_manifest/v3/display_content.rb

@@ -2,7 +2,7 @@ module IIIFManifest
   module V3
     class DisplayContent
       attr_reader :url, :width, :height, :duration, :iiif_endpoint, :format, :type,
-                  :label, :auth_service, :thumbnail
+                  :label, :auth_service, :auth2_service, :thumbnail
       def initialize(url, type:, **kwargs)
         @url = url
         @type = type
@@ -13,6 +13,7 @@ module IIIFManifest
         @format = kwargs[:format]
         @iiif_endpoint = kwargs[:iiif_endpoint]
         @auth_service = kwargs[:auth_service]
+        @auth2_service = kwargs[:auth2_service]
         @thumbnail = kwargs[:thumbnail]
       end
     end

data/lib/iiif_manifest/v3/manifest_builder/body_builder.rb

@@ -12,7 +12,7 @@ module IIIFManifest
         def apply(annotation)
           build_body
           image_service_builder.apply(body) if iiif_endpoint
-          apply_auth_service if auth_service
+          apply_auth_service if auth_service || auth2_service
           annotation.body = body
         end
 
@@ -63,11 +63,15 @@ module IIIFManifest
           content.try(:auth_service)
         end
 
+        def auth2_service
+          content.try(:auth2_service)
+        end
+
         def apply_auth_service
           body.service = if body['service'].blank?
-                           [auth_service]
+                           [auth_service, auth2_service].compact
                          else
-                           body['service'] + [auth_service]
+                           body['service'] + [auth_service, auth2_service].compact
                          end
         end
       end

data/lib/iiif_manifest/v3/manifest_builder/canvas_builder.rb

@@ -100,7 +100,7 @@ module IIIFManifest
         def apply_thumbnail_to(canvas)
           if display_image
             canvas.thumbnail = Array(thumbnail_builder_factory.new(display_image).build)
-          elsif display_content.try(:first)
+          elsif display_content.try(:first) && display_content.first.try(:thumbnail)
             canvas.thumbnail = Array(thumbnail_builder_factory.new(display_content.first).build)
           end
         end

data/lib/iiif_manifest/v3/manifest_builder/iiif_service.rb

@@ -222,8 +222,7 @@ module IIIFManifest
 
           def initial_attributes
             {
-              'type' => 'Choice',
-              'choiceHint' => 'user'
+              'type' => 'Choice'
             }
           end
         end

data/lib/iiif_manifest/v3/manifest_builder/record_property_builder.rb

@@ -19,6 +19,7 @@ module IIIFManifest
           setup_manifest_from_record(manifest, record)
           # Build the items array
           canvas_builder.apply(manifest.items)
+          apply_auth2_context(manifest) if auth2?(record)
           apply_thumbnail_to(manifest) unless manifest_thumbnail?
           manifest
         end
@@ -100,6 +101,14 @@ module IIIFManifest
           metadata_field
         end
 
+        def apply_auth2_context(manifest)
+          manifest["@context"] = [
+            'http://www.w3.org/ns/anno.jsonld',
+            'http://iiif.io/api/auth/2/context.json',
+            'http://iiif.io/api/presentation/3/context.json'
+          ]
+        end
+
         def apply_thumbnail_to(manifest)
           if manifest.is_a? IIIFManifest::Collection
             manifest.thumbnail = manifest.items.collect(&:thumbnail).compact
@@ -111,6 +120,12 @@ module IIIFManifest
         def manifest_thumbnail?
           ::IIIFManifest.config.manifest_thumbnail == false
         end
+
+        def auth2?(record)
+          # DisplayContent can be an array, so need to massage things to iterate over everything in all cases
+          content = record.file_set_presenters.map { |pres| Array(pres.try(:display_content)).compact }.flatten
+          content.any? { |item| item.try(:auth2_service).present? }
+        end
       end
     end
   end

data/lib/iiif_manifest/version.rb

@@ -1,3 +1,3 @@
 module IIIFManifest
-  VERSION = '1.6.0'.freeze
+  VERSION = '1.7.0'.freeze
 end

data/lib/iiif_manifest.rb

@@ -8,6 +8,7 @@ module IIIFManifest
   autoload :Configuration
   autoload :ManifestBuilder
   autoload :ManifestFactory
+  autoload :ManifestRange
   autoload :ManifestServiceLocator
   autoload :DisplayImage
   autoload :IIIFCollection

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iiif_manifest
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Justin Coyne
 - Trey Pendragon
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -157,6 +156,7 @@ files:
 - lib/iiif_manifest/manifest_builder/sequence_builder.rb
 - lib/iiif_manifest/manifest_builder/structure_builder.rb
 - lib/iiif_manifest/manifest_factory.rb
+- lib/iiif_manifest/manifest_range.rb
 - lib/iiif_manifest/manifest_service_locator.rb
 - lib/iiif_manifest/v3.rb
 - lib/iiif_manifest/v3/annotation_content.rb
@@ -180,7 +180,6 @@ homepage: https://github.com/samvera/iiif_manifest
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,8 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Generate IIIF presentation manifests for Hydra::Works
 test_files: []