enigmamachine 0.1.4 → 0.2.0

data/README.rdoc

@@ -35,9 +35,9 @@ everything else is handled for you.
 
 Once you've installed the gem (see below), you can do something like:
 
-mkdir enigma
-cd enigma
-enigmamachine start  # -d to daemonize
+ mkdir enigma
+ cd enigma
+ enigmamachine start  # -d to daemonize
 
 Then check it out in your browser, at http://localhost:2002.
 
@@ -56,9 +56,55 @@ Videos are encoded sequentially as they arrive.
 
 == Encoders and Encoding Tasks
 
+When you POST the location of a video to your enigmamachine, you need to tell
+your EM what you want to do to the video.  For example, you might want to take
+an uploaded video and encode it as a 320x240 FLV video, with a 320x240 JPEG
+thumbnail, and a 160x120 miniature thumbnail.
 
-TODO
+To do this, you'd fire up your enigmamachine by typing
 
+ enigmamachine start
+
+and go to http://localhost:2002/encoders.  Clicking the "new encoder" link will
+allow you to define a new encoder.  Let's call it "Flash video with a couple
+thumbnails", and save it.
+
+So, now there's an encoder, but it won't do anything.  Let's add some tasks,
+by clicking on the "new task" link.
+
+Give the first task a name, like _Encode a 320x240 flv at 25 frames per second_.
+
+The output file suffix in this case will be *.flv*.
+
+The encoding command you'll want to use would be
+_-ab 128 -ar 22050 -b 500000 -r 25 -s 320x240_.  This cryptic command string
+tells ffmpeg to encode a Flash video at 320x240 pixels, with an audio bitrate
+of 128kbps, an audio sample rate of 22.050khz, and a frame rate of 25fps. You
+can find out what all the ffmpeg command line switches do by RTFMing at
+http://www.ffmpeg.org/ffmpeg-doc.html
+
+You would go on to define a couple more encoding tasks for your encoder.
+Grabbing a screen frame in ffmpeg can be done with the following command-line
+switches, which you can put into a task called, let's say,
+_Grab a 320x240 JPEG thumbnail_:
+
+ -ss 00:00:05 -t 00:00:01 -vcodec mjpeg -vframes 1 -an -f rawvideo -s 320x240
+
+Rinse and repeat for the 160x120 thumbnail.
+
+== Security
+
+Enigmamachine is set to bind by default to 127.0.0.1 (your system's loopback)
+interface rather than on all network interfaces.
+
+Making an enigmamachine available on an untrusted network (like
+the Internet) would be a suicidal move on your part, since the code used to
+talk to ffmpeg is a simple exec call and you'll be inviting everyone in the world
+to execute commands on your server. Have fun with that.
+
+If you don't know what any of this means, don't run it.  I'm not responsible if
+your enigmamachine screws up your system, allows people to exploit you, or
+eats your mother.
 
 == Installation
 
@@ -76,12 +122,20 @@ You can install it as a gem by doing:
 
 If this command doesn't make any sense to you, it's because you don't know that
 "gems" are ruby code packages, somewhat like apt-get except for ruby code only.
-You can install rubygems on righteous operating systems by typing
+You can install rubygems, necessary sqlite headers, and a C compiler on
+righteous operating systems by typing:
+
+ apt-get install rubygems ruby1.8-dev libopenssl-ruby build-essential libsqlite3-dev # as root
+
+You'll need to add the following line to your ~/.bashrc file, as well:
 
- apt-get install rubygems # as root
+ export PATH=/var/lib/gems/1.8/bin:$PATH
 
-Then "gem install " should theoretically work.  You'll also need a copy of
-ffmpeg installed and available in your path.
+Then _gem install enigmamachine_ should theoretically work.  You'll also need a copy of
+ffmpeg installed and available in your path. On Mac OS X, rubygems should
+already be installed, although you'll need to have a C compiler available
+(make sure you install the developer tools that came with your operating
+system).
 
 == Status
 

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/enigmamachine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{enigmamachine}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["dave"]
-  s.date = %q{2010-07-07}
+  s.date = %q{2010-07-08}
   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.rb

@@ -60,6 +60,11 @@ class EnigmaMachine < Sinatra::Base
   set :views, File.dirname(__FILE__) + '/enigmamachine/views'
   set :public, File.dirname(__FILE__) + '/enigmamachine/public'
 
+  # Let's bind this thing to localhost only, it'd be suicidal to put it on the
+  # internet by binding it to all available interfaces.
+  #
+  set :bind, 'localhost'
+
   # Register helpers
   #
   helpers do
@@ -69,9 +74,13 @@ class EnigmaMachine < Sinatra::Base
 
   # Set up Rack authentication
   #
-  use Rack::Auth::Basic do |username, password|
-    [username, password] == ['admin', 'admin']
-  end
+  # I'm going to disable this for now, although later this might be a good way
+  # of providing security for shared hosts. TODO: figure out how to secure the
+  # app for use on shared hosts.
+  #
+#  use Rack::Auth::Basic do |username, password|
+#    [username, password] == ['admin', 'admin']
+#  end
 
   # Include flash notices
   #

data/lib/enigmamachine/config.ru

@@ -1,3 +1,3 @@
 require File.dirname(__FILE__) + '/../enigmamachine'
-EnigmaMachine.run! :host => 'localhost', :port => 2002
+EnigmaMachine.run! :port => 2002
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: enigmamachine
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - dave
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-07 00:00:00 +01:00
+date: 2010-07-08 00:00:00 +01:00
 default_executable: enigmamachine
 dependencies: 
 - !ruby/object:Gem::Dependency