constable 0.1.0 → 0.2.0

data/README.md

@@ -8,6 +8,33 @@ anything quite as powerful will be generated using the service, but if you do
 make something nice please let me know!
 
 
+Up and running fast
+-------------------
+
+I've provided a Vagrant setup that will get you up and running fast. Install
+the necessary gems using bundler:
+
+    cd /path/to/checkout/of/constable
+    bundle
+
+Ask Vagrant to bring up the server components for you:
+
+    cd /path/to/checkout/of/constable
+    bundle exec vagrant up
+
+Ask Constable to do some work:
+
+    cd /path/to/checkout/of/constable
+    bundle exec ./bin/constable-identify -- /path/to/input.png -verbose
+
+That's it, you just used ImageMagick as a service.
+
+Of course, if you want to use it as a real service on your network you'll
+probably want to set it up a little differently. See the following sections on
+Installing and Usage for information on how to setup your own ImageMagick
+service.
+
+
 Installing
 ----------
 
@@ -31,9 +58,9 @@ and I'll pull your changes.
 
 Run the server, somewhere that has ImageMagick installed:
 
-    constabled --broker=stomp://mq.yourdomain.com:61613
+    $ constabled --broker=stomp://mq.yourdomain.com:61613
 
-Use the services on the command line. You don't need ot have ImageMagick
+Use the services on the command line. You don't need to have ImageMagick
 installed on your client machines, just constable.
 
 Command names are based on ImageMagick command names, prefixed with
@@ -41,16 +68,20 @@ Command names are based on ImageMagick command names, prefixed with
 and will give you a decent explanation of what they do and their options if
 you ask for it.
 
-The commands are designed to take their input on standard input and return
-results on standard output. It's up to you what you do with the input and
-output; write it to a file, pipe it to another process, that's not handled by
-Constable (and I have no plans to handle it).
+The commands are designed to take their input just like ImageMagick and return
+results on standard output. It's up to you what you do with the output;
+write it to a file, pipe it to another process, that's not handled by Constable.
+A caveat of this is that you must construct your Constable invocations such that
+ImageMagick would write to standard output rather than a file.
 
 A brief example of what interacting with Constable looks like, here
 identifying some image file I had lying around on disk:
 
-    $ cat input_file | constable-identify --broker=stomp://mq.yourdomain.com:61613
-    constabled-164829495-102948483-1939485.jpg JPEG 640x480 DirectClass 87kb 0.050u 0:01
+    $ constable-identify --broker=stomp://mq.yourdomain.com:61613 -- input_file
+    input_file JPEG 640x480 DirectClass 87kb 0.050u 0:01
+
+    $ constable-convert --broker=stomp://mq.yourdomain.com:61613 -- \
+      -resize 50% input.png jpg:- > output.jpg
 
 I explicitly state the broker in the above commands but if you leave out that
 option it'll default to stomp://localhost:61613 ie it expects a broker running

data/bin/constable-convert

@@ -0,0 +1,47 @@
+#! /usr/bin/env ruby
+
+require 'base64'
+require 'stomp'
+require 'json'
+require "getoptlong"
+
+options = {}
+argv = GetoptLong.new(
+  [ "--broker", "-b", GetoptLong::OPTIONAL_ARGUMENT ]
+)
+argv.each do |option, value|
+  options['broker'] = value if option == '--broker'
+end
+options['broker'] ||= 'stomp://127.0.0.1:61613'
+
+parameters = ARGV.join ' '
+command = {
+  command: File.basename($0).gsub(/^constable-/, ''),
+  parameters: parameters,
+  files: {}
+}
+ARGV.each do |file_name|
+  if File.exists? file_name
+    file = File.read file_name
+    data = Base64.encode64 file
+    command[:files][file_name] = data
+  end
+end
+
+command_json = JSON.generate command
+
+results = '/queue/constable.results-' + Process.pid.to_s + '-' + Time.now.to_i.to_s
+client = Stomp::Client.new options['broker']
+client.publish '/queue/constable', command_json, 'reply-to' => results
+
+client.subscribe results, 'auto-delete' => true do |message|
+  results = JSON.parse message.body
+  if results['exit_code'] == 0
+    print results['stdout']
+  else
+    print results['stderr']
+  end
+  client.close
+end
+
+client.join

data/bin/constable-identify

@@ -1,14 +1,6 @@
 #! /usr/bin/env ruby
 
-image = STDIN.read
-if image.to_s == ''
-  puts "Give me some input!"
-  exit 1
-end
-
 require 'base64'
-encoded_input = Base64.encode64 image
-
 require 'stomp'
 require 'json'
 require "getoptlong"
@@ -22,8 +14,26 @@ argv.each do |option, value|
 end
 options['broker'] ||= 'stomp://127.0.0.1:61613'
 
+parameters = ARGV.join ' '
+command = {
+  command: File.basename($0).gsub(/^constable-/, ''),
+  parameters: parameters,
+  files: {}
+}
+ARGV.each do |file_name|
+  if File.exists? file_name
+    file = File.read file_name
+    data = Base64.encode64 file
+    command[:files][file_name] = data
+  end
+end
+
+command_json = JSON.generate command
+
 results = '/queue/constable.results-' + Process.pid.to_s + '-' + Time.now.to_i.to_s
 client = Stomp::Client.new options['broker']
+client.publish '/queue/constable', command_json, 'reply-to' => results
+
 client.subscribe results, 'auto-delete' => true do |message|
   results = JSON.parse message.body
   if results['exit_code'] == 0
@@ -34,13 +44,4 @@ client.subscribe results, 'auto-delete' => true do |message|
   client.close
 end
 
-parameters = ARGV.join ' '
-command = {
-  command: 'identify',
-  input: encoded_input,
-  parameters: parameters
-}
-command_json = JSON.generate command
-
-client.publish '/queue/constable', command_json, 'reply-to' => results
 client.join

data/bin/constabled

@@ -10,38 +10,98 @@ require 'getoptlong'
 
 class Job
   module WorkingEnvironment
-    def with_temp_file
-      temp_file = Tempfile.new serial
-      yield temp_file
-    ensure
-      temp_file.close!
-    end
-
     def serial
       @job_id ||= [
         File.basename($0), Time.now.to_i, rand(1_000_000)
       ].join '-'
     end
 
-    def using_file_with_content encoded_content, &block
-      decoded_content = Base64.decode64 encoded_content
-      with_temp_file do |file|
-        file.print decoded_content
-        file.flush
-        yield file
+    def working_directory
+      @working_directory ||= %x[mktemp -d -t #{serial}-XXXXXX].strip
+    end
+
+    def clean_up
+      %x[ test -d "#{@working_directory}" && rm -rf "#{@working_directory}"]
+    end
+
+    def write_files
+      files.each_pair do |file_name, content|
+        puts "Decoding #{file_name}"
+        decoded_content = Base64.decode64 content
+        puts "Writing #{file_name} content"
+        file = write_file decoded_content, file_name.split(/\./)[-1]
+        puts "Wrote #{file_name} to #{file.path}"
+        rewrite_file_parameter file_name, file.path
       end
     end
 
-    def run_command command_line
+    def write_file content, ext = nil
+      hash = Digest::SHA1.hexdigest content
+      ext = ".#{ext}" if ext && ext[0] != '.'
+      file = File.open File.join(working_directory, "#{hash}#{ext}"), 'w+'
+      file.print content
+      file.close
+      file
+    end
+
+    # FIXME: We can still end up with parameters we don't know about being sent
+    # here, including shell escaped... insane.
+    #
+    # Figure out some way to generate a whitelist of ImageMagick commands and
+    # parameters.
+
+    def rewrite_file_parameter file_name, actual_file
+      file_map[actual_file] = file_name
+      puts "Rewriting parameter #{file_name} to #{actual_file}"
+      parameters.gsub! file_name, actual_file
+    end
+
+    def file_map
+      @file_map ||= {}
+    end
+
+    def unwrap_file_parameters result
+      file_map.each_pair do |local_file, remote_file|
+        puts "Rewriting parameter #{local_file} to #{remote_file}"
+        result.gsub! local_file, remote_file
+      end
+    end
+
+    def files
+      options['files']
+    end
+
+    def parameters
+      options['parameters']
+    end
+
+    def hostname
+      %x[hostname].strip
+    end
+
+    def run_command command
+      write_files
+      command_line = [ command, parameters ].join ' '
       puts "Running #{command_line}"
-      stdin, stdout, stderr, command = Open3.popen3 command_line
+      stdin, stdout, stderr = Open3.popen3 command_line
+      output = stdout.readlines.join
+      errors = stderr.readlines.join
+      unwrap_file_parameters command_line
+      unwrap_file_parameters output
       {
-        stdout: stdout.readlines.join,
-        stderr: stderr.readlines.join,
-        exit_code: command.value.exitstatus,
-        pid: command.value.pid,
-        command_line: command_line
+        :stdout => output,
+        :stderr => errors,
+        :command_line => command_line,
+        :exit_code => $?.exitstatus,
+        :pid => $?.pid,
+        :working_directory => working_directory,
+        :processor => {
+          :hostname => hostname,
+          :pid => Process.pid
+        }
       }
+    ensure
+      clean_up
     end
   end
 
@@ -56,13 +116,22 @@ class Job
     end
 
     def execute
-      using_file_with_content options['input'] do |file|
-        run_command "identify #{parameters} #{file.path}"
-      end
+      run_command :identify
     end
+  end
 
-    def parameters
-      '-verbose' if options['parameters'] == '-verbose'
+  class ConvertCommand
+    include WorkingEnvironment
+
+    attr_accessor :options
+    private :options, :options=
+
+    def initialize options
+      self.options = options
+    end
+
+    def execute
+      run_command :convert
     end
   end
 

data/lib/constable/version.rb

@@ -1,3 +1,3 @@
 module Constable
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: constable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-30 00:00:00.000000000Z
+date: 2011-10-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stomp
-  requirement: &70227556077520 !ruby/object:Gem::Requirement
+  requirement: &70206086170300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70227556077520
+  version_requirements: *70206086170300
 description: Installing ImageMagick and RMagick everywhere sucks, right? So install
   it in one place and have everything else use that one install.
 email:
@@ -34,6 +34,7 @@ extra_rdoc_files: []
 files:
 - lib/constable/version.rb
 - lib/constable.rb
+- bin/constable-convert
 - bin/constable-identify
 - bin/constabled
 - README.md