enigmamachine 0.3.4 → 0.4.0

data/README.rdoc

@@ -32,6 +32,7 @@ with good threading support it still sort of sucks. With Enigmamachine, all you
 need to do to trigger encoding of a video is shoot off an HTTP request, and
 everything else is handled for you.
 
+
 == Using it
 
 Once you've installed the gem (see below), you can do something like:
@@ -82,9 +83,12 @@ Programmatic requests in Ruby might look something like this:
         @auth = encode_credentials(u, p)
       end
 
-      def post(path_to_video, encoder_id)
+      def post(path_to_video, encoder_id, callback_url)
         self.class.post("/videos", {
-          :body => {:video => {:file => path_to_video}, :encoder_id => encoder_id},
+          :body => {:video => {
+            :file => path_to_video,
+            :callback_url => callback_url
+            }, :encoder_id => encoder_id},
           :basic_auth => @auth})
       end
 
@@ -101,12 +105,12 @@ Programmatic requests in Ruby might look something like this:
  #
  irb
  require 'enigma_client'
- EnigmaClient.new("admin", "admin").post("/path/to/your/uploaded/video.mp4", 1)
+ EnigmaClient.new("admin", "admin").post("/path/to/your/uploaded/video.mp4", 1, "http://example.org/call/back/id")
 
 
 A simpler, wget-based approach might look like this:
 
- wget http://admin:admin@localhost:2002/videos --post-data 'video[file]=/path/to/your/video.mp4&encoder_id=1'
+ wget http://admin:admin@localhost:2002/videos --post-data 'video[file]=/path/to/your/video.mp4&video[callback_url]=http://example.org/call/back/id&encoder_id=1'
 
 <b>Don't use wget like this on a shared host, it's insecure</b> (read the wget
 docs for more on this).  This wget example is just to show you what's going on
@@ -205,9 +209,9 @@ system).
 
 == Status
 
-This thing is still pre-release.
+This thing is still pre-release, but it is usable in a basic form now.
 
-I'm just working on getting the gem dependencies correct, so you may need to
+I'm still working on getting the gem dependencies correct, so you may need to
 manually install a few things to get it to work.  You'll also need a working
 copy of ffmpeg available on your path.
 

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.4.0

data/enigmamachine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{enigmamachine}
-  s.version = "0.3.4"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dave Hrycyszyn"]
-  s.date = %q{2010-07-12}
+  s.date = %q{2010-07-20}
   s.default_executable = %q{enigmamachine}
   s.description = %q{A RESTful video encoder which you can use as either a front-end to ffmpeg or headless on a server.}
   s.email = %q{dave@caprica}

data/lib/enigmamachine/models/encoder.rb

@@ -1,4 +1,6 @@
 require File.dirname(__FILE__) + '/video'
+require 'net/http'
+require 'uri'
 
 # An encoding profile which can be applied to a video.  It has a name and is
 # composed of a bunch of EncodingTasks.
@@ -45,6 +47,7 @@ class Encoder
       if task == encoding_tasks.last
         video.state = "complete"
         video.save
+        video.notify_complete
       else
         next_task_index = current_task_index + 1
         next_task = encoding_tasks[next_task_index]

data/lib/enigmamachine/models/video.rb

@@ -14,21 +14,42 @@ class Video
   property :created_at, DateTime
   property :updated_at, DateTime
   property :encoder_id, Integer, :required => true
+  property :callback_url, String
 
   belongs_to :encoder
 
+  # Notifies a calling application that processing has completed by sending
+  # a GET request to the video's callback_url.
+  #
+  def notify_complete
+    begin
+      Net::HTTP.get(URI.parse(video.callback_url)) unless callback_url.nil?
+    rescue
+    end
+  end
+
+
+  # Named scope for all videos which are waiting to start encoding.
+  #
   def self.unencoded
     all(:state => 'unencoded')
   end
 
+  # Named scope for all videos which are currently encoding.  Theoretically
+  # there should only ever be one.
+  #
   def self.encoding
     all(:state => 'encoding')
   end
 
+  # Named scope giving back all videos with encoding errors.
+  #
   def self.with_errors
     all(:state => 'error')
   end
 
+  # Named scope giving back all videos which have completed encoding.
+  #
   def self.complete
     all(:state => 'complete', :order => [:updated_at.desc])
   end

data/lib/enigmamachine/views/videos/form.erb

@@ -8,6 +8,13 @@
   <option value="<%= e.id %>"><%= e.name %></option>
 <% end %>
 </select>
+
+<p>
+  <strong>Callback url:</strong>
+  <br/>
+  <input name="video[callback_url]" id="video_callback_url" value="<%= @video.callback_url %>" size="50"></input>
+</p>
+
 <input type="submit" value="Save"/>
 <p>
   <a href="/videos">cancel</a>

data/test/support/blueprints.rb

@@ -10,6 +10,7 @@ Video.blueprint do
   encoder
   file { File.dirname(__FILE__) + "/afile.mpg" }
   state { "unencoded" }
+  callback_url { "http://example.org/call/back/id" }
   created_at DateTime.now
   updated_at DateTime.now
 end

data/test/test_video.rb

@@ -6,13 +6,27 @@ class TestVideo <  Test::Unit::TestCase
   context "A Video instance" do
 
     should "be invalid without a file path" do
-      resource = ::Video.make_unsaved
+      resource = ::Video.make
       resource.file = ""
       assert !resource.valid?
       resource.file = nil
       assert !resource.valid?
     end
 
+    should "be valid without a callback_url" do
+      resource = ::Video.make
+      resource.callback_url = ""
+      assert resource.valid?
+      resource.callback_url = nil
+      assert resource.valid?
+    end
+
+    should "be valid with a callback_url" do
+      resource = ::Video.make
+      resource.callback_url = "blah"
+      assert resource.valid?
+    end
+
     should "be valid with a file path" do
       resource = ::Video.make
       resource.file = "foo.mpg"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: enigmamachine
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
   - 4
-  version: 0.3.4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Dave Hrycyszyn
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-12 00:00:00 +01:00
+date: 2010-07-20 00:00:00 +01:00
 default_executable: enigmamachine
 dependencies: 
 - !ruby/object:Gem::Dependency