hydra-derivatives 1.0.0.rc1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a187e27d98d4794b3b08e838f1447ab327c3c087
-  data.tar.gz: af4f7cb52f6ba4baa4030fec666246c56d15f316
+  metadata.gz: fcf72cd8457040e024d1afc7165e39fcd934b9e6
+  data.tar.gz: c32e5d6d99fd839685c76d3e7ae5f535ee9a2df5
 SHA512:
-  metadata.gz: 088f11cb8055706f5598635efa2cfa2b30f3c9cb68da5569b462fc416198a19aad676464fa3696e41d21810e00414033e1cca6cfb328e52772ca68cb39e33b4e
-  data.tar.gz: bb4f41955207630d92d09bc3c7e53b1a1a93b5c1e46efe711eb6136725d3205d02d7495a2be775b1e669bb6a8895c341d70fbda51de61adfafa1804e6dd9ec42
+  metadata.gz: d0a0f31a6c6be71ed6d88ea9504cc6f16800449dd44d70c8b5c487cbcd232fee19acccb64c4f1b71a7d64a5029307a014b29698253d5433db6e945ff69399d56
+  data.tar.gz: 33c5c95a19390035f4b4227acae0dd78ccf6053de8b9215f25b0f29559a9b9e3dc03cfe544d92bc15a20708f67f1a76a66aedc400fbae0179ef148381422fdbb

data/VERSION

@@ -1 +1 @@
-1.0.0.rc1
+1.0.0

data/hydra-derivatives.gemspec

@@ -1,6 +1,7 @@
 # coding: utf-8
 version = File.read(File.expand_path("../VERSION", __FILE__)).strip
 
+
 Gem::Specification.new do |spec|
   spec.name          = "hydra-derivatives"
   spec.version       = version
@@ -16,15 +17,16 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "jettywrapper"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'jettywrapper', '~> 2.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
 
-  spec.add_dependency 'active-fedora', '~> 9.0.0.rc2'
-  spec.add_dependency 'hydra-file_characterization'
-  spec.add_dependency 'mini_magick'
-  spec.add_dependency 'activesupport', '>= 3.2.13', '< 5.0'
-  spec.add_dependency 'mime-types'
-  spec.add_dependency 'deprecation'
+  spec.add_dependency 'active-fedora', '~> 9.0'
+  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 'deprecation', '~> 0.1'
 end
+

data/lib/hydra/derivatives.rb

@@ -20,6 +20,9 @@ module Hydra
     autoload :Jpeg2kImage
     autoload :Logger
 
+    # Raised if the timout elapses
+    class TimeoutError < ::Timeout::Error; end
+
     def self.config
       @config ||= reset_config!
     end
@@ -79,8 +82,17 @@ module Hydra
     #   transform_file :content, { :mp4 => {format: 'mp4'}, :webm => {format: 'webm'} }, processor: :video
     #
     def transform_file(file_name, transform_directives, opts={})
-      processor = opts[:processor] ? opts[:processor] : :image
-      "Hydra::Derivatives::#{processor.to_s.classify}".constantize.new(self, file_name, transform_directives).process
+      processor = processor_class(opts[:processor] || :image)
+      processor.new(self, file_name, transform_directives).process
+    end
+
+    def processor_class(processor)
+      case processor
+        when :video
+          Hydra::Derivatives::Video::Processor
+        else
+          "Hydra::Derivatives::#{processor.to_s.classify}".constantize
+        end
     end
 
     def transform_datastream(file_name, transform_directives, opts={})

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_dsid, 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'
@@ -24,7 +24,7 @@ module Hydra
           end
         end
         out_file = File.open(new_output, "rb")
-        object.add_file_datastream(out_file.read, dsid: dest_dsid, mime_type: mime_type)
+        object.add_file(out_file.read, path: dest_path, mime_type: mime_type)
         File.unlink(out_file)
       end
 

data/lib/hydra/derivatives/jpeg2k_image.rb

@@ -25,7 +25,7 @@ module Hydra
         end
       end
 
-      def encode_file(dest_dsid, recipe, opts={})
+      def encode_file(dest_path, recipe, opts={})
         output_file = self.class.tmp_file('.jp2')
         if opts[:file_path]
           self.class.encode(opts[:file_path], recipe, output_file)
@@ -35,7 +35,7 @@ module Hydra
           end
         end
         out_file = File.open(output_file, "rb")
-        object.add_file_datastream(out_file.read, dsid: dest_dsid, mime_type: 'image/jp2')
+        object.add_file(out_file.read, path: dest_path, mime_type: 'image/jp2')
         File.unlink(output_file)
       end
 

data/lib/hydra/derivatives/shell_based_processor.rb

@@ -9,6 +9,7 @@ module Hydra
       extend ActiveSupport::Concern
 
       included do
+        class_attribute :timeout
         extend Open3
       end
 
@@ -26,20 +27,44 @@ module Hydra
       def options_for(format)
       end
 
-      def encode_file(dest_dsid, 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|
           self.class.encode(f.path, options, output_file)
         end
         out_file = File.open(output_file, "rb")
-        object.add_file_datastream(out_file.read, dsid: dest_dsid, mime_type: mime_type)
+        object.add_file(out_file.read, path: dest_path, mime_type: mime_type)
         File.unlink(output_file)
       end
 
       module ClassMethods
+
         def execute(command)
+          context = {}
+          if timeout
+            execute_with_timeout(timeout, command, context)
+          else
+            execute_without_timeout(command, context)
+          end
+        end
+
+        def execute_with_timeout(timeout, command, context)
+          begin
+            status = Timeout::timeout(timeout) do
+              execute_without_timeout(command, context)
+            end
+          rescue Timeout::Error => ex
+            pid = context[:pid]
+            Process.kill("KILL", pid)
+            raise Hydra::Derivatives::TimeoutError, "Unable to execute command \"#{command}\"\nThe command took longer than #{timeout} seconds to execute"
+          end
+
+        end
+
+        def execute_without_timeout(command, context)
           stdin, stdout, stderr, wait_thr = popen3(command)
+          context[:pid] = wait_thr[:pid]
           stdin.close
           out = stdout.read
           stdout.close

data/lib/hydra/derivatives/video.rb

@@ -1,58 +1,10 @@
-module Hydra
-  module Derivatives
-    class Video < Processor
-      include Ffmpeg
+module Hydra::Derivatives
+  module Video
+    extend ActiveSupport::Autoload
 
-      protected
-
-      def options_for(format)
-        input_options=""
-        output_options = "-s #{size_attributes} #{codecs(format)}"
-
-        if (format == "jpg")
-          input_options +=" -itsoffset -2"
-          output_options+= " -vframes 1 -an -f rawvideo"
-        else
-          output_options +=" #{video_attributes} #{audio_attributes}"
-        end
-
-        { Ffmpeg::OUTPUT_OPTIONS => output_options, Ffmpeg::INPUT_OPTIONS => input_options}
-      end
-
-      def video_bitrate
-        '345k'
-      end
-
-      def video_attributes
-        "-g 30 -b:v #{video_bitrate}"
-      end
-
-      def size_attributes
-        "320x240"
-      end
-
-      def audio_attributes 
-        "-ac 2 -ab 96k -ar 44100"
-      end
-
-      def codecs(format)
-        case format
-        when 'mp4'
-          "-vcodec libx264 -acodec libfdk_aac"
-        when 'webm'
-          "-vcodec libvpx -acodec libvorbis"
-        when "mkv"
-          "-vcodec ffv1"
-        when "jpg"
-          "-vcodec mjpeg"
-        else
-          raise ArgumentError, "Unknown format `#{format}'"
-        end
-      end
-
-      def new_mime_type(format)
-        format == "jpg" ? "image/jpeg" : "video/#{format}"
-      end
+    eager_autoload do
+      autoload :Processor
+      autoload :Config
     end
   end
 end

data/lib/hydra/derivatives/video/config.rb

@@ -0,0 +1,67 @@
+module Hydra::Derivatives::Video
+  class Config
+    attr_writer :video_bitrate, :video_attributes, :size_attributes, :audio_attributes
+
+    def video_bitrate
+      @video_bitrate ||= default_video_bitrate
+    end
+
+    def video_attributes
+      @video_attributes ||= default_video_attributes
+    end
+
+    def size_attributes
+      @size_attributes ||= default_size_attributes
+    end
+
+    def audio_attributes
+      @audio_attributes ||= default_audio_attributes
+    end
+
+    def mpeg4
+      @mpeg4 ||= CodecConfig.new('-vcodec libx264 -acodec libfdk_aac')
+    end
+
+    def webm
+      @webm ||= CodecConfig.new('-vcodec libvpx -acodec libvorbis')
+    end
+
+    def mkv
+      @mkv ||= CodecConfig.new('-vcodec ffv1')
+    end
+
+    def jpeg
+      @jpeg ||= CodecConfig.new('-vcodec mjpeg')
+    end
+
+    class CodecConfig
+      attr_writer :codec
+
+      def initialize(default)
+        @codec = default
+      end
+
+      def codec
+        @codec
+      end
+    end
+
+
+    protected
+      def default_video_bitrate
+        '345k'
+      end
+
+      def default_video_attributes
+        "-g 30 -b:v #{video_bitrate}"
+      end
+
+      def default_size_attributes
+        "320x240"
+      end
+
+      def default_audio_attributes
+        "-ac 2 -ab 96k -ar 44100"
+      end
+  end
+end

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

@@ -0,0 +1,47 @@
+module Hydra::Derivatives
+  module Video
+    class Processor < Hydra::Derivatives::Processor
+      include Ffmpeg
+
+      class_attribute :config
+      self.config = Config.new
+
+      protected
+
+      def options_for(format)
+        input_options=""
+        output_options = "-s #{config.size_attributes} #{codecs(format)}"
+
+        if (format == "jpg")
+          input_options +=" -itsoffset -2"
+          output_options+= " -vframes 1 -an -f rawvideo"
+        else
+          output_options +=" #{config.video_attributes} #{config.audio_attributes}"
+        end
+
+        { Ffmpeg::OUTPUT_OPTIONS => output_options, Ffmpeg::INPUT_OPTIONS => input_options}
+      end
+
+      def codecs(format)
+        case format
+        when 'mp4'
+          config.mpeg4.codec
+        when 'webm'
+          config.webm.codec
+        when "mkv"
+          config.mkv.codec
+        when "jpg"
+          config.jpeg.codec
+        else
+          raise ArgumentError, "Unknown format `#{format}'"
+        end
+      end
+
+      def new_mime_type(format)
+        format == "jpg" ? "image/jpeg" : "video/#{format}"
+      end
+    end
+  end
+end
+
+

data/spec/units/transcoding_spec.rb

@@ -138,6 +138,19 @@ describe "Transcoder" do
       expect(file.attached_files['thumbnail']).to have_content
       expect(file.attached_files['thumbnail'].mime_type).to eq('image/jpeg')
     end
+
+    context "and the timeout is set" do
+      before do
+        Hydra::Derivatives::Video::Processor.timeout = 1 # one second
+      end
+      after do
+        Hydra::Derivatives::Video::Processor.timeout = nil # clear timeout
+      end
+
+      it "should raise a timeout" do
+        expect { file.create_derivatives }.to raise_error Hydra::Derivatives::TimeoutError
+      end
+    end
   end
 
   describe "using callback methods" do

data/spec/units/video_spec.rb

@@ -1,10 +1,26 @@
 require 'spec_helper'
 
-describe Hydra::Derivatives::Video do
-  describe "when arguments are passed as a hash" do
-    describe "and datastream is provided as an argument" do
-      let(:directives) {{ :thumb => {format: "webm", datastream: 'thumbnail'} }}
-      subject { Hydra::Derivatives::Video.new(double(:obj), 'content', directives)}
+describe Hydra::Derivatives::Video::Processor do
+  subject { described_class.new(double(:obj), 'content', directives)}
+
+  describe ".config" do
+    before do
+      @original_config = described_class.config.dup
+      described_class.config.mpeg4.codec = "-vcodec mpeg4 -acodec aac -strict -2"
+    end
+
+    after { described_class.config = @original_config }
+      let(:directives) {{ thumb: { format: "mp4", datastream: 'thumbnail' } }}
+
+    it "should be configurable" do
+      expect(subject).to receive(:encode_file).with("thumbnail", "mp4", 'video/mp4', {Hydra::Derivatives::Ffmpeg::OUTPUT_OPTIONS =>"-s 320x240 -vcodec mpeg4 -acodec aac -strict -2 -g 30 -b:v 345k -ac 2 -ab 96k -ar 44100", Hydra::Derivatives::Ffmpeg::INPUT_OPTIONS=>""})
+      subject.process
+    end
+  end
+
+  context "when arguments are passed as a hash" do
+    context "and datastream is provided as an argument" do
+      let(:directives) {{ thumb: { format: "webm", datastream: 'thumbnail' } }}
       it "should create a datastream with the specified name" do
         expect(subject).to receive(:encode_file).with("thumbnail", "webm", 'video/webm', {Hydra::Derivatives::Ffmpeg::OUTPUT_OPTIONS =>"-s 320x240 -vcodec libvpx -acodec libvorbis -g 30 -b:v 345k -ac 2 -ab 96k -ar 44100", Hydra::Derivatives::Ffmpeg::INPUT_OPTIONS=>""})
         subject.process
@@ -12,9 +28,8 @@ describe Hydra::Derivatives::Video do
       end
     end
 
-    describe "and datastream is not provided as an argument" do
-      let(:directives) {{ :thumb => {format: "webm"} }}
-      subject { Hydra::Derivatives::Video.new(double(:obj), 'content', directives)}
+    context "and datastream is not provided as an argument" do
+      let(:directives) {{ thumb: { format: "webm" } }}
       it "should create a datastream and infer the name" do
         expect(subject).to receive(:encode_file).with("content_thumb", "webm", 'video/webm', {Hydra::Derivatives::Ffmpeg::OUTPUT_OPTIONS =>"-s 320x240 -vcodec libvpx -acodec libvorbis -g 30 -b:v 345k -ac 2 -ab 96k -ar 44100", Hydra::Derivatives::Ffmpeg::INPUT_OPTIONS=>""})
         subject.process
@@ -22,9 +37,8 @@ describe Hydra::Derivatives::Video do
       end
     end
 
-    describe "and jpg is requested" do
-      let(:directives) {{ :thumb => {:format => 'jpg' , datastream: 'thumbnail'} }}
-      subject { Hydra::Derivatives::Video.new(double(:obj), 'content', directives)}
+    context "and jpg is requested" do
+      let(:directives) {{ thumb: { format: 'jpg' , datastream: 'thumbnail'} }}
       it "should create a datastream and infer the name" do
         expect(subject).to receive(:encode_file).with("thumbnail", "jpg", "image/jpeg", {:output_options=>"-s 320x240 -vcodec mjpeg -vframes 1 -an -f rawvideo", :input_options=>" -itsoffset -2"})
         subject.process

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-derivatives
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,134 +28,134 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: jettywrapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: active-fedora
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.0.0.rc2
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.0.0.rc2
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: hydra-file_characterization
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.13
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.13
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 description: Derivative generation plugin for hydra
 email:
 - justin@curationexperts.com
@@ -191,6 +191,8 @@ files:
 - lib/hydra/derivatives/railtie.rb
 - lib/hydra/derivatives/shell_based_processor.rb
 - lib/hydra/derivatives/video.rb
+- lib/hydra/derivatives/video/config.rb
+- lib/hydra/derivatives/video/processor.rb
 - spec/fixtures/FlashPix.ppt
 - spec/fixtures/adobe1998.tif
 - spec/fixtures/countdown.avi
@@ -229,12 +231,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Derivative generation plugin for hydra
@@ -262,3 +264,4 @@ test_files:
 - spec/units/logger_spec.rb
 - spec/units/transcoding_spec.rb
 - spec/units/video_spec.rb
+has_rdoc: