iiif_manifest 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3cba606c659d4ff84c0709b6332ba67cdf938015
-  data.tar.gz: a140e32c9319b5747210da28634becb8213f35d3
+SHA256:
+  metadata.gz: cfc7099813836fb900812b98e9c32b2946479b399beb603689bde033fbaae84e
+  data.tar.gz: bf71a041c8452f34c2c2e8acfbf6e88f74185574fde224134fa8c0e5f644b43c
 SHA512:
-  metadata.gz: 0fbbff5fca777d6e14bda44fe3d46df558234b872a87e62d4136f011c4a1909a4659966dc1ddd6b2e2769de6cdb10898a10c13b832b39efe926c6d4f1ee9739b
-  data.tar.gz: 48db3a55ee7899108d8c89a5a126046f0b92bc1b91fa983a3f47e0bd6a0db2dc32af8a56b7b0143c003481b69dcb348aaa336ef63936699fdfd9730a2d594d48
+  metadata.gz: 474f3b2a9a348067e83c7e1b63096be5aaafdb3d8c99a9e4c1c8ac7d442a6b6f2a12407c9897390d8c99cb13ed05a4fd0001a448c5274b3f0cb2a59f5702b265
+  data.tar.gz: 914f36916f395785a3f002a864aed38de35341684463b6a71154efc68bee1dcd0b9334cbe186f1756caa00ed3e8afcd01b45a823c7a17ec3f614932e5d905e21

data/README.md

@@ -13,11 +13,11 @@ Additionally it ***should*** implement `#manifest_url` that shows where the mani
 
 Additionally it ***should*** implement `#manifest_metadata` to provide an array containing hashes of metadata Label/Value pairs.
 
-Additionally it ***may*** implement `#search_service` to contain the url for an IIIF search api compliant search endpoint and `#autocomplete_service` to contain the url for an IIIF search api compliant autocomplete endpoint. Please note, the autocomplete service is embedded within the search service description so if an autocomplete_service is supplied without a search_service it will be ignored. The IIIF `profile` added to the service descriptions is version 0 as this is the version supported by the current version of Universal Viewer. Only include a search_service within the manifest if your application has impelmented an IIIF search service at the endpoint specified in the manifest.
+Additionally it ***may*** implement `#search_service` to contain the url for a IIIF search api compliant search endpoint and `#autocomplete_service` to contain the url for a IIIF search api compliant autocomplete endpoint. Please note, the autocomplete service is embedded within the search service description so if an autocomplete_service is supplied without a search_service it will be ignored. The IIIF `profile` added to the service descriptions is version 0 as this is the version supported by the current version of Universal Viewer. Only include a search_service within the manifest if your application has implemented a IIIF search service at the endpoint specified in the manifest.
 
 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
+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`.
 
@@ -131,7 +131,7 @@ Then you can produce the manifest on the book object like this:
 
 Provisional support for the [3.0 alpha version of the IIIF presentation api spec](https://iiif.io/api/presentation/3.0/) has been added with a focus on audiovisual content.  The [change log](https://iiif.io/api/presentation/3.0/change-log/) lists the changes to the specification.
 
-The presentation 3.0 support has been contained to the `V3` namespace.  Version 2.0 manifests are still be built using `IIIFManifest::ManifestFactory` while version 3.0 manifets can now be built using `IIIFManifest::V3::ManifestFactory`.
+The presentation 3.0 support has been contained to the `V3` namespace.  Version 2.0 manifests are still be built using `IIIFManifest::ManifestFactory` while version 3.0 manifests can now be built using `IIIFManifest::V3::ManifestFactory`.
 
 ```ruby
   book = Book.new('book-77',[Page.new('page-99')])
@@ -141,9 +141,11 @@ The presentation 3.0 support has been contained to the `V3` namespace.  Version
 ### Notable changes for Presentation 3.0
 - Presenters must still define `#description` but it is now serialized as `summary`. (https://iiif.io/api/presentation/3.0/change-log/#126-rename-description-to-summary)
 - All textual strings, including metadata labels and values, are now serialized as language maps and may be provided as a hash with language code keys with string values.  Values not provided in this format are automatically converted so no change to `#description`, `#manifest_metadata`, range labels, or other fields are required. (https://iiif.io/api/presentation/3.0/change-log/#133-use-language-map-pattern-for-label-value-summary)
+- Presenters ***may*** implement `#homepage` to contain a hash for linking back to a repository webpage for this manifest. The hash must contain "id", "format" (mime type), "type", and "label" (eg. `{ "id" => "repository url", "format" => "text/html", "type" => "Text", "label" => { "en": ["View in repository"] }`).
 - File set presenters may target a fragment of its content by providing `#media_fragment` which will be appended to its `id`.
 - Range objects may now implement `#items` instead of `#ranges` and `#file_set_presenters` to allow for interleaving these objects.  `#items` is not required and existing range objects should continue to work.
 - File set presenters may provide `#display_content` which should return an instance of `IIIFManifest::V3::DisplayContent` (or an array of instances in the case of a user `Choice`).  `#display_image` is no longer required but will still work if provided.
+- 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.
 
 ## Development
 

data/lib/iiif_manifest/v3/display_content.rb

@@ -1,8 +1,10 @@
 module IIIFManifest
   module V3
     class DisplayContent
-      attr_reader :url, :width, :height, :duration, :iiif_endpoint, :format, :type, :label
-      def initialize(url, type:, width: nil, height: nil, duration: nil, label: nil, format: nil, iiif_endpoint: nil)
+      attr_reader :url, :width, :height, :duration, :iiif_endpoint, :format, :type,
+                  :label, :auth_service
+      def initialize(url, type:, width: nil, height: nil, duration: nil, label: nil,
+                     format: nil, iiif_endpoint: nil, auth_service: nil)
         @url = url
         @type = type
         @width = width
@@ -11,6 +13,7 @@ module IIIFManifest
         @label = label
         @format = format
         @iiif_endpoint = iiif_endpoint
+        @auth_service = auth_service
       end
     end
   end

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

@@ -12,6 +12,7 @@ module IIIFManifest
         def apply(annotation)
           build_body
           image_service_builder.apply(body) if iiif_endpoint
+          apply_auth_service if auth_service
           annotation.body = body
         end
 
@@ -42,6 +43,18 @@ module IIIFManifest
           def image_service_builder
             image_service_builder_factory.new(iiif_endpoint)
           end
+
+          def auth_service
+            display_content.try(:auth_service)
+          end
+
+          def apply_auth_service
+            body.service = if body['service'].blank?
+                             [auth_service]
+                           else
+                             body['service'] + [auth_service]
+                           end
+          end
       end
     end
   end

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

@@ -30,7 +30,7 @@ module IIIFManifest
 
         def path
           path = "#{parent.manifest_url}/canvas/#{record.id}"
-          path << "##{record.media_fragment}" if record.respond_to?(:media_fragment)
+          path << "##{record.media_fragment}" if record.respond_to?(:media_fragment) && record.media_fragment.present?
           path
         end
 

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

@@ -68,6 +68,10 @@ module IIIFManifest
           inner_hash['rights'] = rights
         end
 
+        def homepage=(homepage)
+          inner_hash['homepage'] = homepage
+        end
+
         def initial_attributes
           {
             '@context' => [

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

@@ -41,6 +41,7 @@ module IIIFManifest
             canvas_builder_factory.from(record)
           end
 
+          # rubocop:disable Metrics/CyclomaticComplexity
           def setup_manifest_from_record(manifest, record)
             manifest['id'] = record.manifest_url.to_s
             manifest.label = ManifestBuilder.language_map(record.to_s) if record.to_s.present?
@@ -50,7 +51,9 @@ module IIIFManifest
             manifest.viewing_direction = viewing_direction if viewing_direction.present?
             manifest.service = services if search_service.present?
             manifest.rendering = populate_rendering
+            manifest.homepage = record.homepage if record.try(:homepage).present?
           end
+          # rubocop:enable Metrics/CyclomaticComplexity
 
           def metadata_from_record(record)
             if valid_v3_metadata?

data/lib/iiif_manifest/version.rb

@@ -1,3 +1,3 @@
 module IIIFManifest
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iiif_manifest
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-01 00:00:00.000000000 Z
+date: 2019-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -197,8 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Generate IIIF presentation manifests for Hydra::Works