fire_and_forget 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    fire_and_forget (0.1.0)
+      daemons (~> 1.1.0)
+      json (~> 1.4.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    daemons (1.1.0)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    jnunemaker-matchy (0.4.0)
+    json (1.4.6)
+    rake (0.8.7)
+    rr (1.0.2)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  daemons (~> 1.1.0)
+  fire_and_forget!
+  jeweler (~> 1.5.1)
+  jnunemaker-matchy (~> 0.4)
+  json (~> 1.4.6)
+  rr (~> 1.0.2)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Garry Hill
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,105 @@
+= Fire & Forget
+
+Fire & Forget is a simple, framework agnostic, background task launcher for Ruby web apps.
+
+What it does:
+
+- Designed for infrequent calls to very long running operations
+- Provides a mechanism for calling any external script from within a HTTP request
+- Gives simple inter-process communication for status updates
+- Launches long running tasks as completely independent processes so that you can restart/redeploy your application without interrupting any running tasks
+- Provides a 'kill' mechanism so you can cancel your tasks
+
+What it doesn't:
+
+- Have any kind of queue mechanism. If you fire the same task twice then that task will be running twice
+- Have any persistant state
+
+== Quick Start
+
+
+FAF works by running a simple TCP socket server so before we want to use it we have to start this server.
+
+  $ faf
+  FAF process 16235 listening on 127.0.0.1:3001...
+
+The service defaults to listening to port 3001 on localhost. You can change these values thus:
+
+  $ faf -a 192.168.1.22 -p 9090
+
+If you do this you will need to set both the web-app and the tasks to use the right values using
+
+  FireAndForget.port = 9090
+  FireAndForget.bind_address = "192.168.1.22"
+
+Now inside our Ruby app:
+
+  require 'rubygems'
+  require 'fire_and_forget'
+
+  # First set register our task by giving it a name and a path to a script file
+  FireAndForget.add_task(:long_running_task, "/path/to/script")
+
+  # when we want to call the script we simple call #fire passing the name of the task and the options
+  # we want to pass
+  FireAndForget.fire(:long_running_task, {:param3 => "value3"})
+
+  # Or, use the name as a method:
+  FireAndForget.long_running_task({:param3 => "value3"})
+
+This will result in the following command being exec'd in an independent process:
+
+  /path/to/script --param3="value3"
+
+It up to the script to parse and deal with the command line options.
+
+Interprocess communication is relatively easy. Take the following as the source of the script "/path/to/script"
+
+  #!/usr/bin/env ruby
+
+  require 'rubygems'
+  require 'fire_and_forget'
+
+  # this will mix in the comms methods and map this task to the :long_running_task label
+  # used in the calling script
+  include FireAndForget::Daemon[:long_running_task]
+
+  30.times do |i|
+    # update our status. What you put here is up to you, but it should be a String
+    set_task_status("#{i+1} of 30")
+    sleep(1)
+  end
+
+Now in the client all we have to do to get the status for our task is:
+
+  FireAndForget.get_status(:long_running_task)
+  # => "18 of 30"
+
+If we decided we've had enough then we can kill it:
+
+  # Send "SIG_TERM" to our task
+  FireAndForget.term(:long_running_task)
+
+  # Or send any signal (see the Process.kill documentation)
+  FireAndForget.kill(:long_running_task, "HUP")
+
+== Security
+
+F&F is intended to be run in a relatively trusted environment and by default only binds to localhost to stop external access. But to stop unintended access to system commands, only scripts belonging to the same user as the F&F server process are executed. This might not be enough so in the future I might add a limit on the locations of runnable scripts.
+
+
+== Contributing to fire_and_forget
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Garry Hill. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+# require 'bundler'
+# begin
+#   Bundler.setup(:default, :development)
+# rescue Bundler::BundlerError => e
+#   $stderr.puts e.message
+#   $stderr.puts "Run `bundle install` to install missing gems"
+#   exit e.status_code
+# end
+require 'rake'
+require 'jeweler'
+
+require 'lib/fire_and_forget/version'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fire_and_forget"
+  gem.homepage = "http://github.com/magnetised/fire_and_forget"
+  gem.license = "MIT"
+  gem.summary = %Q{Fire & Forget is a simple, framework agnostic, background task launcher for Ruby web apps}
+  gem.description = %Q{Fire & Forget is a simple, framework agnostic, background task launcher for Ruby web apps}
+  gem.email = "garry@magnetised.info"
+  gem.authors = ["Garry Hill"]
+  gem.version = FireAndForget::VERSION
+
+  gem.add_runtime_dependency "json", "~>1.4.6"
+  gem.add_runtime_dependency "daemons", "~>1.1.0"
+
+  gem.add_development_dependency "shoulda", ">= 0"
+  gem.add_development_dependency 'jnunemaker-matchy', '~>0.4'
+  gem.add_development_dependency "bundler", "~> 1.0.0"
+  gem.add_development_dependency "jeweler", "~> 1.5.1"
+  gem.add_development_dependency "rr", "~>1.0.2"
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fire_and_forget #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/fire_forget

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+
+Dir.chdir(File.join(File.dirname(__FILE__), '..'))
+
+faf_lib_path = File.expand_path(File.dirname(__FILE__) + "/../lib")
+$:.unshift(faf_lib_path) unless $:.include?(faf_lib_path)
+
+require 'rubygems' unless defined?(Gem)
+
+require 'ostruct'
+require 'optparse'
+require 'socket'
+require 'fire_and_forget'
+
+options = OpenStruct.new
+options.bind_address = "127.0.0.1"
+options.port = FAF::DEFAULT_PORT
+
+OptionParser.new do |opts|
+  opts.on("-a", "--bind-address ADDRESS", "Bind Address") { |v| options.bind_address = v }
+  opts.on("-p", "--port PORT", Integer, "Port") { |p| options.port = p }
+end.parse!
+
+server = nil
+
+begin
+  server = TCPServer.new(options.bind_address, options.port)
+rescue Errno::EADDRINUSE
+  puts "FAF unable to bind to #{options.bind_address}:#{options.port}"
+  exit(1)
+end
+
+run = true
+
+server_thread = Thread.new do
+  while run and (session = server.accept)
+    request = response = ""
+
+    while l = session.gets
+      request << l
+    end
+    session.close_read
+
+    begin
+      response = FAF::Server.parse(request)
+    rescue  => e
+      response = "ERROR #{e}"
+    end
+    session.write(response)
+    session.close
+  end
+end
+
+['INT', 'TERM'].each do |signal|
+  trap(signal) do
+    run = false;
+    server_thread.exit
+  end
+end
+
+puts "Fire&Forget process #{$$} listening on #{options.bind_address}:#{options.port}..."
+
+server_thread.join
+

data/examples/long_task

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+Dir.chdir(File.join(File.dirname(__FILE__), '..'))
+
+$:.unshift(File.dirname(__FILE__) + "/../lib")
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'fire_and_forget'
+
+include FAF::Daemon[:publish]
+
+
+File.open(File.join(File.dirname(__FILE__), "../../long.out"), 'w') do |file|
+  file.sync = true
+  file.write("PID: #{$$}\n")
+  file.write(`ps -xO nice | grep  '^#{$$}'`)
+  file.write("\n")
+  60.times do |i|
+    file.write("#{i}\n")
+    begin
+      set_status(i)
+    rescue Exception => e
+      file.write(e.to_s + "\n")
+    end
+    sleep(1)
+  end
+end

data/fire_and_forget.gemspec

@@ -0,0 +1,114 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fire_and_forget}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Garry Hill"]
+  s.date = %q{2010-12-15}
+  s.default_executable = %q{fire_forget}
+  s.description = %q{Fire & Forget is a simple, framework agnostic, background task launcher for Ruby web apps}
+  s.email = %q{garry@magnetised.info}
+  s.executables = ["fire_forget"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/fire_forget",
+    "examples/long_task",
+    "fire_and_forget.gemspec",
+    "lib/fire_and_forget.rb",
+    "lib/fire_and_forget/client.rb",
+    "lib/fire_and_forget/command.rb",
+    "lib/fire_and_forget/command/fire.rb",
+    "lib/fire_and_forget/command/get_status.rb",
+    "lib/fire_and_forget/command/kill.rb",
+    "lib/fire_and_forget/command/set_pid.rb",
+    "lib/fire_and_forget/command/set_status.rb",
+    "lib/fire_and_forget/config.rb",
+    "lib/fire_and_forget/daemon.rb",
+    "lib/fire_and_forget/launcher.rb",
+    "lib/fire_and_forget/server.rb",
+    "lib/fire_and_forget/task.rb",
+    "lib/fire_and_forget/utilities.rb",
+    "lib/fire_and_forget/version.rb",
+    "test/helper.rb",
+    "test/test_fire_and_forget.rb"
+  ]
+  s.homepage = %q{http://github.com/magnetised/fire_and_forget}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Fire & Forget is a simple, framework agnostic, background task launcher for Ruby web apps}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_fire_and_forget.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<fire_and_forget>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, ["~> 1.4.6"])
+      s.add_runtime_dependency(%q<daemons>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<jnunemaker-matchy>, ["~> 0.4"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rr>, ["~> 1.0.2"])
+      s.add_runtime_dependency(%q<json>, ["~> 1.4.6"])
+      s.add_runtime_dependency(%q<daemons>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<jnunemaker-matchy>, ["~> 0.4"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rr>, ["~> 1.0.2"])
+    else
+      s.add_dependency(%q<fire_and_forget>, [">= 0"])
+      s.add_dependency(%q<json>, ["~> 1.4.6"])
+      s.add_dependency(%q<daemons>, ["~> 1.1.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<jnunemaker-matchy>, ["~> 0.4"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rr>, ["~> 1.0.2"])
+      s.add_dependency(%q<json>, ["~> 1.4.6"])
+      s.add_dependency(%q<daemons>, ["~> 1.1.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<jnunemaker-matchy>, ["~> 0.4"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rr>, ["~> 1.0.2"])
+    end
+  else
+    s.add_dependency(%q<fire_and_forget>, [">= 0"])
+    s.add_dependency(%q<json>, ["~> 1.4.6"])
+    s.add_dependency(%q<daemons>, ["~> 1.1.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<jnunemaker-matchy>, ["~> 0.4"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rr>, ["~> 1.0.2"])
+    s.add_dependency(%q<json>, ["~> 1.4.6"])
+    s.add_dependency(%q<daemons>, ["~> 1.1.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<jnunemaker-matchy>, ["~> 0.4"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rr>, ["~> 1.0.2"])
+  end
+end
+

data/lib/fire_and_forget.rb

@@ -0,0 +1,19 @@
+
+module FireAndForget
+  DEFAULT_PORT = 3001
+
+  autoload :Config, "fire_and_forget/config"
+  autoload :Utilities, "fire_and_forget/utilities"
+  autoload :Launcher, "fire_and_forget/launcher"
+  autoload :Task, "fire_and_forget/task"
+  autoload :Client, "fire_and_forget/client"
+  autoload :Command, "fire_and_forget/command"
+  autoload :Server, "fire_and_forget/server"
+  autoload :Daemon, "fire_and_forget/daemon"
+
+  extend Config
+  extend Utilities
+  extend Launcher
+end
+
+FAF = FireAndForget unless defined?(FAF)

data/lib/fire_and_forget/client.rb

@@ -0,0 +1,29 @@
+require 'socket'
+
+module FireAndForget
+  class Client
+
+    class << self
+      def run(cmd)
+        result = open_connection do |connection|
+          connection.send(cmd.dump, 0)
+        end
+      end
+
+      def open_connection
+        connection = result = nil
+        begin
+          connection = TCPSocket.open(FireAndForget.bind_address, FireAndForget.port)
+          yield(connection)
+          connection.flush
+          connection.close_write
+          result = connection.read
+        ensure
+          connection.close if connection rescue nil
+        end
+        result
+      end
+    end
+  end
+end
+

data/lib/fire_and_forget/command.rb

@@ -0,0 +1,43 @@
+
+module FireAndForget
+  module Command
+    SEPARATOR = "||".freeze
+
+    def self.load(command)
+      Marshal.load(command)
+    end
+
+    class CommandBase
+      attr_reader :tag, :cmd, :params, :task
+
+      def initialize(task, params={})
+        @task, @params = task, merge_params(task.params, params)
+      end
+
+      def dump
+        Marshal.dump(self)
+      end
+
+      def run
+        # overridden in subclasses
+      end
+
+
+      def merge_params(task_params, call_params)
+        params = task_params.to_a.inject({}) do |hash, (key, value)|
+          hash[key.to_s] = value; hash
+        end
+        call_params.each do |key, value|
+          params[key.to_s] = value
+        end if call_params
+        params
+      end
+    end
+
+    autoload :Fire, "fire_and_forget/command/fire"
+    autoload :Kill, "fire_and_forget/command/kill"
+    autoload :SetStatus, "fire_and_forget/command/set_status"
+    autoload :GetStatus, "fire_and_forget/command/get_status"
+    autoload :SetPid, "fire_and_forget/command/set_pid"
+  end
+end

data/lib/fire_and_forget/command/fire.rb

@@ -0,0 +1,49 @@
+
+require 'daemons'
+
+module FireAndForget
+  module Command
+    class Fire < CommandBase
+      attr_reader :niceness
+
+      def niceness
+        @task.niceness
+      end
+
+      def binary
+        @task.binary
+      end
+
+      def cmd
+        %(#{binary} #{FireAndForget.to_arguments(@params)})
+      end
+
+      def valid?
+        exists? && permitted?
+      end
+
+      def permitted?
+        raise Errno::EACCES.new("'#{binary}' does not belong to user '#{ENV["USER"]}'") unless File.owned?(binary)
+        true
+      end
+
+      def exists?
+        raise Errno::ENOENT.new("'#{binary}'") unless File.exists?(binary)
+        true
+      end
+
+      def run
+        if valid?
+          pid = fork do
+            Daemons.daemonize(:backtrace => true)
+            Process.setpriority(Process::PRIO_PROCESS, 0, niceness) if niceness > 0
+            exec(cmd)
+          end
+          Process.detach(pid) if pid
+          pid
+        end
+      end
+    end
+  end
+end
+

data/lib/fire_and_forget/command/get_status.rb

@@ -0,0 +1,16 @@
+module FireAndForget
+  module Command
+    class GetStatus < CommandBase
+
+      def initialize(task_name)
+        @task_name = task_name.to_sym
+      end
+
+      def run
+        FireAndForget::Server.status[@task_name]
+      end
+    end
+  end
+end
+
+

data/lib/fire_and_forget/command/kill.rb

@@ -0,0 +1,17 @@
+module FireAndForget
+  module Command
+    class Kill < CommandBase
+
+      def initialize(task_name, signal="TERM")
+        @task_name, @signal = task_name.to_sym, signal
+      end
+
+      def run
+        FireAndForget::Server.kill(@task_name, @signal)
+      end
+    end
+  end
+end
+
+
+

data/lib/fire_and_forget/command/set_pid.rb

@@ -0,0 +1,19 @@
+module FireAndForget
+  module Command
+    class SetPid < CommandBase
+
+      attr_reader :task_name, :pid
+
+      def initialize(task_name, pid)
+        @task_name, @pid = task_name.to_sym, pid.to_i
+      end
+
+      def run
+        FireAndForget::Server.pids[@task_name] = @pid
+      end
+    end
+  end
+end
+
+
+

data/lib/fire_and_forget/command/set_status.rb

@@ -0,0 +1,17 @@
+module FireAndForget
+  module Command
+    class SetStatus < CommandBase
+
+      def initialize(task_name, status_value)
+        @task_name, @status_value = task_name.to_sym, status_value
+        @pid = $$
+      end
+
+      def run
+        FireAndForget::Server.set_pid(@task_name, @pid)
+        FireAndForget::Server.status[@task_name] = @status_value
+      end
+    end
+  end
+end
+

data/lib/fire_and_forget/config.rb

@@ -0,0 +1,15 @@
+module FireAndForget
+  module Config
+    attr_accessor :port
+    attr_accessor :bind_address
+
+    def port
+      @port ||= FireAndForget::DEFAULT_PORT
+    end
+
+    def bind_address
+      @bind_address ||= "127.0.0.1"
+    end
+  end
+end
+

data/lib/fire_and_forget/daemon.rb

@@ -0,0 +1,31 @@
+module FireAndForget
+  module Daemon # need better name!
+
+    def self.[](task_name)
+      m = Module.new do
+        def self.included(klass)
+          FireAndForget.map_pid(self.task_name, $$)
+        rescue Errno::ECONNREFUSED
+          # server isn't running but we don't want this to stop our script
+        end
+
+        def self.task_name=(task_name)
+          @@task_name = task_name
+        end
+
+        def self.task_name
+          @@task_name
+        end
+
+        def set_task_status(status)
+          FireAndForget.set_status(@@task_name, status)
+        rescue Errno::ECONNREFUSED
+          # server isn't running but we don't want this to stop our script
+        end
+      end
+      m.task_name = task_name
+      m
+    end
+
+  end
+end

data/lib/fire_and_forget/launcher.rb

@@ -0,0 +1,67 @@
+module FireAndForget
+  module Launcher
+    def add_task(task_name, path_to_binary, default_params={}, niceness=0)
+      if default_params.is_a?(Numeric)
+        niceness = default_params
+        default_params = {}
+      end
+      tasks[task_name] = Task.new(task_name, path_to_binary, default_params, niceness)
+    end
+
+    def binary(task_name)
+      tasks[task_name].binary
+    end
+
+    def [](task_name)
+      tasks[task_name]
+    end
+
+    def tasks
+      @tasks ||= {}
+    end
+
+    def fire(task_name, params={})
+      task = tasks[task_name]
+      command = Command::Fire.new(task, params)
+      Client.run(command)
+    end
+
+    def set_status(task_name, status)
+      command = Command::SetStatus.new(task_name, status)
+      Client.run(command)
+    end
+
+    def get_status(task_name)
+      command = Command::GetStatus.new(task_name)
+      Client.run(command)
+    end
+
+    def map_pid(task_name, pid)
+      command = Command::SetPid.new(task_name, pid)
+      Client.run(command)
+    end
+
+    def term(task_name)
+      kill(task_name, "TERM")
+    end
+
+    def int(task_name)
+      kill(task_name, "INT")
+    end
+
+    def kill(task_name, signal="TERM")
+      command = Command::Kill.new(task_name, signal)
+      Client.run(command)
+    end
+
+    protected
+
+    def method_missing(method, *args, &block)
+      if tasks.key?(method)
+        fire(method, *args, &block)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/fire_and_forget/server.rb

@@ -0,0 +1,34 @@
+
+module FireAndForget
+  class Server
+    def self.parse(command_string)
+      command = Command.load(command_string)
+      run(command)
+    end
+
+    def self.run(cmd)
+      cmd.run
+    end
+
+    def self.kill(task_name, signal="TERM")
+      pid = pids[task_name]
+      Process.kill(signal, pid) unless pid == 0
+    end
+
+    def self.status
+      @status ||= {}
+    end
+
+    def self.set_pid(task_name, pid)
+      pids[task_name] = pid.to_i
+    end
+
+    def self.get_pid(task)
+      pids[task.name]
+    end
+
+    def self.pids
+      @pids ||= {}
+    end
+  end
+end

data/lib/fire_and_forget/task.rb

@@ -0,0 +1,11 @@
+
+
+module FireAndForget
+  class Task
+    attr_reader :name, :binary, :niceness, :params
+
+    def initialize(name, path_to_binary, default_parameters={}, niceness=0)
+      @name, @binary, @params, @niceness = name, path_to_binary, default_parameters, niceness
+    end
+  end
+end

data/lib/fire_and_forget/utilities.rb

@@ -0,0 +1,20 @@
+require "json"
+
+module FireAndForget
+  module Utilities
+    def to_arguments(params={})
+      params.keys.sort { |a, b| a.to_s <=> b.to_s }.map do |key|
+        %(--#{key}=#{to_json(params[key])})
+      end.join(" ")
+    end
+
+    def to_json(obj)
+      if obj.is_a?(String)
+        obj.inspect
+      else
+        JSON.generate(obj)
+      end
+    end
+  end
+end
+

data/lib/fire_and_forget/version.rb

@@ -0,0 +1,4 @@
+
+module FireAndForget
+  VERSION = "0.1.0"
+end

data/test/helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'matchy'
+require 'rr'
+
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+
+require 'fire_and_forget'
+
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+end

data/test/test_fire_and_forget.rb

@@ -0,0 +1,131 @@
+require 'helper'
+
+class TestFireAndForget < Test::Unit::TestCase
+  context "Utilities" do
+    should "translate a hash to command line arguments" do
+      FAF.to_arguments({
+        :param1 => "value1",
+        :param2 => "value2",
+        :array => [1, 2, "3"]
+      }).should == %(--array=[1,2,"3"] --param1="value1" --param2="value2")
+    end
+  end
+  context "configuration" do
+    should "enable mapping of task to a binary" do
+      FAF.add_task(:publish, "/path/to/binary")
+      FAF.binary(:publish).should ==  "/path/to/binary"
+      FAF[:publish].binary.should ==  "/path/to/binary"
+    end
+
+    should "enable setting of a niceness value for the task" do
+      FAF.add_task(:publish, "/path/to/binary", 10)
+      FAF[:publish].niceness.should ==  10
+    end
+
+    should "enable launching a task by its name" do
+      FAF.add_task(:publish, "/path/to/binary")
+      args = {:param1 => "param1", :param2 => "param2"}
+      mock(FAF).fire(:publish, args)
+      FAF.publish(args)
+    end
+
+    should "enable setting of port for server" do
+      FAF.port = 3007
+      FAF.port.should == 3007
+    end
+
+    should "enable setting an address for the server" do
+      FAF.bind_address = "10.0.1.10"
+      FAF.bind_address.should == "10.0.1.10"
+    end
+  end
+
+  context "commands" do
+    should "serialize and deserialize correctly" do
+      task = FAF::Task.new(:publish, "/publish", {:param1 => "value1", :param2 => "value2"}, 9)
+      cmd = FAF::Command::CommandBase.new(task, {"param2" => "newvalue2", :param3 => "value3"})
+      cmd2 = FAF::Command.load(cmd.dump)
+      task2 = cmd2.task
+      task2.binary.should == task.binary
+      task2.params.should == task.params
+      task2.name.should == task.name
+      cmd.params.should == {"param1" => "value1", "param2" => "newvalue2", "param3" => "value3"}
+    end
+  end
+
+  context "actions" do
+    setup do
+      @task = FAF::Task.new(:publish, "/publish", {:param1 => "value1", :param2 => "value2"}, 9)
+    end
+    should "set status for a task" do
+      cmd = FAF::Command::SetStatus.new(:publish, :doing)
+      FAF::Server.run(cmd)
+      cmd = FAF::Command::GetStatus.new(:publish)
+      status = FAF::Server.run(cmd)
+      status.should == :doing
+    end
+    should "only run scripts belonging to the same user as the ruby process" do
+      stub(File).exist?("/publish") { true }
+      stub(File).exists?("/publish") { true }
+      stub(File).owned?("/publish") { false }
+      cmd = FAF::Command::Fire.new(@task)
+      lambda { cmd.run }.should raise_error(Errno::EACCES)
+    end
+    should "give error if binary doesn't exist" do
+      stub(File).exist?("/publish") { false }
+      stub(File).exists?("/publish") { false }
+      stub(File).owned?("/publish") { true }
+      cmd = FAF::Command::Fire.new(@task)
+      lambda { cmd.run }.should raise_error(Errno::ENOENT )
+    end
+  end
+
+  context "client" do
+    should "send right command to server" do
+      task = FAF.add_task(:publish, "/publish", {:param1 => "value1", :param2 => "value2"}, 12)
+      command = Object.new
+      mock(command).dump { "dumpedcommand" }
+      mock(FAF::Command::Fire).new(task, {:param2 => "value3"}) { command }
+      connection = Object.new
+      mock(connection).send("dumpedcommand", 0)
+      stub(connection).flush
+      stub(connection).close_write
+      mock(connection).read { "99999" }
+      mock(connection).close
+      FAF.bind_address = "10.0.1.10"
+      FAF.port = 9007
+      mock(TCPSocket).open("10.0.1.10", 9007) { connection }
+      pid = FAF.publish({:param2 => "value3"})
+      pid.should == "99999"
+    end
+  end
+
+  context "server" do
+    setup do
+      @server = FAF::Server.new
+    end
+
+    should "run any command sent to it" do
+      command = Object.new
+      mock(FAF::Command).load(is_a(String)) { command }
+      mock(command).run { "666" }
+      result = FAF::Server.parse("object")
+      result.should == "666"
+    end
+  end
+  context "daemon methods" do
+    setup do
+      class ::TaskClass; end
+    end
+    teardown do
+      Object.send(:remove_const, :TaskClass) rescue nil
+    end
+
+    should "map a taskname to a pid when included" do
+      mock(FAF::Client).run(satisfy { |cmd|
+        (cmd.pid == $$) && (cmd.task_name == :tasking)
+      })
+      TaskClass.send(:include, FAF::Daemon[:tasking])
+    end
+  end
+end

metadata

@@ -0,0 +1,290 @@
+--- !ruby/object:Gem::Specification 
+name: fire_and_forget
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Garry Hill
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-15 00:00:00 +00:00
+default_executable: fire_forget
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  name: fire_and_forget
+  requirement: *id001
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  name: json
+  requirement: *id002
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  name: daemons
+  requirement: *id003
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  requirement: *id004
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
+  name: jnunemaker-matchy
+  requirement: *id005
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  requirement: *id006
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  name: jeweler
+  requirement: *id007
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  name: rr
+  requirement: *id008
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  name: json
+  requirement: *id009
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  name: daemons
+  requirement: *id010
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  requirement: *id011
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
+  name: jnunemaker-matchy
+  requirement: *id012
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  requirement: *id013
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id014 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  name: jeweler
+  requirement: *id014
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id015 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  name: rr
+  requirement: *id015
+  prerelease: false
+  type: :development
+description: Fire & Forget is a simple, framework agnostic, background task launcher for Ruby web apps
+email: garry@magnetised.info
+executables: 
+- fire_forget
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/fire_forget
+- examples/long_task
+- fire_and_forget.gemspec
+- lib/fire_and_forget.rb
+- lib/fire_and_forget/client.rb
+- lib/fire_and_forget/command.rb
+- lib/fire_and_forget/command/fire.rb
+- lib/fire_and_forget/command/get_status.rb
+- lib/fire_and_forget/command/kill.rb
+- lib/fire_and_forget/command/set_pid.rb
+- lib/fire_and_forget/command/set_status.rb
+- lib/fire_and_forget/config.rb
+- lib/fire_and_forget/daemon.rb
+- lib/fire_and_forget/launcher.rb
+- lib/fire_and_forget/server.rb
+- lib/fire_and_forget/task.rb
+- lib/fire_and_forget/utilities.rb
+- lib/fire_and_forget/version.rb
+- test/helper.rb
+- test/test_fire_and_forget.rb
+has_rdoc: true
+homepage: http://github.com/magnetised/fire_and_forget
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Fire & Forget is a simple, framework agnostic, background task launcher for Ruby web apps
+test_files: 
+- test/helper.rb
+- test/test_fire_and_forget.rb