hydra-derivatives 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcf72cd8457040e024d1afc7165e39fcd934b9e6
-  data.tar.gz: c32e5d6d99fd839685c76d3e7ae5f535ee9a2df5
+  metadata.gz: 14f09b6670a1ef6add67ed44818c17c7cf8c36b1
+  data.tar.gz: 408048906e8ab82bccb72a05c9849826cc09c742
 SHA512:
-  metadata.gz: d0a0f31a6c6be71ed6d88ea9504cc6f16800449dd44d70c8b5c487cbcd232fee19acccb64c4f1b71a7d64a5029307a014b29698253d5433db6e945ff69399d56
-  data.tar.gz: 33c5c95a19390035f4b4227acae0dd78ccf6053de8b9215f25b0f29559a9b9e3dc03cfe544d92bc15a20708f67f1a76a66aedc400fbae0179ef148381422fdbb
+  metadata.gz: 0d97b2c7b9cff0b1e09f0394feef16e136808cb840b50ff48bb40b6ed8e24903862a88e99b5f054f24fb80a4789a0bce5251cb02c3f942010311ab7ba24f32c9
+  data.tar.gz: 4afab72548ce8ba1524b9d957cd08574d1a543a6a0741ebc9e2ade3dc6675d731b7f7286d479d6b9920ed157e7a0bfc38d8a68e9a51f7cab6d403c378e679cd4

data/README.md

@@ -1,4 +1,4 @@
-# hydra-derivatives [![Version](https://badge.fury.io/rb/hydra-derivatives.png)](http://badge.fury.io/rb/hydra-derivatives) [![Build Status](https://travis-ci.org/projecthydra-labs/hydra-derivatives.png?branch=master)](https://travis-ci.org/projecthydra-labs/hydra-derivatives) [![Dependency Status](https://gemnasium.com/projecthydra-labs/hydra-derivatives.png)](https://gemnasium.com/projecthydra-labs/hydra-derivatives)
+# hydra-derivatives [![Version](https://badge.fury.io/rb/hydra-derivatives.png)](http://badge.fury.io/rb/hydra-derivatives) [![Build Status](https://travis-ci.org/projecthydra/hydra-derivatives.png?branch=master)](https://travis-ci.org/projecthydra/hydra-derivatives) [![Dependency Status](https://gemnasium.com/projecthydra/hydra-derivatives.png)](https://gemnasium.com/projecthydra/hydra-derivatives)
 
 Derivative generation for hydra
 
@@ -70,6 +70,34 @@ Then when you call `obj.create_derivatives` two new files, 'thumbnail' and 'cont
 
 We recommend you run `obj.create_derivatives` in a background worker, because some derivative creation (especially videos) can take a long time.
 
+## Configuration
+
+### Processing Timeouts
+
+hydra-derivatives can be configured to timeout derivatives processes.  Each process type has a separate timeout.
+If no timeout is set the system will process until complete (possibly indefinitely).
+
+```
+require 'hydra/derivatives'
+
+Hydra::Derivatives::Video::Processor.timeout  = 10.minutes
+Hydra::Derivatives::Document.timeout = 5.minutes
+Hydra::Derivatives::Audio.timeout = 10.minutes
+Hydra::Derivatives::Image.timeout = 5.minutes
+
+```
+
+### Video Processing configuration
+
+Flags can be set for using different video codes.  Default codecs are shown below
+
+```
+Hydra::Derivatives::Video::Processor.config.mpeg4.codec = '-vcodec libx264 -acodec libfdk_aac'
+Hydra::Derivatives::Video::Processor.config.webm.codec = '-vcodec libvpx -acodec libvorbis'
+Hydra::Derivatives::Video::Processor.config.mkv.codec = '-vcodec ffv1'
+Hydra::Derivatives::Video::Processor.config.jpeg.codec = '-vcodec mjpeg'
+```
+
 # Installation
 
 Just add `gem 'hydra-derivatives'` to your Gemfile.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/hydra-derivatives.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'hydra-file_characterization', '~> 0.3'
   spec.add_dependency 'mini_magick', '>= 3.2', '< 5'
   spec.add_dependency 'activesupport', '~> 4.0'
-  spec.add_dependency 'mime-types', '~> 2.3'
+  spec.add_dependency 'mime-types', '~> 1'
   spec.add_dependency 'deprecation', '~> 0.1'
 end
 

data/lib/hydra/derivatives/document.rb

@@ -9,7 +9,7 @@ module Hydra
         execute "#{Hydra::Derivatives.libreoffice_path} --invisible --headless --convert-to #{format} --outdir #{outdir} #{path}"
       end
 
-      def encode_file(dest_path, file_suffix, mime_type, options = '')
+      def encode_file(dest_path, file_suffix, mime_type, options = { })
         new_output = ''
         source_file.to_tempfile do |f|
           if mime_type == 'image/jpeg'

data/lib/hydra/derivatives/ffmpeg.rb

@@ -19,10 +19,8 @@ module Hydra
       module ClassMethods
 
         def encode(path, options, output_file)
-          inopts = options[INPUT_OPTIONS]  if options
-          inopts ||= "-y"
-          outopts = options[OUTPUT_OPTIONS]  if options
-          outopts ||= options
+          inopts = options[INPUT_OPTIONS] ||= "-y"
+          outopts = options[OUTPUT_OPTIONS] ||= ""
           execute "#{Hydra::Derivatives.ffmpeg_path} #{inopts} -i \"#{path}\" #{outopts} #{output_file}"
         end
       end

data/lib/hydra/derivatives/image.rb

@@ -2,7 +2,21 @@ require 'mini_magick'
 module Hydra
   module Derivatives
     class Image < Processor
+      class_attribute :timeout
+
       def process
+        timeout ? process_with_timeout : process_without_timeout
+      end
+
+      def process_with_timeout
+        status = Timeout::timeout(timeout) do
+          process_without_timeout
+        end
+      rescue Timeout::Error => ex
+        raise Hydra::Derivatives::TimeoutError, "Unable to process image derivative\nThe command took longer than #{timeout} seconds to execute"
+      end
+
+      def process_without_timeout
         directives.each do |name, args|
           opts = args.kind_of?(Hash) ? args : {size: args}
           format = opts.fetch(:format, 'png')

data/lib/hydra/derivatives/processor.rb

@@ -35,4 +35,3 @@ module Hydra
     end
   end
 end
-

data/lib/hydra/derivatives/shell_based_processor.rb

@@ -24,10 +24,12 @@ module Hydra
       end
 
       # override this method in subclass if you want to provide specific options.
+      # returns a hash of options that the specific processors use
       def options_for(format)
+        {}
       end
 
-      def encode_file(dest_path, file_suffix, mime_type, options = '')
+      def encode_file(dest_path, file_suffix, mime_type, options)
         out_file = nil
         output_file = Dir::Tmpname.create(['sufia', ".#{file_suffix}"], Hydra::Derivatives.temp_file_base){}
         source_file.to_tempfile do |f|

data/spec/units/image_spec.rb

@@ -6,7 +6,7 @@ describe Hydra::Derivatives::Image do
 
   subject { Hydra::Derivatives::Image.new(object, 'content', directives)}
 
-  before { expect(subject).to receive(:output_file).with(file_name).and_return(output_file) }
+  before { allow(subject).to receive(:output_file).with(file_name).and_return(output_file) }
 
   describe "when arguments are passed as a string" do
     let(:directives) { { thumb: "100x100>" } }
@@ -27,4 +27,32 @@ describe Hydra::Derivatives::Image do
       subject.process
     end
   end
+
+  describe 'timeout' do
+    let(:directives) { { thumb: "100x100>" } }
+    let(:file_name) { 'content_thumb' }
+
+    before do
+      allow(subject).to receive(:create_resized_image).with(output_file, "100x100>", 'png')
+    end
+
+    context 'when set' do
+      before do
+        subject.timeout = 0.1
+        allow_any_instance_of(Hydra::Derivatives::Image).to receive(:process_without_timeout) { sleep 0.2 }
+      end
+      it 'raises a timeout exception' do
+        expect { subject.process }.to raise_error Hydra::Derivatives::TimeoutError
+      end
+    end
+
+    context 'when not set' do
+      before { subject.timeout = nil }
+      it 'processes without a timeout' do
+        expect(subject).to receive(:process_with_timeout).never
+        expect(subject).to receive(:process_without_timeout).once
+        subject.process
+      end
+    end
+  end
 end

data/spec/units/shell_based_processor_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+
+describe Hydra::Derivatives::ShellBasedProcessor do
+  class TestProcessor  <
+    include Hydra::Derivatives::ShellBasedProcessor
+  end
+
+  let (:processor) {TestProcessor.new}
+
+  describe "has expected interface" do
+
+    describe "options_for" do
+      it "returns a hash" do
+        expect(processor.options_for("a")).to be_a Hash
+      end
+    end
+  end
+end
+
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-derivatives
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-30 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -214,6 +214,7 @@ files:
 - spec/units/image_spec.rb
 - spec/units/jpeg2k_spec.rb
 - spec/units/logger_spec.rb
+- spec/units/shell_based_processor_spec.rb
 - spec/units/transcoding_spec.rb
 - spec/units/video_spec.rb
 homepage: https://github.com/projecthydra/hydra-derivatives
@@ -236,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Derivative generation plugin for hydra
@@ -262,6 +263,6 @@ test_files:
 - spec/units/image_spec.rb
 - spec/units/jpeg2k_spec.rb
 - spec/units/logger_spec.rb
+- spec/units/shell_based_processor_spec.rb
 - spec/units/transcoding_spec.rb
 - spec/units/video_spec.rb
-has_rdoc: