spotlight-resources-iiif 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fbc962270af9f8879ad88cb7518450028149e9d
-  data.tar.gz: d1e148ef76b96e482b7813d066880ed914d667b9
+  metadata.gz: 99f85b3ef79f2c569645668b1bb55318756c70a5
+  data.tar.gz: 54414056e0566e567250875a5dca68427c1dff7e
 SHA512:
-  metadata.gz: c0d8eb4a499d156fbce45138f8766e73840859ec380e0dcb6f18e66573f448d39caa9de0b2756104e146aa570317c4899f9d5ed53a13cb56cacf1b3623af5141
-  data.tar.gz: 4941537eb392d728e53e34c74bf98054ad984a7519c16af5b890f276fde927cdf2d47675a06f4989e0aa35d1817fe68ad98d6b07f74cbcab1a57273a03af750b
+  metadata.gz: 5472e66b31c7e6e2020967ab18e63a4960584302b93f0cf42665265522c91407308fb650f6aa243982c4ea7459da1ac67fb80769198a9051b1cdba91448e0269
+  data.tar.gz: 0e976a850c9822d501301e66a78b68a6f40b3280b22ef8f7af6bd2b58a3018cb40fac78a2fb76d506d3a46bcaf389ec829a8d55c64f4d66a29c529bd1ef9545b

data/.rubocop.yml

@@ -3,6 +3,7 @@ inherit_from: .rubocop_todo.yml
 require: rubocop-rspec
 
 AllCops:
+  TargetRubyVersion: 2.2
   Exclude:
     - 'Gemfile'
     - 'bin/**/*'

data/app/controllers/spotlight/resources/iiif_harvester_controller.rb

@@ -0,0 +1,32 @@
+module Spotlight
+  module Resources
+    class IiifHarvesterController < Spotlight::ApplicationController
+      before_action :authenticate_user!
+
+      load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
+      before_action :build_resource
+
+      def create
+        if @resource.save_and_index
+          redirect_to spotlight.admin_exhibit_catalog_index_path(current_exhibit, sort: :timestamp)
+        else
+          flash[:error] = @resource.errors.values.join(', ') if @resource.errors.present?
+          redirect_to spotlight.new_exhibit_resource_path(current_exhibit)
+        end
+      end
+
+      private
+
+      def resource_params
+        params.require(:resources_iiif_harvester).permit(:url)
+      end
+
+      def build_resource
+        @resource ||= Spotlight::Resources::IiifHarvester.create(
+          url: resource_params[:url],
+          exhibit: current_exhibit
+        )
+      end
+    end
+  end
+end

data/app/models/spotlight/resources/iiif_harvester.rb

@@ -1,10 +1,43 @@
-module Spotlight::Resources
-  # harvest Images from IIIF Manifest and turn them into a Spotlight::Resource
-  class IiifHarvester < Spotlight::Resource
-    self.weight = -5000
+require 'iiif/presentation'
 
-    after_save :harvest_resources
+module Spotlight
+  module Resources
+    # harvest Images from IIIF Manifest and turn them into a Spotlight::Resource
+    # Note: IIIF API : http://iiif.io/api/presentation/2.0
+    class IiifHarvester < Spotlight::Resource
+      self.weight = -5000
 
+      validate :valid_url?
 
+      def to_solr
+        return to_enum(:to_solr) { 0 } unless block_given?
+
+        base_doc = super
+        iiif_manifests.each do |manifest|
+          manifest.with_exhibit(exhibit)
+          manifest_solr = manifest.to_solr
+          yield base_doc.merge(manifest_solr) if manifest_solr.present?
+        end
+      end
+
+      private
+
+      def iiif_manifests
+        @iiif_manifests ||= IiifService.parse(url)
+      end
+
+      def valid_url?
+        errors.add(:url, 'Invalid IIIF URL') unless url_is_iiif?(url)
+      end
+
+      def url_is_iiif?(url)
+        valid_content_types = ['application/json', 'application/ld+json']
+        req = Faraday.head(url)
+        return unless req.success?
+        valid_content_types.any? do |valid_type|
+          req.headers['content-type'].include?(valid_type)
+        end
+      end
+    end
   end
-end
+end

data/app/models/spotlight/resources/iiif_manifest.rb

@@ -0,0 +1,186 @@
+module Spotlight
+  module Resources
+    ##
+    # A PORO to construct a solr hash for a given IiifManifest
+    class IiifManifest
+      def initialize(attrs = {})
+        @url = attrs[:url]
+        @manifest = attrs[:manifest]
+        @solr_hash = {}
+      end
+
+      def to_solr
+        add_document_id
+        add_label
+        add_thumbnail_url
+        add_manifest_url
+        add_image_urls
+        add_metadata
+        solr_hash
+      end
+
+      def with_exhibit(e)
+        @exhibit = e
+      end
+
+      private
+
+      attr_reader :url, :manifest, :exhibit, :solr_hash
+      delegate :blacklight_config, to: :exhibit
+
+      def compound_id
+        Digest::MD5.hexdigest("#{exhibit.id}-#{url}")
+      end
+
+      def add_document_id
+        solr_hash[exhibit.blacklight_config.document_model.unique_key.to_sym] = compound_id
+      end
+
+      def add_manifest_url
+        solr_hash[Spotlight::Resources::Iiif::Engine.config.iiif_manifest_field] = url
+      end
+
+      def add_thumbnail_url
+        return unless thumbnail_field && manifest['thumbnail'].present?
+        solr_hash[thumbnail_field] = manifest['thumbnail']['@id']
+      end
+
+      def add_label
+        return unless title_field && manifest.try(:label)
+        solr_hash[title_field] = manifest.label
+      end
+
+      def add_image_urls
+        solr_hash[tile_source_field] = image_urls
+      end
+
+      def add_metadata
+        solr_hash.merge!(manifest_metadata)
+        sidecar.update(data: sidecar.data.merge(manifest_metadata))
+      end
+
+      def manifest_metadata
+        metadata = metadata_class.new(manifest).to_solr
+        return {} unless metadata.present?
+        create_sidecars_for(*metadata.keys)
+
+        metadata.each_with_object({}) do |(key, value), hash|
+          next unless (field = exhibit_custom_fields[key])
+          hash[field.field] = value
+        end
+      end
+
+      def create_sidecars_for(*keys)
+        missing_keys(keys).each do |k|
+          exhibit.custom_fields.create! label: k
+        end
+        @exhibit_custom_fields = nil
+      end
+
+      def missing_keys(keys)
+        custom_field_keys = exhibit_custom_fields.keys.map(&:downcase)
+        keys.reject do |key|
+          custom_field_keys.include?(key.downcase)
+        end
+      end
+
+      def exhibit_custom_fields
+        @exhibit_custom_fields ||= exhibit.custom_fields.each_with_object({}) do |value, hash|
+          hash[value.label] = value
+        end
+      end
+
+      def image_urls
+        @image_urls ||= resources.map do |resource|
+          next unless resource && !resource.service.empty?
+          image_url = resource.service['@id']
+          image_url << '/info.json' unless image_url.downcase.ends_with?('/info.json')
+          image_url
+        end
+      end
+
+      def resources
+        @resources ||= sequences
+                       .flat_map(&:canvases)
+                       .flat_map(&:images)
+                       .flat_map(&:resource)
+      end
+
+      def sequences
+        manifest.try(:sequences) || []
+      end
+
+      def thumbnail_field
+        blacklight_config.index.try(:thumbnail_field)
+      end
+
+      def tile_source_field
+        blacklight_config.show.try(:tile_source_field)
+      end
+
+      def title_field
+        blacklight_config.index.try(:title_field)
+      end
+
+      def sidecar
+        @sidecar ||= document_model.new(id: compound_id).sidecar(exhibit)
+      end
+
+      def document_model
+        exhibit.blacklight_config.document_model
+      end
+
+      def metadata_class
+        Spotlight::Resources::Iiif::Engine.config.metadata_class.call
+      end
+
+      ###
+      #  A simple class to map the metadata field
+      #  in a IIIF document to label/value pairs
+      #  This is intended to be overriden by an
+      #  application if a different metadata
+      #  strucure is used by the consumer
+      class Metadata
+        def initialize(manifest)
+          @manifest = manifest
+        end
+
+        def to_solr
+          metadata_hash.merge(manifest_level_metadata)
+        end
+
+        private
+
+        attr_reader :manifest
+
+        def metadata
+          manifest.try(:metadata) || []
+        end
+
+        def metadata_hash
+          return {} unless metadata.present?
+          return {} unless metadata.is_a?(Array)
+
+          metadata.each_with_object({}) do |md, hash|
+            next unless md['label'] && md['value']
+            hash[md['label']] ||= []
+            hash[md['label']] += Array(md['value'])
+          end
+        end
+
+        def manifest_level_metadata
+          manifest_fields.each_with_object({}) do |field, hash|
+            next unless manifest.respond_to?(field) &&
+                        manifest.send(field).present?
+            hash[field.capitalize] ||= []
+            hash[field.capitalize] += Array(manifest.send(field))
+          end
+        end
+
+        def manifest_fields
+          %w(attribution description license)
+        end
+      end
+    end
+  end
+end

data/app/models/spotlight/resources/iiif_service.rb

@@ -0,0 +1,85 @@
+require 'iiif/presentation'
+module Spotlight
+  module Resources
+    ###
+    # Wrapper around IIIIF-Presentation's IIIF::Service that provides the
+    # ability to recursively traverse through all collections and manifests
+    class IiifService
+      def initialize(url)
+        @url = url
+      end
+
+      def collections
+        @collections ||= (object.try(:collections) || []).map do |collection|
+          self.class.new(collection['@id'])
+        end
+      end
+
+      def manifests
+        @manifests ||= if manifest?
+                         [create_iiif_manifest(object)]
+                       else
+                         things = []
+                         things << create_iiif_manifest(object) if collection?
+                         (object.try(:manifests) || []).each do |manifest|
+                           things << create_iiif_manifest(
+                             self.class.new(manifest['@id']).object
+                           )
+                         end
+                         things
+                       end
+      end
+
+      def self.parse(url)
+        recursive_manifests(new(url))
+      end
+
+      protected
+
+      def object
+        @object ||= IIIF::Service.parse(response)
+      end
+
+      private
+
+      attr_reader :url
+
+      class << self
+        private
+
+        def recursive_manifests(thing, &block)
+          return to_enum(:recursive_manifests, thing) unless block_given?
+
+          thing.manifests.each(&block)
+
+          thing.collections.each do |collection|
+            recursive_manifests(collection, &block)
+          end if thing.collections.present?
+        end
+
+        def iiif_response(url)
+          Faraday.get(url).body
+        rescue Faraday::Error::ConnectionFailed, Faraday::TimeoutError => e
+          Rails.logger.warn("HTTP GET for #{url} failed with #{e}")
+          {}.to_json
+        end
+      end
+
+      def create_iiif_manifest(manifest)
+        IiifManifest.new(url: manifest['@id'], manifest: manifest)
+      end
+
+      def manifest?
+        object.is_a?(IIIF::Presentation::Manifest)
+      end
+
+      def collection?
+        object.is_a?(IIIF::Presentation::Collection)
+      end
+
+      def response
+        @response ||= self.class.iiif_response(url)
+      end
+    end
+  end
+end

data/app/views/spotlight/resources/iiif/{_manifest.html.erb → _form.html.erb}

@@ -1,4 +1,4 @@
-<%= bootstrap_form_for([current_exhibit, @resource], layout: :horizontal, label_col: 'col-md-2', control_col: 'col-sm-6 col-md-6', html: { class: 'item-upload-form', multipart: true } ) do |f| %>
+<%= bootstrap_form_for([spotlight_resources_iiif_engine, current_exhibit, Spotlight::Resources::IiifHarvester.new], layout: :horizontal, label_col: 'col-md-2', control_col: 'col-sm-6 col-md-6' ) do |f| %>
   <%= f.text_field :url, help: t('.url-field.help'), label: t('.manifest') %>
   <div class="form-actions">
     <div class="primary-actions">

data/config/locales/spotlight-resources-iiif.en.yml

@@ -2,10 +2,9 @@ en:
   spotlight:
     resources:
       iiif:
-        tabbed_form:
-          manifest: "IIIF Manifest"
-        manifest:
-          manifest: "Manifest"
-          add_item: "Add IIIF manifest URLs"
+        form:
+          title: 'IIIF URL'
+          manifest: "URL"
+          add_item: "Add IIIF items"
           url-field:
-            help: "Add the URL of a IIIF manifest."
+            help: "Add the URL of a IIIF manifest or collection."

data/config/routes.rb

@@ -0,0 +1,5 @@
+Spotlight::Resources::Iiif::Engine.routes.draw do
+  resources :exhibits, only: [] do
+    resource :iiif_harvester, controller: :"spotlight/resources/iiif_harvester", only: :create, as: :resources_iiif_harvesters
+  end
+end

data/lib/generators/spotlight/resources/iiif/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+module Spotlight
+  module Resources
+    module Iiif
+      class InstallGenerator < Rails::Generators::Base
+        desc 'This generator mounts the Spotlight::Resources::Iiif engine'
+
+        def inject_spotlight_iiif_routes
+          route "mount Spotlight::Resources::Iiif::Engine, at: 'spotlight_resources_iiif'"
+        end
+      end
+    end
+  end
+end

data/lib/spotlight/resources/iiif.rb

@@ -1,4 +1,6 @@
-require "spotlight/resources/iiif/version"
+require 'spotlight/resources/iiif/version'
+require 'spotlight'
+require 'faraday'
 
 module Spotlight
   module Resources

data/lib/spotlight/resources/iiif/engine.rb

@@ -2,11 +2,14 @@ require 'spotlight/engine'
 
 module Spotlight::Resources::Iiif
   class Engine < ::Rails::Engine
-    Spotlight::Resources::Iiif::Engine.config.resource_partials = ['spotlight/resources/iiif/manifest']
+    Spotlight::Resources::Iiif::Engine.config.resource_partial = 'spotlight/resources/iiif/form'
+    Spotlight::Resources::Iiif::Engine.config.metadata_class = -> { Spotlight::Resources::IiifManifest::Metadata }
+    Spotlight::Resources::Iiif::Engine.config.iiif_manifest_field = :content_metadata_iiif_manifest_ssm
+
+
     initializer 'spotlight.resources.iiif.initialize' do
-      Spotlight::Engine.config.resource_providers << Spotlight::Resources::IiifHarvester
-      Spotlight::Engine.config.new_resource_partials ||= []
-      Spotlight::Engine.config.new_resource_partials << 'spotlight/resources/iiif/tabbed_form'
+      Spotlight::Engine.config.external_resources_partials ||= []
+      Spotlight::Engine.config.external_resources_partials << Spotlight::Resources::Iiif::Engine.config.resource_partial
     end
   end
-end
+end

data/lib/spotlight/resources/iiif/version.rb

@@ -1,7 +1,7 @@
 module Spotlight
   module Resources
     module Iiif
-      VERSION = "0.0.1"
+      VERSION = "0.1.0"
     end
   end
 end

data/spotlight-resources-iiif.gemspec

@@ -6,8 +6,8 @@ require 'spotlight/resources/iiif/version'
 Gem::Specification.new do |spec|
   spec.name          = "spotlight-resources-iiif"
   spec.version       = Spotlight::Resources::Iiif::VERSION
-  spec.authors       = ["Naomi Dushay"]
-  spec.email         = ["ndushay@stanford.edu"]
+  spec.authors       = ["Naomi Dushay", "Peter Mangiafico"]
+  spec.email         = ["ndushay@stanford.edu", "petucket@stanford.edu"]
 
   spec.summary       = 'Spotlight Resource Indexer for IIIF manifests or collections.'
   spec.homepage      = "https://github.com/sul-dlss/spotlight-resources-iiif"
@@ -19,12 +19,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "blacklight-spotlight"
+  spec.add_dependency "faraday"
+  spec.add_dependency "iiif-presentation"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency 'capybara'
-  spec.add_development_dependency 'factory_girl', '~> 4.5'
+  spec.add_development_dependency 'factory_girl_rails'
   spec.add_development_dependency 'database_cleaner', '~> 1.3'
 #  spec.add_development_dependency 'poltergeist', '>= 1.5.0' # for js testing using phantomjs
   spec.add_development_dependency "coveralls"

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: spotlight-resources-iiif
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Naomi Dushay
+- Peter Mangiafico
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2016-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight-spotlight
@@ -24,6 +25,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: iiif-presentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -81,19 +110,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_girl_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -223,6 +252,7 @@ dependencies:
 description: 
 email:
 - ndushay@stanford.edu
+- petucket@stanford.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -237,13 +267,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/spotlight/resources/iiif_harvester_controller.rb
 - app/models/spotlight/resources/iiif_harvester.rb
-- app/views/spotlight/resources/iiif/_manifest.html.erb
-- app/views/spotlight/resources/iiif/_tabbed_form.html.erb
+- app/models/spotlight/resources/iiif_manifest.rb
+- app/models/spotlight/resources/iiif_service.rb
+- app/views/spotlight/resources/iiif/_form.html.erb
 - bin/console
 - bin/setup
 - config/jetty.yml
 - config/locales/spotlight-resources-iiif.en.yml
+- config/routes.rb
+- lib/generators/spotlight/resources/iiif/install_generator.rb
 - lib/spotlight/resources/iiif.rb
 - lib/spotlight/resources/iiif/engine.rb
 - lib/spotlight/resources/iiif/version.rb

data/app/views/spotlight/resources/iiif/_tabbed_form.html.erb

@@ -1,18 +0,0 @@
-<div role="tabpanel" class="item-upload-tabs">
-  <ul class="nav nav-tabs" role="tablist">
-    <% Spotlight::Resources::Iiif::Engine.config.resource_partials.each_with_index do |p, i| %>
-      <% name = p.split('/').last %>
-      <li role="presentation" class="<%= "active" if i ==0 %>">
-        <%= link_to t(".#{name}"), "##{name}", role: 'tab', 'data-toggle' => 'tab', 'aria-controls' => 'single' %>
-      </li>
-    <% end %>
-  </ul>
-  <div class="tab-content">
-    <% Spotlight::Resources::Iiif::Engine.config.resource_partials.each_with_index do |p, i| %>
-      <% name = p.split('/').last %>
-      <%= content_tag :div, id: name, role: 'tabpanel', class: "tab-pane #{"active" if i == 0}" do %>
-        <%= render p %>
-      <% end %>
-    <% end %>
-  </div>
-</div>