blacklight-spotlight 0.32.0 → 0.33.0

data/spec/models/spotlight/solr_document/uploaded_resource_spec.rb

@@ -1,4 +1,3 @@
-
 describe Spotlight::SolrDocument::UploadedResource, type: :model do
   let(:valid_resource) do
     SolrDocument.new(id: '123',
@@ -17,35 +16,18 @@ describe Spotlight::SolrDocument::UploadedResource, type: :model do
     end
   end
   describe 'to_openseadragon' do
-    let(:subject) { valid_resource.to_openseadragon }
-    it 'includes hashes for each full_image_url_ssm' do
-      expect(subject).to be_an Array
-      expect(subject.length).to eq 1
-      expect(subject.first.keys.length).to eq 1
-    end
-    it 'the hashes key should be a LegacyImagePyramidTileSource object' do
-      expect(subject.first.keys.first).to be_a(Spotlight::SolrDocument::UploadedResource::LegacyImagePyramidTileSource)
+    subject(:osd) { valid_resource.to_openseadragon }
+    let(:uploaded_resource) { instance_double(Spotlight::Resources::Upload, upload: upload) }
+    let(:upload) { instance_double(Spotlight::FeaturedImage, iiif_tilesource: '/whatever/info.json') }
+
+    before do
+      allow(valid_resource).to receive(:uploaded_resource).and_return(uploaded_resource)
     end
-    describe 'LegacyImagePyramidTileSource' do
-      let(:subject) { valid_resource.to_openseadragon.first.keys.first.to_tilesource }
-      it 'is a hash' do
-        expect(subject).to be_a Hash
-      end
-      it 'is a legacy image pyramid type' do
-        expect(subject[:type]).to eq 'legacy-image-pyramid'
-      end
-      describe 'levels' do
-        it 'includes one level' do
-          expect(subject[:levels].length).to eq 1
-        end
-        it 'includes the image url' do
-          expect(subject[:levels].first[:url]).to eq 'http://example.com/png.png'
-        end
-        it 'includes the height and width from the document' do
-          expect(subject[:levels].first[:height]).to eq '1400'
-          expect(subject[:levels].first[:width]).to eq '1000'
-        end
-      end
+
+    it 'includes hashes for each full_image_url_ssm' do
+      expect(osd).to be_an Array
+      expect(osd.length).to eq 1
+      expect(osd.first).to end_with '/whatever/info.json'
     end
   end
 end

data/spec/presenters/spotlight/iiif_manifest_presenter_spec.rb

@@ -0,0 +1,123 @@
+describe Spotlight::IiifManifestPresenter do
+  require 'iiif_manifest'
+
+  let(:resource) { FactoryGirl.build(:uploaded_resource) }
+  let(:controller) { double(Spotlight::CatalogController) }
+
+  let(:subject) { described_class.new(resource, controller) }
+
+  let(:profile_url) { 'http://iiif.io/api/image/2/level2.json' }
+
+  describe 'public methods' do
+    let(:iiif_url) { 'https://iiif.test/images/1-1' }
+    let(:endpoint) { IIIFManifest::IIIFEndpoint.new(iiif_url, profile: profile_url) }
+    let(:manifest_url) { 'https://iiif.test/spotlight/test/catalog/1-1/manifest' }
+    let(:spotlight_route_helper) { double }
+    let(:blacklight_config) { double(Spotlight::BlacklightConfiguration) }
+
+    let(:id) { 123 }
+    let(:title_field_name) { 'title_field_name' }
+    let(:title_field_value) { 'title' }
+    let(:description_field_value) { 'description' }
+    let(:img_width) { 11 }
+    let(:img_height) { 10 }
+
+    before do
+      allow(resource).to receive(:uploaded_resource).and_return(double(exhibit: resource.exhibit))
+
+      allow(spotlight_route_helper).to receive(:manifest_exhibit_solr_document_url).with(resource.exhibit, resource).and_return(manifest_url)
+      allow(controller).to receive(:spotlight).and_return(spotlight_route_helper)
+
+      allow(blacklight_config).to receive(:view_config).with(:show).and_return(double(title_field: title_field_name))
+      allow(controller).to receive(:blacklight_config).and_return(blacklight_config)
+
+      allow(resource).to receive(:first).with(title_field_name).and_return(title_field_value)
+      allow(resource).to receive(:first).with(Spotlight::Engine.config.upload_description_field).and_return(description_field_value)
+      allow(resource).to receive(:first).with(:spotlight_full_image_width_ssm).and_return(img_width)
+      allow(resource).to receive(:first).with(:spotlight_full_image_height_ssm).and_return(img_height)
+
+      allow(subject).to receive(:endpoint).and_return(endpoint)
+      allow(subject).to receive(:id).and_return(id)
+    end
+
+    describe '#display_image' do
+      it 'returns a properly configured instance of IIIFManifest::DisplayImage' do
+        # can't do:
+        #   expect(subject.display_image).to eq(IIIFManifest::DisplayImage.new(0, width: 10, height: 10, format: 'image/jpeg', iiif_endpoint: endpoint))
+        # because IIIFManifest::DisplayImage doesn't implement #==
+        result = subject.display_image
+        expect(result.url).to eq id
+        expect(result.width).to eq img_width
+        expect(result.height).to eq img_height
+        expect(result.format).to eq 'image/jpeg'
+        expect(result.iiif_endpoint).to eq endpoint
+      end
+    end
+
+    describe '#file_set_presenters' do
+      it "returns a single-element list containing the presenter object on which it's called" do
+        expect(subject.file_set_presenters).to eq([subject])
+      end
+    end
+
+    describe '#work_presenters' do
+      it "returns an empty list, because we don't yet support interstitial nodes in the document manifest" do
+        expect(subject.work_presenters).to eq([])
+      end
+    end
+
+    describe '#manifest_url' do
+      it 'relays the value from the spotlight route url helper' do
+        expect(subject.manifest_url).to eq(manifest_url)
+      end
+    end
+
+    describe '#description' do
+      it 'gets the description from the resource using the configured upload_description_field' do
+        expect(subject.description).to eq(description_field_value)
+      end
+    end
+
+    describe '#to_s' do
+      it "uses the resource's title field value as the presenter's string representation" do
+        expect(subject.to_s).to eq(title_field_value)
+      end
+    end
+
+    describe '#iiif_manifest' do
+      it 'builds a IIIFManifest object based on the presenter object info' do
+        result = subject.iiif_manifest
+        expect(result).to be_an_instance_of(IIIFManifest::ManifestBuilder)
+        expect(result.work).to be(subject)
+      end
+    end
+
+    describe '#iiif_manifest_json' do
+      it 'returns json for the manifest generated from the presenter object info' do
+        expect(subject.iiif_manifest_json).to eq(subject.iiif_manifest.to_h.to_json)
+      end
+    end
+  end
+
+  describe 'private methods' do
+    describe '#endpoint' do
+      it 'returns a properly configured instance of IIIFManifest::IIIFEndpoint' do
+        iiif_url = 'https://iiif.test/images/1-1'
+        allow(subject).to receive(:iiif_url).and_return(iiif_url)
+
+        result = subject.send(:endpoint)
+        expect(result.url).to eq(iiif_url)
+        expect(result.profile).to eq(profile_url)
+      end
+    end
+
+    describe '#iiif_url' do
+      it 'returns the info_url from the Riiif engine routes, minus the trailing .json' do
+        riiif_route_helper = double(info_url: 'https://iiif.test/path/info.json')
+        allow(controller).to receive(:riiif).and_return(riiif_route_helper)
+
+        expect(subject.send(:iiif_url)).to eq('https://iiif.test/path')
+      end
+    end
+  end
+end

data/spec/routing/spotlight/exhibit_catalog_spec.rb

@@ -5,5 +5,9 @@ describe 'Catalog controller', type: :routing do
     it 'routes to #edit' do
       expect(get('/1/catalog/dq287tq6352/edit')).to route_to('spotlight/catalog#edit', exhibit_id: '1', id: 'dq287tq6352')
     end
+
+    it 'routes to #manifest' do
+      expect(get('/1/catalog/1-1/manifest.json')).to route_to('spotlight/catalog#manifest', exhibit_id: '1', id: '1-1', format: 'json')
+    end
   end
 end

data/spec/routing/spotlight/featured_images_spec.rb

@@ -0,0 +1,21 @@
+describe 'Featured Images Controller', type: :routing do
+  describe 'routing' do
+    routes { Spotlight::Engine.routes }
+
+    it 'routes to /contact_images to #create' do
+      expect(post('/contact_images')).to route_to 'spotlight/featured_images#create'
+    end
+
+    it 'routes to /exhibit_thumbnails to #create' do
+      expect(post('/exhibit_thumbnails')).to route_to 'spotlight/featured_images#create'
+    end
+
+    it 'routes to /mastheads to #create' do
+      expect(post('/mastheads')).to route_to 'spotlight/featured_images#create'
+    end
+
+    it 'routes to /featured_images to #create' do
+      expect(post('/featured_images')).to route_to 'spotlight/featured_images#create'
+    end
+  end
+end

data/spec/serializers/spotlight/exhibit_export_serializer_spec.rb

@@ -122,18 +122,21 @@ describe Spotlight::ExhibitExportSerializer do
     end
 
     context 'for an exhibit with contacts' do
-      let!(:curator) do
-        FactoryGirl.create(:contact,
-                           exhibit: source_exhibit,
-                           contact_info: { title: 'xyz' })
-      end
-      it 'has contacts' do
-        expect(subject.contacts.count).to eq 1
-        contact = subject.contacts.first
-        expect(contact.contact_info[:title]).to eq 'xyz'
+      context 'for a contact with an avatar' do
+        let!(:curator) do
+          FactoryGirl.create(:contact, :with_avatar,
+                             exhibit: source_exhibit,
+                             contact_info: { title: 'xyz' })
+        end
+        it 'has contacts' do
+          expect(subject.contacts.count).to eq 1
+          contact = subject.contacts.first
+          expect(contact.contact_info[:title]).to eq 'xyz'
+          expect(contact.avatar).to be_kind_of Spotlight::ContactImage
+        end
       end
 
-      describe 'for a contact without an avatar' do
+      context 'for a contact without an avatar' do
         let!(:curator) do
           FactoryGirl.create(:contact, exhibit: source_exhibit, avatar: nil)
         end
@@ -213,7 +216,7 @@ describe Spotlight::ExhibitExportSerializer do
       resource = FactoryGirl.create :uploaded_resource, exhibit: source_exhibit
       expect(subject.resources.length).to eq 1
       expect(subject.resources.first.class).to eq Spotlight::Resources::Upload
-      expect(subject.resources.first.url.file.path).not_to eq resource.url.file.path
+      expect(subject.resources.first.upload.image.path).not_to eq resource.upload.image.path
     end
 
     it 'assigns normal resources the correct class' do
@@ -223,12 +226,6 @@ describe Spotlight::ExhibitExportSerializer do
       expect(subject.resources.first.url).to eq resource.url
     end
 
-    it 'copies contact avatars' do
-      contact = FactoryGirl.create :contact, exhibit: source_exhibit
-      expect(subject.contacts.length).to eq 1
-      expect(subject.contacts.first.avatar.file.path).not_to eq contact.avatar.file.path
-    end
-
     context 'with a browse category' do
       let(:masthead) { FactoryGirl.create(:masthead) }
       let(:thumbnail) { FactoryGirl.create(:featured_image) }
@@ -289,7 +286,7 @@ describe Spotlight::ExhibitExportSerializer do
     end
 
     context 'with a thumbnail' do
-      let!(:thumbnail) { FactoryGirl.create(:featured_image) }
+      let!(:thumbnail) { FactoryGirl.create(:exhibit_thumbnail) }
 
       before do
         source_exhibit.thumbnail = thumbnail

data/spec/services/spotlight/iiif_resource_resolver_spec.rb

@@ -0,0 +1,90 @@
+describe Spotlight::IiifResourceResolver do
+  let(:fixture_json) do
+    File.open(
+      File.expand_path(File.join('..', 'spec', 'fixtures', 'gk446cj2442-manifest.json'), Rails.root)
+    ).read
+  end
+  let(:iiif_manifest_url) { 'https://purl.stanford.edu/gk446cj2442/manifest.json' }
+  let(:resource) do
+    FactoryGirl.create(
+      :featured_image,
+      iiif_manifest_url: iiif_manifest_url,
+      iiif_image_id: 'https://purl.stanford.edu/gk446cj2442/iiif/annotation/gk446cj2442_1',
+      iiif_canvas_id: 'https://purl.stanford.edu/gk446cj2442/iiif/canvas/gk446cj2442_1',
+      iiif_tilesource: 'https://stacks.stanford.edu/image/iiif/gk446cj2442%2Fgk446cj2442_05_0001/info.json'
+    )
+  end
+
+  subject(:resolver) { described_class.new(resource) }
+
+  before do
+    expect(resolver).to receive(:response).and_return(fixture_json)
+  end
+
+  context 'success' do
+    context 'when the tilesource has changed' do
+      before do
+        resource.iiif_tilesource = 'a-tilesource-that-no-longer-exists'
+        resource.save
+      end
+      it 'the resource is updated and saved' do
+        expect(resource).to receive(:save).and_call_original
+        resolver.resolve!
+        expect(resource.reload.iiif_tilesource).to eq 'https://stacks.stanford.edu/image/iiif/gk446cj2442%2Fgk446cj2442_05_0001/info.json'
+      end
+    end
+
+    context 'when the tilesource has not changed' do
+      it 'the resource is not saved' do
+        expect(resource).not_to receive(:save)
+        resolver.resolve!
+      end
+
+      it 'a statment indicating nothing was changed is loged' do
+        expect(Rails.logger).to receive(:info).with(
+          "Spotlight::IiifResourceResolver resolved #{iiif_manifest_url}, but nothing changed."
+        )
+        resolver.resolve!
+      end
+    end
+  end
+
+  context 'failure' do
+    before do
+      expect(resource).not_to receive(:save) # No spec should trigger a save under failure
+    end
+
+    context 'when the stored canvas ID is not present' do
+      it 'raises a ManifestError' do
+        resource.iiif_canvas_id = 'not-a-real-canvas-id'
+
+        expect { resolver.resolve! }.to raise_error(
+          Spotlight::IiifResourceResolver::ManifestError,
+          "No canvas with @id not-a-real-canvas-id found in #{iiif_manifest_url}"
+        )
+      end
+    end
+
+    context 'when the stored canvas ID is not present' do
+      it 'raises a ManifestError' do
+        resource.iiif_image_id = 'not-a-real-image-id'
+
+        expect { resolver.resolve! }.to raise_error(
+          Spotlight::IiifResourceResolver::ManifestError,
+          "No image with @id not-a-real-image-id found in #{iiif_manifest_url}"
+        )
+      end
+    end
+
+    context 'when the JSON is unparsable' do
+      let(:fixture_json) { 'Some sort of html error!' }
+      it 'logs that the JSON was unparsable and falls through to an no-canvas error' do
+        klass = described_class.name
+        expect(Rails.logger).to receive(:warn).with(
+          a_string_matching(/#{klass} failed to parse #{iiif_manifest_url} with: \d{3}: unexpected token at '#{fixture_json}'/)
+        )
+        expect { resolver.resolve! }.to raise_error(Spotlight::IiifResourceResolver::ManifestError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -40,6 +40,9 @@ end
 
 require 'spotlight'
 
+# configure spotlight with all the settings necessary to test functionality
+Spotlight::Engine.config.exhibit_themes = %w(default modern)
+
 Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
 
 FactoryGirl.definition_file_paths = [File.expand_path('../factories', __FILE__)]

data/spec/support/features/test_features_helpers.rb

@@ -1,11 +1,12 @@
 module Spotlight
   module TestFeaturesHelpers
     def fill_in_typeahead_field(opts = {})
+      type = opts[:type] || 'twitter'
       # Poltergeist / Capybara doesn't fire the events typeahead.js
       # is listening for, so we help it out a little:
       page.execute_script <<-EOF
-        $("[data-twitter-typeahead]").val("#{opts[:with]}").trigger("input");
-        $("[data-twitter-typeahead]").typeahead("open");
+        $("[data-#{type}-typeahead]:visible").val("#{opts[:with]}").trigger("input");
+        $("[data-#{type}-typeahead]:visible").typeahead("open");
         $(".tt-suggestion").click();
       EOF
 

data/spec/support/stub_iiif_response.rb

@@ -0,0 +1,24 @@
+require 'fixtures/iiif_responses'
+module StubIiifResponse
+  def stub_iiif_response_for_url(url, response)
+    allow(Spotlight::Resources::IiifService).to receive(:iiif_response).with(url).and_return(response)
+  end
+
+  def stub_default_collection
+    allow_any_instance_of(Spotlight::Resources::IiifHarvester).to receive_messages(url_is_iiif?: true)
+    stub_iiif_response_for_url('uri://for-top-level-collection', complex_collection)
+    stub_iiif_response_for_url('uri://for-child-collection1', child_collection1)
+    stub_iiif_response_for_url('uri://for-child-collection2', child_collection2)
+    stub_iiif_response_for_url('uri://for-child-collection3', child_collection3)
+
+    stub_iiif_response_for_url('uri://for-manifest1', test_manifest1)
+    stub_iiif_response_for_url('uri://for-manifest2', test_manifest2)
+    stub_iiif_response_for_url('uri://for-manifest3', test_manifest3)
+    stub_iiif_response_for_url('uri://for-manifest4', test_manifest4)
+  end
+end
+
+RSpec.configure do |config|
+  config.include IiifResponses
+  config.include StubIiifResponse
+end

data/spec/support/views/test_view_helpers.rb

@@ -9,6 +9,7 @@ module Spotlight
         view.send(:extend, Spotlight::CrudLinkHelpers)
         view.send(:extend, Spotlight::TitleHelper)
         view.send(:extend, Spotlight::NavbarHelper)
+        view.send(:extend, Spotlight::CropHelper)
         view.send(:extend, Blacklight::ComponentHelperBehavior)
         view.send(:extend, BreadcrumbsOnRails::ActionController::HelperMethods)
       end

data/spec/test_app_templates/Gemfile.extra

@@ -1 +0,0 @@
-gem 'friendly_id', github: 'norman/friendly_id'

data/spec/uploaders/spotlight/attachment_uploader_spec.rb

@@ -0,0 +1,24 @@
+describe Spotlight::AttachmentUploader do
+  let(:mounter) { Spotlight::Attachment.new(id: '5') }
+  subject(:attachment_uploader) { described_class.new(mounter, 'mounted_as') }
+
+  describe '#store_dir' do
+    let(:store_dir) { attachment_uploader.store_dir }
+
+    it 'is prefixed with "uploads/spotlight"' do
+      expect(store_dir).to start_with 'uploads/spotlight/'
+    end
+
+    it "includes the mounter's class name" do
+      expect(store_dir).to match '/attachment/'
+    end
+
+    it 'includes the mounted_as option' do
+      expect(store_dir).to match '/mounted_as/'
+    end
+
+    it "ends with the mounter's id" do
+      expect(store_dir).to end_with "/#{mounter.id}"
+    end
+  end
+end