hyrax-iiif_av 0.1.0

data/app/helpers/hyrax/iiif_av/iiif_av_helper.rb

@@ -0,0 +1,40 @@
+# 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  ---
+
+module Hyrax
+  module IiifAv
+    module IiifAvHelper
+      def iiif_viewer_display(presenter, locals = {})
+        render iiif_viewer_display_partial(presenter),
+               locals.merge(presenter: presenter)
+      end
+
+      def iiif_viewer_display_partial(work_presenter)
+        'hyrax/base/iiif_viewers/' + iiif_viewer_for_work(work_presenter).to_s
+      end
+
+      def iiif_viewer_for_work(work_presenter)
+        if work_presenter.respond_to? :iiif_viewer
+          work_presenter.iiif_viewer
+        else
+          :universal_viewer
+        end
+      end
+    end
+  end
+end

data/app/presenters/concerns/hyrax/iiif_av/displays_content.rb

@@ -0,0 +1,123 @@
+# 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  ---
+
+require 'iiif_manifest'
+
+module Hyrax
+  module IiifAv
+    # This gets mixed into IiifFileSetPresenter in order to create
+    # a canvas on a IIIF manifest
+    module DisplaysContent
+      extend ActiveSupport::Concern
+
+      # Creates a display content only where FileSet is an image, audio, or video.
+      #
+      # @return [IIIFManifest::V3::DisplayContent] the display content required by the manifest builder.
+      def display_content
+        return nil unless display_content_allowed?
+
+        return image_content if solr_document.image?
+        return video_content if solr_document.video?
+        return audio_content if solr_document.audio?
+      end
+
+      private
+
+        def display_content_allowed?
+          content_supported? && current_ability.can?(:read, id)
+        end
+
+        def content_supported?
+          solr_document.video? || solr_document.audio? || solr_document.image?
+        end
+
+        def image_content
+          url = Hyrax.config.iiif_image_url_builder.call(
+            solr_document.id,
+            request.base_url,
+            Hyrax.config.iiif_image_size_default
+          )
+
+          # Look at the request and target prezi 2 or 3 for images
+          parent.iiif_version == 3 ? image_content_v3(url) : image_content_v2(url)
+        end
+
+        def image_content_v3(url)
+          # @see https://github.com/samvera-labs/iiif_manifest
+          IIIFManifest::V3::DisplayContent.new(url,
+                                               width: 640,
+                                               height: 480,
+                                               type: 'Image',
+                                               iiif_endpoint: iiif_endpoint(solr_document.id))
+        end
+
+        def image_content_v2(url)
+          # @see https://github.com/samvera-labs/iiif_manifest
+          IIIFManifest::DisplayImage.new(url,
+                                         width: 640,
+                                         height: 480,
+                                         iiif_endpoint: iiif_endpoint(solr_document.id))
+        end
+
+        def video_content
+          # @see https://github.com/samvera-labs/iiif_manifest
+          if solr_document['derivatives_metadata_ssi'].present?
+            files_metadata = JSON.parse(solr_document['derivatives_metadata_ssi'])
+            external_files = files_metadata.select { |f| f['external_file_uri'].present? }
+            unless external_files.empty?
+              return external_files.map do |f|
+                uri = URI(f['external_file_uri'])
+                uri = URI.join(request.base_url, uri) if uri.relative?
+                video_display_content(uri, f['label'])
+              end
+            end
+          end
+          [video_display_content(download_path('mp4'), 'mp4'), video_display_content(download_path('webm'), 'webm')]
+        end
+
+        def video_display_content(url, label = '')
+          IIIFManifest::V3::DisplayContent.new(url,
+                                               label: label,
+                                               width: Array(solr_document.width).first.try(:to_i),
+                                               height: Array(solr_document.height).first.try(:to_i),
+                                               duration: Array(solr_document.duration).first.try(:to_i) / 1000.0,
+                                               type: 'Video')
+        end
+
+        def audio_content
+          if solr_document['derivatives_metadata_ssi'].present?
+            files_metadata = JSON.parse(solr_document['derivatives_metadata_ssi'])
+            external_files = files_metadata.select { |f| f['external_file_uri'].present? }
+            return external_files.map { |f| audio_display_content(f['external_file_uri'], f['label']) } unless external_files.empty?
+          end
+          [audio_display_content(download_path('ogg'), 'ogg'), audio_display_content(download_path('mp3'), 'mp3')]
+        end
+
+        def audio_display_content(url, label = '')
+          IIIFManifest::V3::DisplayContent.new(url,
+                                               label: label,
+                                               duration: Array(solr_document.duration).first.try(:to_i) / 1000.0,
+                                               type: 'Sound')
+        end
+
+        def download_path(extension)
+          Hyrax::Engine.routes.url_helpers.download_url(solr_document, file: extension, host: request.base_url)
+        end
+    end
+  end
+end

data/app/presenters/concerns/hyrax/iiif_av/displays_iiif_av.rb

@@ -0,0 +1,87 @@
+# 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  ---
+
+require 'hyrax/iiif_av/manifest_range'
+
+module Hyrax
+  module IiifAv
+    module DisplaysIiifAv
+      extend ActiveSupport::Concern
+
+      IIIF_DEFAULT_VERSION = 2
+      IIIF_DEFAULT_MANIFEST_MIME = "application/json;profile=http://iiif.io/api/presentation/#{IIIF_DEFAULT_VERSION}/context.json"
+
+      # @return [Boolean] render a IIIF viewer
+      def iiif_viewer?
+        representative_id.present? &&
+          representative_presenter.present? &&
+          (representative_presenter.video? ||
+           representative_presenter.audio? ||
+           (representative_presenter.image? && Hyrax.config.iiif_image_server?))
+      end
+
+      alias universal_viewer? iiif_viewer?
+      # deprecation_deprecate universal_viewer?: "use iiif_viewer? instead"
+
+      def iiif_viewer
+        if representative_presenter.video? || representative_presenter.audio?
+          :avalon
+        elsif representative_presenter.image?
+          :universal_viewer
+        end
+      end
+
+      # @return the highest IIIF version (as an integer) specified in the Accept request header, or the default version if none specified
+      def iiif_version
+        accept = parse_accept(request.headers['Accept'])
+        return accept if accept.present?
+        if representative_presenter.present? &&
+           (representative_presenter.video? ||
+            representative_presenter.audio?)
+          3
+        else
+          IIIF_DEFAULT_VERSION
+        end
+      end
+
+      def ranges
+        [
+          Hyrax::IiifAv::ManifestRange.new(
+            label: { '@none'.to_sym => title.first },
+            items: file_set_presenters.collect(&:range)
+          )
+        ]
+      end
+
+      private
+
+        def parse_accept(accept)
+          return nil if accept.blank?
+          version = 0 # assume all valid versions will be at least greater than 0
+          # check for multiple profiles for highest IIIF version. Note: only digits are allowed in the version number
+          regexp = Regexp.new(Regexp.escape(IIIF_DEFAULT_MANIFEST_MIME[/profile.*$/]).gsub("/#{IIIF_DEFAULT_VERSION}/", "/(\\d+)/"))
+          accept.scan(regexp).each do |matched|
+            v = matched[0].to_i
+            version = v > version ? v : version
+          end
+          version.zero? ? nil : version
+        end
+    end
+  end
+end

data/app/presenters/hyrax/iiif_av/iiif_file_set_presenter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module IiifAv
+    class IiifFileSetPresenter < ::Hyrax::FileSetPresenter
+      include Hyrax::IiifAv::DisplaysContent
+
+      # Override this to include ranges in your manifest
+      def range
+        []
+      end
+    end
+  end
+end

data/app/views/hyrax/base/_representative_media.html.erb

@@ -0,0 +1,27 @@
+<%#
+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  ---
+%>
+<% if presenter.representative_id.present? && presenter.representative_presenter.present? %>
+  <% if defined?(viewer) && viewer %>
+    <%= iiif_viewer_display presenter %>
+  <% else %>
+    <%= media_display presenter.representative_presenter %>
+  <% end %>
+<% else %>
+  <%= image_tag 'default.png', class: "canonical-image" %>
+<% end %>

data/app/views/hyrax/base/iiif_viewers/_universal_viewer.html.erb

@@ -0,0 +1,4 @@
+<%= PulUvRails::UniversalViewer.script_tag %>
+<div class="viewer-wrapper">
+  <div class="uv viewer" data-uri="<%= main_app.polymorphic_path [main_app, :manifest, presenter], { locale: nil } %>"></div>
+</div>

data/bin/rails

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/hyrax/iiif_av/engine', __dir__)
+# APP_PATH = File.expand_path('../.internal_test_app/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/hyrax-iiif_av.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+
+# Maintain your gem's version:
+require "hyrax/iiif_av/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "hyrax-iiif_av"
+  s.version     = Hyrax::IiifAv::VERSION
+  s.authors     = ["Chris Colvard", "Brian Keese", "Ying Feng", "Phuong Dinh"]
+  s.email       = ["cjcolvar@indiana.edu", "bkeese@indiana.edu", "yingfeng@iu.edu", "phuongdh@gmail.com"]
+  s.summary     = "Hyrax plugin for IIIF Presentation 3.0 audiovisual support"
+  s.description = "Hyrax plugin for IIIF Presentation 3.0 audiovisual support"
+  s.license     = 'Apache-2.0'
+
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  s.add_dependency "rails", "~>5.1"
+  s.add_dependency "blacklight"
+  s.add_dependency "hyrax", "~> 2.1"
+  s.add_dependency "iiif_manifest", "~> 0.5"
+
+  s.add_development_dependency 'bixby'
+  s.add_development_dependency 'coffee-rails'
+  s.add_development_dependency 'engine_cart', '~> 2.0'
+  s.add_development_dependency 'factory_bot_rails'
+  s.add_development_dependency 'rails-controller-testing'
+  s.add_development_dependency 'rspec-rails', '~> 3.8'
+end

data/lib/generators/hyrax/iiif_av/add_to_work_type_generator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'rails/generators'
+require 'rails/generators/model_helpers'
+
+module Hyrax
+  module IiifAv
+    class AddToWorkTypeGenerator < Rails::Generators::NamedBase
+      # ActiveSupport can interpret models as plural which causes
+      # counter-intuitive route paths. Pull in ModelHelpers from
+      # Rails which warns users about pluralization when generating
+      # new models or scaffolds.
+      include Rails::Generators::ModelHelpers
+
+      def inject_into_controller
+        controller_file = File.join('app/controllers/hyrax', class_path, "#{plural_file_name}_controller.rb")
+        insert_into_file controller_file, after: 'include Hyrax::BreadcrumbsForWorks' do
+          "\n" \
+          "    # Adds behaviors for hyrax-iiif_av plugin.\n" \
+          "    include Hyrax::IiifAv::ControllerBehavior"
+        end
+      end
+
+      def inject_into_presenter
+        presenter_file = File.join('app/presenters/hyrax', class_path, "#{file_name}_presenter.rb")
+        insert_into_file presenter_file, after: '< Hyrax::WorkShowPresenter' do
+          "\n" \
+          "    # Adds behaviors for hyrax-iiif_av plugin.\n" \
+          "    include Hyrax::IiifAv::DisplaysIiifAv\n" \
+          "    Hyrax::MemberPresenterFactory.file_presenter_class = Hyrax::IiifAv::IiifFileSetPresenter\n" \
+          "\n" \
+          "    # Optional override to select iiif viewer to render\n" \
+          "    # default :avalon for audio and video, :universal_viewer for images\n" \
+          "    # def iiif_viewer\n" \
+          "    #   :avalon\n" \
+          "    # end"
+        end
+      end
+    end
+  end
+end

data/lib/generators/hyrax/iiif_av/install_avalon_player_generator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'rails/generators'
+
+module Hyrax
+  module IiifAv
+    class InstallAvalonPlayerGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def install_dependencies
+        gem 'webpacker'
+        gem 'react-rails'
+
+        Bundler.with_clean_env do
+          run "bundle install"
+        end
+      end
+
+      def webpacker_install
+        rake("webpacker:install")
+      end
+
+      def react_install
+        rake("webpacker:install:react")
+        generate "react:install"
+      end
+
+      def add_avalon_yarn_dependency
+        `yarn add react-iiif-media-player`
+      end
+
+      def copy_avalon_player
+        copy_file '_avalon.html.erb', 'app/views/hyrax/base/iiif_viewers/_avalon.html.erb'
+      end
+
+      def copy_avalon_react_component
+        copy_file 'AvalonIiifPlayer.js', 'app/javascript/components/AvalonIiifPlayer.js'
+      end
+    end
+  end
+end

data/lib/generators/hyrax/iiif_av/install_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'rails/generators'
+
+module Hyrax
+  module IiifAv
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      # Do nothing for now
+    end
+  end
+end