active_encode 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e36b69edd440383a39009cc2a331f6cda32974e62fde4961353e5abd80e2bc0b
-  data.tar.gz: ce26e5a14a08c96b708d6fea08ff127606f9da7023a674444037374cf9812ef9
+  metadata.gz: 0cc3915da436ad8220ab0a23f27280ad490dd31b1250f56957ca2667ecd6666d
+  data.tar.gz: 6a43e177fbe445be244a80ee44f503324d0e34f98fc4ac90e9b20f5110c120c4
 SHA512:
-  metadata.gz: d82bbc86cfc93cc33d699fb943c5b1caab27bc76b8149a599a61514f5257572aa3f0239ab617062f5b9ed4ef5b3874b9764f6786b0700fe2fa08625b917ead07
-  data.tar.gz: 53aabadb2c2337ac2cf8725ca0476b5afb9446aa8102aa156e93913d978317ceece57facf2bce0775fb8d5e3cf6e5a9ad47538c15006aed40d7bb94b98e301ce
+  metadata.gz: 7936993f21839c01bab5f3dd6cb7614bb837244c2ab9de2fa5953154d9f0a5c3460a485a2da1748f74c545b76d555c35c18decf697791002783d3607efaaed57
+  data.tar.gz: '069ba0aaec4e5e0a31661018a560cfb73d9d39092076c0f3c9fdcc7ee7afea9ad1a23b5114fca4bd1aadd16f85b7c1d0f59a8206ef89b20efc1ccf7a2bd6a93c'

data/.circleci/config.yml

@@ -1,15 +1,13 @@
 version: 2.1
 orbs:
-  samvera: samvera/circleci-orb@0.3.2
+  samvera: samvera/circleci-orb@1
 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
@@ -27,11 +25,12 @@ jobs:
     steps:
       - run: 
           command: |
+            sudo apt-get update
             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
+            sudo wget -P /tmp/ https://mediaarea.net/download/binary/libzen0/0.4.39/libzen0v5_0.4.39-1_amd64.Debian_11.deb
+            sudo wget -P /tmp/ https://mediaarea.net/download/binary/libmediainfo0/22.03/libmediainfo0v5_22.03-1_amd64.Debian_11.deb
+            sudo wget -P /tmp/ https://mediaarea.net/download/binary/mediainfo/22.03/mediainfo_22.03-1_amd64.Debian_11.deb
+            sudo dpkg -i /tmp/libzen0v5_0.4.39-1_amd64.Debian_11.deb /tmp/libmediainfo0v5_22.03-1_amd64.Debian_11.deb /tmp/mediainfo_22.03-1_amd64.Debian_11.deb
 
       - restore_cache:
           keys:
@@ -65,16 +64,26 @@ workflows:
   ci:
     jobs:
       - bundle_and_test:
-          name: "ruby2-6_rails5-2"
-          ruby_version: "2.6.3"
+          name: "ruby3-0_rails7-0"
+          ruby_version: "3.0.3"
+          rails_version: "7.0.1"
+      - bundle_and_test:
+          name: "ruby3-0_rails6-1"
+          ruby_version: "3.0.3"
+          rails_version: "6.1.4.4"
       - bundle_and_test:
-          name: "ruby2-5_rails5-2"
-          ruby_version: "2.5.5"
+          name: "ruby3-0_rails6-0"
+          ruby_version: "3.0.3"
+          rails_version: "6.0.4.4"
       - bundle_and_test:
-          name: "ruby2-6_rails5-1"
-          ruby_version: "2.6.3"
-          rails_version: "5.1.7"
+          name: "ruby2-7_rails6-0"
+          ruby_version: "2.7.5"
+          rails_version: "6.0.4.4"
       - bundle_and_test:
-          name: "ruby2-5_rails5-1"
-          ruby_version: "2.5.5"
-          rails_version: "5.1.7"
+          name: "ruby2-7_rails5-2"
+          ruby_version: "2.7.5"
+          rails_version: "5.2.6"
+      - bundle_and_test:
+          name: "ruby2-6_rails5-2"
+          ruby_version: "2.6.9"
+          rails_version: "5.2.6"

data/.rubocop.yml

@@ -5,10 +5,14 @@ inherit_from: .rubocop_todo.yml
 
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6
   DisplayCopNames: true
   Exclude:
     - 'active_encode.gemspec'
     - 'vendor/**/*'
-  Include:
-    - '**/Rakefile'
+
+Rails/RakeEnvironment:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false

data/.rubocop_todo.yml

@@ -18,12 +18,18 @@ Metrics/ClassLength:
   Exclude:
     - 'lib/active_encode/engine_adapters/*'
 
+Metrics/ModuleLength:
+  Exclude:
+    - 'lib/active_encode/engine_adapters/*'
+
 Metrics/CyclomaticComplexity:
   Exclude:
+    - 'lib/active_encode/engine_adapters/elastic_transcoder_adapter.rb'
     - 'lib/active_encode/engine_adapters/ffmpeg_adapter.rb'
     - 'lib/active_encode/engine_adapters/zencoder_adapter.rb'
+    - 'lib/active_encode/engine_adapters/media_convert_adapter.rb'
 
-Metrics/LineLength:
+Layout/LineLength:
   Exclude:
     - 'lib/active_encode/engine_adapters/matterhorn_adapter.rb'
     - 'spec/**/*'
@@ -36,6 +42,7 @@ Metrics/MethodLength:
 Metrics/PerceivedComplexity:
   Exclude:
     - 'lib/active_encode/engine_adapters/ffmpeg_adapter.rb'
+    - 'lib/active_encode/engine_adapters/media_convert_adapter.rb'
     - 'lib/file_locator.rb'
 
 RSpec/AnyInstance:

data/CONTRIBUTING.md

@@ -22,6 +22,28 @@ https://wiki.duraspace.org/display/samvera/Samvera+Community+Intellectual+Proper
 
 You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
 
+## Language
+
+The language we use matters.  Today, tomorrow, and for years to come
+people will read the code we write.  They will judge us for our
+design, logic, and the words we use to describe the system.
+
+Our words should be accessible.  Favor descriptive words that give
+meaning while avoiding reinforcing systemic inequities.  For example,
+in the Samvera community, we should favor using allowed\_list instead
+of whitelist, denied\_list instead of blacklist, or source/copy
+instead of master/slave.
+
+We're going to get it wrong, but this is a call to keep working to
+make it right.  View our code and the words we choose as a chance to
+have a conversation. A chance to grow an understanding of the systems
+we develop as well as the systems in which we live.
+
+See [“Blacklists” and “whitelists”: a salutary warning concerning the
+prevalence of racist language in discussions of predatory
+publishing](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6148600/) for
+further details.
+
 ## Contribution Tasks
 
 * Reporting Issues
@@ -45,15 +67,22 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
 
 * Fork the repository on GitHub
 * Create a topic branch from where you want to base your work.
-  * This is usually the master branch.
-  * To quickly create a topic branch based on master; `git branch fix/master/my_contribution master`
-  * Then checkout the new branch with `git checkout fix/master/my_contribution`.
-  * Please avoid working directly on the `master` branch.
+  * This is usually the `main` branch.
+  * To quickly create a topic branch based on `main`; `git branch fix/master/my_contribution main`
+  * Then checkout the new branch with `git checkout fix/main/my_contribution`.
+  * Please avoid working directly on the `main` branch.
+  * Please do not create a branch called `master`. (See note below.)
   * You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful
 * Make sure you have added sufficient tests and documentation for your changes.
   * Test functionality with RSpec; Test features / UI with Capybara.
 * Run _all_ the tests to assure nothing else was accidentally broken.
 
+NOTE: This repository follows the [Samvera Community Code of Conduct](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Code+of+Conduct) 
+and [language recommendations](#language).  
+Please ***do not*** create a branch called `master` for this repository or as part of 
+your pull request; the branch will either need to be removed or renamed before it can 
+be considered for inclusion in the code base and history of this repository.
+
 ### Documenting Code
 
 * All new public methods, modules, and classes should include inline documentation in [YARD](http://yardoc.org/).
@@ -109,15 +138,15 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
 ### Submitting Changes
 
 * Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
-* Make sure your branch is up to date with its parent branch (i.e. master)
-  * `git checkout master`
+* Make sure your branch is up to date with its parent branch (i.e. main)
+  * `git checkout main`
   * `git pull --rebase`
   * `git checkout <your-branch>`
-  * `git rebase master`
+  * `git rebase main`
   * It is a good idea to run your tests again.
 * If you've made more than one commit take a moment to consider whether squashing commits together would help improve their logical grouping.
   * [Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
-  * `git rebase --interactive master` ([See Github help](https://help.github.com/articles/interactive-rebase))
+  * `git rebase --interactive main` ([See Github help](https://help.github.com/articles/interactive-rebase))
   * Squashing your branch's changes into one commit is "good form" and helps the person merging your request to see everything that is going on.
 * Push your changes to a topic branch in your fork of the repository.
 * Submit a pull request from your fork to the project.
@@ -127,12 +156,13 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
 We adopted [Github's Pull Request Review](https://help.github.com/articles/about-pull-request-reviews/) for our repositories.
 Common checks that may occur in our repositories:
 
-1. Travis CI - where our automated tests are running
-2. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.
+1. [CircleCI](https://circleci.com/gh/samvera) - where our automated tests are running
+2. RuboCop/Bixby - where we check for style violations
+3. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.
 
 If one or more of the required checks failed (or are incomplete), the code should not be merged (and the UI will not allow it). If all of the checks have passed, then anyone on the project (including the pull request submitter) may merge the code.
 
-*Example: Carolyn submits a pull request, Justin reviews the pull request and approves. However, Justin is still waiting on other checks (Travis CI is usually the culprit), so he does not merge the pull request. Eventually, all of the checks pass. At this point, Carolyn or anyone else may merge the pull request.*
+*Example: Carolyn submits a pull request, Justin reviews the pull request and approves. However, Justin is still waiting on other checks (CI are usually the culprit), so he does not merge the pull request. Eventually, all of the checks pass. At this point, Carolyn or anyone else may merge the pull request.*
 
 #### Things to Consider When Reviewing
 
@@ -149,7 +179,7 @@ This is your chance for a mentoring moment of another developer. Take time to gi
   * Do new or changed methods, modules, and classes have documentation?
   * Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
   * Does the description of the new/changed specs match your understanding of what the spec is doing?
-  * Did the Travis tests complete successfully?
+  * Did the Continuous Integration tests complete successfully?
 
 If you are uncertain, bring other contributors into the conversation by assigning them as a reviewer.
 

data/Gemfile

@@ -4,7 +4,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in hydra-transcoder.gemspec
 gemspec
 
-gem 'addressable'
 gem 'aws-sdk-elastictranscoder'
 gem 'aws-sdk-s3'
 gem 'byebug'
@@ -13,8 +12,8 @@ gem 'shingoncoder'
 gem 'zencoder'
 
 # BEGIN ENGINE_CART BLOCK
-# engine_cart: 2.0.1
-# engine_cart stanza: 0.10.0
+# engine_cart: 2.4.0
+# engine_cart stanza: 2.5.0
 # the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
 file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', File.dirname(__FILE__)))
 if File.exist?(file)
@@ -34,15 +33,16 @@ else
     else
       gem 'rails', ENV['RAILS_VERSION']
     end
-  end
 
-  case ENV['RAILS_VERSION']
-  when /^4.2/
-    gem 'coffee-rails', '~> 4.1.0'
-    gem 'responders', '~> 2.0'
-    gem 'sass-rails', '>= 5.0'
-  when /^4.[01]/
-    gem 'sass-rails', '< 5.0'
+    case ENV['RAILS_VERSION']
+    when /^6.0/
+      gem 'sass-rails', '>= 6'
+      gem 'webpacker', '~> 4.0'
+    when /^5.[12]/
+      gem 'sass-rails', '~> 5.0'
+      gem 'sprockets', '~> 3.7'
+      gem 'thor', '~> 0.20'
+    end
   end
 end
 # END ENGINE_CART BLOCK

data/README.md

@@ -11,7 +11,7 @@ Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samv
 
 # What is ActiveEncode?
 
-ActiveEncode serves as the basis for the interface between a Ruby (Rails) application and a provider of encoding services such as [FFmpeg](https://www.ffmpeg.org/), [Amazon Elastic Transcoder](http://aws.amazon.com/elastictranscoder/), and [Zencoder](http://zencoder.com).
+ActiveEncode serves as the basis for the interface between a Ruby (Rails) application and a provider of encoding services such as [FFmpeg](https://www.ffmpeg.org/), [Amazon Elastic Transcoder](http://aws.amazon.com/elastictranscoder/), [AWS Elemental MediaConvert](https://aws.amazon.com/mediaconvert/), and [Zencoder](http://zencoder.com).
 
 # Help
 
@@ -39,31 +39,54 @@ FFmpeg (tested with version 4+) and mediainfo (version 17.10+) need to be instal
 
 ## Usage
 
-Set the engine adapter (default: test), configure it (if neccessary), then submit encoding jobs!
+Set the engine adapter (default: test), configure it (if neccessary), then submit encoding jobs. The outputs option specifies the output(s) to create in an adapter-specific way, see individual adapter documentation.
 
 ```ruby
 ActiveEncode::Base.engine_adapter = :ffmpeg
 file = "file://#{File.absolute_path "spec/fixtures/fireworks.mp4"}"
 ActiveEncode::Base.create(file, { outputs: [{ label: "low", ffmpeg_opt: "-s 640x480", extension: "mp4"}, { label: "high", ffmpeg_opt: "-s 1280x720", extension: "mp4"}] })
 ```
-Create returns an encoding job that has been submitted to the adapter for processing.  At this point it will have an id, a state, the input, and any additional information the adapter returns.
 
-```ruby
-#<ActiveEncode::Base:0x007f8ef3b2ae88 @input=#<ActiveEncode::Input:0x007f8ef3b23188 @url="file:///Users/cjcolvar/Documents/Code/samvera-labs/active_encode/spec/fixtures/fireworks.mp4", @width=960.0, @height=540.0, @frame_rate=29.671, @duration=6024, @file_size=1629578, @audio_codec="mp4a-40-2", @video_codec="avc1", @audio_bitrate=69737, @video_bitrate=2092780, @created_at=2018-12-03 14:22:05 -0500, @updated_at=2018-12-03 14:22:05 -0500, @id=7653>, @options={:outputs=>[{:label=>"low", :ffmpeg_opt=>"-s 640x480", :extension=>"mp4"}, {:label=>"high", :ffmpeg_opt=>"-s 1280x720", :extension=>"mp4"}]}, @id="1e4a907a-ccff-494f-ad70-b1c5072c2465", @created_at=2018-12-03 14:22:05 -0500, @updated_at=2018-12-03 14:22:05 -0500, @current_operations=[], @output=[], @state=:running, @percent_complete=1, @errors=[]>
-```
+Create returns an encoding job (which we sometimes call "an encode object") that has been submitted to the adapter for processing.  At this point it will have an id, a state, the input url, and possibly additional adapter-specific metadata.
+
 ```ruby
 encode.id  # "1e4a907a-ccff-494f-ad70-b1c5072c2465"
 encode.state  # :running
+encode.input.url
 ```
 
-This encode can be looked back up later using #find.  Alternatively, use #reload to refresh an instance with the latest information from the adapter:
+At this point the encode is not complete. You can check on status by looking up the encode by id, or by calling #reload on an existing encode object to refresh it:
 
 ```ruby
 encode = ActiveEncode::Base.find("1e4a907a-ccff-494f-ad70-b1c5072c2465")
+# or
 encode.reload
+
+encode.percent_complete
+encode.status # running, cancelled, failed, completed
+encode.errors # array of errors in case of status `failed`
+```
+
+Progress of a running encode is shown with current operations (multiple are possible when outputs are generated in parallel) and percent complete.
+
+Technical metadata about the input file may be added by some adapters, and may be available before completion.  This should include a mime type, checksum, duration, and basic technical details of the audio and video content of the file (codec, audio channels, bitrate, frame rate, and dimensions).
+
+```ruby
+encode.input.url
+encode.input.height
+encode.input.width
+encode.input.checksum
+# etc
 ```
 
-Progress of a running encode is shown with current operations (multiple are possible when outputs are generated in parallel) and percent complete.  Technical metadata about the input file may be added by the adapter.  This should include a mime type, checksum, duration, and basic technical details of the audio and video content of the file (codec, audio channels, bitrate, frame rate, and dimensions).  Outputs are added once they are created and should include the same technical metadata along with an id, label, and url.
+Outputs are added once they are created and should include the same technical metadata along with an id, label, and url.
+
+```ruby
+output = encode.outputs.first
+output.url
+output.id
+output.width
+```
 
 If you want to stop the encoding job call cancel:
 
@@ -72,7 +95,7 @@ encode.cancel!
 encode.cancelled?  # true
 ```
 
-An encoding job is meant to be the record of the work of the encoding engine and not the current state of the outputs.  Therefore moved or deleted outputs will not be reflected in the encoding job.
+An encode object is meant to be the record of the work of the encoding engine and not the current state of the outputs.  Therefore moved or deleted outputs will not be reflected in the encode object.
 
 ### AWS ElasticTranscoder
 
@@ -104,6 +127,37 @@ file = 'file:///path/to/file/fireworks.mp4' # or 's3://my-bucket/fireworks.mp4'
 encode = ActiveEncode::Base.create(file, options)
 ```
 
+### AWS Elemental MediaCovert
+
+[MediaConvert](https://aws.amazon.com/mediaconvert/) is a newer AWS service than Elastic Transcoder. The MediaConvert adapter works using [output presets]((https://docs.aws.amazon.com/mediaconvert/latest/ug/creating-preset-from-scratch.html)) defined in the MediaConvert service for your account. Some additional dependencies will need to be added to your project, see [Guide](./guides/media_convert_adapter.md).
+
+```ruby
+ActiveEncode::Base.engine_adapter = :media_convert
+ActiveEncode::Base.engine_adapter.role = 'arn:aws:iam::111111111111:role/name-of-role'
+ActiveEncode::Base.engine_adapter.output_bucket = 'name-of-bucket'
+
+# will create CloudWatch/EventBridge resources necessary to capture outputs,
+# only needs to be called once although is safe to call redundantly.
+ActiveEncode::Base.engine_adapter.setup!
+
+encode = ActiveEncode::Base.create(
+  "file://path/to/file.mp4",
+  {
+    masterfile_bucket: "name-of-my-masterfile_bucket"
+    output_prefix: "path/to/output/base_name_of_outputs",
+    use_original_url: true,
+    outputs: [
+      { preset: "my-hls-preset-high", modifier: "_high" },
+      { preset: "my-hls-preset-medium", modifier: "_medium" },
+      { preset: "my-hls-preset-low", modifier: "_low" },
+    ]
+  }
+)
+```
+
+See more details and guidance in our [longer guide](./guides/media_convert_adapter.md), or in comment docs in [adapter class](./lib/active_encode/engine_adapters/media_convert_adapter.rb).
+
+
 ### Custom jobs
 
 Subclass ActiveEncode::Base to add custom callbacks or default options.  Available callbacks are before, after, and around the create and cancel actions.
@@ -136,7 +190,7 @@ module ActiveEncode
         # locally queued job.
 
         # Return an instance ActiveEncode::Base (or subclass) that represents
-        # the encoding job that was just started.        
+        # the encoding job that was just started.
       end
 
       def find(id, opts = {})

data/active_encode.gemspec

@@ -21,13 +21,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails"
+  spec.add_dependency "addressable", "~> 2.8"
 
   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 "bixby", '~> 5.0', '>= 5.0.2'
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "database_cleaner"
@@ -36,7 +37,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   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,6 +1,6 @@
 # frozen_string_literal: true
 module ActiveEncode
-  class EncodeRecordController < ActionController::Base
+  class EncodeRecordController < ApplicationController
     rescue_from ActiveRecord::RecordNotFound do |e|
       render json: { message: e.message }, status: :not_found
     end

data/app/jobs/active_encode/polling_job.rb

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

data/app/models/active_encode/encode_record.rb

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