active_encode 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4a97d45ac966ff1988311fd6787fde4bc9b40850fb83ddd78aaa79ef495a885
-  data.tar.gz: f66be6fc89de6e14cb192cc55f6d467a211598804511f8aca981e3d441dd9493
+  metadata.gz: 22be45555a3ea9208b56552c17e86a0052865e753cd2cd03fae9a876ebee6964
+  data.tar.gz: 55ba9a105b56e2d660b8bbe237cee26dc10caea24c87dd0b7e81a46b2ad28979
 SHA512:
-  metadata.gz: 360d90909956f64d5e499e1260128a85ac498891cdc4eb448e9ce53f5e4cc02372bec4df79143129202963fab95d8e4fc6c79f83335346d82b2fa2a20bf4d4df
-  data.tar.gz: 76bf91cce817790e2b9775e83df44208812f024e353524cccbfc470525b083c2b172c6576af8f8711896b227e5fab438feb97c3da4b9849c1b378451ebfb62a8
+  metadata.gz: b3ced87039d84e596fc2f011f70b586ef46d2501af00d94e64e91a2241df93c9e93b153814125454eb8af96ae63a2289188067fa4193fe01ee6568d5b9471113
+  data.tar.gz: 5dc21ccd48592fe2460599404f17c886f242f77a57cd3dbc9a8064176da44f9f1566a9cbf2c529491f037f25da252e0dd3fe40e345b15d9310b7c4464add310a

data/.circleci/config.yml

@@ -0,0 +1,72 @@
+version: 2.1
+orbs:
+  samvera: samvera/circleci-orb@0
+jobs:
+  bundle_and_test:
+    parameters:
+      ruby_version:
+        type: string
+        default: 2.6.3
+      rails_version:
+        type: string
+        default: 5.2.3
+      bundler_version:
+        type: string
+        default: 2.0.1
+    executor:
+      name: 'samvera/ruby'
+      ruby_version: << parameters.ruby_version >>
+    environment:
+      ENGINE_CART_RAILS_OPTIONS: --skip-git --skip-bundle --skip-listen --skip-spring --skip-yarn --skip-keeps --skip-coffee --skip-puma --skip-test
+      RAILS_VERSION: << parameters.rails_version >>
+    working_directory: ~/project
+    steps:
+      - run: sudo apt-get install libmms0
+      - run: sudo wget -P /tmp/ https://mediaarea.net/download/binary/libzen0/0.4.37/libzen0v5_0.4.37-1_amd64.Debian_9.0.deb
+      - run: sudo wget -P /tmp/ https://mediaarea.net/download/binary/libmediainfo0/19.04/libmediainfo0v5_19.04-1_amd64.Debian_9.0.deb
+      - run: sudo wget -P /tmp/ https://mediaarea.net/download/binary/mediainfo/19.04/mediainfo_19.04-1_amd64.Debian_9.0.deb
+      - run: sudo dpkg -i /tmp/libzen0v5_0.4.37-1_amd64.Debian_9.0.deb /tmp/libmediainfo0v5_19.04-1_amd64.Debian_9.0.deb /tmp/mediainfo_19.04-1_amd64.Debian_9.0.deb
+
+      - samvera/cached_checkout
+
+      - samvera/bundle_for_gem:
+          ruby_version: << parameters.ruby_version >>
+          bundler_version: << parameters.bundler_version >>
+          project: active_encode
+
+      - samvera/engine_cart_generate:
+          cache_key: v2-internal-test-app-{{ checksum "active_encode.gemspec" }}-{{ checksum "spec/test_app_templates/lib/generators/test_app_generator.rb" }}-<< parameters.rails_version >>-<< parameters.ruby_version >>
+
+      - samvera/bundle_for_gem:
+          ruby_version: << parameters.ruby_version >>
+          bundler_version: << parameters.bundler_version >>
+          project: active_encode
+
+      - samvera/rubocop
+
+      - samvera/parallel_rspec
+
+workflows:
+  ci:
+    jobs:
+      - bundle_and_test:
+          name: "ruby2-6_rails5-2"
+          ruby_version: "2.6.3"
+      - bundle_and_test:
+          name: "ruby2-5_rails5-2"
+          ruby_version: "2.5.5"
+      - bundle_and_test:
+          name: "ruby2-4_rails5-2"
+          ruby_version: "2.4.6"
+      - bundle_and_test:
+          name: "ruby2-6_rails5-1"
+          ruby_version: "2.6.3"
+          rails_version: "5.1.7"
+      - bundle_and_test:
+          name: "ruby2-5_rails5-1"
+          ruby_version: "2.5.5"
+          rails_version: "5.1.7"
+      - bundle_and_test:
+          name: "ruby2-4_rails5-1"
+          ruby_version: "2.4.6"
+          rails_version: "5.1.7"

data/.rubocop.yml

@@ -1,75 +1,13 @@
-require: rubocop-rspec
+inherit_gem:
+  bixby: bixby_default.yml
+
+inherit_from: .rubocop_todo.yml
+
 
 AllCops:
+  TargetRubyVersion: 2.4
   DisplayCopNames: true
-  Include:
-    - '**/Rakefile'
   Exclude:
-    - 'spec/**/*'
     - 'vendor/**/*'
-
-Rails:
-  Enabled: True
-
-Metrics/LineLength:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/MethodLength:
-  Exclude:
-    - 'lib/active_encode/engine_adapters/*'
-
-Metrics/ClassLength:
-  Exclude:
-    - 'lib/active_encode/engine_adapters/*'
-
-Metrics/CyclomaticComplexity:
-  Exclude:
-    - 'lib/active_encode/engine_adapters/*'
-
-Style/IndentationConsistency:
-  EnforcedStyle: rails
-
-Style/CollectionMethods:
-  PreferredMethods:
-    collect: 'map'
-    collect!: 'map!'
-    inject: 'reduce'
-    detect: 'find'
-    find_all: 'select'
-
-Style/FileName: # https://github.com/bbatsov/rubocop/issues/2973
-  Exclude:
-    - 'Gemfile'
-
-Style/WordArray:
-  Enabled: false
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: false
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-RSpec/ExampleWording:
-  CustomTransform:
-    be: is
-    have: has
-    not: does not
-    NOT: does NOT
-  IgnoredWords:
-    - only
-
-RSpec/FilePath:
-  Enabled: false
-
-RSpec/InstanceVariable:
-  Enabled: false
+  Include:
+    - '**/Rakefile'

data/.rubocop_todo.yml

@@ -0,0 +1,64 @@
+Bundler/DuplicatedGem:
+  Enabled: false
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/active_encode/engine_adapters/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/BlockNesting:
+  Exclude:
+    - 'lib/file_locator.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/active_encode/engine_adapters/*'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/active_encode/engine_adapters/ffmpeg_adapter.rb'
+    - 'lib/active_encode/engine_adapters/zencoder_adapter.rb'
+
+Metrics/LineLength:
+  Exclude:
+    - 'lib/active_encode/engine_adapters/matterhorn_adapter.rb'
+    - 'spec/**/*'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/active_encode/engine_adapters/*'
+    - 'lib/file_locator.rb'
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/active_encode/engine_adapters/ffmpeg_adapter.rb'
+    - 'lib/file_locator.rb'
+
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/integration/ffmpeg_adapter_spec.rb'
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/integration/ffmpeg_adapter_spec.rb'
+
+RSpec/MessageSpies:
+  Exclude:
+    - 'spec/integration/matterhorn_adapter_spec.rb'
+    - 'spec/integration/ffmpeg_adapter_spec.rb'
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+Style/GuardClause:
+  Exclude:
+    - 'lib/file_locator.rb'

data/Gemfile

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hydra-transcoder.gemspec
 gemspec
 
+gem 'addressable'
 gem 'aws-sdk'
 gem 'byebug'
-gem 'rubocop', require: false
-gem 'rubocop-rspec', require: false
 gem 'rubyhorn', git: "https://github.com/avalonmediasystem/rubyhorn.git"
 gem 'shingoncoder'
 gem 'zencoder'
@@ -37,9 +37,9 @@ else
 
   case ENV['RAILS_VERSION']
   when /^4.2/
+    gem 'coffee-rails', '~> 4.1.0'
     gem 'responders', '~> 2.0'
     gem 'sass-rails', '>= 5.0'
-    gem 'coffee-rails', '~> 4.1.0'
   when /^4.[01]/
     gem 'sass-rails', '< 5.0'
   end

data/active_encode.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -10,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Michael Klein, Chris Colvard, Phuong Dinh"]
   spec.email         = ["mbklein@gmail.com, chris.colvard@gmail.com, phuongdh@gmail.com"]
   spec.summary       = 'Declare encode job classes that can be run by a variety of encoding services'
-  spec.description   = 'This gem serves as the basis for the interface between a Ruby (Rails) application and a provider of transcoding services such as Opencast Matterhorn, Zencoder, and Amazon Elastic Transcoder.'
+  spec.description   = 'This gem provides an interface to transcoding services such as Ffmpeg, Amazon Elastic Transcoder, or Zencoder.'
   spec.homepage      = "https://github.com/samvera-labs/active_encode"
   spec.license       = "Apache-2.0"
 
@@ -22,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rails"
 
   spec.add_development_dependency "aws-sdk"
+  spec.add_development_dependency "bixby", '~> 1.0.0'
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "database_cleaner"
@@ -29,5 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency "rspec-rails"
 end

data/app/controllers/active_encode/encode_record_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveEncode
   class EncodeRecordController < ActionController::Base
     rescue_from ActiveRecord::RecordNotFound do |e|

data/app/jobs/active_encode/polling_job.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
 module ActiveEncode
   class PollingJob < ActiveJob::Base
-
     def perform(encode)
       encode.run_callbacks(:status_update) { encode }
       case encode.state

data/app/models/active_encode/encode_record.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveEncode
   class EncodeRecord < ActiveRecord::Base
     # sql id, globalid, state, adapter, input filename/job title, timestamps

data/db/migrate/20180822021048_create_active_encode_encode_records.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class CreateActiveEncodeEncodeRecords < ActiveRecord::Migration[5.0]
   def change
     create_table :active_encode_encode_records do |t|

data/db/migrate/20190702153755_add_create_options_to_active_encode_encode_records.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+class AddCreateOptionsToActiveEncodeEncodeRecords < ActiveRecord::Migration[5.0]
+  def change
+    add_column :active_encode_encode_records, :create_options, :text
+  end
+end

data/db/migrate/20190712174821_add_progress_to_active_encode_encode_records.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+class AddProgressToActiveEncodeEncodeRecords < ActiveRecord::Migration[5.1]
+  def change
+    add_column :active_encode_encode_records, :progress, :float
+  end
+end

data/lib/active_encode.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_encode/version'
 require 'active_encode/base'
 require 'active_encode/engine'

data/lib/active_encode/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_encode/core'
 require 'active_encode/engine_adapter'
 require 'active_encode/status'

data/lib/active_encode/callbacks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_model/callbacks'
 
 module ActiveEncode

data/lib/active_encode/core.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_support'
 require 'active_encode/callbacks'
 
@@ -44,19 +45,19 @@ module ActiveEncode
     end
 
     def initialize(input_url, options = nil)
-      @input = Input.new.tap{ |input| input.url = input_url }
+      @input = Input.new.tap { |input| input.url = input_url }
       @options = self.class.default_options(input_url).merge(Hash(options))
     end
 
     def create!
       run_callbacks :create do
-        merge!(self.class.engine_adapter.create(self.input.url, self.options))
+        merge!(self.class.engine_adapter.create(input.url, options))
       end
     end
 
     def cancel!
       run_callbacks :cancel do
-        merge!(self.class.engine_adapter.cancel(self.id))
+        merge!(self.class.engine_adapter.cancel(id))
       end
     end
 

data/lib/active_encode/engine.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails'
 
 module ActiveEncode

data/lib/active_encode/engine_adapter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_encode/engine_adapters'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/string/inflections'

data/lib/active_encode/engine_adapters.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module ActiveEncode
   # == Active Encode adapters
   #
@@ -14,7 +15,7 @@ module ActiveEncode
     autoload :TestAdapter
     autoload :FfmpegAdapter
 
-    ADAPTER = 'Adapter'.freeze
+    ADAPTER = 'Adapter'
     private_constant :ADAPTER
 
     class << self

data/lib/active_encode/engine_adapters/elastic_transcoder_adapter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'addressable/uri'
 require 'aws-sdk'
 require 'file_locator'
@@ -5,11 +6,10 @@ require 'file_locator'
 module ActiveEncode
   module EngineAdapters
     class ElasticTranscoderAdapter
-
       JOB_STATES = {
         "Submitted" => :running, "Progressing" => :running, "Canceled" => :cancelled,
         "Error" => :failed, "Complete" => :completed
-      }
+      }.freeze
 
       # Require options to include :pipeline_id, :masterfile_bucket and :outputs
       # Example :outputs value:
@@ -29,7 +29,7 @@ module ActiveEncode
         build_encode(job)
       end
 
-      def find(id, opts = {})
+      def find(id, _opts = {})
         build_encode(get_job_details(id))
       end
 
@@ -58,14 +58,14 @@ module ActiveEncode
           return nil if job.nil?
           encode = ActiveEncode::Base.new(convert_input(job), {})
           encode.id = job.id
-        	encode.state = JOB_STATES[job.status]
-        	encode.current_operations = []
-        	encode.percent_complete = convert_percent_complete(job)
-        	encode.created_at = convert_time(job.timing["submit_time_millis"])
-        	encode.updated_at = convert_time(job.timing["finish_time_millis"]) || convert_time(job.timing["start_time_millis"]) || encode.created_at
+          encode.state = JOB_STATES[job.status]
+          encode.current_operations = []
+          encode.percent_complete = convert_percent_complete(job)
+          encode.created_at = convert_time(job.timing["submit_time_millis"])
+          encode.updated_at = convert_time(job.timing["finish_time_millis"]) || convert_time(job.timing["start_time_millis"]) || encode.created_at
 
-        	encode.output = convert_output(job)
-        	encode.errors = job.outputs.select { |o| o.status == "Error" }.collect(&:status_detail).compact
+          encode.output = convert_output(job)
+          encode.errors = job.outputs.select { |o| o.status == "Error" }.collect(&:status_detail).compact
 
           tech_md = convert_tech_metadata(job.input.detected_properties)
           [:width, :height, :frame_rate, :duration, :file_size].each do |field|
@@ -82,7 +82,7 @@ module ActiveEncode
 
         def convert_time(time_millis)
           return nil if time_millis.nil?
-          Time.at(time_millis / 1000)
+          Time.at(time_millis / 1000).utc
         end
 
         def convert_bitrate(rate)
@@ -124,35 +124,35 @@ module ActiveEncode
           job.input
         end
 
-        def copy_to_input_bucket input_url, bucket
+        def copy_to_input_bucket(input_url, bucket)
           case Addressable::URI.parse(input_url).scheme
-          when nil,'file'
+          when nil, 'file'
             upload_to_s3 input_url, bucket
           when 's3'
             check_s3_bucket input_url, bucket
           end
         end
 
-        def check_s3_bucket input_url, source_bucket
+        def check_s3_bucket(input_url, source_bucket)
           # logger.info("Checking `#{input_url}'")
           s3_object = FileLocator::S3File.new(input_url).object
           if s3_object.bucket_name == source_bucket
             # logger.info("Already in bucket `#{source_bucket}'")
             s3_object.key
           else
-            s3_key = File.join(SecureRandom.uuid,s3_object.key)
+            s3_key = File.join(SecureRandom.uuid, s3_object.key)
             # logger.info("Copying to `#{source_bucket}/#{input_url}'")
             target = Aws::S3::Object.new(bucket_name: source_bucket, key: input_url)
-            target.copy_from(s3_object, multipart_copy: s3_object.size > 15728640) # 15.megabytes
+            target.copy_from(s3_object, multipart_copy: s3_object.size > 15_728_640) # 15.megabytes
             s3_key
           end
         end
 
-        def upload_to_s3 input_url, source_bucket
-          original_input = input_url
+        def upload_to_s3(input_url, source_bucket)
+          # original_input = input_url
           bucket = Aws::S3::Resource.new(client: s3client).bucket(source_bucket)
           filename = FileLocator.new(input_url).location
-          s3_key = File.join(SecureRandom.uuid,File.basename(filename))
+          s3_key = File.join(SecureRandom.uuid, File.basename(filename))
           # logger.info("Copying `#{original_input}' to `#{source_bucket}/#{input_url}'")
           obj = bucket.object(s3_key)
           obj.upload_file filename
@@ -169,12 +169,13 @@ module ActiveEncode
           job.outputs.collect do |joutput|
             preset = read_preset(joutput.preset_id)
             extension = preset.container == 'ts' ? '.m3u8' : ''
-            tech_md = convert_tech_metadata(joutput, preset).merge({
+            additional_metadata = {
               managed: false,
               id: joutput.id,
               label: joutput.key.split("/", 2).first,
               url: "s3://#{pipeline.output_bucket}/#{job.output_key_prefix}#{joutput.key}#{extension}"
-            })
+            }
+            tech_md = convert_tech_metadata(joutput, preset).merge(additional_metadata)
 
             output = ActiveEncode::Output.new
             output.state = convert_state(joutput)
@@ -194,7 +195,7 @@ module ActiveEncode
           job.outputs.select { |o| o.status == "Error" }.collect(&:status_detail).compact
         end
 
-        def convert_tech_metadata(props, preset=nil)
+        def convert_tech_metadata(props, preset = nil)
           return {} if props.nil? || props.empty?
           metadata_fields = {
             file_size: { key: :file_size, method: :itself },
@@ -216,13 +217,13 @@ module ActiveEncode
           unless preset.nil?
             audio = preset.audio
             video = preset.video
-            metadata.merge!({
+            metadata.merge!(
               audio_codec: audio&.codec,
               audio_channels: audio&.channels,
               audio_bitrate: convert_bitrate(audio&.bit_rate),
               video_codec: video&.codec,
               video_bitrate: convert_bitrate(video&.bit_rate)
-            })
+            )
           end
 
           metadata