hydra-derivatives 3.3.2 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3cb485ab21d05631d5c5643d6fe6726d2dc82fb3
-  data.tar.gz: 2f30a6f276a10e750bd4d1f5acde291d775e5668
+SHA256:
+  metadata.gz: 8528fcd35248b83ece67695b925ea0339e98c4b903d07509377b22907d1b7aa4
+  data.tar.gz: 142811abdaf02fa588a3e7cd7cf6441033561fbcd984710cd2b7220b733a3546
 SHA512:
-  metadata.gz: 6b0618b15bb531bbe5d2b476b790b3f26652a8ebab3403a325ff720d2fc16b933de2e8c37e94521eb14e405b1f15ceda036c0ef647808d995e81389fb471a250
-  data.tar.gz: 02225a904af793102c24dbd983116640dea8183ce331f0fb40830095d8012466dfe7c5870ca0a6f398956b2bbdaffeaadfa555d1e7a49c8db936caf65e759c6d
+  metadata.gz: cffe7544e081933bce5083c6c6516bb29faf383cfbcf002511048899bb9ae11dcfa4d7b06198a888757d7ab79a9fa142971333f209738068ec579a6be5ec67fb
+  data.tar.gz: a9d7f1cd5914313b3febd42691e503d1262853bb6e8128dae093647b50fd74d2627d18f2a1e7955dbee51aced523705ed1c1ab9260921f6b9c8cf549e53800ae

data/.rubocop.yml

@@ -3,42 +3,35 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   DisplayCopNames: true
-  Include:
-    - '**/Rakefile'
   Exclude:
     - 'vendor/**/*'
     - 'spec/internal/bin/*'
     - 'spec/internal/db/schema.rb'
+    - Gemfile
+    - hydra-derivatives.gemspec
+    - Rakefile
 
-Metrics/LineLength:
-  Enabled: false
-
-Style/CollectionMethods:
-  PreferredMethods:
-    collect: 'map'
-    collect!: 'map!'
-    inject: 'reduce'
-    detect: 'find'
-    find_all: 'select'
-
-Style/ClassAndModuleChildren:
-  Enabled: false
+Layout/IndentationConsistency:
+  EnforcedStyle: rails
 
-Style/Documentation:
-  Enabled: false
+Metrics/AbcSize:
+  Max: 42
+  Exclude:
+    - lib/hydra/derivatives/processors/document.rb
+    - lib/hydra/derivatives/processors/full_text.rb
+    - lib/hydra/derivatives/processors/jpeg2k_image.rb
+    - lib/hydra/derivatives/processors/shell_based_processor.rb
+    - lib/hydra/derivatives/services/persist_basic_contained_output_file_service.rb
+    - lib/hydra/derivatives/services/tempfile_service.rb
 
-Style/StringLiterals:
-  Enabled: false
+Metrics/BlockLength:
+  Max: 320
 
-Style/SignalException:
+Metrics/LineLength:
   Enabled: false
 
-Style/IndentationConsistency:
-  EnforcedStyle: rails
-
-Style/PredicateName:
-  Exclude:
-    - spec/services/tempfile_service_spec.rb
+RSpec/ExampleLength:
+  Max: 10
 
 RSpec/ExampleWording:
   CustomTransform:
@@ -52,15 +45,41 @@ RSpec/ExampleWording:
 RSpec/FilePath:
   Enabled: false
 
+RSpec/HookArgument:
+  Exclude:
+    - spec/spec_helper.rb
+
 RSpec/InstanceVariable:
   Enabled: false
 
-RSpec/DescribeClass:
-  Exclude:
-    - spec/units/config_spec.rb
-    - spec/units/transcoding_spec.rb
+RSpec/MessageSpies:
+  Enabled: false
 
-RSpec/AnyInstance:
-  Exclude:
-    - spec/processors/image_spec.rb
-    - spec/units/transcoding_spec.rb
+RSpec/MultipleExpectations:
+  Max: 10
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 4
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'
+
+Style/Documentation:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,5 +1,14 @@
 # List of files that we ought to fix based on what Rubocop is complaining about them
 
+Layout/SpaceBeforeBlockBraces:
+  Exclude:
+    - lib/hydra/derivatives/processors/jpeg2k_image.rb
+    - lib/hydra/derivatives/processors/shell_based_processor.rb
+
+Metrics/ClassLength:
+  Exclude:
+    - lib/hydra/derivatives/processors/jpeg2k_image.rb
+
 Metrics/CyclomaticComplexity:
   Exclude:
     - spec/units/transcoding_spec.rb
@@ -12,18 +21,42 @@ Metrics/MethodLength:
     - lib/hydra/derivatives/processors/shell_based_processor.rb
     - lib/hydra/derivatives/processors/video/processor.rb
     - lib/hydra/derivatives/services/tempfile_service.rb
+    - spec/**/*.rb
+
+Naming/PredicateName:
+  Exclude:
+    - spec/services/tempfile_service_spec.rb
+
+RSpec/AnyInstance:
+  Exclude:
+    - spec/processors/image_spec.rb
     - spec/units/transcoding_spec.rb
 
-Metrics/ClassLength:
+RSpec/BeforeAfterAll:
   Exclude:
-    - lib/hydra/derivatives/processors/jpeg2k_image.rb
+    - spec/**/*.rb
 
-Metrics/AbcSize:
+RSpec/DescribeClass:
   Exclude:
-    - lib/hydra/derivatives/processors/document.rb
-    - lib/hydra/derivatives/processors/full_text.rb
-    - lib/hydra/derivatives/processors/jpeg2k_image.rb
-    - lib/hydra/derivatives/processors/shell_based_processor.rb
-    - lib/hydra/derivatives/services/persist_basic_contained_output_file_service.rb
-    - lib/hydra/derivatives/services/tempfile_service.rb
+    - spec/units/config_spec.rb
     - spec/units/transcoding_spec.rb
+
+RSpec/PredicateMatcher:
+  Exclude:
+    - spec/**/*.rb
+
+RSpec/ReturnFromStub:
+  Exclude:
+    - spec/processors/jpeg2k_spec.rb
+
+RSpec/SubjectStub:
+  Exclude:
+    - spec/**/*.rb
+
+RSpec/VerifiedDoubles:
+  Exclude:
+    - spec/processors/full_text_spec.rb
+
+Style/EvalWithLocation:
+  Exclude:
+    - lib/hydra/derivatives.rb

data/.travis.yml

@@ -24,3 +24,15 @@ notifications:
       - "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

data/Gemfile

@@ -4,9 +4,9 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'simplecov'
-  gem 'coveralls'
   gem 'byebug' unless ENV['TRAVIS']
-  gem 'rubocop', '~> 0.37.2', require: false
+  gem 'coveralls'
+  gem 'rubocop', '~> 0.52.0', require: false
   gem 'rubocop-rspec', require: false
+  gem 'simplecov'
 end

data/Rakefile

@@ -20,7 +20,7 @@ namespace :derivatives do
   end
 
   RSpec::Core::RakeTask.new(:rspec) do |task|
-    task.rspec_opts = "--tag ~requires_imagemagick --tag ~requires_ffmpeg --tag ~requires_libreoffice --tag ~requires_kdu_compress" if ENV['TRAVIS']
+    task.rspec_opts = "--tag ~requires_kdu_compress" if ENV['TRAVIS']
   end
 
   desc 'Start up Solr & Fedora and run tests'

data/VERSION

@@ -1 +1 @@
-3.3.2
+3.4.0

data/config/fcrepo_wrapper_test.yml

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

data/hydra-derivatives.gemspec

@@ -1,14 +1,12 @@
-# coding: utf-8
 version = File.read(File.expand_path("../VERSION", __FILE__)).strip
 
-
 Gem::Specification.new do |spec|
   spec.name          = "hydra-derivatives"
   spec.version       = version
   spec.authors       = ["Justin Coyne"]
   spec.email         = ["justin@curationexperts.com"]
-  spec.description   = %q{Derivative generation plugin for hydra}
-  spec.summary       = %q{Derivative generation plugin for hydra}
+  spec.description   = "Derivative generation plugin for hydra"
+  spec.summary       = "Derivative generation plugin for hydra"
   spec.license       = "APACHE2"
   spec.homepage      = "https://github.com/projecthydra/hydra-derivatives"
 
@@ -18,17 +16,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency 'bundler', '~> 1.3'
+  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 'fcrepo_wrapper', '~> 0.2'
 
-  spec.add_dependency 'active-fedora', '>= 11.3.1', '< 12'
-  spec.add_dependency 'mini_magick', '>= 3.2', '< 5'
-  spec.add_dependency 'activesupport', '>= 4.0', '< 6'
-  spec.add_dependency 'mime-types', '> 2.0', '< 4.0'
+  spec.add_dependency 'active-fedora', '>= 11.3.1', '< 13'
   spec.add_dependency 'active_encode', '~>0.1'
+  spec.add_dependency 'activesupport', '>= 4.0', '< 6'
   spec.add_dependency 'addressable', '~>2.5'
   spec.add_dependency 'deprecation'
+  spec.add_dependency 'mime-types', '> 2.0', '< 4.0'
+  spec.add_dependency 'mini_magick', '>= 3.2', '< 5'
 end
-

data/lib/hydra/derivatives.rb

@@ -50,8 +50,8 @@ module Hydra
       @config = Config.new
     end
 
-    CONFIG_METHODS = [:ffmpeg_path, :libreoffice_path, :temp_file_base, :fits_path, :kdu_compress_path,
-                      :kdu_compress_recipes, :enable_ffmpeg, :source_file_service, :output_file_service, :active_encode_poll_time].freeze
+    CONFIG_METHODS = %i[ffmpeg_path libreoffice_path temp_file_base fits_path kdu_compress_path
+                        kdu_compress_recipes enable_ffmpeg source_file_service output_file_service active_encode_poll_time].freeze
     CONFIG_METHODS.each do |method|
       module_eval <<-RUBY
         def self.#{method}

data/lib/hydra/derivatives/audio_encoder.rb

@@ -4,7 +4,7 @@ module Hydra::Derivatives
   class AudioEncoder
     def initialize
       @ffmpeg_output = Open3.capture3('ffmpeg -codecs').to_s
-    rescue
+    rescue StandardError
       Logger.warn('Unable to find ffmpeg')
       @ffmpeg_output = ""
     end

data/lib/hydra/derivatives/io_decorator.rb

@@ -1,6 +1,7 @@
-# Nieve implementation of IO wrapper class that adds mime_type and original_name attributes.
-# This is done so the attributes do not have to be passed as additional arguments,
-#  and are attached properly to the object they describe.
+# Naive implementation of IO wrapper class that adds mime_type and original_filename
+# attributes. This is done to match the interface of ActionDispatch::HTTP::UploadedFile
+# so the attributes do not have to be passed as additional arguments, and are attached
+# properly to the object they describe.
 #
 #
 #  Use SimpleDelegator to wrap the given class or instance
@@ -9,12 +10,16 @@ require 'delegate'
 module Hydra
   module Derivatives
     class IoDecorator < SimpleDelegator
-      attr_accessor :mime_type, :original_name
+      extend Deprecation
 
-      def initialize(file, mime_type = nil, original_name = nil)
+      attr_accessor :mime_type, :original_filename
+      alias original_name original_filename
+      deprecation_deprecate original_name: 'original_name has been deprecated. Use original_filename instead. This will be removed in hydra-derivatives 4.0'
+
+      def initialize(file, mime_type = nil, original_filename = nil)
         super(file)
         self.mime_type = mime_type
-        self.original_name = original_name
+        self.original_filename = original_filename
       end
     end
   end

data/lib/hydra/derivatives/logger.rb

@@ -3,7 +3,7 @@ module Hydra::Derivatives
     class << self
       def method_missing(method_name, *arguments, &block)
         logger.send(method_name, *arguments, &block)
-      rescue
+      rescue StandardError
         super
       end
 
@@ -11,6 +11,10 @@ module Hydra::Derivatives
         logger.respond_to? method_name
       end
 
+      def respond_to_missing?(method_name, _include_private = false)
+        logger.respond_to_missing? method_name
+      end
+
       private
 
       def logger

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

@@ -45,7 +45,7 @@ module Hydra::Derivatives::Processors
       # After a timeout error, try to cancel the encoding.
       def cleanup_after_timeout
         encode_job.cancel!
-      rescue => e
+      rescue StandardError => e
         cancel_error = e
       ensure
         msg = "Unable to process ActiveEncode derivative: The command took longer than #{timeout} seconds to execute. Encoding will be cancelled."

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

@@ -23,6 +23,7 @@ module Hydra::Derivatives::Processors
       # @return [String] the result of calling the extract service
       def fetch
         req = Net::HTTP.new(uri.host, uri.port)
+        req.use_ssl = true if check_for_ssl
         resp = req.post(uri.to_s, file_content, request_headers)
         raise "Solr Extract service was unsuccessful. '#{uri}' returned code #{resp.code} for #{source_path}\n#{resp.body}" unless resp.code == '200'
         file_content.rewind if file_content.respond_to?(:rewind)
@@ -56,6 +57,10 @@ module Hydra::Derivatives::Processors
         @uri ||= connection_url + 'update/extract?extractOnly=true&wt=json&extractFormat=text'
       end
 
+      def check_for_ssl
+        uri.scheme == 'https'
+      end
+
       # @returns [URI] path to the solr collection
       def connection_url
         ActiveFedora::SolrService.instance.conn.uri

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

@@ -17,16 +17,13 @@ module Hydra::Derivatives::Processors
       def kdu_compress_recipe(args, quality, long_dim)
         if args[:recipe].is_a? Symbol
           recipe = [args[:recipe].to_s, quality].join('_').to_sym
-          if Hydra::Derivatives.kdu_compress_recipes.key? recipe
-            return Hydra::Derivatives.kdu_compress_recipes[recipe]
-          else
-            ActiveFedora::Base.logger.warn "No JP2 recipe for :#{args[:recipe]} ('#{recipe}') found in configuration. Using best guess."
-            return calculate_recipe(args, quality, long_dim)
-          end
+          return Hydra::Derivatives.kdu_compress_recipes[recipe] if Hydra::Derivatives.kdu_compress_recipes.key? recipe
+          ActiveFedora::Base.logger.warn "No JP2 recipe for :#{args[:recipe]} ('#{recipe}') found in configuration. Using best guess."
+          calculate_recipe(args, quality, long_dim)
         elsif args[:recipe].is_a? String
-          return args[:recipe]
+          args[:recipe]
         else
-          return calculate_recipe(args, quality, long_dim)
+          calculate_recipe(args, quality, long_dim)
         end
       end
 

data/lib/hydra/derivatives/runners/full_text_extract.rb

@@ -3,7 +3,7 @@ module Hydra::Derivatives
     # Adds format: 'txt' as the default to each of the directives
     def self.transform_directives(options)
       options.each do |directive|
-        directive.reverse_merge!(format: 'txt')
+        directive.reverse_merge!(format: 'txt', binary: false)
       end
       options
     end

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

@@ -5,7 +5,7 @@ module Hydra::Derivatives
     attr_accessor :ffmpeg_output
     def capture_output
       @ffmpeg_output = Open3.capture3('ffmpeg -codecs').to_s
-    rescue
+    rescue StandardError
       Logger.warn('Unable to find ffmpeg')
       @ffmpeg_output = ""
     end

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

@@ -31,8 +31,12 @@ module Hydra::Derivatives
     end
     private_class_method :retrieve_remote_file
 
+    # @param [IO,String] content the data to be persisted
+    # @param [Hash] directives directions which can be used to determine where to persist to.
+    # @return [Hydra::Derivatives::IoDecorator]
     def self.io(content, directives)
-      Hydra::Derivatives::IoDecorator.new(content, new_mime_type(directives.fetch(:format), charset(content)))
+      charset = charset(content) if directives[:format] == 'txt' || !directives.fetch(:binary, true)
+      Hydra::Derivatives::IoDecorator.new(content, new_mime_type(directives.fetch(:format), charset))
     end
     private_class_method :io
 

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

@@ -9,14 +9,16 @@ module Hydra::Derivatives
       raise NotImplementedError, "PersistOutputFileService is an abstract class. Implement `call' on #{self.class.name}"
     end
 
+    # @param file [Hydra::Derivatives::IoDecorator]
     def self.determine_original_name(file)
-      if file.respond_to? :original_name
-        file.original_name
+      if file.respond_to? :original_filename
+        file.original_filename
       else
         "derivative"
       end
     end
 
+    # @param file [Hydra::Derivatives::IoDecorator]
     def self.determine_mime_type(file)
       if file.respond_to? :mime_type
         file.mime_type