active_encode 0.1.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4cc9a23af554f70fe254b6c08dd9422e0799c5e
-  data.tar.gz: 7c4ba992d65bd57c36767cbcd386b35a645a0b8c
+  metadata.gz: 3346c9f9ae44a17bf60b9f71dbf6a3bd8b951883
+  data.tar.gz: 8f228d1184a1f61629bbed814176d131bc98de40
 SHA512:
-  metadata.gz: 07f0ac6c7f1f0bd3a794ca21ae31ecacd311dbd2cba15b6e878706fe6c7a11b4c481fd538391d8564b28f4de37bc5d4ff91dd14125f64b642f2b4e166b721d9d
-  data.tar.gz: 5fd817093bab2eb625ac4098f256fb4597ac316b8d747fb003e64f7aeafc6faa2f79d74c50c5692bcb611339dc9d605b646286bd3c8bb6fbbe465d9124b850dd
+  metadata.gz: 47fde2ffc94ad11ef0b8ab3af29672f3c8707128d887d2dd48249f0e13346b66b5450434ab1d79f1b840bf2ac695c05f5cd6f1ef11ce697d16bbd63193a5ad8e
+  data.tar.gz: 74073edc357c19e84fb51c80044684dceae704dcb8bef6061a49b62b269c78aa60fb47563db691d00fe798e76bfd7af88467290a4c135438beff51efbc2989b7

data/.gitignore

@@ -15,3 +15,4 @@ mkmf.log
 coverage
 .ruby-version
 .byebug_history
+.internal_test_app

data/.travis.yml

@@ -2,8 +2,9 @@ language: ruby
 cache: bundler
 sudo: false
 rvm:
-  - 2.2.5
-  - 2.3.1
+  - 2.3.7
+  - 2.4.4
+  - 2.5.1
 env:
   global:
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/Gemfile

@@ -10,3 +10,38 @@ gem 'rubocop-rspec', require: false
 gem 'rubyhorn', git: "https://github.com/avalonmediasystem/rubyhorn.git"
 gem 'shingoncoder'
 gem 'zencoder'
+
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 2.0.1
+# engine_cart stanza: 0.10.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)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
+    Bundler.ui.warn e.message
+  end
+else
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
+  if ENV['RAILS_VERSION']
+    if ENV['RAILS_VERSION'] == 'edge'
+      gem 'rails', github: 'rails/rails'
+      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
+    else
+      gem 'rails', ENV['RAILS_VERSION']
+    end
+  end
+
+  case ENV['RAILS_VERSION']
+  when /^4.2/
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
+    gem 'coffee-rails', '~> 4.1.0'
+  when /^4.[01]/
+    gem 'sass-rails', '< 5.0'
+  end
+end
+# END ENGINE_CART BLOCK

data/README.md

@@ -1,6 +1,6 @@
 # ActiveEncode
 
-This gem serves as the basis for the interface between a Ruby (Rails) application and a provider of transcoding services such as [Opencast Matterhorn](http://opencast.org), [Zencoder](http://zencoder.com), [Shingoncoder](http://github.com/jcoyne/shingoncoder), and [Amazon Elastic Transcoder](http://aws.amazon.com/elastictranscoder/).
+This gem serves as the basis for the interface between a Ruby (Rails) application and a provider of transcoding services such as [Opencast Matterhorn](http://opencast.org), [Zencoder](http://zencoder.com), and [Amazon Elastic Transcoder](http://aws.amazon.com/elastictranscoder/).
 
 ## Installation
 
@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-Set the engine adapter (default: inline), configure it (if neccessary), then submit encoding jobs!
+Set the engine adapter (default: test), configure it (if neccessary), then submit encoding jobs!
 
 ```ruby
 ActiveEncode::Base.engine_adapter = :matterhorn
@@ -52,6 +52,8 @@ encode.cancel!
 encode.cancelled?  # true
 ```
 
+> `#purge!` and `#remove_output!` and the following documentation have been deprecated and will be removed in ActiveEncode 0.3.
+
 If the encoding job should be deleted, call purge:
 ```ruby
 encode.purge!
@@ -67,7 +69,7 @@ An encoding job is meant to be the record of the work of the encoding engine and
 
 ### Custom jobs
 
-Subclass ActiveEncode::Base to add custom callbacks or default options.  Available callbacks are before, after, and around the create, cancel, and purge actions.
+Subclass ActiveEncode::Base to add custom callbacks or default options.  Available callbacks are before, after, and around the create and cancel actions.
 
 ```ruby
 class CustomEncode < ActiveEncode::Base
@@ -83,17 +85,16 @@ end
 
 ### Engine Adapters
 
-Engine adapters are shims between ActiveEncode and the back end encoding service.  Each service has its own API and idiosyncracies so consult the table below to see what features are supported by each adapter.  Add an additional engines by creating an engine adapter class that implements :create, :find, :list, :cancel, :purge, and :remove_output.
-
-| Adapter/Feature          | Create | Find | List | Cancel | Purge | Remove Output | Preset | Multiple Outputs |
-|--------------------------|--------|------|------|--------|-------|---------------|--------|------------------|
-| Matterhorn               |    X   |  X   |      |   X    |   X   |       X       |   X    |         X        |
-| Zencoder                 |    X   |  X   |      |   X    |       |               |        |                  |
-| Shingoncoder (prototype) |    X   |  X   |      |        |       |               |        |                  |
-| Shingoncoder             |    X   |  X   |      |        |       |               |        |                  |
-| AWS Elastic Transcoder   |    X   |  X   |      |   X    |       |               |        |                  |
-| Inline                   |    X   |  X   |      |        |       |               |        |                  |
-| Test                     |    X   |  X   |      |   X    |       |       X       |        |                  |
+Engine adapters are shims between ActiveEncode and the back end encoding service.  Each service has its own API and idiosyncracies so consult the table below to see what features are supported by each adapter.  Add an additional engines by creating an engine adapter class that implements :create, :find, and :cancel.
+
+| Adapter/Feature          | Create | Find | Cancel | Preset | Multiple Outputs |
+|--------------------------|--------|------|--------|--------|------------------|
+| Test                     |    X   |  X   |   X    |        |                  |
+| AWS Elastic Transcoder   |    X   |  X   |   X    |        |                  |
+| Zencoder                 |    X   |  X   |   X    |        |                  |
+| Matterhorn               |    X   |  X   |   X    |   X    |         X        |
+
+> The Inline and Shingoncoder adapters are deprecated and will be removed in ActiveEncode 0.3.
 
 ## Contributing
 

data/Rakefile

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 require 'rake/clean'
 require 'bundler'
 require 'rubocop/rake_task'
+require 'engine_cart/rake_task'
 
 Bundler::GemHelper.install_tasks
 
 desc "CI build"
-task ci: ["active_encode:adapters:clean", "active_encode:ci"]
+task ci: ["active_encode:ci"]
 desc "Rspec"
 task spec: ["active_encode:ci"]
 
@@ -23,16 +26,8 @@ namespace 'active_encode' do
   end
 
   desc "CI build"
-  task ci: [:rubocop, "active_encode:environment", "active_encode:adapters:start", "active_encode:spec"]
+  task ci: [:rubocop, "active_encode:environment", "engine_cart:generate", "active_encode:spec"]
 
   require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new(:spec)
-
-  namespace 'adapters' do
-    desc "Clean any local services needed by the adapters"
-    task 'clean' => []
-
-    desc "Start any local services needed by the adapters"
-    task 'start' => []
-  end
 end

data/active_encode.gemspec

@@ -19,11 +19,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport"
+  spec.add_dependency "rails"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-its", "~> 1.2"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "engine_cart"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rspec-rails"
 end

data/app/jobs/active_encode/polling_job.rb

@@ -0,0 +1,20 @@
+module ActiveEncode
+  class PollingJob < ActiveJob::Base
+
+    def perform(encode)
+      encode.run_callbacks(:status_update) { encode }
+      case encode.state
+      when :error
+        encode.run_callbacks(:error) { encode }
+      when :cancelled
+        encode.run_callbacks(:cancelled) { encode }
+      when :complete
+        encode.run_callbacks(:complete) { encode }
+      when :running
+        ActiveEncode::PollingJob.set(wait: ActiveEncode::Polling::POLLING_WAIT_TIME).perform_later(encode)
+      else # other states are illegal and ignored
+        raise StandardError, "Illegal state #{encode.state} in encode #{encode.id}!"
+      end
+    end
+  end
+end

data/app/models/active_encode/encode_record.rb

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

data/db/migrate/20180822021048_create_active_encode_encode_records.rb

@@ -0,0 +1,13 @@
+class CreateActiveEncodeEncodeRecords < ActiveRecord::Migration[5.2]
+  def change
+    create_table :active_encode_encode_records do |t|
+      t.string :global_id
+      t.string :state
+      t.string :adapter
+      t.string :title
+      t.text :raw_object
+
+      t.timestamps
+    end
+  end
+end

data/lib/active_encode.rb

@@ -1,2 +1,3 @@
 require 'active_encode/version'
 require 'active_encode/base'
+require 'active_encode/engine'

data/lib/active_encode/base.rb

@@ -2,16 +2,20 @@ require 'active_encode/core'
 require 'active_encode/engine_adapter'
 require 'active_encode/status'
 require 'active_encode/technical_metadata'
+require 'active_encode/input'
+require 'active_encode/output'
 require 'active_encode/callbacks'
-# require 'active_encode/logging'
+require 'active_encode/global_id'
+require 'active_encode/persistence'
+require 'active_encode/polling'
 
 module ActiveEncode #:nodoc:
   class Base
     include Core
     include Status
-    include TechnicalMetadata
     include EngineAdapter
     include Callbacks
+    include GlobalID
   end
 
   class NotFound < RuntimeError; end

data/lib/active_encode/callbacks.rb

@@ -1,4 +1,4 @@
-require 'active_support/callbacks'
+require 'active_model/callbacks'
 
 module ActiveEncode
   # = Active Encode Callbacks
@@ -6,6 +6,8 @@ module ActiveEncode
   # Active Encode provides hooks during the life cycle of an encode. Callbacks allow you
   # to trigger logic during the life cycle of an encode. Available callbacks are:
   #
+  # * <tt>after_find</tt>
+  # * <tt>after_reload</tt>
   # * <tt>before_create</tt>
   # * <tt>around_create</tt>
   # * <tt>after_create</tt>
@@ -18,50 +20,31 @@ module ActiveEncode
   #
   module Callbacks
     extend ActiveSupport::Concern
-    include ActiveSupport::Callbacks
 
-    included do
-      define_callbacks :create
-      define_callbacks :cancel
-      define_callbacks :purge
-    end
-
-    # These methods will be included into any Active Encode object, adding
-    # callbacks for +create+, +cancel+, and +purge+ methods.
-    module ClassMethods
-      def before_create(*filters, &blk)
-        set_callback(:create, :before, *filters, &blk)
-      end
+    CALLBACKS = [
+      :after_find, :after_reload, :before_create, :around_create,
+      :after_create, :before_cancel, :around_cancel, :after_cancel,
+      :before_purge, :around_purge, :after_purge
+    ].freeze
 
-      def after_create(*filters, &blk)
-        set_callback(:create, :after, *filters, &blk)
-      end
-
-      def around_create(*filters, &blk)
-        set_callback(:create, :around, *filters, &blk)
-      end
-
-      def before_cancel(*filters, &blk)
-        set_callback(:cancel, :before, *filters, &blk)
-      end
-
-      def after_cancel(*filters, &blk)
-        set_callback(:cancel, :after, *filters, &blk)
-      end
+    included do
+      extend ActiveModel::Callbacks
 
-      def around_cancel(*filters, &blk)
-        set_callback(:cancel, :around, *filters, &blk)
-      end
+      define_model_callbacks :find, :reload, only: :after
+      define_model_callbacks :create, :cancel, :purge
 
-      def before_purge(*filters, &blk)
+      def self.before_purge(*filters, &blk)
+        ActiveSupport::Deprecation.warn("before_purge will be removed without replacement in ActiveEncode 0.3")
         set_callback(:purge, :before, *filters, &blk)
       end
 
-      def after_purge(*filters, &blk)
+      def self.after_purge(*filters, &blk)
+        ActiveSupport::Deprecation.warn("after_purge will be removed without replacement in ActiveEncode 0.3")
         set_callback(:purge, :after, *filters, &blk)
       end
 
-      def around_purge(*filters, &blk)
+      def self.around_purge(*filters, &blk)
+        ActiveSupport::Deprecation.warn("around_purge will be removed without replacement in ActiveEncode 0.3")
         set_callback(:purge, :around, *filters, &blk)
       end
     end

data/lib/active_encode/core.rb

@@ -10,71 +10,115 @@ module ActiveEncode
       attr_accessor :id
 
       # Encode input
+      # @return ActiveEncode::Input
       attr_accessor :input
 
       # Encode output(s)
+      # @return Array[ActiveEncode::Output]
       attr_accessor :output
 
       # Encode options
       attr_accessor :options
+
+      attr_accessor :current_operations
+      attr_accessor :percent_complete
+
+      # @deprecated
+      attr_accessor :tech_metadata
     end
 
     module ClassMethods
-      def default_options(_input)
+      def default_options(_input_url)
         {}
       end
 
-      def create(input, options = nil)
-        object = new(input, options)
+      def create(input_url, options = {})
+        object = new(input_url, options)
         object.create!
       end
 
       def find(id)
         raise ArgumentError, 'id cannot be nil' unless id
-        engine_adapter.find(id, cast: self)
+        encode = new(nil)
+        encode.run_callbacks :find do
+          encode.send(:merge!, engine_adapter.find(id))
+        end
       end
 
-      delegate :list, to: :engine_adapter
+      def list(*args)
+        ActiveSupport::Deprecation.warn("#list will be removed without replacement in ActiveEncode 0.3")
+        engine_adapter.list(args)
+      end
     end
 
-    def initialize(input, options = nil)
-      @input = input
-      @options = options || self.class.default_options(input)
+    def initialize(input_url, options = nil)
+      @input = Input.new.tap{ |input| input.url = input_url }
+      @options = options || self.class.default_options(input_url)
     end
 
     def create!
+      # TODO: Raise ArgumentError if self has an id?
       run_callbacks :create do
-        self.class.engine_adapter.create self
+        merge!(self.class.engine_adapter.create(self.input.url, self.options))
       end
     end
 
     def cancel!
       run_callbacks :cancel do
-        self.class.engine_adapter.cancel self
+        merge!(self.class.engine_adapter.cancel(self.id))
       end
     end
 
     def purge!
+      ActiveSupport::Deprecation.warn("#purge! will be removed without replacement in ActiveEncode 0.3")
       run_callbacks :purge do
         self.class.engine_adapter.purge self
       end
     end
 
     def remove_output!(output_id)
+      ActiveSupport::Deprecation.warn("#remove_output will be removed without replacement in ActiveEncode 0.3")
       self.class.engine_adapter.remove_output self, output_id
     end
 
     def reload
-      fresh_encode = self.class.engine_adapter.find(id, cast: self.class)
-      @id = fresh_encode.id
-      @input = fresh_encode.input
-      @output = fresh_encode.output
-      @state = fresh_encode.state
-      @current_operations = fresh_encode.current_operations
-      @errors = fresh_encode.errors
-      @tech_metadata = fresh_encode.tech_metadata
-
-      self
+      run_callbacks :reload do
+        merge!(self.class.engine_adapter.find(id))
+      end
+    end
+
+    def created?
+      !id.nil?
     end
+
+    # @deprecated
+    def tech_metadata
+      metadata = {}
+      [:width, :height, :frame_rate, :duration, :file_size,
+       :audio_codec, :video_codec, :audio_bitrate, :video_bitrate, :checksum].each do |key|
+        metadata[key] = input.send(key)
+      end
+    end
+
+    protected
+
+      def merge!(encode)
+        @id = encode.id
+        @input = encode.input
+        @output = encode.output
+        @options = encode.options
+        @state = encode.state
+        @errors = encode.errors
+        @created_at = encode.created_at
+        @updated_at = encode.updated_at
+        @current_operations = encode.current_operations
+        @percent_complete = encode.percent_complete
+
+        # deprecated
+        @tech_metadata = encode.tech_metadata
+        @finished_at = encode.finished_at
+
+        self
+      end
   end
 end