stalker 0.2.0 → 0.2.1

data/README.md

@@ -0,0 +1,89 @@
+Stalker - a job queueing DSL for Beanstalk
+==========================================
+
+[Beanstalkd](http://kr.github.com/beanstalkd/) is a fast, lightweight queueing backend inspired by mmemcached.  The [Ruby Beanstalk client](http://beanstalk.rubyforge.org/) is a bit raw, however, so Stalker provides a thin wrapper to make job queueing from your Ruby app easy and fun.
+
+Queueing jobs
+-------------
+
+From anywhere in your app:
+
+    require 'stalker'
+
+    Stalker.enqueue('email.send', :to => 'joe@example.com')
+    Stalker.enqueue('post.cleanup.all')
+    Stalker.enqueue('post.cleanup', :id => post.id)
+
+Working jobs
+------------
+
+In a standalone file, typically jobs.rb or worker.rb:
+
+    require 'stalker'
+    include Stalker
+
+    job 'email.send' do |args|
+      Pony.send(:to => args['to'], :subject => "Hello there")
+    end
+
+    job 'post.cleanup.all' do |args|
+      Post.all.each do |post|
+        enqueue('post.cleanup', :id => post.all)
+      end
+    end
+
+    job 'post.cleanup' do |args|
+      Post.find(args['id']).cleanup
+    end
+
+Running
+-------
+
+First, make sure you have Beanstalkd installed and running:
+
+    $ sudo port install beanstalkd
+    $ beanstalkd
+
+Stalker:
+
+    $ sudo gem install stalker
+
+Now run a worker using the stalk binary:
+
+    $ stalk jobs.rb
+    [Thu May 13 01:08:19 -0700 2010] Working 3 jobs: [ email.send post.cleanup.all post.cleanup ]
+    [Thu May 13 01:08:21 -0700 2010] -> send.email (email=hello@example.com)
+    [Thu May 13 01:08:21 -0700 2010] -> send.email finished in 31ms
+
+Stalker will log to stdout as it starts working each job, and then again when the job finishes including the ellapsed time in milliseconds.
+
+Filter to a list of jobs you wish to run with an argument:
+
+    $ stalk jobs.rb post.cleanup.all,post.cleanup
+    [Sat Apr 17 14:13:40 -0700 2010] Working 2 jobs: [ post.cleanup.all post.cleanup ]
+
+In a production environment you may run one or more high-priority workers (limited to short/urgent jobs) and any number of regular workers (working all jobs).  For example, two workers working just the email.send job, and four running all jobs:
+
+    $ for i in 1 2; do stalk jobs.rb email.send > log/urgent-worker.log 2>&1; end
+    $ for i in 1 2 3 4; do stalk jobs.rb > log/worker.log 2>&1; end
+
+Tidbits
+-------
+
+* Jobs are serialized as JSON, so you should stick to strings, integers, arrays, and hashes as arguments to jobs.  e.g. don't pass full Ruby objects - use something like an ActiveRecord/MongoMapper/CouchRest id instead.
+* Because there are no class definitions associated with jobs, you can queue jobs from anywhere without needing to include your full app's environment.
+* If you need to change the location of your Beanstalk from the default (localhost:11300), set BEANSTALK_URL in your environment, e.g. export BEANSTALK_URL=beanstalk://example.com:11300/
+* The stalk binary is just for convenience, you can also run a worker with a straight Ruby command:
+    $ ruby -r jobs -e Stalker.work
+
+Meta
+----
+
+Created by Adam Wiggins
+
+Heavily inspired by [Minion](http://github.com/orionz/minion) by Orion Henry
+
+Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
+
+http://github.com/adamwiggins/stalker
+

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/examples/enqueue.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift '../lib'
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'stalker'
 
 Stalker.enqueue('send.email', :email => 'hello@example.com')

data/examples/jobs.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift '../lib'
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'stalker'
 
 include Stalker

data/lib/stalker.rb

@@ -27,7 +27,7 @@ module Stalker
 			raise(NoSuchJob, job) unless @@handlers[job]
 		end
 
-		log "Working #{jobs.size} jobs  :: [ #{jobs.join(' ')} ]"
+		log "Working #{jobs.size} jobs: [ #{jobs.join(' ')} ]"
 
 		beanstalk.list_tubes_watched.each { |tube| beanstalk.ignore(tube) }
 		jobs.each { |job| beanstalk.watch(job) }
@@ -40,22 +40,34 @@ module Stalker
 	def work_one_job
 		job = beanstalk.reserve
 		name, args = JSON.parse job.body
-		log_job(name, args)
+		log_job_begin(name, args)
 		handler = @@handlers[name]
 		raise(NoSuchJob, name) unless handler
 		handler.call(args)
 		job.delete
+		log_job_end(name)
 	rescue => e
 		STDERR.puts exception_message(e)
 		job.bury
 	end
 
-	def log_job(name, args)
-		args_flat = args.inject("") do |accum, (key,value)|
-			accum += "#{key}=#{value} "
+	def log_job_begin(name, args)
+		args_flat = unless args.empty?
+			'(' + args.inject([]) do |accum, (key,value)|
+				accum << "#{key}=#{value}"
+			end.join(' ') + ')'
+		else
+			''
 		end
 
-		log sprintf("%-15s :: #{args_flat}", name)
+		log [ "->", name, args_flat ].join(' ')
+		@job_begun = Time.now
+	end
+
+	def log_job_end(name)
+		ellapsed = Time.now - @job_begun
+		ms = (ellapsed.to_f * 1000).to_i
+		log "-> #{name} finished in #{ms}ms"
 	end
 
 	def log(msg)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Adam Wiggins
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-10 00:00:00 -07:00
+date: 2010-05-13 00:00:00 -07:00
 default_executable: stalk
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,9 +35,10 @@ executables:
 - stalk
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.md
 files: 
+- README.md
 - Rakefile
 - VERSION
 - bin/stalk