hydra-derivatives 3.4.2 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47fbc2bf8a041e266066dac9b4735ef653ab669e373e475c976e36615ce98f09
-  data.tar.gz: ee2435c0b1cd2aebc7b274b92e4280a4c68f493e0c2665b3dfce3b1b363acfaa
+  metadata.gz: 60d19f9f569bcbc802b64a375b73be6e019d62f9b2c6a9a0e6b35dbd2fcfe58a
+  data.tar.gz: 88f0cabb0114f725c9f8473cd793b6eb2fc274e575e6ae59bceeb50498551025
 SHA512:
-  metadata.gz: 8adf3f99d52e6b8f21597a2d022fd3f9f1c5c0b319c9ebfb68ae91202db3b61531aea12169fd5bc4fd9602fa8fcfe2d7bc3486c097b704e8575e5b22c2b44c1a
-  data.tar.gz: 92c5704c75bd8cbff6f2b10f8a238cf60da0e2d9c914396c148152cf8d7c55c61b5799f97abaec5d6401b86ac94a26810aed4ae6c965f21d19695faecea20ef0
+  metadata.gz: 44611dab7f3cd84daf842d95953ed4ad8e2a3899e615c155848458620f1a066bf667f034c13e91c600614f6aadffc352d9dcd595bdfff7b96eefa76af7ccb33e
+  data.tar.gz: f47fef855a22d55db4c4088dbdddf1fb999b8427d0aa255f7510cf2581509ad0ce3239d08059b77bd00a91620054dcba6a50cc10c3e45114fe5fc37cc014856f

data/.circleci/config.yml

@@ -0,0 +1,62 @@
+version: 2.1
+orbs:
+  samvera: samvera/circleci-orb@0
+jobs:
+  bundle_lint_test:
+    parameters:
+      ruby_version:
+        type: string
+      project:
+        type: string
+      bundler_version:
+        type: string
+        default: 2.0.1
+    executor:
+      name: 'samvera/ruby_fcrepo_solr'
+      ruby_version: << parameters.ruby_version >>
+    steps:
+      - samvera/cached_checkout
+      - run:
+          name: Install dependencies
+          command: |
+            sudo apt-get update
+            sudo apt-get install ghostscript ufraw-batch libpng-dev imagemagick ffmpeg libreoffice
+      - run:
+          name: Install Kakadu
+          command: |
+            if [ ! -d "kakadu" ]; then
+              mkdir ~/downloads
+              wget http://kakadusoftware.com/wp-content/uploads/2014/06/KDU77_Demo_Apps_for_Linux-x86-64_150710.zip -O ~/downloads/kakadu.zip
+              unzip ~/downloads/kakadu.zip
+              mv KDU77_Demo_Apps_for_Linux-x86-64_150710 kakadu
+            fi
+            sudo cp kakadu/*.so /usr/lib
+            sudo cp kakadu/* /usr/bin
+
+      - samvera/bundle_for_gem:
+          ruby_version: << parameters.ruby_version >>
+          bundler_version: << parameters.bundler_version >>
+          project: << parameters.project >>
+          cache_version: '2'
+
+      - samvera/install_solr_core
+
+      - samvera/rubocop
+
+      - samvera/parallel_rspec
+
+workflows:
+  ci:
+    jobs:
+      - bundle_lint_test:
+          name: ruby2-4-6
+          ruby_version: 2.4.6
+          project: hydra-derivatives
+      - bundle_lint_test:
+          name: ruby2-5-5
+          ruby_version: 2.5.5
+          project: hydra-derivatives
+      - bundle_lint_test:
+          name: ruby2-6-3
+          ruby_version: 2.6.3
+          project: hydra-derivatives

data/.solr_wrapper

@@ -0,0 +1,2 @@
+---
+version: '7.7.2'

data/Gemfile

@@ -9,4 +9,5 @@ group :development, :test do
   gem 'rubocop', '~> 0.52.0', require: false
   gem 'rubocop-rspec', require: false
   gem 'simplecov'
+  gem 'rspec_junit_formatter'
 end

data/README.md

@@ -2,7 +2,7 @@
 
 Code:
 [![Version](https://badge.fury.io/rb/hydra-derivatives.png)](http://badge.fury.io/rb/hydra-derivatives)
-[![Build Status](https://travis-ci.org/samvera/hydra-derivatives.png?branch=master)](https://travis-ci.org/samvera/hydra-derivatives)
+[![Build Status](https://circleci.com/gh/samvera/hydra-derivatives.svg?style=svg)](https://circleci.com/gh/samvera/hydra-derivatives)
 [![Coverage Status](https://coveralls.io/repos/github/samvera/hydra-derivatives/badge.svg?branch=master)](https://coveralls.io/github/samvera/hydra-derivatives?branch=master)
 
 Docs:
@@ -13,7 +13,7 @@ Jump In: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samv
 
 # What is hydra-derivatives?
 
-Derivative generation for hydra
+Derivative generation for Samvera applications.
 
 ## Product Owner & Maintenance
 
@@ -213,6 +213,37 @@ Instead, each directive may contain these arguments:
   * `:compression` (Integer) : The left number of the compression ratio `n:1`, e.g. 12 will apply 12:1 compression. Default: 10.
   * `:tile_size` (Integer) : Pixel dimension of the tiles. Default: 1024
 
+# Development Environment
+
+## Dependencies
+
+* [ImageMagick](https://www.imagemagick.org)
+    * On a mac, do `brew install imagemagick`
+* [LibreOffice](https://www.libreoffice.org/)
+*   * On a mac, do `brew cask install libreoffice`
+* [Kakadu](http://kakadusoftware.com/)
+    * On a mac, extract the file and run the pkg installer therein (don't get distracted by the files called kdu_show)
+* [Ghostscript](https://www.ghostscript.com/)
+    * On a mac, `brew install ghostscript`
+* ufraw
+    * On a mac, `brew install ufraw`
+* libvpx
+    * On a mac, `brew install libvpx`
+* ffmpeg
+    * On a mac, `brew install ffmpeg`
+    * Ensure `libvpx` is installed first
+
+## Running Tests
+
+1. Run tests with `RAILS_ENV=test bundle exec rake ci`
+
+## Running specific tests
+
+If you don't want to run the whole suite all at once like CI, do the following:
+
+1. Run the test servers with `rake derivatives:test_server`
+2. Run the tests.
+
 # Acknowledgments
 
 This software has been developed by and is brought to you by the Samvera community.  Learn more at the

data/Rakefile

@@ -29,6 +29,18 @@ namespace :derivatives do
       Rake::Task['derivatives:rspec'].invoke
     end
   end
+
+  desc 'Start up test server'
+  task :test_server do
+    ENV["RAILS_ENV"] = "test"
+    with_test_server do
+      puts "Solr: http://localhost:#{ENV["SOLR_TEST_PORT"]}/solr"
+      puts "Fedora: http://localhost:#{ENV["FCREPO_TEST_PORT"]}/rest"
+      while(1) do
+        sleep(1)
+      end
+    end
+  end
 end
 
 desc 'Run continuous integration build'

data/VERSION

@@ -1 +1 @@
-3.4.2
+3.5.0

data/config/fcrepo_wrapper_test.yml

@@ -1,6 +1,6 @@
-port: null
+port: 8986
 verbose: true
 managed: true
 enable_jms: false
 fcrepo_home_dir: tmp/fcrepo4-test-data
-version: 4.7.4
+version: 4.7.4

data/config/solr_wrapper_test.yml

@@ -0,0 +1,2 @@
+---
+port: 8985

data/hydra-derivatives.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.name          = "hydra-derivatives"
   spec.version       = version
   spec.authors       = ["Justin Coyne"]
-  spec.email         = ["justin@curationexperts.com"]
+  spec.email         = ["jenlindner@gmail.com", "jcoyne85@stanford.edu"]
   spec.description   = "Derivative generation plugin for hydra"
   spec.summary       = "Derivative generation plugin for hydra"
   spec.license       = "APACHE2"
@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'fcrepo_wrapper', '~> 0.2'
   spec.add_development_dependency 'rake', '~> 10.1'
   spec.add_development_dependency 'rspec', '~> 3.1'
-  spec.add_development_dependency "solr_wrapper", "~> 0.4"
+  spec.add_development_dependency "solr_wrapper", "~> 2.0"
 
-  spec.add_dependency 'active-fedora', '>= 11.3.1', '< 13'
+  spec.add_dependency 'active-fedora', '>= 11.3.1', '< 14'
   spec.add_dependency 'active_encode', '~>0.1'
   spec.add_dependency 'activesupport', '>= 4.0', '< 6'
   spec.add_dependency 'addressable', '~>2.5'

data/lib/hydra/derivatives/logger.rb

@@ -11,8 +11,8 @@ module Hydra::Derivatives
         logger.respond_to? method_name
       end
 
-      def respond_to_missing?(method_name, _include_private = false)
-        logger.respond_to_missing? method_name
+      def respond_to_missing?(method_name, include_private = false)
+        logger.send(:respond_to_missing?, method_name, include_private)
       end
 
       private

data/lib/hydra/derivatives/processors/jpeg2k_image.rb

@@ -99,15 +99,9 @@ module Hydra::Derivatives::Processors
       File.unlink(file_path) unless file_path.nil?
     end
 
-    def encode_file(recipe, opts = {})
+    def encode_file(recipe, file_path:)
       output_file = self.class.tmp_file('.jp2')
-      if opts[:file_path]
-        self.class.encode(opts[:file_path], recipe, output_file)
-      else
-        Hydra::Derivatives::TempfileService.create(source_file) do |f|
-          self.class.encode(f.path, recipe, output_file)
-        end
-      end
+      self.class.encode(file_path, recipe, output_file)
       output_file_service.call(File.open(output_file, 'rb'), directives)
       File.unlink(output_file)
     end

data/lib/hydra/derivatives/processors/processor.rb

@@ -19,13 +19,6 @@ module Hydra::Derivatives::Processors
       raise "Processor is an abstract class. Implement `process' on #{self.class.name}"
     end
 
-    # This governs the output key sent to the persist file service
-    # while this is adequate for storing in Fedora, it's not a great name for saving
-    # to the file system.
-    def output_file_id(name)
-      [out_prefix, name].join('_')
-    end
-
     def output_filename_for(_name)
       File.basename(source_path)
     end

data/lib/hydra/derivatives/services/persist_output_file_service.rb

@@ -23,7 +23,7 @@ module Hydra::Derivatives
       if file.respond_to? :mime_type
         file.mime_type
       else
-        "appliction/octet-stream"
+        "application/octet-stream"
       end
     end
   end

data/solr/config/schema.xml

@@ -168,7 +168,6 @@
     <fieldType class="solr.TextField" name="textSuggest" positionIncrementGap="100">
       <analyzer>
         <tokenizer class="solr.KeywordTokenizerFactory"/>
-        <filter class="solr.StandardFilterFactory"/>
         <filter class="solr.LowerCaseFilterFactory"/>
         <filter class="solr.RemoveDuplicatesTokenFilterFactory"/>
       </analyzer>
@@ -338,7 +337,6 @@
  <!--  <defaultSearchField>text</defaultSearchField> -->
 
  <!-- SolrQueryParser configuration: defaultOperator="AND|OR" -->
- <solrQueryParser defaultOperator="OR"/>
 
   <!-- copyField commands copy one field to another at the time a document
         is added to the index.  It's used either to index the same field differently,

data/spec/processors/processor_spec.rb

@@ -6,7 +6,7 @@ describe Hydra::Derivatives::Processors::Processor do
   let(:object)        { "Fake Object" }
   let(:source_name)   { 'content' }
   let(:directives)    { { thumb: "100x100>" } }
-  let(:file_path)     { double }
+  let(:file_path)     { Pathname.new("test/unicorn.jpg") }
 
   describe "output_file_service" do
     let(:custom_output_file_service) { "fake service" }
@@ -32,4 +32,22 @@ describe Hydra::Derivatives::Processors::Processor do
       end
     end
   end
+
+  describe "#process" do
+    it "raises an implementation error" do
+      expect { subject.process }.to raise_error "Processor is an abstract class. Implement `process' on Hydra::Derivatives::Processors::Processor"
+    end
+  end
+
+  describe "#output_file" do
+    it "raises an implementation error" do
+      expect { subject.output_file }.to raise_error "Processor is an abstract class. Utilize an implementation of a PersistOutputFileService class in Hydra::Derivatives::Processors::Processor"
+    end
+  end
+
+  describe "#output_filename_for" do
+    it "returns the basename of the source file" do
+      expect(subject.output_filename_for("ignored")).to eq "unicorn.jpg"
+    end
+  end
 end

data/spec/processors/video_spec.rb

@@ -38,5 +38,22 @@ describe Hydra::Derivatives::Processors::Video::Processor do
         subject.process
       end
     end
+
+    context "when an mkv is requested" do
+      let(:directives) { { label: :thumb, format: 'mkv', url: 'http://localhost:8983/fedora/rest/dev/1234/thumbnail' } }
+
+      it "creates a fedora resource and infers the name" do
+        expect(subject).to receive(:encode_file).with("mkv", Hydra::Derivatives::Processors::Ffmpeg::OUTPUT_OPTIONS => "-s 320x240 -vcodec ffv1 -g 30 -b:v 345k -ac 2 -ab 96k -ar 44100", Hydra::Derivatives::Processors::Ffmpeg::INPUT_OPTIONS => "")
+        subject.process
+      end
+    end
+
+    context "when an unknown format is requested" do
+      let(:directives) { { label: :thumb, format: 'nocnv', url: 'http://localhost:8983/fedora/rest/dev/1234/thumbnail' } }
+
+      it "raises an ArgumentError" do
+        expect { subject.process }.to raise_error ArgumentError, "Unknown format `nocnv'"
+      end
+    end
   end
 end

data/spec/runners/runner_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+RSpec.describe Hydra::Derivatives::Runner do
+  describe ".processor_class" do
+    it "raises an error if it's not overridden" do
+      expect { described_class.processor_class }.to raise_error "Overide the processor_class method in a sub class"
+    end
+  end
+end

data/spec/services/persist_output_file_service_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+RSpec.describe Hydra::Derivatives::PersistOutputFileService do
+  let(:original_filename_class) do
+    Class.new do
+      def original_filename
+        "original filename"
+      end
+
+      def mime_type
+        "image/tiff"
+      end
+    end
+  end
+
+  describe ".call" do
+    it "raises an error if not implemented" do
+      expect { described_class.call(nil, nil) }.to raise_error NotImplementedError, "PersistOutputFileService is an abstract class. Implement `call' on Class"
+    end
+  end
+
+  describe ".determine_original_name" do
+    context "when given something with an original filename" do
+      it "returns it from that file" do
+        expect(described_class.determine_original_name(original_filename_class.new)).to eq "original filename"
+      end
+    end
+    context "when given something without an original filename" do
+      it "returns derivative" do
+        expect(described_class.determine_original_name("tardis")).to eq "derivative"
+      end
+    end
+  end
+
+  describe ".determine_mime_type" do
+    context "when given something with #mime_type" do
+      it "returns it from that file" do
+        expect(described_class.determine_mime_type(original_filename_class.new)).to eq "image/tiff"
+      end
+    end
+    context "when given something without #mime_type" do
+      it "returns application/octet-stream" do
+        expect(described_class.determine_mime_type("tardis")).to eq "application/octet-stream"
+      end
+    end
+  end
+end

data/spec/services/tempfile_service_spec.rb

@@ -19,6 +19,14 @@ describe Hydra::Derivatives::TempfileService do
     end
   end
 
+  let(:class_with_tempfile) do
+    Class.new do
+      def to_tempfile
+        "stub"
+      end
+    end
+  end
+
   let(:initialization_options) { { content: 'abc', mime_type: 'text/plain' } }
 
   let(:file) { class_with_metadata_extraction.new(initialization_options) }
@@ -27,5 +35,20 @@ describe Hydra::Derivatives::TempfileService do
     it 'has a method called to_tempfile' do
       expect { |b| subject.tempfile(&b) }.to yield_with_args(Tempfile)
     end
+    it "will call read on passed content if available" do
+      file_with_readable_content = class_with_metadata_extraction.new(content: StringIO.new("test"), mime_type: 'text/plain')
+
+      service = described_class.new(file_with_readable_content)
+
+      service.tempfile do |t|
+        expect(t.read).to eq "test"
+      end
+    end
+    it "delegates down to `to_tempfile` if available" do
+      tempfile_stub = class_with_tempfile.new
+      service = described_class.new(tempfile_stub)
+
+      expect(service.tempfile).to eq "stub"
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,12 +1,19 @@
 ENV['environment'] ||= 'test'
+ENV['RAILS_ENV'] = 'test'
 
 require 'simplecov'
 require 'coveralls'
-SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+)
+SimpleCov.minimum_coverage 100
 SimpleCov.start do
   add_filter '/spec'
 end
-Coveralls.wear!
 
 # - RSpec adds ./lib to the $LOAD_PATH
 require 'hydra/derivatives'

data/spec/units/audio_encoder_spec.rb

@@ -20,4 +20,15 @@ describe Hydra::Derivatives::AudioEncoder do
       expect(audio_encoder).to eq('aac')
     end
   end
+
+  context "when ffmpeg is not installed" do
+    it "logs a warning" do
+      allow(ActiveFedora::Base.logger).to receive(:warn)
+      allow(Open3).to receive(:capture3).with('ffmpeg -codecs').and_raise StandardError
+
+      described_class.new
+
+      expect(ActiveFedora::Base.logger).to have_received(:warn).with('Unable to find ffmpeg')
+    end
+  end
 end

data/spec/units/derivatives_spec.rb

@@ -40,6 +40,12 @@ describe Hydra::Derivatives do
       end
     end
     describe "#{method}=" do
+      around do |example|
+        value = subject.config.send(method)
+        example.call
+        subject.send("#{method}=", value)
+      end
+
       it 'stores config changes' do
         expect { subject.send("#{method}=", "new_value") }.to change { subject.config.send(method) }.from(subject.config.send(method)).to("new_value")
       end

data/spec/units/logger_spec.rb

@@ -14,6 +14,11 @@ describe Hydra::Derivatives::Logger do
     end
   end
 
+  it "delegates respond_to_missing" do
+    allow(ActiveFedora::Base.logger).to receive(:respond_to_missing?).with(:weird, false).and_return(true)
+    expect(described_class.respond_to_missing?(:weird)).to be_truthy
+  end
+
   context "with garbage" do
     it "raises an error" do
       expect { described_class.garbage }.to raise_error(NoMethodError)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-derivatives
 version: !ruby/object:Gem::Version
-  version: 3.4.2
+  version: 3.5.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-18 00:00:00.000000000 Z
+date: 2019-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: active-fedora
   requirement: !ruby/object:Gem::Requirement
@@ -89,7 +89,7 @@ dependencies:
         version: 11.3.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -99,7 +99,7 @@ dependencies:
         version: 11.3.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '14'
 - !ruby/object:Gem::Dependency
   name: active_encode
   requirement: !ruby/object:Gem::Requirement
@@ -204,16 +204,18 @@ dependencies:
         version: '5'
 description: Derivative generation plugin for hydra
 email:
-- justin@curationexperts.com
+- jenlindner@gmail.com
+- jcoyne85@stanford.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
+- ".solr_wrapper"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
@@ -226,6 +228,7 @@ files:
 - VERSION
 - config/fcrepo_wrapper_test.yml
 - config/jetty.yml
+- config/solr_wrapper_test.yml
 - doc/amazon_elastic_transcoder.md
 - hydra-derivatives.gemspec
 - lib/color_profiles/license.txt
@@ -306,9 +309,11 @@ files:
 - spec/processors/shell_based_processor_spec.rb
 - spec/processors/video_spec.rb
 - spec/runners/active_encode_derivatives_spec.rb
+- spec/runners/runner_spec.rb
 - spec/services/audio_derivatives_spec.rb
 - spec/services/persist_basic_contained_output_file_service_spec.rb
 - spec/services/persist_external_file_output_file_service_spec.rb
+- spec/services/persist_output_file_service_spec.rb
 - spec/services/remote_source_file_spec.rb
 - spec/services/retrieve_source_file_service_spec.rb
 - spec/services/tempfile_service_spec.rb
@@ -338,7 +343,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Derivative generation plugin for hydra
@@ -367,9 +372,11 @@ test_files:
 - spec/processors/shell_based_processor_spec.rb
 - spec/processors/video_spec.rb
 - spec/runners/active_encode_derivatives_spec.rb
+- spec/runners/runner_spec.rb
 - spec/services/audio_derivatives_spec.rb
 - spec/services/persist_basic_contained_output_file_service_spec.rb
 - spec/services/persist_external_file_output_file_service_spec.rb
+- spec/services/persist_output_file_service_spec.rb
 - spec/services/remote_source_file_spec.rb
 - spec/services/retrieve_source_file_service_spec.rb
 - spec/services/tempfile_service_spec.rb

data/.travis.yml

@@ -1,39 +0,0 @@
-language: ruby
-cache: bundler
-sudo: false
-before_install:
-  - gem update --system
-  - gem install bundler
-rvm:
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - 2.6.0
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-jdk:
-  - oraclejdk8
-notifications:
-  email:
-    recipients:
-      - "ul-dlt-applications@lists.psu.edu"
-    on_success: "change"
-    on_failure: "always"
-  irc:
-    channels:
-      - "irc.freenode.org#scholarsphere"
-    template:
-      - "%{repository}//%{branch}@%{commit} by %{author}: %{message} - %{build_url}"
-addons:
-  apt:
-    sources:
-      - "trusty-media"
-      - sourceline: ppa:jonathonf/ffmpeg-3
-    packages:
-      - ghostscript
-      - ufraw-batch
-      - libpng-dev
-      - imagemagick
-      - ffmpeg
-      - libreoffice