active_encode 0.5.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4a97d45ac966ff1988311fd6787fde4bc9b40850fb83ddd78aaa79ef495a885
-  data.tar.gz: f66be6fc89de6e14cb192cc55f6d467a211598804511f8aca981e3d441dd9493
+  metadata.gz: 5347f6f8d85a2181c8a2a8961edfaea95c4e29606ef02b13eaa44145e322bfb2
+  data.tar.gz: '05810638aea1f82ae53098c06099990e07ee1bc7c0c513d7088e90ab79b7f8b8'
 SHA512:
-  metadata.gz: 360d90909956f64d5e499e1260128a85ac498891cdc4eb448e9ce53f5e4cc02372bec4df79143129202963fab95d8e4fc6c79f83335346d82b2fa2a20bf4d4df
-  data.tar.gz: 76bf91cce817790e2b9775e83df44208812f024e353524cccbfc470525b083c2b172c6576af8f8711896b227e5fab438feb97c3da4b9849c1b378451ebfb62a8
+  metadata.gz: 7e4447428944fb5a156ed73d13f5b6a9480b237fc6021ddcbee3d7975bb7d390793a3796fe41cd6b2f2f55486d148aac157850168ea215e34fc5debbb536cd41
+  data.tar.gz: 63911ec850c0648e57d3b180b629464e26ee7ffe623f0f787cd2ee79b69ca1af5e06d0e7569a5e975a6d6540b325f44410d2830aadf1f309374bb779101990ef

data/.circleci/config.yml

@@ -0,0 +1,80 @@
+version: 2.1
+orbs:
+  samvera: samvera/circleci-orb@0.3.2
+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.2
+      ffmpeg_version:
+        type: string
+        default: 4.1.4
+    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 >>
+      FFMPEG_PATH: /tmp/ffmpeg
+    working_directory: ~/project
+    steps:
+      - run: 
+          command: |
+            sudo apt-get install libmms0
+            sudo wget -P /tmp/ https://mediaarea.net/download/binary/libzen0/0.4.37/libzen0v5_0.4.37-1_amd64.Debian_9.0.deb
+            sudo wget -P /tmp/ https://mediaarea.net/download/binary/libmediainfo0/19.04/libmediainfo0v5_19.04-1_amd64.Debian_9.0.deb
+            sudo wget -P /tmp/ https://mediaarea.net/download/binary/mediainfo/19.04/mediainfo_19.04-1_amd64.Debian_9.0.deb
+            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
+
+      - restore_cache:
+          keys:
+            - v1-ffmpeg-<< parameters.ffmpeg_version >>
+
+      - run: curl https://www.johnvansickle.com/ffmpeg/old-releases/ffmpeg-<< parameters.ffmpeg_version >>-amd64-static.tar.xz | tar xJ -C /tmp/ --strip-components=1
+
+      - save_cache:
+          key: v1-ffmpeg-<< parameters.ffmpeg_version >>`
+          paths:
+            - /tmp/ffmpeg
+
+      - samvera/cached_checkout
+
+      - samvera/bundle:
+          ruby_version: << parameters.ruby_version >>
+          bundler_version: << parameters.bundler_version >>
+
+      - 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:
+          ruby_version: << parameters.ruby_version >>
+          bundler_version: << parameters.bundler_version >>
+
+      - 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-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"

data/.rubocop.yml

@@ -1,75 +1,14 @@
-require: rubocop-rspec
+inherit_gem:
+  bixby: bixby_default.yml
+
+inherit_from: .rubocop_todo.yml
+
 
 AllCops:
+  TargetRubyVersion: 2.4
   DisplayCopNames: true
-  Include:
-    - '**/Rakefile'
   Exclude:
-    - 'spec/**/*'
+    - 'active_encode.gemspec'
     - '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,68 @@
+Bundler/DuplicatedGem:
+  Enabled: false
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/active_encode/engine_adapters/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'lib/active_encode/spec/shared_specs/*'
+    - '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'
+    - 'spec/integration/pass_through_adapter_spec.rb'
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/integration/ffmpeg_adapter_spec.rb'
+    - 'spec/integration/pass_through_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/active_encode/engine_adapters/pass_through_adapter.rb'
+    - 'lib/file_locator.rb'

data/Gemfile

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hydra-transcoder.gemspec
 gemspec
 
-gem 'aws-sdk'
+gem 'addressable'
+gem 'aws-sdk-elastictranscoder'
+gem 'aws-sdk-s3'
 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 +38,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/README.md

@@ -124,6 +124,75 @@ end
 
 Engine adapters are shims between ActiveEncode and the back end encoding service.  You can add an additional engine by creating an engine adapter class that implements `:create`, `:find`, and `:cancel` and passes the shared specs.
 
+For example:
+```ruby
+# In your application at:
+# lib/active_encode/engine_adapters/my_custom_adapter.rb
+module ActiveEncode
+  module EngineAdapters
+    class MyCustomAdapter
+      def create(input_url, options = {})
+        # Start a new encoding job. This may be an external service, or a
+        # locally queued job.
+
+        # Return an instance ActiveEncode::Base (or subclass) that represents
+        # the encoding job that was just started.        
+      end
+
+      def find(id, opts = {})
+        # Find the encoding job for the given parameters.
+
+        # Return an instance of ActiveEncode::Base (or subclass) that represents
+        # the found encoding job.
+      end
+
+      def cancel(id)
+        # Cancel the encoding job for the given id.
+
+        # Return an instance of ActiveEncode::Base (or subclass) that represents
+        # the canceled job.
+      end
+    end
+  end
+end
+```
+Then, use the shared specs...
+```ruby
+# In your application at...
+# spec/lib/active_encode/engine_adapters/my_custom_adapter_spec.rb
+require 'spec_helper'
+require 'active_encode/spec/shared_specs'
+RSpec.describe MyCustomAdapter do
+  let(:created_job) {
+    # an instance of ActiveEncode::Base represented a newly created encode job
+  }
+  let(:running_job) {
+    # an instance of ActiveEncode::Base represented a running encode job
+  }
+  let(:canceled_job) {
+    # an instance of ActiveEncode::Base represented a canceled encode job
+  }
+  let(:completed_job) {
+    # an instance of ActiveEncode::Base represented a completed encode job
+  }
+  let(:failed_job) {
+    # an instance of ActiveEncode::Base represented a failed encode job
+  }
+  let(:completed_tech_metadata) {
+    # a hash representing completed technical metadata
+  }
+  let(:completed_output) {
+    # data representing completed output
+  }
+  let(:failed_tech_metadata) {
+    # a hash representing failed technical metadata
+  }
+
+  # Run the shared specs.
+  it_behaves_like 'an ActiveEncode::EngineAdapter'
+end
+```
+
 # Acknowledgments
 
 This software has been developed by and is brought to you by the Samvera community.  Learn more at the

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"
 
@@ -21,13 +22,21 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rails"
 
-  spec.add_development_dependency "aws-sdk"
+  spec.add_development_dependency "aws-sdk-cloudwatchevents"
+  spec.add_development_dependency "aws-sdk-cloudwatchlogs"
+  spec.add_development_dependency "aws-sdk-elastictranscoder"
+  spec.add_development_dependency "aws-sdk-mediaconvert"
+  spec.add_development_dependency "aws-sdk-s3"
+  spec.add_development_dependency "bixby", '~> 1.0.0'
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "engine_cart", "~> 2.2"
   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"
+
+  # Pin sprockets to < 4 so it works with ruby 2.5+
+  spec.add_dependency 'sprockets', '< 4'
 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,5 +1,7 @@
+# frozen_string_literal: true
 require 'active_encode/core'
 require 'active_encode/engine_adapter'
+require 'active_encode/errors'
 require 'active_encode/status'
 require 'active_encode/technical_metadata'
 require 'active_encode/input'
@@ -17,6 +19,4 @@ module ActiveEncode #:nodoc:
     include Callbacks
     include GlobalID
   end
-
-  class NotFound < RuntimeError; end
 end