stalker 0.8.0 → 0.9.0

data/README.md

@@ -90,7 +90,7 @@ 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/
+* 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/. You can specify multiple beanstalk servers, separated by whitespace or comma, e.g. export BEANSTALK_URL="beanstalk://b1.example.com:11300/, beanstalk://b2.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
 
@@ -99,22 +99,22 @@ Running the tests
 
 If you wish to hack on Stalker, install these extra gems:
 
-    $ gem install contest mocha turn
+    $ gem install contest mocha
 
-Run the tests:
+Make sure you have a beanstalkd running, then run the tests:
 
-    $ turn
+    $ ruby test/stalker_test.rb
 
 Meta
 ----
 
-Created by Adam Wiggins
+Created by [Adam Wiggins](https://github.com/adamwiggins)
 
-Patches from Jamie Cobbett, Scott Water, Keith Rarick, Mark McGranaghan, Sean Walberg, Adam Pohorecki
+Patches from Jamie Cobbett, Scott Water, Keith Rarick, Mark McGranaghan, Sean Walberg, Adam Pohorecki, Han Kessels
 
-Heavily inspired by [Minion](http://github.com/orionz/minion) by Orion Henry
+Heavily inspired by [Minion](https://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
+https://github.com/han/stalker
 

data/Rakefile

@@ -6,7 +6,7 @@ Jeweler::Tasks.new do |s|
 	s.description = "A job queueing and background workers system using Beanstalkd.  Inspired by the Minion gem."
 	s.author = "Adam Wiggins"
 	s.email = "adam@heroku.com"
-	s.homepage = "http://github.com/adamwiggins/stalker"
+	s.homepage = "https://github.com/han/stalker"
 	s.executables = [ "stalk" ]
 	s.rubyforge_project = "stalker"
 

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.9.0

data/examples/jobs.rb

@@ -1,11 +1,11 @@
 job 'send.email' do |args|
-	log "Sending email to #{args['email']}"
+  log "Sending email to #{args['email']}"
 end
 
 job 'transform.image' do |args|
-	log "Image transform"
+  log "Image transform"
 end
 
 job 'cleanup.strays' do |args|
-	log "Cleaning up"
+  log "Cleaning up"
 end

data/lib/stalker.rb

@@ -4,98 +4,98 @@ require 'uri'
 require 'timeout'
 
 module Stalker
-	extend self
-
-	def connect(url)
-		@@url = url
-		beanstalk
-	end
-
-	def enqueue(job, args={}, opts={})
-		pri   = opts[:pri]   || 65536
-		delay = opts[:delay] || 0
-		ttr   = opts[:ttr]   || 120
-		beanstalk.use job
-		beanstalk.put [ job, args ].to_json, pri, delay, ttr
-	rescue Beanstalk::NotConnected => e
-		failed_connection(e)
-	end
-
-	def job(j, &block)
-		@@handlers ||= {}
-		@@handlers[j] = block
-	end
-
-	def before(&block)
-		@@before_handlers ||= []
-		@@before_handlers << block
-	end
-
-	def error(&blk)
-		@@error_handler = blk
-	end
-
-	class NoJobsDefined < RuntimeError; end
-	class NoSuchJob < RuntimeError; end
-
-	def prep(jobs=nil)
-		raise NoJobsDefined unless defined?(@@handlers)
-		@@error_handler = nil unless defined?(@@error_handler)
-
-		jobs ||= all_jobs
-
-		jobs.each do |job|
-			raise(NoSuchJob, job) unless @@handlers[job]
-		end
-
-		log "Working #{jobs.size} jobs: [ #{jobs.join(' ')} ]"
-
-		jobs.each { |job| beanstalk.watch(job) }
-
-		beanstalk.list_tubes_watched.each do |server, tubes|
-			tubes.each { |tube| beanstalk.ignore(tube) unless jobs.include?(tube) }
-		end
-	rescue Beanstalk::NotConnected => e
-		failed_connection(e)
-	end
-
-	def work(jobs=nil)
-		prep(jobs)
-		loop { work_one_job }
-	end
-
-	class JobTimeout < RuntimeError; end
-
-	def work_one_job
-		job = beanstalk.reserve
-		name, args = JSON.parse job.body
-		log_job_begin(name, args)
-		handler = @@handlers[name]
-		raise(NoSuchJob, name) unless handler
-
-		begin
-			Timeout::timeout(job.ttr - 1) do
-				if defined? @@before_handlers and @@before_handlers.respond_to? :each
-					@@before_handlers.each do |block|
-						block.call(name)
-					end
-				end
-				handler.call(args)
-			end
-		rescue Timeout::Error
-			raise JobTimeout, "#{name} hit #{job.ttr-1}s timeout"
-		end
-
-		job.delete
-		log_job_end(name)
-	rescue Beanstalk::NotConnected => e
-		failed_connection(e)
-	rescue SystemExit
-		raise
-	rescue => e
-		log_error exception_message(e)
-		job.bury rescue nil
-		log_job_end(name, 'failed')
+  extend self
+
+  def connect(url)
+    @@url = url
+    beanstalk
+  end
+
+  def enqueue(job, args={}, opts={})
+    pri   = opts[:pri]   || 65536
+    delay = [0, opts[:delay].to_i].max  
+    ttr   = opts[:ttr]   || 120
+    beanstalk.use job
+    beanstalk.put [ job, args ].to_json, pri, delay, ttr
+  rescue Beanstalk::NotConnected => e
+    failed_connection(e)
+  end
+
+  def job(j, &block)
+    @@handlers ||= {}
+    @@handlers[j] = block
+  end
+
+  def before(&block)
+    @@before_handlers ||= []
+    @@before_handlers << block
+  end
+
+  def error(&blk)
+    @@error_handler = blk
+  end
+
+  class NoJobsDefined < RuntimeError; end
+  class NoSuchJob < RuntimeError; end
+
+  def prep(jobs=nil)
+    raise NoJobsDefined unless defined?(@@handlers)
+    @@error_handler = nil unless defined?(@@error_handler)
+
+    jobs ||= all_jobs
+
+    jobs.each do |job|
+      raise(NoSuchJob, job) unless @@handlers[job]
+    end
+
+    log "Working #{jobs.size} jobs: [ #{jobs.join(' ')} ]"
+
+    jobs.each { |job| beanstalk.watch(job) }
+
+    beanstalk.list_tubes_watched.each do |server, tubes|
+      tubes.each { |tube| beanstalk.ignore(tube) unless jobs.include?(tube) }
+    end
+  rescue Beanstalk::NotConnected => e
+    failed_connection(e)
+  end
+
+  def work(jobs=nil)
+    prep(jobs)
+    loop { work_one_job }
+  end
+
+  class JobTimeout < RuntimeError; end
+
+  def work_one_job
+    job = beanstalk.reserve
+    name, args = JSON.parse job.body
+    log_job_begin(name, args)
+    handler = @@handlers[name]
+    raise(NoSuchJob, name) unless handler
+
+    begin
+      Timeout::timeout(job.ttr - 1) do
+        if defined? @@before_handlers and @@before_handlers.respond_to? :each
+          @@before_handlers.each do |block|
+            block.call(name)
+          end
+        end
+        handler.call(args)
+      end
+    rescue Timeout::Error
+      raise JobTimeout, "#{name} hit #{job.ttr-1}s timeout"
+    end
+
+    job.delete
+    log_job_end(name)
+  rescue Beanstalk::NotConnected => e
+    failed_connection(e)
+  rescue SystemExit
+    raise
+  rescue => e
+    log_error exception_message(e)
+    job.bury rescue nil
+		log_job_end(name, 'failed') if @job_begun
     if error_handler
       if error_handler.arity == 1
         error_handler.call(e)
@@ -103,81 +103,86 @@ module Stalker
         error_handler.call(e, name, args)
       end
     end
-	end
-
-	def failed_connection(e)
-		log_error exception_message(e)
-		log_error "*** Failed connection to #{beanstalk_url}"
-		log_error "*** Check that beanstalkd is running (or set a different BEANSTALK_URL)"
-		exit 1
-	end
-
-	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 [ "Working", name, args_flat ].join(' ')
-		@job_begun = Time.now
-	end
-
-	def log_job_end(name, failed=false)
-		ellapsed = Time.now - @job_begun
-		ms = (ellapsed.to_f * 1000).to_i
-		log "Finished #{name} in #{ms}ms #{failed ? ' (failed)' : ''}"
-	end
-
-	def log(msg)
-		puts msg
-	end
-
-	def log_error(msg)
-		STDERR.puts msg
-	end
-
-	def beanstalk
-		@@beanstalk ||= Beanstalk::Pool.new([ beanstalk_host_and_port ])
-	end
-
-	def beanstalk_url
-		return @@url if defined?(@@url) and @@url
-		ENV['BEANSTALK_URL'] || 'beanstalk://localhost/'
-	end
-
-	class BadURL < RuntimeError; end
-
-	def beanstalk_host_and_port
-		uri = URI.parse(beanstalk_url)
-		raise(BadURL, beanstalk_url) if uri.scheme != 'beanstalk'
-		return "#{uri.host}:#{uri.port || 11300}"
-	end
-
-	def exception_message(e)
-		msg = [ "Exception #{e.class} -> #{e.message}" ]
-
-		base = File.expand_path(Dir.pwd) + '/'
-		e.backtrace.each do |t|
-			msg << "   #{File.expand_path(t).gsub(/#{base}/, '')}"
-		end
-
-		msg.join("\n")
-	end
-
-	def all_jobs
-		@@handlers.keys
-	end
-
-	def error_handler
-		@@error_handler
-	end
-
-	def clear!
-		@@handlers = nil
-		@@before_handlers = nil
-		@@error_handler = nil
-	end
+  end
+
+  def failed_connection(e)
+    log_error exception_message(e)
+    log_error "*** Failed connection to #{beanstalk_url}"
+    log_error "*** Check that beanstalkd is running (or set a different BEANSTALK_URL)"
+    exit 1
+  end
+
+  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 [ "Working", name, args_flat ].join(' ')
+    @job_begun = Time.now
+  end
+
+  def log_job_end(name, failed=false)
+    ellapsed = Time.now - @job_begun
+    ms = (ellapsed.to_f * 1000).to_i
+    log "Finished #{name} in #{ms}ms #{failed ? ' (failed)' : ''}"
+  end
+
+  def log(msg)
+    puts msg
+  end
+
+  def log_error(msg)
+    STDERR.puts msg
+  end
+
+  def beanstalk
+    @@beanstalk ||= Beanstalk::Pool.new(beanstalk_addresses)
+  end
+
+  def beanstalk_url
+    return @@url if defined?(@@url) and @@url
+    ENV['BEANSTALK_URL'] || 'beanstalk://localhost/'
+  end
+
+  class BadURL < RuntimeError; end
+
+  def beanstalk_addresses
+    uris = beanstalk_url.split(/[\s,]+/)
+    uris.map {|uri| beanstalk_host_and_port(uri)}
+  end
+
+  def beanstalk_host_and_port(uri_string)
+    uri = URI.parse(uri_string)
+    raise(BadURL, uri_string) if uri.scheme != 'beanstalk'
+    "#{uri.host}:#{uri.port || 11300}"
+  end
+
+  def exception_message(e)
+    msg = [ "Exception #{e.class} -> #{e.message}" ]
+
+    base = File.expand_path(Dir.pwd) + '/'
+    e.backtrace.each do |t|
+      msg << "   #{File.expand_path(t).gsub(/#{base}/, '')}"
+    end
+
+    msg.join("\n")
+  end
+
+  def all_jobs
+    @@handlers.keys
+  end
+
+  def error_handler
+    @@error_handler
+  end
+
+  def clear!
+    @@handlers = nil
+    @@before_handlers = nil
+    @@error_handler = nil
+  end
 end

data/test/stalker_test.rb

@@ -3,109 +3,122 @@ require 'contest'
 require 'mocha'
 
 module Stalker
-	def log(msg); end
-	def log_error(msg); end
+  def log(msg); end
+  def log_error(msg); end
 end
 
 class StalkerTest < Test::Unit::TestCase
-	setup do
-		Stalker.clear!
-		$result = -1
-		$handled = false
-	end
+  setup do
+    Stalker.clear!
+    $result = -1
+    $handled = false
+  end
 
-	def with_an_error_handler
-		Stalker.error do |e, job_name, args|
-			$handled = e.class
-			$job_name = job_name
-			$job_args = args
-		end
-	end
+  def with_an_error_handler
+    Stalker.error do |e, job_name, args|
+      $handled = e.class
+      $job_name = job_name
+      $job_args = args
+    end
+  end
 
-	test "enqueue and work a job" do
-		val = rand(999999)
-		Stalker.job('my.job') { |args| $result = args['val'] }
-		Stalker.enqueue('my.job', :val => val)
-		Stalker.prep
-		Stalker.work_one_job
-		assert_equal val, $result
-	end
+  test "enqueue and work a job" do
+    val = rand(999999)
+    Stalker.job('my.job') { |args| $result = args['val'] }
+    Stalker.enqueue('my.job', :val => val)
+    Stalker.prep
+    Stalker.work_one_job
+    assert_equal val, $result
+  end
 
-	test "invoke error handler when defined" do
-		with_an_error_handler
-		Stalker.job('my.job') { |args| fail }
-		Stalker.enqueue('my.job', :foo => 123)
-		Stalker.prep
-		Stalker.work_one_job
-		assert $handled
-		assert_equal 'my.job', $job_name
-		assert_equal({'foo' => 123}, $job_args)
-	end
+  test "invoke error handler when defined" do
+    with_an_error_handler
+    Stalker.job('my.job') { |args| fail }
+    Stalker.enqueue('my.job', :foo => 123)
+    Stalker.prep
+    Stalker.work_one_job
+    assert $handled
+    assert_equal 'my.job', $job_name
+    assert_equal({'foo' => 123}, $job_args)
+  end
 
-	test "should be compatible with legacy error handlers" do
-		exception = StandardError.new("Oh my, the job has failed!")
-		Stalker.error { |e| $handled = e }
-		Stalker.job('my.job') { |args| raise exception }
-		Stalker.enqueue('my.job', :foo => 123)
-		Stalker.prep
-		Stalker.work_one_job
-		assert_equal exception, $handled
-	end
+  test "should be compatible with legacy error handlers" do
+    exception = StandardError.new("Oh my, the job has failed!")
+    Stalker.error { |e| $handled = e }
+    Stalker.job('my.job') { |args| raise exception }
+    Stalker.enqueue('my.job', :foo => 123)
+    Stalker.prep
+    Stalker.work_one_job
+    assert_equal exception, $handled
+  end
 
-	test "continue working when error handler not defined" do
-		Stalker.job('my.job') { fail }
-		Stalker.enqueue('my.job')
-		Stalker.prep
-		Stalker.work_one_job
-		assert_equal false, $handled
-	end
+  test "continue working when error handler not defined" do
+    Stalker.job('my.job') { fail }
+    Stalker.enqueue('my.job')
+    Stalker.prep
+    Stalker.work_one_job
+    assert_equal false, $handled
+  end
 
-	test "exception raised one second before beanstalk ttr reached" do
-		with_an_error_handler
-		Stalker.job('my.job') { sleep(3); $handled = "didn't time out" }
-		Stalker.enqueue('my.job', {}, :ttr => 2)
-		Stalker.prep
-		Stalker.work_one_job
-		assert_equal Stalker::JobTimeout, $handled
-	end
+  test "exception raised one second before beanstalk ttr reached" do
+    with_an_error_handler
+    Stalker.job('my.job') { sleep(3); $handled = "didn't time out" }
+    Stalker.enqueue('my.job', {}, :ttr => 2)
+    Stalker.prep
+    Stalker.work_one_job
+    assert_equal Stalker::JobTimeout, $handled
+  end
 
-	test "before filter gets run first" do
-		Stalker.before { |name| $flag = "i_was_here" }
-		Stalker.job('my.job') { |args| $handled = ($flag == 'i_was_here') }
-		Stalker.enqueue('my.job')
-		Stalker.prep
-		Stalker.work_one_job
-		assert_equal true, $handled
-	end
+  test "before filter gets run first" do
+    Stalker.before { |name| $flag = "i_was_here" }
+    Stalker.job('my.job') { |args| $handled = ($flag == 'i_was_here') }
+    Stalker.enqueue('my.job')
+    Stalker.prep
+    Stalker.work_one_job
+    assert_equal true, $handled
+  end
 
-	test "before filter passes the name of the job" do
-		Stalker.before { |name| $jobname = name }
-		Stalker.job('my.job') { true }
-		Stalker.enqueue('my.job')
-		Stalker.prep
-		Stalker.work_one_job
-		assert_equal 'my.job', $jobname
-	end
+  test "before filter passes the name of the job" do
+    Stalker.before { |name| $jobname = name }
+    Stalker.job('my.job') { true }
+    Stalker.enqueue('my.job')
+    Stalker.prep
+    Stalker.work_one_job
+    assert_equal 'my.job', $jobname
+  end
 
-	test "before filter can pass an instance var" do
-		Stalker.before { |name| @foo = "hello" }
-		Stalker.job('my.job') { |args| $handled = (@foo == "hello") }
-		Stalker.enqueue('my.job')
-		Stalker.prep
-		Stalker.work_one_job
-		assert_equal true, $handled
-	end
+  test "before filter can pass an instance var" do
+    Stalker.before { |name| @foo = "hello" }
+    Stalker.job('my.job') { |args| $handled = (@foo == "hello") }
+    Stalker.enqueue('my.job')
+    Stalker.prep
+    Stalker.work_one_job
+    assert_equal true, $handled
+  end
 
-	test "before filter invokes error handler when defined" do
-		with_an_error_handler
-		Stalker.before { |name| fail }
-		Stalker.job('my.job') {	}
-		Stalker.enqueue('my.job', :foo => 123)
-		Stalker.prep
-		Stalker.work_one_job
-		assert $handled
-		assert_equal 'my.job', $job_name
-		assert_equal({'foo' => 123}, $job_args)
-	end
+  test "before filter invokes error handler when defined" do
+    with_an_error_handler
+    Stalker.before { |name| fail }
+    Stalker.job('my.job') {  }
+    Stalker.enqueue('my.job', :foo => 123)
+    Stalker.prep
+    Stalker.work_one_job
+    assert $handled
+    assert_equal 'my.job', $job_name
+    assert_equal({'foo' => 123}, $job_args)
+  end
+  
+  test "parse BEANSTALK_URL" do
+    ENV['BEANSTALK_URL'] = "beanstalk://localhost:12300"
+    assert_equal Stalker.beanstalk_addresses, ["localhost:12300"]
+    ENV['BEANSTALK_URL'] = "beanstalk://localhost:12300/, beanstalk://localhost:12301/"
+    assert_equal Stalker.beanstalk_addresses, ["localhost:12300","localhost:12301"]
+    ENV['BEANSTALK_URL'] = "beanstalk://localhost:12300   beanstalk://localhost:12301"
+    assert_equal Stalker.beanstalk_addresses, ["localhost:12300","localhost:12301"]
+    ENV['BEANSTALK_URL'] = "beanstalk://localhost:12300, http://localhost:12301"
+    assert_raise Stalker::BadURL do
+      Stalker.beanstalk_addresses 
+    end
+  end
 
 end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stalker
 version: !ruby/object:Gem::Version 
+  hash: 59
   prerelease: 
-  version: 0.8.0
+  segments: 
+  - 0
+  - 9
+  - 0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Adam Wiggins
@@ -10,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-11 00:00:00 -08:00
-default_executable: stalk
+date: 2011-04-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: beanstalk-client
@@ -21,6 +25,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -32,6 +39,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -52,8 +62,7 @@ files:
 - examples/enqueue.rb
 - examples/jobs.rb
 - test/stalker_test.rb
-has_rdoc: true
-homepage: http://github.com/adamwiggins/stalker
+homepage: https://github.com/han/stalker
 licenses: []
 
 post_install_message: 
@@ -66,17 +75,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: stalker
-rubygems_version: 1.5.0
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: A job queueing and background workers system using Beanstalkd.