vidibus-recording 1.0.0 → 2.0.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Andre Pankratz
+Copyright (c) 2011-2013 Andre Pankratz
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,102 @@
+# Vidibus::Recording
+
+Allows recording of RTMP video streams. Uses RTMPdump. Requires at least Ruby 1.9.
+
+This gem is part of [Vidibus](http://vidibus.org), an open source toolset for building distributed (video) applications.
+
+
+## Installation
+
+Add `gem 'vidibus-recording'` to the Gemfile of your application. Then call `bundle install` on your console.
+
+
+## Usage
+
+### Available methods
+
+To control a recording, you may use these methods:
+
+```ruby
+recording.start   # starts recording
+recording.stop    # stops recording
+recording.resume  # continues if recording has been started but is not running
+recording.restart # erases recorded data and restarts recording
+```
+
+
+### Custom class names
+
+This gem will set up a model `Recording` if Rails is around. If you want to use the recording logic inside of a custom model, you just have to include the module `Vidibus::Recording::Mongoid`:
+
+```ruby
+class MyCustomRecording
+  include Mongoid::Document
+  include Vidibus::Recording::Mongoid
+end
+```
+
+
+### Monitoring
+
+If the worker process does not receive data, it will halt the recording. To monitor and restart a recording perform `Vidibus::Recording.monitor`. Beware, this method is blocking, so better spawn the daemon.
+
+
+#### Monitoring daemon
+
+To run the monitor as daemon, this gem provides a shell script. Install it with
+
+```
+rails g vidibus:recording
+```
+
+The daemon requires that `gem 'daemons'` is installed. To spawn him, enter
+
+```
+script/recording start
+```
+
+#### Possible caveat
+
+To monitor your custom recording classes, `Vidibus::Recording.monitor` requires that all classes that include `Vidibus::Recording::Mongoid` have been loaded.
+
+Because Rails is autoloading almost everything in development, this requirement is not met without the help of a little hack: To trigger autoloading, the monitor collects all aforementioned class names from the `app` directory and constantizes them.
+
+**So here's the caveat:** If you define custom recording models outside of the `app` directory, you'll have to let the listener know. An initializer is perfect for that:
+
+```ruby
+# Collect all recording models in lib, too
+Vidibus::Recording.autoload_paths << '/lib/**/*.rb'
+```
+
+
+## Deployment
+
+A Capistrano configuration is included. Require it in your Capistrano `config.rb`.
+
+```ruby
+require 'vidibus/recording/capistrano'
+```
+
+That will add a bunch of callback hooks.
+
+```ruby
+after 'deploy:stop',    'vidibus:recording:stop'
+after 'deploy:start',   'vidibus:recording:start'
+after 'deploy:restart', 'vidibus:recording:restart'
+```
+
+If you need more control over the callbacks, you may load just the recipes without the hooks.
+
+```ruby
+require 'vidibus/recording/capistrano/recipes'
+```
+
+
+## Testing
+
+To test this gem, call `bundle install` and `bundle exec rspec spec` on your console.
+
+
+## Copyright
+
+&copy; 2011-2013 André Pankratz. See LICENSE for details.

data/lib/generators/vidibus/recording_generator.rb

@@ -2,7 +2,7 @@ require 'rails/generators'
 require 'rails/generators/named_base'
 
 module Vidibus
-  class RecorderGenerator < Rails::Generators::Base
+  class RecordingGenerator < Rails::Generators::Base
 
     self.source_paths << File.join(File.dirname(__FILE__), 'templates')
 

data/lib/generators/vidibus/templates/script

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 
 require File.expand_path('../../config/environment', __FILE__)
-require 'vidibus/recorder/daemon'
+require 'vidibus/recording/daemon'
 
-Vidibus::WatchFolder::Daemon.new(ARGV).daemonize
+Vidibus::Recording.monitoring_interval = 1 # second
+Vidibus::Recording.autoload_paths << Rails.root.join('app/**/*.rb')
+Vidibus::Recording::Daemon.new(ARGV).daemonize

data/lib/vidibus/recording/backend/rtmpdump.rb

@@ -79,7 +79,7 @@ module Vidibus::Recording::Backend
       end
     end
 
-    # Extract metadata from stdout or stderr.
+    # Detect error from stdout or stderr.
     # Output delivered by rtmpdump looks like this:
     #
     # RTMPDump v2.4
@@ -88,9 +88,12 @@ module Vidibus::Recording::Backend
     # ERROR: Problem accessing the DNS. (addr: whatever.domain)
     #
     def detect_error(string)
-      prefix = /(?:ERROR\:\ (.+))/ if string.match(/ERROR\:/)
-      if string.match(/(?:ERROR\:\ (.+))/)
-        raise RuntimeError.new($1)
+      if error = string[/(?:ERROR\:\ (.+))/,1]
+        case error
+          when 'rtmp server sent error'
+        else
+          raise RuntimeError.new($1)
+        end
       end
     end
   end

data/lib/vidibus/recording/capistrano/recipes.rb

@@ -1,4 +1,4 @@
-# Capistrano Recipes for watching folders.
+# Capistrano Recipes for monitoring recordings.
 #
 # Load this file from your Capistrano config.rb:
 # require 'vidibus/recording/capistrano/recipes'

data/lib/vidibus/recording/capistrano.rb

@@ -1,12 +1,12 @@
 require 'vidibus/recording/capistrano/recipes'
 
-# Run Capistrano Recipes for watching folders.
+# Run Capistrano Recipes for monitoring recordings.
 #
 # Load this file from your Capistrano config.rb:
-# require 'vidibus/watch_folder/capistrano'
+# require 'vidibus/recording/capistrano'
 #
 Capistrano::Configuration.instance.load do
-  after 'deploy:stop',    'vidibus:watch_folder:stop'
-  after 'deploy:start',   'vidibus:watch_folder:start'
-  after 'deploy:restart', 'vidibus:watch_folder:restart'
+  after 'deploy:stop',    'vidibus:recording:stop'
+  after 'deploy:start',   'vidibus:recording:start'
+  after 'deploy:restart', 'vidibus:recording:restart'
 end

data/lib/vidibus/recording/daemon.rb

@@ -6,7 +6,7 @@ end
 require 'optparse'
 
 module Vidibus
-  module Recorder
+  module Recording
     class Daemon
 
       def initialize(args)
@@ -34,10 +34,10 @@ module Vidibus
       def run
         Dir.chdir(Rails.root)
         log = File.join(Rails.root, 'log', 'recording.log')
-        Vidibus::Recorder.logger = ActiveSupport::BufferedLogger.new(log)
-        Vidibus::Recorder.monitor
+        Vidibus::Recording.logger = ActiveSupport::BufferedLogger.new(log)
+        Vidibus::Recording.monitor
       rescue => e
-        Vidibus::Recorder.logger.fatal(e)
+        Vidibus::Recording.logger.fatal(e)
         STDERR.puts(e.message)
         exit 1
       end

data/lib/vidibus/recording/mongoid.rb

@@ -1,3 +1,8 @@
+require 'mongoid'
+require 'vidibus-uuid'
+require 'active_support/core_ext'
+require 'delayed_job_mongoid'
+
 module Vidibus::Recording
   module Mongoid
     extend ActiveSupport::Concern
@@ -10,7 +15,6 @@ module Vidibus::Recording
 
       field :name
       field :stream
-      # field :live, :type => Boolean
       field :pid, :type => Integer
       field :info, :type => Hash
       field :size, :type => Integer
@@ -20,13 +24,17 @@ module Vidibus::Recording
       field :started_at, :type => DateTime
       field :stopped_at, :type => DateTime
       field :failed_at, :type => DateTime
+      field :active, :type => Boolean, :default => false
       field :running, :type => Boolean, :default => false
-      field :monitoring_job_identifier, :type => String
+
+      index :active
 
       validates :name, :presence => true
       validates :stream, :format => {:with => /^rtmp.*?:\/\/.+$/}
 
       before_destroy :cleanup
+
+      scope :active, where(active: true)
     end
 
     # Starts a recording worker now, unless it has been done already.
@@ -35,8 +43,8 @@ module Vidibus::Recording
       return false if done? || started?
       if time == :now
         self.started_at = Time.now
+        self.active = true
         start_worker
-        start_monitoring_job
         save!
       else
         schedule(time)
@@ -48,8 +56,8 @@ module Vidibus::Recording
       return false if running? || !started?
       self.stopped_at = nil
       self.failed_at = nil
+      self.active = true
       start_worker
-      start_monitoring_job
       save!
     end
 
@@ -67,7 +75,7 @@ module Vidibus::Recording
       self.pid = nil
       self.stopped_at = Time.now
       self.running = false
-      self.monitoring_job_identifier = nil
+      self.active = false
       postprocess
     end
 
@@ -89,6 +97,7 @@ module Vidibus::Recording
       self.error = msg
       self.failed_at = Time.now
       self.running = false
+      self.active = false
       postprocess
     end
 
@@ -104,8 +113,7 @@ module Vidibus::Recording
         :info,
         :error,
         :size,
-        :duration,
-        :monitoring_job_identifier
+        :duration
       ].map {|a| blank[a] = nil }
       update_attributes!(blank)
       destroy_all_parts
@@ -222,16 +230,6 @@ module Vidibus::Recording
       self.pid = worker.pid
     end
 
-    # Start a new monitoring job
-    def start_monitoring_job
-      self.monitoring_job_identifier = Vidibus::Uuid.generate
-      Vidibus::Recording::MonitoringJob.create({
-        :class_name => self.class.to_s,
-        :uuid => uuid,
-        :identifier => monitoring_job_identifier
-      })
-    end
-
     def setup_next_part
       number = nil
       if current_part

data/lib/vidibus/recording/part.rb

@@ -1,3 +1,7 @@
+require 'yaml'
+require 'mongoid'
+require 'vidibus-uuid'
+
 module Vidibus::Recording
   class Part
     include Mongoid::Document

data/lib/vidibus/recording/railtie.rb

@@ -1 +1,9 @@
-railtie.rb
+require 'rails'
+
+module Vidibus
+  module Recording
+    if defined?(Rails)
+      class Engine < ::Rails::Engine; end
+    end
+  end
+end

data/lib/vidibus/recording/version.rb

@@ -1,5 +1,5 @@
 module Vidibus
   module Recording
-    VERSION = '1.0.0'
+    VERSION = '2.0.0'
   end
 end

data/lib/vidibus/recording/worker.rb

@@ -1,11 +1,12 @@
+require 'open3'
 require 'timeout'
 
 module Vidibus::Recording
   class Worker
     class ProcessError < StandardError; end
 
-    # START_TIMEOUT = 20
-    STOP_TIMEOUT = 10
+    START_TIMEOUT = 20
+    STOP_TIMEOUT = 2
 
     attr_accessor :recording, :pid, :metadata
 
@@ -33,8 +34,7 @@ module Vidibus::Recording
           Timeout::timeout(STOP_TIMEOUT) do
             begin
               log("Stopping process #{pid}...")
-              # Use SIGQUIT to terminate because DelayedJob traps INT and TERM
-              Process.kill('SIGQUIT', pid)
+              Process.kill('SIGTERM', pid)
               Process.wait(pid)
               log('STOPPED')
             rescue Errno::ECHILD
@@ -73,8 +73,8 @@ module Vidibus::Recording
     def record
       cmd = recording.backend.command
       log("START: #{recording.stream}", true)
+      timeout = Time.now + START_TIMEOUT
       Open3::popen3(cmd) do |stdin, stdout, stderr|
-        maxloops = 10
         loop do
           begin
             string = stdout.read_nonblock(1024).force_encoding('UTF-8')
@@ -90,12 +90,11 @@ module Vidibus::Recording
             fail(e.message) && break
           end
           unless metadata
-            maxloops -= 1
-            if maxloops == 0
-              halt('No Metadata has been received so far.') && break
+            if Time.now > timeout
+              halt('No Metadata has been received so far, exiting.') && break
             end
           end
-          sleep 2
+          sleep(2)
         end
       end
     end

data/lib/vidibus/recording.rb

@@ -1,6 +1,65 @@
 require 'vidibus/recording/worker'
-require 'vidibus/recording/monitoring_job'
 require 'vidibus/recording/backend'
 require 'vidibus/recording/helpers'
 require 'vidibus/recording/part'
 require 'vidibus/recording/mongoid'
+require 'vidibus/recording/railtie' if defined?(Rails::Railtie)
+
+module Vidibus
+  module Recording
+    extend self
+
+    class Error < StandardError; end
+
+    INTERVAL = 1
+
+    attr_accessor :logger, :autoload_paths, :classes, :monitoring_interval
+    @logger = Logger.new(STDOUT)
+    @autoload_paths = []
+    @classes = []
+    @monitoring_interval = 1
+
+    # Monitor all started recordings
+    def monitor
+      autoload
+      unless classes.any?
+        logger.error("[#{Time.now.utc}] - No recording classes given")
+      else
+        logger.info("[#{Time.now.utc}] - Watching recordings")
+        run
+      end
+    end
+
+    # Obtain all classes that include the Mongoid module
+    def autoload
+      return [] unless autoload_paths.any?
+      regexp = /class ([^<\n]+).+include Vidibus::Recording::Mongoid/m
+      names = Dir[*autoload_paths].map do |f|
+        File.read(f)[regexp, 1]
+      end.compact
+      self.classes = names.map { |k| k.constantize }
+    end
+
+    private
+
+    def run
+      loop do
+        classes.each do |klass|
+          klass.active.each do |recording|
+            begin
+              if recording.worker_running?
+                recording.track_progress
+              else
+                logger.info("[#{Time.now.utc}] - Resuming #{recording.class.name} #{recording.uuid}")
+                recording.resume
+              end
+            rescue => e
+              logger.error("[#{Time.now.utc}] - ERROR:\n#{e.inspect}\n---\n#{e.backtrace.join("\n")}")
+            end
+          end
+        end
+        sleep(monitoring_interval)
+      end
+    end
+  end
+end

data/lib/vidibus-recording.rb

@@ -1,15 +1 @@
-require 'open3'
-require 'yaml'
-require 'delayed_job_mongoid'
-require 'active_support/core_ext'
-require 'vidibus-uuid'
-
-module Vidibus
-  module Recording
-    if defined?(Rails)
-      class Engine < ::Rails::Engine; end
-    end
-  end
-end
-
 require 'vidibus/recording'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vidibus-recording
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-30 00:00:00.000000000 Z
+date: 2013-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: delayed_job_mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +179,6 @@ extra_rdoc_files: []
 files:
 - lib/generators/vidibus/recording_generator.rb
 - lib/generators/vidibus/templates/script
-- lib/vidibus/recording/backend/railtie.rb
 - lib/vidibus/recording/backend/rtmpdump.rb
 - lib/vidibus/recording/backend.rb
 - lib/vidibus/recording/capistrano/recipes.rb
@@ -187,7 +186,6 @@ files:
 - lib/vidibus/recording/daemon.rb
 - lib/vidibus/recording/helpers.rb
 - lib/vidibus/recording/mongoid.rb
-- lib/vidibus/recording/monitoring_job.rb
 - lib/vidibus/recording/part.rb
 - lib/vidibus/recording/railtie.rb
 - lib/vidibus/recording/version.rb
@@ -196,7 +194,7 @@ files:
 - lib/vidibus-recording.rb
 - app/models/recording.rb
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 homepage: https://github.com/vidibus/vidibus-recording
 licenses: []
@@ -212,7 +210,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 766807753862642645
+      hash: 507116490268825761
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/README.rdoc

@@ -1,11 +0,0 @@
-= Vidibus::Recording
-
-Allows recording of RTMP video streams. Uses RTMPdump.
-Further description goes here.
-
-Requires Ruby 1.9
-
-
-== Copyright
-
-Copyright (c) 2013 Andre Pankratz. See LICENSE for details.

data/lib/vidibus/recording/backend/railtie.rb

@@ -1 +0,0 @@
-railtie.rb

data/lib/vidibus/recording/monitoring_job.rb

@@ -1,52 +0,0 @@
-module Vidibus::Recording
-  class MonitoringJob
-    INTERVAL = 10.seconds
-
-    def initialize(args)
-      unless @uuid = args[:uuid]
-        raise(ArgumentError, 'No recording UUID given')
-      end
-      unless @class_name = args[:class_name]
-        raise(ArgumentError, 'Must provide class name of recording')
-      end
-      unless @identifier = args[:identifier]
-        raise(ArgumentError, 'Must provide identifier of monitoring job')
-      end
-      ensure_recording
-    end
-
-    def perform
-      r = recording.reload
-      return unless r.monitoring_job_identifier == @identifier
-      if r.worker_running?
-        r.track_progress
-        run_again
-      elsif !r.stopped?
-        r.resume
-      end
-    end
-
-    # Returns job
-    def self.create(args)
-      job = new(args)
-      Delayed::Job.enqueue(job)
-    end
-
-    private
-
-    def recording
-      @class_name.constantize.where(:uuid => @uuid).first
-    end
-
-    def ensure_recording
-      recording || raise(ArgumentError, 'No valid recording UUID given')
-    end
-
-    def run_again
-      obj = self.class.new({
-        :uuid => @uuid, :class_name => @class_name, :identifier => @identifier
-      })
-      Delayed::Job.enqueue(obj, 0, INTERVAL.from_now)
-    end
-  end
-end