iiif_manifest 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bf49dd68d7cea2339444aafd8eb4f98ac3cdcd9
-  data.tar.gz: ddee2270d2cf0f5098c40ecee97fd696a59a36f1
+  metadata.gz: c9bfc627db90ac1d23556a85e962f89447195fb7
+  data.tar.gz: b59e46225bae67ddfc5e2460b3672d4be113e4b6
 SHA512:
-  metadata.gz: ef3820b328e75af3da30aee55bafd526ae0d6ae7c7533cc53bf0ae743d61d83cf027cca5048a70460a02eb39103c94c2e03e900be19ffe29b57e3cee3b61b4bc
-  data.tar.gz: 5c948e5dc59e0926ce983c9ba6445d4f7011f342eae3bd18cff854a5183687affb78e396e2498c54f8be240268b6774d415be69ec38fa77fe2526df8f2916908
+  metadata.gz: 64f3b567ca52687d5fd6fe889bc085ed8850b69a343220819a5296c5ecce3d7d1a1aa7de386ca5f2ef82a3aedbac0a3b078c19c280c1e22ba7fc42effbf1234c
+  data.tar.gz: f550acc4ad049b10514d2c68333db4256ee0ac6e79bc4d995a9024681824bda83ac060d7fbbb9697f01e33e5eae5900c0e429212ed178133d0d9fb2f659e35d4

data/.rubocop.yml

@@ -11,5 +11,9 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
 
+Naming/MethodName:
+  Exclude:
+    - 'lib/iiif_manifest/manifest_builder/iiif_service.rb'
+
 RSpec/MultipleExpectations:
   Enabled: false

data/.rubocop_todo.yml

@@ -65,6 +65,7 @@ Style/Documentation:
     - 'lib/iiif_manifest/manifest_factory.rb'
     - 'lib/iiif_manifest/manifest_service_locator.rb'
     - 'lib/iiif_manifest.rb'
+    - 'lib/iiif_manifest/manifest_builder/iiif_service.rb'
     - 'spec/lib/iiif_manifest/manifest_factory_spec.rb'
 
 # Offense count: 1

data/README.md

@@ -13,7 +13,9 @@ 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 `#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" }`). 
+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 `#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
@@ -50,6 +52,14 @@ For example:
             { "label" => "Creator", "value" => "Morrissey, Stephen Patrick" }
           ]
     end
+    
+    def search_service
+      "http://test.host/books/#{@id}/search"
+    end
+    
+    def autocomplete_service
+      "http://test.host/books/#{@id}/autocomplete"
+    end
 
     def sequence_rendering
       [{"@id" => "http://test.host/file_set/id/download", "format" => "application/pdf", "label" => "Download"}]

data/iiif_manifest.gemspec

@@ -18,12 +18,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '>= 4'
-  spec.add_dependency 'iiif-presentation', '~> 0.2.0'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'pry-byebug'
 end

data/lib/iiif_manifest.rb

@@ -2,7 +2,6 @@ require 'iiif_manifest/version'
 require 'active_support'
 require 'active_support/core_ext/module'
 require 'active_support/core_ext/object'
-require 'iiif/presentation' # AKA O'Sullivan
 
 module IIIFManifest
   extend ActiveSupport::Autoload

data/lib/iiif_manifest/manifest_builder.rb

@@ -1,3 +1,4 @@
+require_relative 'manifest_builder/iiif_service'
 require_relative 'manifest_builder/canvas_builder'
 require_relative 'manifest_builder/canvas_builder_factory'
 require_relative 'manifest_builder/child_manifest_builder_factory'

data/lib/iiif_manifest/manifest_builder/iiif_service.rb

@@ -0,0 +1,197 @@
+module IIIFManifest
+  class ManifestBuilder
+    class IIIFService
+      attr_reader :inner_hash
+      def initialize
+        @inner_hash = initial_attributes
+      end
+
+      delegate :[]=, :[], :as_json, :to_json, :has_key?, to: :inner_hash
+
+      def initial_attributes
+        {}
+      end
+    end
+
+    class IIIFManifest < IIIFService
+      def label
+        inner_hash['label']
+      end
+
+      def label=(label)
+        inner_hash['label'] = label
+      end
+
+      def description=(description)
+        return unless description.present?
+        inner_hash['description'] = description
+      end
+
+      def viewing_hint=(viewing_hint)
+        return unless viewing_hint.present?
+        inner_hash['viewingHint'] = viewing_hint
+      end
+
+      def viewing_direction=(viewing_direction)
+        return unless viewing_direction.present?
+        inner_hash['viewingDirection'] = viewing_direction
+      end
+
+      def viewingDirection
+        inner_hash['viewingDirection']
+      end
+
+      def sequences
+        inner_hash['sequences'] || []
+      end
+
+      def sequences=(sequences)
+        inner_hash['sequences'] = sequences
+      end
+
+      def metadata=(metadata)
+        inner_hash['metadata'] = metadata
+      end
+
+      def service
+        inner_hash['service'] || []
+      end
+
+      def service=(service)
+        inner_hash['service'] = service
+      end
+
+      def see_also=(see_also)
+        inner_hash['seeAlso'] = see_also
+      end
+
+      def license=(license)
+        inner_hash['license'] = license
+      end
+
+      def initial_attributes
+        {
+          '@context' => 'http://iiif.io/api/presentation/2/context.json',
+          '@type' => 'sc:Manifest'
+        }
+      end
+
+      class Collection < IIIFManifest
+        def initial_attributes
+          {
+            '@context' => 'http://iiif.io/api/presentation/2/context.json',
+            '@type' => 'sc:Collection'
+          }
+        end
+      end
+
+      class Sequence < IIIFService
+        def canvases
+          inner_hash['canvases'] || []
+        end
+
+        def canvases=(canvases)
+          inner_hash['canvases'] = canvases
+        end
+
+        def initial_attributes
+          {
+            '@type' => 'sc:Sequence'
+          }
+        end
+      end
+
+      class Canvas < IIIFService
+        def label=(label)
+          inner_hash['label'] = label
+        end
+
+        def images
+          inner_hash['images'] || []
+        end
+
+        def images=(images)
+          inner_hash['images'] = images
+        end
+
+        def initial_attributes
+          {
+            '@type' => 'sc:Canvas'
+          }
+        end
+      end
+
+      class Range < IIIFService
+        def initial_attributes
+          {
+            '@type' => 'sc:Range'
+          }
+        end
+      end
+
+      class Resource < IIIFService
+        def service=(service)
+          inner_hash['service'] = service
+        end
+
+        def initial_attributes
+          {
+            '@type' => 'sc:Range'
+          }
+        end
+      end
+
+      class Annotation < IIIFService
+        def resource=(resource)
+          inner_hash['resource'] = resource
+        end
+
+        def resource
+          inner_hash['resource']
+        end
+
+        def initial_attributes
+          {
+            '@type' => 'oa:Annotation',
+            'motivation' => 'sc:painting'
+          }
+        end
+      end
+
+      class SearchService < IIIFService
+        def service=(service)
+          inner_hash['service'] = service
+        end
+
+        def search_service=(search_service)
+          inner_hash['@id'] = search_service
+        end
+
+        def initial_attributes
+          {
+            '@context' => 'http://iiif.io/api/search/0/context.json',
+            'profile' => 'http://iiif.io/api/search/0/search',
+            'label' => 'Search within this manifest'
+          }
+        end
+      end
+
+      class AutocompleteService < IIIFService
+        def autocomplete_service
+          inner_hash['@id']
+        end
+
+        def autocomplete_service=(autocomplete_service)
+          inner_hash['@id'] = autocomplete_service
+        end
+
+        def initial_attributes
+          {
+            'profile' => 'http://iiif.io/api/search/0/autocomplete',
+            'label' => 'Get suggested words in this manifest'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/iiif_manifest/manifest_builder/record_property_builder.rb

@@ -1,19 +1,25 @@
 module IIIFManifest
   class ManifestBuilder
     class RecordPropertyBuilder
-      attr_reader :record, :path
-      def initialize(record)
+      attr_reader :record, :iiif_search_service_factory, :iiif_autocomplete_service_factory
+      def initialize(record, iiif_search_service_factory:, iiif_autocomplete_service_factory:)
         @record = record
+        @iiif_search_service_factory = iiif_search_service_factory
+        @iiif_autocomplete_service_factory = iiif_autocomplete_service_factory
       end
 
+      # rubocop:disable Metrics/AbcSize
       def apply(manifest)
         manifest['@id'] = record.manifest_url.to_s
         manifest.label = record.to_s
         manifest.description = record.description
         manifest.viewing_hint = viewing_hint if viewing_hint.present?
+        manifest.viewing_direction = viewing_direction if viewing_direction.present?
         manifest.metadata = record.manifest_metadata if valid_metadata?
+        manifest.service = services if search_service.present?
         manifest
       end
+      # rubocop:enable Metrics/AbcSize
 
       private
 
@@ -21,6 +27,37 @@ module IIIFManifest
         (record.respond_to?(:viewing_hint) && record.send(:viewing_hint))
       end
 
+      def viewing_direction
+        (record.respond_to?(:viewing_direction) && record.send(:viewing_direction))
+      end
+
+      def autocomplete_service
+        (record.respond_to?(:autocomplete_service) && record.send(:autocomplete_service))
+      end
+
+      def search_service
+        (record.respond_to?(:search_service) && record.send(:search_service))
+      end
+
+      def iiif_search_service
+        @iiif_search_service ||= iiif_search_service_factory.new
+      end
+
+      def iiif_autocomplete_service
+        @iiif_autocomplete_service ||= iiif_autocomplete_service_factory.new
+      end
+
+      # Build services. Currently supported:
+      #   search_service, with (optional) embedded autocomplete service
+      #
+      # @return [Array] array of services
+      def services
+        iiif_search_service.search_service = search_service
+        iiif_autocomplete_service.autocomplete_service = autocomplete_service
+        iiif_search_service.service = iiif_autocomplete_service if autocomplete_service.present?
+        [iiif_search_service]
+      end
+
       # Validate manifest_metadata against the IIIF spec format for metadata
       #
       # @return [Boolean]

data/lib/iiif_manifest/manifest_factory.rb

@@ -16,15 +16,21 @@ module IIIFManifest
 
     def new(work)
       if !work.work_presenters.empty?
-        if work.file_set_presenters.empty?
+        if sammelband?(work) || !work.file_set_presenters.empty?
+          sammelband_manifest_builder.new(work)
+        elsif work.file_set_presenters.empty?
           work = IIIFCollection.new(work)
           collection_manifest_builder.new(work)
-        elsif !work.file_set_presenters.empty?
-          sammelband_manifest_builder.new(work)
         end
       else
         manifest_builder.new(work)
       end
     end
+
+    private
+
+    def sammelband?(work)
+      work.respond_to?(:sammelband?) && work.sammelband?
+    end
   end
 end

data/lib/iiif_manifest/manifest_service_locator.rb

@@ -68,7 +68,7 @@ module IIIFManifest
       end
 
       def iiif_collection_factory
-        IIIF::Presentation::Collection
+        IIIFManifest::ManifestBuilder::IIIFManifest::Collection
       end
 
       def composite_builder
@@ -80,7 +80,11 @@ module IIIFManifest
       end
 
       def record_property_builder
-        ManifestBuilder::RecordPropertyBuilder
+        InjectedFactory.new(
+          ManifestBuilder::RecordPropertyBuilder,
+          iiif_search_service_factory: iiif_search_service_factory,
+          iiif_autocomplete_service_factory: iiif_autocomplete_service_factory
+        )
       end
 
       def structure_builder
@@ -108,7 +112,7 @@ module IIIFManifest
       end
 
       def sequence_factory
-        IIIF::Presentation::Sequence
+        IIIFManifest::ManifestBuilder::IIIFManifest::Sequence
       end
 
       def canvas_builder_factory
@@ -157,27 +161,35 @@ module IIIFManifest
       end
 
       def iiif_service_factory
-        IIIF::Service
+        IIIFManifest::ManifestBuilder::IIIFService
       end
 
       def iiif_resource_factory
-        IIIF::Presentation::Resource
+        IIIFManifest::ManifestBuilder::IIIFManifest::Resource
       end
 
       def iiif_annotation_factory
-        IIIF::Presentation::Annotation
+        IIIFManifest::ManifestBuilder::IIIFManifest::Annotation
       end
 
       def iiif_manifest_factory
-        IIIF::Presentation::Manifest
+        IIIFManifest::ManifestBuilder::IIIFManifest
       end
 
       def iiif_canvas_factory
-        IIIF::Presentation::Canvas
+        IIIFManifest::ManifestBuilder::IIIFManifest::Canvas
       end
 
       def iiif_range_factory
-        IIIF::Presentation::Range
+        IIIFManifest::ManifestBuilder::IIIFManifest::Range
+      end
+
+      def iiif_search_service_factory
+        IIIFManifest::ManifestBuilder::IIIFManifest::SearchService
+      end
+
+      def iiif_autocomplete_service_factory
+        IIIFManifest::ManifestBuilder::IIIFManifest::AutocompleteService
       end
     end
 

data/lib/iiif_manifest/version.rb

@@ -1,3 +1,3 @@
 module IIIFManifest
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iiif_manifest
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-02 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -26,33 +26,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: iiif-presentation
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :runtime
+        version: '1.11'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -109,20 +109,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: IIIF http://iiif.io/ defines an API for presenting related images in
   a viewer. This transforms Hydra::Works objects into that format usable by players
   such as http://universalviewer.io/
@@ -156,6 +142,7 @@ files:
 - lib/iiif_manifest/manifest_builder/composite_builder.rb
 - lib/iiif_manifest/manifest_builder/composite_builder_factory.rb
 - lib/iiif_manifest/manifest_builder/deep_canvas_builder_factory.rb
+- lib/iiif_manifest/manifest_builder/iiif_service.rb
 - lib/iiif_manifest/manifest_builder/image_builder.rb
 - lib/iiif_manifest/manifest_builder/image_service_builder.rb
 - lib/iiif_manifest/manifest_builder/record_property_builder.rb
@@ -184,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Generate IIIF presentation manifests for Hydra::Works