hyrax-iiif_av 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7175259d686db59f6e4d217489dc482160627417
-  data.tar.gz: 625d46c52ad2e322f43404ce59d463e2a2fa66a1
+  metadata.gz: 1048d5bad3dcabb9cfbaa7617e7ac7e325e650bf
+  data.tar.gz: b53798072660f48f69438f5569eb8b51451c8b7e
 SHA512:
-  metadata.gz: 84d57cae07a601937a22832fe3591b3303de66f766bdc1fafec4a03f7baa588761c7c28f271650918d9c90da6444d2f2476fb12c85a1a66c78c9a3a39b6b9eb1
-  data.tar.gz: c5f7569a394a53b5de49406402cb30d3d26cd741a97b3a0810651726e9f9ecf8f1ac2f406869d7ba3b0f2b1c2b7e8225baaa5f4435ca04012bcf25c74ced2aaa
+  metadata.gz: 7f9759d67ab956c8aa7e2b1f09efe2ba53c17e9922c45d2317b4f2248a14d6503a6587231d113b6daf3ce85228be9bf3b4e3df6d3f60f41f33fcedd8d66398c9
+  data.tar.gz: 9cf31dba99e9c3c2b646c08f06889b4d55c625752f7dcce859b4b654a453e57977da2afed310b0875ac5f835d868836559431d0a3d4100380fa90a9e46f37d62

data/app/controllers/concerns/hyrax/iiif_av/controller_behavior.rb

@@ -24,7 +24,6 @@ module Hyrax
 
       included do
         prepend_view_path(Hyrax::IiifAv::Engine.view_path)
-        helper Hyrax::IiifAv::IiifAvHelper
       end
 
       IIIF_PRESENTATION_2_MIME = 'application/json;profile=http://iiif.io/api/presentation/2/context.json'

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

@@ -76,18 +76,12 @@ module Hyrax
 
         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
+          streams = stream_urls
+          if streams.present?
+            streams.collect { |label, url| video_display_content(url, label) }
+          else
+            [video_display_content(download_path('mp4'), 'mp4'), video_display_content(download_path('webm'), 'webm')]
           end
-          [video_display_content(download_path('mp4'), 'mp4'), video_display_content(download_path('webm'), 'webm')]
         end
 
         def video_display_content(url, label = '')
@@ -100,12 +94,12 @@ module Hyrax
         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?
+          streams = stream_urls
+          if streams.present?
+            streams.collect { |label, url| audio_display_content(url, label) }
+          else
+            [audio_display_content(download_path('ogg'), 'ogg'), audio_display_content(download_path('mp3'), 'mp3')]
           end
-          [audio_display_content(download_path('ogg'), 'ogg'), audio_display_content(download_path('mp3'), 'mp3')]
         end
 
         def audio_display_content(url, label = '')
@@ -118,6 +112,22 @@ module Hyrax
         def download_path(extension)
           Hyrax::Engine.routes.url_helpers.download_url(solr_document, file: extension, host: request.base_url)
         end
+
+        def stream_urls
+          return {} unless solr_document['derivatives_metadata_ssi'].present?
+          files_metadata = JSON.parse(solr_document['derivatives_metadata_ssi'])
+          file_locations = files_metadata.select { |f| f['file_location_uri'].present? }
+          streams = {}
+          if file_locations.present?
+            file_locations.each do |f|
+              streams[f['label']] = Hyrax::IiifAv.config.iiif_av_url_builder.call(
+                f['file_location_uri'],
+                request.base_url
+              )
+            end
+          end
+          streams
+        end
     end
   end
 end

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

@@ -36,14 +36,11 @@ module Hyrax
            (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
+        else
+          super
         end
       end
 

data/hyrax-iiif_av.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "rails", "~>5.1"
   s.add_dependency "blacklight"
-  s.add_dependency "hyrax", "~> 2.1"
+  s.add_dependency "hyrax", "~> 2.4"
   s.add_dependency "iiif_manifest", "~> 0.5"
 
   s.add_development_dependency 'bixby'

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

@@ -20,4 +20,4 @@ limitations under the License.
   <%= javascript_pack_tag 'application' %>
   <%= stylesheet_pack_tag 'application' %>
 <% end %>
-<%= react_component("AvalonIiifPlayer", { manifestUrl: main_app.polymorphic_path([main_app, :manifest, presenter], { locale: nil }) }) %>
+<%= react_component("AvalonIiifPlayer", { manifestUrl: main_app.polymorphic_url([main_app, :manifest, presenter], { locale: nil }) }) %>

data/lib/hyrax/iiif_av.rb

@@ -3,6 +3,25 @@ require "hyrax/iiif_av/engine"
 
 module Hyrax
   module IiifAv
-    # Your code goes here...
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload :Configuration
+    end
+
+    # @api public
+    #
+    # Exposes the Hyrax configuration
+    #
+    # @yield [Hyrax::IiifAv::Configuration] if a block is passed
+    # @return [Hyrax::IiifAv::Configuration]
+    # @see Hyrax::IiifAv::Configuration for configuration options
+    def self.config(&block)
+      @config ||= Hyrax::IiifAv::Configuration.new
+
+      yield @config if block
+
+      @config
+    end
   end
 end

data/lib/hyrax/iiif_av/configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Hyrax
+  module IiifAv
+    class Configuration
+      # URL that resolves to an AV stream provided to a IIIF presentation manifest
+      #
+      # @return [#call] lambda/proc that generates a URL to an AV stream
+      def iiif_av_url_builder
+        @iiif_av_url_builder ||= lambda do |file_location_uri, _base_url|
+          # Reverse engineering Hyrax::DerivativePath
+          path = file_location_uri.sub(/^#{Hyrax.config.derivatives_path}/, '')
+          id_path, file_path = path.split('-', 2)
+          file_set_id = id_path.delete('/')
+          filename = file_path[0, file_path.size / 2]
+          Hyrax::Engine.routes.url_helpers.download_path(file_set_id, file: filename)
+        end
+      end
+      attr_writer :iiif_av_url_builder
+    end
+  end
+end

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

@@ -80,10 +80,11 @@ RSpec.shared_examples "IiifAv::DisplaysContent" do
       end
 
       context 'when the file is an audio derivative with metadata' do
+        let(:file_set_id) { 'abcdefg' }
         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' }
+            { id: '1', label: 'high', file_location_uri: Hyrax::DerivativePath.derivative_path_for_reference(file_set_id, 'medium.mp3') },
+            { id: '2', label: 'medium', file_location_uri: Hyrax::DerivativePath.derivative_path_for_reference(file_set_id, 'high.mp3') }
           ]
         end
         let(:solr_document) { SolrDocument.new(id: '12345', duration_tesim: 1000, derivatives_metadata_ssi: derivatives_metadata.to_json) }
@@ -96,7 +97,29 @@ RSpec.shared_examples "IiifAv::DisplaysContent" 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'])
+          expect(content.map(&:url)).to match_array([Hyrax::Engine.routes.url_helpers.download_path(file_set_id, file: 'high.mp3'),
+                                                     Hyrax::Engine.routes.url_helpers.download_path(file_set_id, file: 'medium.mp3')])
+        end
+
+        context 'with custom av url builder' do
+          let(:custom_builder) do
+            ->(file_location_uri, _base_url) { "http://streaming.example.com/stream/#{File.basename(file_location_uri)}" }
+          end
+
+          around do |example|
+            default_builder = Hyrax::IiifAv.config.iiif_av_url_builder
+            Hyrax::IiifAv.config.iiif_av_url_builder = custom_builder
+            example.run
+            Hyrax::IiifAv.config.iiif_av_url_builder = default_builder
+          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://streaming.example.com/stream/g-high.mp3.high.mp3',
+                                                       'http://streaming.example.com/stream/g-medium.mp3.medium.mp3'])
+          end
         end
       end
 

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

@@ -123,7 +123,7 @@ RSpec.shared_examples "IiifAv::DisplaysIiifAv" do
     context 'with no representative_presenter' do
       let(:representative_presenter) { instance_double('Hyrax::FileSetPresenter', present?: false) }
 
-      it { is_expected.to be nil }
+      it { is_expected.to be :universal_viewer }
     end
   end
 end

data/lib/hyrax/iiif_av/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Hyrax
   module IiifAv
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyrax-iiif_av
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Colvard
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-02 00:00:00.000000000 Z
+date: 2018-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -47,14 +47,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: iiif_manifest
   requirement: !ruby/object:Gem::Requirement
@@ -172,12 +172,10 @@ files:
 - README.md
 - Rakefile
 - app/controllers/concerns/hyrax/iiif_av/controller_behavior.rb
-- app/helpers/hyrax/iiif_av/iiif_av_helper.rb
+- app/models/hyrax/iiif_av/manifest_range.rb
 - app/presenters/concerns/hyrax/iiif_av/displays_content.rb
 - app/presenters/concerns/hyrax/iiif_av/displays_iiif_av.rb
 - app/presenters/hyrax/iiif_av/iiif_file_set_presenter.rb
-- app/views/hyrax/base/_representative_media.html.erb
-- app/views/hyrax/base/iiif_viewers/_universal_viewer.html.erb
 - bin/rails
 - hyrax-iiif_av.gemspec
 - lib/generators/hyrax/iiif_av/add_to_work_type_generator.rb
@@ -186,8 +184,8 @@ files:
 - lib/generators/hyrax/iiif_av/templates/AvalonIiifPlayer.js
 - lib/generators/hyrax/iiif_av/templates/_avalon.html.erb
 - lib/hyrax/iiif_av.rb
+- lib/hyrax/iiif_av/configuration.rb
 - lib/hyrax/iiif_av/engine.rb
-- lib/hyrax/iiif_av/manifest_range.rb
 - lib/hyrax/iiif_av/spec/shared_specs.rb
 - lib/hyrax/iiif_av/spec/shared_specs/controller_behavior.rb
 - lib/hyrax/iiif_av/spec/shared_specs/displays_content.rb

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

@@ -1,40 +0,0 @@
-# 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/views/hyrax/base/_representative_media.html.erb

@@ -1,27 +0,0 @@
-<%#
-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

@@ -1,4 +0,0 @@
-<%= 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>