Merge spotlight_resources_iiif gem into this project

.rubocop.yml

@@ -46,6 +46,8 @@ Metrics/AbcSize:
 
 Metrics/ModuleLength:
   Max: 120
+  Exclude:
+    - 'spec/fixtures/**/*'
 
 Metrics/LineLength:
   Max: 160
@@ -57,6 +59,7 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Exclude:
     - 'app/models/spotlight/resource.rb'
+    - 'app/models/spotlight/resources/iiif_manifest.rb'
     - 'lib/generators/spotlight/**/*' # Generators tend to have longer class lengths due to their lengthy public API
 
 Style/PredicateName:
@@ -66,6 +69,7 @@ Style/PredicateName:
 Metrics/MethodLength:
   Exclude:
     - 'lib/generators/spotlight/**/*'
+    - 'spec/fixtures/**/*'
 
 RSpec/NestedGroups:
   Max: 4

spotlight_resources_iiif/app/controllers/spotlight/resources/iiif_harvester_controller.rb → app/controllers/spotlight/resources/iiif_harvester_controller.rb

@@ -1,5 +1,6 @@
 module Spotlight
   module Resources
+    # IIIF resources harvesting endpoint
     class IiifHarvesterController < Spotlight::ResourcesController
       def resource_class
         Spotlight::Resources::IiifHarvester

spotlight_resources_iiif/app/models/spotlight/resources/iiif_manifest.rb → app/models/spotlight/resources/iiif_manifest.rb

@@ -41,17 +41,15 @@ def add_document_id
       end
 
       def add_collection_id
-        if collection
-          solr_hash[collection_id_field] = [collection.compound_id]
-        end
+        solr_hash[collection_id_field] = [collection.compound_id] if collection
       end
 
       def collection_id_field
-        Spotlight::Resources::Iiif::Engine.config.collection_id_field
+        Spotlight::Engine.config.iiif_collection_id_field
       end
 
       def add_manifest_url
-        solr_hash[Spotlight::Resources::Iiif::Engine.config.iiif_manifest_field] = url
+        solr_hash[Spotlight::Engine.config.iiif_manifest_field] = url
       end
 
       def add_thumbnail_url
@@ -158,7 +156,7 @@ def document_model
       end
 
       def metadata_class
-        Spotlight::Resources::Iiif::Engine.config.metadata_class.call
+        Spotlight::Engine.config.iiif_metadata_class.call
       end
 
       ###

spotlight_resources_iiif/app/models/spotlight/resources/iiif_service.rb → app/models/spotlight/resources/iiif_service.rb

@@ -19,17 +19,7 @@ def manifests
         @manifests ||= if manifest?
                          [create_iiif_manifest(object)]
                        else
-                         things = []
-                         if collection?
-                           self_manifest = create_iiif_manifest(object)
-                           things << self_manifest
-                         end
-                         (object.try(:manifests) || []).each do |manifest|
-                           things << create_iiif_manifest(
-                             self.class.new(manifest['@id']).object, self_manifest
-                           )
-                         end
-                         things
+                         build_collection_manifest.to_a
                        end
       end
 
@@ -62,9 +52,11 @@ def recursive_manifests(thing, &block)
 
           thing.manifests.each(&block)
 
+          return unless thing.collections.present?
+
           thing.collections.each do |collection|
             recursive_manifests(collection, &block)
-          end if thing.collections.present?
+          end
         end
       end
 
@@ -83,6 +75,19 @@ def collection?
       def response
         @response ||= self.class.iiif_response(url)
       end
+
+      def build_collection_manifest
+        return to_enum(:build_collection_manifest) unless block_given?
+
+        if collection?
+          self_manifest = create_iiif_manifest(object)
+          yield self_manifest
+        end
+
+        (object.try(:manifests) || []).each do |manifest|
+          yield create_iiif_manifest(self.class.new(manifest['@id']).object, self_manifest)
+        end
+      end
     end
   end
 end

spotlight_resources_iiif/app/views/spotlight/resources/iiif/_form.html.erb → app/views/spotlight/resources/iiif/_form.html.erb

@@ -1,4 +1,4 @@
-<%= bootstrap_form_for([spotlight_resources_iiif_engine, current_exhibit, @resource.becomes(Spotlight::Resources::IiifHarvester)], as: :resource, layout: :horizontal, label_col: 'col-md-2', control_col: 'col-sm-6 col-md-6' ) do |f| %>
+<%= bootstrap_form_for([spotlight, current_exhibit, @resource.becomes(Spotlight::Resources::IiifHarvester)], as: :resource, 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">

config/locales/spotlight.en.yml

@@ -560,6 +560,13 @@ en:
           title: "Upload raw documents"
           add_item: "Add item"
           file_label: "JSON File"
+      iiif:
+        form:
+          title: 'IIIF URL'
+          manifest: "URL"
+          add_item: "Add IIIF items"
+          url-field:
+            help: "Add the URL of a IIIF manifest or collection."
       bookmarklet:
         instructions:  "Drag this button to the bookmarks toolbar in your web browser"
         bookmarklet: "%{application_name} widget"

config/routes.rb

@@ -80,6 +80,8 @@
       end
     end
 
+    resources :iiif_harvesters, controller: 'resources/iiif_harvester', only: :create, as: 'resources_iiif_harvesters'
+
     resources :searches do
       collection do
         patch :update_all

lib/spotlight/engine.rb

@@ -93,7 +93,8 @@ def self.blacklight_config
       'spotlight/resources/external_resources_form',
       'spotlight/resources/upload/form',
       'spotlight/resources/csv_upload/form',
-      'spotlight/resources/json_upload/form'
+      'spotlight/resources/json_upload/form',
+      'spotlight/resources/iiif/form'
     ]
     config.external_resources_partials = []
     config.solr_batch_size = 20
@@ -135,6 +136,8 @@ def self.blacklight_config
     ]
 
     config.iiif_manifest_field = :iiif_manifest_url_ssi
+    config.iiif_metadata_class = -> { Spotlight::Resources::IiifManifest::Metadata }
+    config.iiif_collection_id_field = :collection_id_ssim
 
     config.masthead_initial_crop_selection = [1200, 120]
     config.thumbnail_initial_crop_selection = [120, 120]

spotlight_resources_iiif/spec/features/add_iiif_manifest_spec.rb → spec/features/add_iiif_manifest_spec.rb

@@ -1,4 +1,4 @@
-require 'rails_helper'
+require 'spec_helper'
 
 describe 'adding IIIF Manifest', type: :feature do
   let(:exhibit) { FactoryGirl.create(:exhibit) }

spotlight_resources_iiif/spec/models/spotlight/resources/iiif_harvester_spec.rb → spec/models/spotlight/resources/iiif_harvester_spec.rb

@@ -1,4 +1,4 @@
-require 'rails_helper'
+require 'spec_helper'
 
 describe Spotlight::Resources::IiifHarvester do
   let(:exhibit) { FactoryGirl.create(:exhibit) }
@@ -26,11 +26,5 @@
       expect(subject.documents_to_index).to be_a(Enumerator)
       expect(subject.documents_to_index.count).to eq 8
     end
-
-    it 'all solr documents include exhibit context' do
-      subject.documents_to_index.each do |doc|
-        expect(doc).to have_key("spotlight_exhibit_slug_#{exhibit.slug}_bsi")
-      end
-    end
   end
 end

spotlight_resources_iiif/spec/models/spotlight/resources/iiif_manifest_spec.rb → spec/models/spotlight/resources/iiif_manifest_spec.rb

@@ -1,8 +1,7 @@
-require 'rails_helper'
+require 'spec_helper'
 
 class TestMetadataClass
-  def initialize(*)
-  end
+  def initialize(*); end
 
   def to_solr
     { 'test_field' => 'metadata-to-solr' }
@@ -11,8 +10,8 @@ def to_solr
 
 describe Spotlight::Resources::IiifManifest do
   let(:url) { 'uri://to-manifest' }
-  subject { described_class.new({ url: url, manifest: manifest, collection: collection}) }
-  let(:collection) { double( compound_id: "1" ) }
+  subject { described_class.new(url: url, manifest: manifest, collection: collection) }
+  let(:collection) { double(compound_id: '1') }
   before do
     stub_iiif_response_for_url(url, test_manifest1)
     subject.with_exhibit(exhibit)
@@ -34,15 +33,15 @@ def to_solr
       end
     end
 
-    describe "collection id" do
-      it "is included when a collection is given" do
-        expect(subject.to_solr[:collection_id_ssim]).to eq ["1"]
+    describe 'collection id' do
+      it 'is included when a collection is given' do
+        expect(subject.to_solr[:collection_id_ssim]).to eq ['1']
       end
     end
 
     describe 'manifest url' do
       it 'is inlcuded in the solr document when present' do
-        expect(subject.to_solr[:content_metadata_iiif_manifest_ssm]).to eq url
+        expect(subject.to_solr[:iiif_manifest_url_ssi]).to eq url
       end
     end
 
@@ -53,7 +52,7 @@ def to_solr
     end
 
     describe 'full size image url' do
-      it "is included in the solr document" do
+      it 'is included in the solr document' do
         expect(subject.to_solr[:full_image_url_ssm]).to eq 'uri://full-image'
       end
     end
@@ -90,13 +89,13 @@ def to_solr
         expect { subject.to_solr }.to change(Spotlight::CustomField, :count).by(5)
       end
 
-      it "creates read-only custom fields" do
+      it 'creates read-only custom fields' do
         expect { subject.to_solr }.to change(Spotlight::CustomField.where(readonly_field: true), :count).by(5)
       end
 
       context 'custom class' do
         before do
-          Spotlight::Resources::Iiif::Engine.config.metadata_class = -> { TestMetadataClass }
+          Spotlight::Engine.config.iiif_metadata_class = -> { TestMetadataClass }
         end
 
         it 'merges the solr hash from the configured custom metadata class' do

spotlight_resources_iiif/spec/models/spotlight/resources/iiif_service_spec.rb → spec/models/spotlight/resources/iiif_service_spec.rb

@@ -1,4 +1,4 @@
-require 'rails_helper'
+require 'spec_helper'
 
 describe Spotlight::Resources::IiifService do
   let(:url) { 'uri://for-top-level-collection' }