bpl-derivatives 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f604a101cd3cc44e245b293607b53448d859356c
+  data.tar.gz: 4a811f18df3c232cee8d428fdd2bd35ab5e218c6
+SHA512:
+  metadata.gz: 6e0846cde9bfe0ebc88fc07dfdccf2eaf29a92b635bb6a29847e7bedda5b5e99bf79624b6cc170d752456cde2b27e3386bf4deb6054b57e3f08f03e8e7e5ee23
+  data.tar.gz: b2472b522793ce7b06662995fb5fb5aa4fced051f418f539552d8e23420be7482637486d873e66e4a2d50f10ad7d500e316fdcbe8988910e45fff860a2b5843d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+#specific
+
+Gemfile.lock
+.ruby-version
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bpl-derivatives.gemspec
+gemspec
+
+group :development, :test do
+  gem 'coveralls'
+  # gem 'rubocop', '~> 0.52.0', require: false
+  # gem 'rubocop-rspec', require: false
+  gem 'simplecov'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 bbarberBPL
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# BPL::Derivatives
+
+Modified version of [samvera/hydra-derivatives](https://github.com/samvera/hydra-derivatives) to be backwards compatible with Fedora Commons 3.8.1.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bpl-derivatives'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bpl-derivatives
+
+## Usage
+
+Currently there is no implementation of the `ActiveTranscoder` features. Also the Audio and Video derivatives have not been thoroughly tested either.  
+
+The main purpose of this was to make newer versions of hydra-derivatives backwards compatible with Fedora 3.8.1 datastreams. Rather than fork this from Samvera I determined that the BPL's use case was out of their current scope and instead implemented this version. Also be aware this has not been tested with `ActiveFedora > 9`
+
+
+Given an `ActiveFedora` Model Like So
+```ruby
+class MyObject < ActiveFedora::Base
+  has_file_datastream 'masterFile' ..
+end
+```
+
+You can now add the following
+```ruby
+  class MyObject < ActiveFedora::Base
+    include BPL::Derivatives
+    ...
+    ...
+    def generate_derivatives
+      case self.masterFile.mimeType
+      when 'image/tif'
+        derivatize runner: :jpeg2k_image, source_datastream: "masterFile", outputs: [ {recipe: :default, dsid:  'myJp2kDatastream'  } ]
+        derivatize runner: :image, source_datastream: "masterFile", outputs: [
+           { label: :thumb, size: "x800>", dsid: 'my800pxThumbDS', format: 'jpg' },
+           { label: :thumb, size: "300x300>", dsid: 'my300pxThumbDS', format: 'jpg' }
+         ]
+      when 'application/pdf'
+        derivatize runner: :image, source_datastream: "masterFile", outputs: [{label: :thumb, size: "300x300>", dsid: 'my300pxThumbDD', format: 'jpg', quality: 100, density: 200, layer: 0}] #Recommend passing in quality denisty and layer 0 for pdfs   
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/boston-library/bpl-derivatives.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+require 'fcrepo_wrapper'
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bpl/derivatives"
+require 'awesome_print'
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bpl-derivatives.gemspec

@@ -0,0 +1,50 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bpl/derivatives/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bpl-derivatives"
+  spec.version       = BPL::Derivatives::VERSION
+  spec.authors       = ["Benjamin Barber"]
+  spec.email         = ["bbarber@bpl.org"]
+
+  spec.summary       = %q{Dervivatives Processor borrowed heavily from Samvera hydra-derivatives}
+  spec.description   = %q{Dervivatives Processor borrowed heavily from Samvera hydra-derivatives with the added benefit of being decoupled to ActiveFedora}
+  spec.homepage      = "https://github.com/boston-library/bpl-derivatives"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # spec.add_dependency 'active_encode', '~> 0.1'
+  spec.add_dependency 'activesupport', '>= 4.0', '< 6'
+  spec.add_dependency 'addressable', '~> 2.5'
+  spec.add_dependency 'mime-types', '> 2.0', '< 4.0'
+  spec.add_dependency 'mini_magick', '>= 3.2', '< 5'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'awesome_print', '~> 0'
+end

data/lib/bpl/derivatives.rb

@@ -0,0 +1,74 @@
+require "bpl/derivatives/version"
+require 'active_support/all'
+
+
+module BPL
+  module Derivatives
+    extend ActiveSupport::Concern
+    extend ActiveSupport::Autoload
+
+    class Error < StandardError; end
+    class TimeoutError < ::Timeout::Error; end
+
+
+
+    autoload_under 'runners' do
+      autoload :AudioDerivatives
+      autoload :DocumentDerivatives
+      autoload :ImageDerivatives
+      autoload :Jpeg2kImageDerivatives
+      autoload :PdfDerivatives
+      autoload :Runner
+      autoload :VideoDerivatives
+    end
+
+
+    autoload :Config
+    autoload :Logger
+    autoload :Processors
+    autoload :TempfileService
+    autoload :IoDecorator
+    autoload :InputObjectDecorator
+    autoload :DatastreamDecorator
+    autoload :OutputObjectDecorator
+    autoload :AudioEncoder
+
+
+    autoload_under 'services' do
+      autoload :RetrieveSourceFileService
+      autoload :RetrieveSourceFileFromDatastreamService
+      autoload :PersistOutputFileService
+      autoload :PersistBasicContainedOutputFileService
+      autoload :PersistDatastreamOutputService
+      autoload :PersistFileSystemOutputService
+      autoload :TempfileService
+      autoload :MimeTypeService
+    end
+
+    @@config = Config.new
+    mattr_reader :config
+
+    def self.configure
+      yield(config) if block_given?
+    end
+
+    def self.reset_config!
+      @@config = Config.new
+    end
+
+    class_methods do
+      def config
+        @@config ||= Config.new
+      end
+    end
+
+    def config
+      self.class.config
+    end
+
+    def derivatize(opts = {})
+      runner = opts[:runner] ? opts.delete(:runner) : :image
+      "BPL::Derivatives::#{runner.to_s.classify}Derivatives".constantize.create(self, opts)
+    end
+  end
+end

data/lib/bpl/derivatives/audio_encoder.rb

@@ -0,0 +1,27 @@
+require 'open3'
+
+module BPL::Derivatives
+  class AudioEncoder
+    def initialize
+      @ffmpeg_output = Open3.capture3('ffmpeg -codecs').to_s
+    rescue StandardError
+      Logger.warn('Unable to find ffmpeg')
+      @ffmpeg_output = ""
+    end
+
+    def audio_encoder
+      audio_encoder = if fdk_aac?
+                        'libfdk_aac'
+                      else
+                        'aac'
+                      end
+      audio_encoder
+    end
+
+    private
+
+      def fdk_aac?
+        @ffmpeg_output.include?('--enable-libfdk-aac') || @ffmpeg_output.include?('--with-fdk-aac')
+      end
+  end
+end

data/lib/bpl/derivatives/config.rb

@@ -0,0 +1,64 @@
+require 'tmpdir'
+
+module BPL::Derivatives
+  class Config
+    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 output_object_class].freeze
+
+    attr_accessor :ffmpeg_path, :libreoffice_path, :temp_file_base,
+                :source_file_service, :output_file_service, :fits_path,
+                :enable_ffmpeg, :kdu_compress_path, :kdu_compress_recipes,
+                :active_encode_poll_time, :base_logger, :output_object_class
+
+    alias_method :jp2_recipes=, :kdu_compress_recipes=
+
+    def initialize
+      @ffmpeg_path ||= 'ffmpeg'
+      @libreoffice_path ||= 'soffice'
+      @temp_file_base ||= Dir.tmpdir
+      @source_file_service ||= BPL::Derivatives::RetrieveSourceFileService
+      @output_file_service ||= BPL::Derivatives::PersistBasicContainedOutputFileService
+      @fits_path ||= 'fits.sh'
+      @enable_ffmpeg = nil
+      @kdu_compress_path ||= 'kdu_compress'
+      @kdu_compress_recipes ||= {
+        default_color: %(-rate 2.4,1.48331273,.91673033,.56657224,.35016049,.21641118,.13374944,.08266171
+          -jp2_space sRGB
+          -double_buffering 10
+          -num_threads 4
+          -no_weights
+          Clevels=6
+          Clayers=8
+          "Cblk={64,64}"
+          Cuse_sop=yes
+          Cuse_eph=yes
+          Corder=RPCL
+          ORGgen_plt=yes
+          ORGtparts=R
+          "Stiles={1024,1024}" ).gsub(/\s+/, " ").strip,
+        default_grey: %(-rate 2.4,1.48331273,.91673033,.56657224,.35016049,.21641118,.13374944,.08266171
+          -jp2_space sLUM
+          -double_buffering 10
+          -num_threads 4
+          -no_weights
+          Clevels=6
+          Clayers=8
+          "Cblk={64,64}"
+          Cuse_sop=yes
+          Cuse_eph=yes
+          Corder=RPCL
+          ORGgen_plt=yes
+          ORGtparts=R
+          "Stiles={1024,1024}" ).gsub(/\s+/, " ").strip
+      }
+      @active_encode_poll_time ||= 10
+      @base_logger ||= ::Logger.new(STDOUT)
+      @output_object_class ||= "ActiveFedora::File"
+    end
+
+    def enable_ffmpeg
+      return @enable_ffmpeg unless @enable_ffmpeg.nil?
+      @enable_ffmpeg = true
+    end
+  end
+end

data/lib/bpl/derivatives/datastream_decorator.rb

@@ -0,0 +1,31 @@
+require 'delegate'
+module BPL::Derivatives
+  class DatastreamDecorator < InputObjectDecorator
+    attr_accessor :source_datastream
+    def initialize(object, source_datastream_name)
+      super(object)
+      self.source_datastream = object.send(source_datastream_name)
+    end
+
+    def content
+      self.source_datastream.content
+    end
+
+    def has_content?
+      self.source_datastream.has_content?
+    end
+
+    def filename_for_characterization
+      return source_datastream.filename_for_characterization if source_datastream.respond_to?(:filename_for_characterization)
+      self.default_filename_for_charaterization
+    end
+
+    protected
+    def default_filename_for_charaterization
+      registered_mime_type = BPL::Derivatives::MimeTypeService.type_lookup(source_datastream.mimeType)
+      BPL::Derivatives.base_logger.warn "Unable to find a registered mime type for #{source_datastream.mimeType.inspect} on #{pid}" unless registered_mime_type
+      extension = registered_mime_type ? ".#{registered_mime_type.extensions.first}" : ''
+      ["#{source_datastream.pid}-#{source_datastream.dsVersionID}", "#{extension}"]
+    end
+  end
+end

data/lib/bpl/derivatives/input_object_decorator.rb

@@ -0,0 +1,11 @@
+require 'delegate'
+
+module BPL::Derivatives
+  class InputObjectDecorator < SimpleDelegator
+    attr_accessor :source_path
+    def initialize(object_or_filename)
+      self.source_path = object_or_filename if object_or_filename.is_a?(String)
+      super(object_or_filename)
+    end
+  end
+end

data/lib/bpl/derivatives/io_decorator.rb

@@ -0,0 +1,15 @@
+require 'delegate'
+
+module BPL::Derivatives
+  class IoDecorator < SimpleDelegator
+    attr_accessor :mime_type, :original_filename
+    alias original_name original_filename
+    alias original_name= original_filename=
+
+    def initialize(file, mime_type = nil, original_filename = nil)
+      super(file)
+      self.mime_type = mime_type
+      self.original_filename = original_filename
+    end
+  end
+end