hyrax-iiif_av 0.1.0

data/lib/generators/hyrax/iiif_av/templates/AvalonIiifPlayer.js

@@ -0,0 +1,28 @@
+import React from "react"
+import PropTypes from "prop-types"
+import IIIFPlayer from 'react-iiif-media-player'
+
+const config = {
+  fetch: {
+    options: {
+      credentials: 'include'
+    }
+  }
+};
+
+class AvalonIiifPlayer extends React.Component {
+  render () {
+    return (
+      <div>
+        <div id="iiif-manifest-url" data-manifest-url={this.props.manifestUrl}></div>
+        <IIIFPlayer config={config} />
+      </div>
+    );
+  }
+}
+
+AvalonIiifPlayer.propTypes = {
+  manifestUrl: PropTypes.string,
+  credentials: PropTypes.string
+};
+export default AvalonIiifPlayer

data/lib/generators/hyrax/iiif_av/templates/_avalon.html.erb

@@ -0,0 +1,23 @@
+<%#
+Copyright 2011-2018, The Trustees of Indiana University and Northwestern
+University. Additional copyright may be held by others, as reflected in
+the commit history.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+---  END LICENSE_HEADER BLOCK  ---
+%>
+<% content_for(:head) do %>
+  <%= javascript_pack_tag 'application' %>
+  <%= stylesheet_pack_tag 'application' %>
+<% end %>
+<%= react_component("AvalonIiifPlayer", { manifestUrl: main_app.polymorphic_path([main_app, :manifest, presenter], { locale: nil }) }) %>

data/lib/hyrax/iiif_av.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require "hyrax/iiif_av/engine"
+
+module Hyrax
+  module IiifAv
+    # Your code goes here...
+  end
+end

data/lib/hyrax/iiif_av/engine.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Hyrax
+  module IiifAv
+    class Engine < ::Rails::Engine
+      isolate_namespace Hyrax::IiifAv
+
+      def self.view_path
+        paths['app/views'].existent
+      end
+    end
+  end
+end

data/lib/hyrax/iiif_av/manifest_range.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module Hyrax
+  module IiifAv
+    class ManifestRange
+      attr_reader :label, :items
+
+      def initialize(label:, items: [])
+        @label = label
+        @items = items
+      end
+    end
+  end
+end

data/lib/hyrax/iiif_av/spec/shared_specs.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require 'hyrax/iiif_av/spec/shared_specs/controller_behavior'
+require 'hyrax/iiif_av/spec/shared_specs/displays_content'
+require 'hyrax/iiif_av/spec/shared_specs/displays_iiif_av'

data/lib/hyrax/iiif_av/spec/shared_specs/controller_behavior.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+# Copyright 2011-2018, The Trustees of Indiana University and Northwestern
+# University. Additional copyright may be held by others, as reflected in
+# the commit history.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ---  END LICENSE_HEADER BLOCK  ---
+
+RSpec.shared_examples "IiifAv::ControllerBehavior" do
+  routes { Rails.application.routes }
+  let(:main_app) { Rails.application.routes.url_helpers }
+  let(:hyrax) { Hyrax::Engine.routes.url_helpers }
+
+  describe '#manifest' do
+    let(:iiif_version) { 2 }
+    let(:presenter) { double("presenter", iiif_version: iiif_version) }
+    let(:mime2) { Hyrax::IiifAv::ControllerBehavior::IIIF_PRESENTATION_2_MIME }
+    let(:mime3) { Hyrax::IiifAv::ControllerBehavior::IIIF_PRESENTATION_3_MIME }
+    let(:manifest_factory2) { instance_double("IIIFManifest::ManifestBuilder", to_h: { test: 'manifest2' }) }
+    let(:manifest_factory3) { instance_double("IIIFManifest::V3::ManifestBuilder", to_h: { test: 'manifest3' }) }
+
+    before do
+      allow(controller).to receive(:presenter).and_return(presenter)
+      allow(IIIFManifest::ManifestFactory).to receive(:new).with(presenter).and_return(manifest_factory2)
+      allow(IIIFManifest::V3::ManifestFactory).to receive(:new).with(presenter).and_return(manifest_factory3)
+      request.headers['Accept'] = mime
+    end
+
+    context 'without an enabled presenter' do
+      let(:mime) { mime2 }
+      let(:presenter) { double("presenter") }
+
+      it 'returns IIIF V2 manifest' do
+        get :manifest, params: { id: 'testwork', format: :json }
+        expect(response.headers['Content-Type']).to eq mime
+        expect(response.body).to eq "{\"test\":\"manifest2\"}"
+      end
+    end
+
+    context 'for request accepting IIIF V2' do
+      let(:mime) { mime2 }
+
+      it 'returns IIIF V2 manifest' do
+        get :manifest, params: { id: 'testwork', format: :json }
+        expect(response.headers['Content-Type']).to eq mime
+        expect(response.body).to eq "{\"test\":\"manifest2\"}"
+      end
+    end
+
+    context 'for request accepting IIIF V3' do
+      let(:iiif_version) { 3 }
+      let(:mime) { mime3 }
+
+      it 'returns IIIF V3 manifest' do
+        get :manifest, params: { id: 'testwork', format: :json }
+        expect(response.headers['Content-Type']).to eq mime
+        expect(response.body).to eq "{\"test\":\"manifest3\"}"
+      end
+    end
+
+    context 'for request without IIIF profile' do
+      let(:mime) { "application/json;" }
+
+      it 'returns IIIF default version manifest' do
+        get :manifest, params: { id: 'testwork', format: :json }
+        expect(response.headers['Content-Type']).to eq Hyrax::IiifAv::ControllerBehavior::IIIF_PRESENTATION_2_MIME
+        # the following code assumes Hyrax::GenericWorksController::IIIF_DEFAULT_VERSION is 2;
+        # if this constant changes, this code also needs to be changed accordingly
+        expect(response.body).to eq "{\"test\":\"manifest2\"}"
+      end
+    end
+
+    context 'for request accepting both IIIF V2 and V3' do
+      let(:mime) { "#{mime2},#{mime3}" }
+      let(:iiif_version) { 3 }
+
+      it 'returns manifest with the highest accepted IIIF version' do
+        get :manifest, params: { id: 'testwork', format: :json }
+        expect(response.headers['Content-Type']).to eq mime3
+        expect(response.body).to eq "{\"test\":\"manifest3\"}"
+      end
+    end
+
+    context 'for request without accept header' do
+      let(:mime) { nil }
+
+      it 'returns manifest with the highest accepted IIIF version' do
+        get :manifest, params: { id: 'testwork', format: :json }
+        expect(response.headers['Content-Type']).to eq Hyrax::IiifAv::ControllerBehavior::IIIF_PRESENTATION_2_MIME
+        expect(response.body).to eq "{\"test\":\"manifest2\"}"
+      end
+
+      context 'for work with audio representative media' do
+        let(:mime) { nil }
+        let(:iiif_version) { 3 }
+        let(:rep_presenter) { instance_double("Hyrax::FileSetPresenter", audio?: true, video?: false) }
+
+        before do
+          allow(presenter).to receive(:representative_presenter).and_return(rep_presenter)
+        end
+
+        it 'returns manifest with the highest accepted IIIF version' do
+          get :manifest, params: { id: 'testwork', format: :json }
+          expect(response.headers['Content-Type']).to eq mime3
+          expect(response.body).to eq "{\"test\":\"manifest3\"}"
+        end
+      end
+
+      context 'for work with video representative media' do
+        let(:mime) { nil }
+        let(:iiif_version) { 3 }
+        let(:rep_presenter) { instance_double("Hyrax::FileSetPresenter", audio?: false, video?: true) }
+
+        before do
+          allow(presenter).to receive(:representative_presenter).and_return(rep_presenter)
+        end
+
+        it 'returns manifest with the highest accepted IIIF version' do
+          get :manifest, params: { id: 'testwork', format: :json }
+          expect(response.headers['Content-Type']).to eq mime3
+          expect(response.body).to eq "{\"test\":\"manifest3\"}"
+        end
+      end
+
+      context 'for work with non-av representative media' do
+        let(:mime) { nil }
+        let(:rep_presenter) { instance_double("Hyrax::FileSetPresenter", audio?: false, video?: false) }
+
+        before do
+          allow(presenter).to receive(:representative_presenter).and_return(rep_presenter)
+        end
+
+        it 'returns manifest with the highest accepted IIIF version' do
+          get :manifest, params: { id: 'testwork', format: :json }
+          expect(response.headers['Content-Type']).to eq mime2
+          expect(response.body).to eq "{\"test\":\"manifest2\"}"
+        end
+      end
+    end
+
+    context 'for request with default browser accept header' do
+      let(:mime) { "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8" }
+
+      it 'returns manifest with the highest accepted IIIF version' do
+        get :manifest, params: { id: 'testwork', format: :json }
+        expect(response.headers['Content-Type']).to eq Hyrax::IiifAv::ControllerBehavior::IIIF_PRESENTATION_2_MIME
+        expect(response.body).to eq "{\"test\":\"manifest2\"}"
+      end
+
+      context 'for work with audio representative media' do
+        let(:mime) { nil }
+        let(:iiif_version) { 3 }
+        let(:rep_presenter) { instance_double("Hyrax::FileSetPresenter", audio?: true, video?: false) }
+
+        before do
+          allow(presenter).to receive(:representative_presenter).and_return(rep_presenter)
+        end
+
+        it 'returns manifest with the highest accepted IIIF version' do
+          get :manifest, params: { id: 'testwork', format: :json }
+          expect(response.headers['Content-Type']).to eq mime3
+          expect(response.body).to eq "{\"test\":\"manifest3\"}"
+        end
+      end
+
+      context 'for work with video representative media' do
+        let(:mime) { nil }
+        let(:iiif_version) { 3 }
+        let(:rep_presenter) { instance_double("Hyrax::FileSetPresenter", audio?: false, video?: true) }
+
+        before do
+          allow(presenter).to receive(:representative_presenter).and_return(rep_presenter)
+        end
+
+        it 'returns manifest with the highest accepted IIIF version' do
+          get :manifest, params: { id: 'testwork', format: :json }
+          expect(response.headers['Content-Type']).to eq mime3
+          expect(response.body).to eq "{\"test\":\"manifest3\"}"
+        end
+      end
+
+      context 'for work with non-av representative media' do
+        let(:mime) { nil }
+        let(:rep_presenter) { instance_double("Hyrax::FileSetPresenter", audio?: false, video?: false) }
+
+        before do
+          allow(presenter).to receive(:representative_presenter).and_return(rep_presenter)
+        end
+
+        it 'returns manifest with the highest accepted IIIF version' do
+          get :manifest, params: { id: 'testwork', format: :json }
+          expect(response.headers['Content-Type']).to eq mime2
+          expect(response.body).to eq "{\"test\":\"manifest2\"}"
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/iiif_av/spec/shared_specs/displays_content.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "IiifAv::DisplaysContent" do
+  let(:id) { '12345' }
+  let(:solr_document) { SolrDocument.new(id: id) }
+  let(:request) { instance_double("Request", base_url: 'http://test.host') }
+  let(:ability) { instance_double("Ability") }
+  let(:presenter) { described_class.new(solr_document, ability, request) }
+  let(:read_permission) { true }
+  let(:parent_presenter) { double("Hyrax::GenericWorkPresenter", iiif_version: 2) }
+  let(:first_title) { 'File Set Title' }
+  let(:title) { [first_title] }
+
+  before do
+    allow(ability).to receive(:can?).with(:read, solr_document.id).and_return(read_permission)
+    allow(presenter).to receive(:parent).and_return(parent_presenter)
+    allow(presenter).to receive(:title).and_return(title)
+  end
+
+  describe '#display_content' do
+    it 'responds to #display_content' do
+      expect(presenter.respond_to?(:display_content)).to be true
+    end
+
+    let(:content) { presenter.display_content }
+
+    context 'without a file' do
+      let(:id) { 'bogus' }
+
+      it 'is nil' do
+        expect(content).to be_nil
+      end
+    end
+
+    context 'with a file' do
+      context "when the file is not a known file" do
+        it 'is nil' do
+          expect(content).to be_nil
+        end
+      end
+
+      context "when the file is a sound recording" do
+        let(:solr_document) { SolrDocument.new(id: '12345', duration_tesim: 1000) }
+        let(:mp3_url) { "http://test.host/downloads/#{solr_document.id}?file=mp3" }
+        let(:ogg_url) { "http://test.host/downloads/#{solr_document.id}?file=ogg" }
+
+        before do
+          allow(solr_document).to receive(:audio?).and_return(true)
+        end
+
+        it 'creates an array of content objects' do
+          expect(content).to all(be_instance_of IIIFManifest::V3::DisplayContent)
+          expect(content.length).to eq 2
+          expect(content.map(&:type)).to all(eq 'Sound')
+          expect(content.map(&:duration)).to all(eq 1.000)
+          expect(content.map(&:label)).to match_array(['mp3', 'ogg'])
+          expect(content.map(&:url)).to match_array([mp3_url, ogg_url])
+        end
+      end
+
+      context "when the file is a video" do
+        let(:solr_document) { SolrDocument.new(id: '12345', width_is: 640, height_is: 480, duration_tesim: 1000) }
+        let(:mp4_url) { "http://test.host/downloads/#{id}?file=mp4" }
+        let(:webm_url) { "http://test.host/downloads/#{id}?file=webm" }
+
+        before do
+          allow(solr_document).to receive(:video?).and_return(true)
+        end
+
+        it 'creates an array of content objects' do
+          expect(content).to all(be_instance_of IIIFManifest::V3::DisplayContent)
+          expect(content.length).to eq 2
+          expect(content.map(&:type)).to all(eq 'Video')
+          expect(content.map(&:width)).to all(eq 640)
+          expect(content.map(&:height)).to all(eq 480)
+          expect(content.map(&:duration)).to all(eq 1.000)
+          expect(content.map(&:label)).to match_array(['mp4', 'webm'])
+          expect(content.map(&:url)).to match_array([mp4_url, webm_url])
+        end
+      end
+
+      context 'when the file is an audio derivative with metadata' do
+        let(:derivatives_metadata) do
+          [
+            { id: '1', label: 'high', external_file_uri: 'http://test.com/high.mp3' },
+            { id: '2', label: 'medium', external_file_uri: 'http://test.com/medium.mp3' }
+          ]
+        end
+        let(:solr_document) { SolrDocument.new(id: '12345', duration_tesim: 1000, derivatives_metadata_ssi: derivatives_metadata.to_json) }
+
+        before do
+          allow(solr_document).to receive(:audio?).and_return(true)
+        end
+
+        it 'creates an array of content objects with metadata' do
+          expect(content).to all(be_instance_of IIIFManifest::V3::DisplayContent)
+          expect(content.length).to eq 2
+          expect(content.map(&:label)).to match_array(['high', 'medium'])
+          expect(content.map(&:url)).to match_array(['http://test.com/high.mp3', 'http://test.com/medium.mp3'])
+        end
+      end
+
+      context "when the file is an image" do
+        before do
+          allow(solr_document).to receive(:image?).and_return(true)
+        end
+
+        it 'creates a content object' do
+          expect(content).to be_instance_of IIIFManifest::DisplayImage
+          expect(content.url).to eq "http://test.host/#{id}/full/600,/0/default.jpg"
+        end
+
+        context 'with custom image size default' do
+          let(:custom_image_size) { '666,' }
+
+          around do |example|
+            default_image_size = Hyrax.config.iiif_image_size_default
+            Hyrax.config.iiif_image_size_default = custom_image_size
+            example.run
+            Hyrax.config.iiif_image_size_default = default_image_size
+          end
+
+          it 'creates a content object' do
+            expect(content).to be_instance_of IIIFManifest::DisplayImage
+            expect(content.url).to eq "http://test.host/#{id}/full/#{custom_image_size}/0/default.jpg"
+          end
+        end
+
+        context 'with custom image url builder' do
+          let(:custom_builder) do
+            ->(file_id, base_url, _size) { "#{base_url}/downloads/#{file_id.split('/').first}" }
+          end
+
+          around do |example|
+            default_builder = Hyrax.config.iiif_image_url_builder
+            Hyrax.config.iiif_image_url_builder = custom_builder
+            example.run
+            Hyrax.config.iiif_image_url_builder = default_builder
+          end
+
+          it 'creates a content object' do
+            expect(content).to be_instance_of IIIFManifest::DisplayImage
+            expect(content.url).to eq "http://test.host/downloads/#{id.split('/').first}"
+          end
+        end
+
+        context "when the user doesn't have permission to view the image" do
+          let(:read_permission) { false }
+
+          it 'is nil' do
+            expect(content).to be_nil
+          end
+        end
+
+        context "when the parent presenter's iiif_version is 3" do
+          let(:parent_presenter) { double("Hyrax::GenericWorkPresenter", iiif_version: 3) }
+
+          it 'creates a V3 content object' do
+            expect(content).to be_instance_of IIIFManifest::V3::DisplayContent
+            expect(content.url).to eq "http://test.host/#{id}/full/600,/0/default.jpg"
+          end
+        end
+      end
+    end
+  end
+end