simplejob 0.1.0 → 0.2.0

data/README.md

@@ -1,32 +1,37 @@
-Simple Job Queue
-================
+simplejob
+=========
 
 Painless job queueing, backed by AMQP.
 
-The design goals were:
-
 * Super simple interface
 * Robust jobs that never get lost
-* Jobs don't get marked complete until they are finished (they survive reboots)
-* One job queue per worker pool, with jobs mapped to that queue (for easy monitoring)
-* Jobs which throw exceptions are logged and removed, preventing infinite job loops
+* Jobs don't get marked complete until they are finished (they survive reboots/kill -9)
+* One work queue per worker pool, with one or more job names mapped to each work queue (for easy monitoring)
+* Jobs which throw exceptions are logged and removed, preventing infinite job-retry loops
+
+Installation
+------------
 
-Hello World
------------
+<pre>
+$ gem install simplejob
+</pre>
+
+Example
+-------
 
 Start your [RabbitMQ](http://www.rabbitmq.com/) server (install one if necessary).
 
-<pre>
-producer.rb:
+### Producer
 
+<pre>
 require "simplejob"
 
 SimpleJob.send("hello")
 </pre>
 
-<pre>
-consumer.rb:
+### Consumer
 
+<pre>
 require "simplejob"
 
 SimpleJob::Worker.start do
@@ -36,15 +41,14 @@ SimpleJob::Worker.start do
 end
 </pre>
 
-<pre>
-$ ruby -rubygems consumer.rb
-</pre>
+### Run
 
 <pre>
 $ ruby -rubygems producer.rb
+$ ruby -rubygems consumer.rb
 </pre>
 
 More examples
 -------------
 
-See the [examples directory](http://github.com/kenpratt/simple-job-queue/tree/master/examples).
+See the [examples directory](http://github.com/kenpratt/simplejob/tree/master/examples).

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/examples/chained_jobs/README.md

@@ -0,0 +1,9 @@
+Chained jobs
+============
+
+Open the consumer in a terminal window, and then run the producer:
+
+    ruby -rubygems consumer.rb
+    ruby -rubygems producer.rb
+
+You should see the consumer processing each step of the request. Try starting up more consumers or running the producer more than once.

data/examples/chained_jobs/consumer.rb

@@ -0,0 +1,35 @@
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require "simplejob"
+
+SimpleJob::Worker.start do
+  handle "step1" do |props|
+    x = props[:x]
+    puts "step1: x = #{x}"
+
+    sleep 0.5
+    send "step2", { :x => x + x }
+  end
+
+  handle "step2" do |props|
+    x = props[:x]
+    puts "step2: x = #{x}"
+
+    sleep 0.5
+    send "step3", { :x => x * 3 }
+  end
+
+  handle "step3" do |props|
+    x = props[:x]
+    puts "step3: x = #{x}"
+
+    sleep 0.5
+    send "step4", { :x => x - 42 }
+  end
+
+  handle "step4" do |props|
+    x = props[:x]
+    puts "step4: x = #{x}"
+    puts "FIN"
+  end
+end

data/examples/chained_jobs/producer.rb

@@ -0,0 +1,5 @@
+$:.unshift(File.expand_path("../../../lib", __FILE__))
+
+require "simplejob"
+
+SimpleJob.send("step1", :x => 12)

data/lib/simplejob/client.rb

@@ -1,5 +1,3 @@
-require "amqp"
-
 module SimpleJob
   DEFAULT_EXCHANGE_NAME = "simplejob"
 
@@ -46,5 +44,33 @@ module SimpleJob
     def subscribe(queue, &proc)
       queue.subscribe({ :ack => true }, &proc)
     end
+
+    alias_method :orig_send, :send
+    def send(topic, props = {})
+      raise "Message properties should be a Hash" unless props.kind_of?(Hash)
+      log.info "[simplejob] New job: #{topic}, #{props.inspect}"
+      publish(topic, props.to_json)
+    end
+
+    private
+
+    def log
+      Client.log
+    end
+
+    def self.log
+      @logger ||= setup_logger
+    end
+
+    def self.setup_logger
+      if defined?(LOGGER)
+        LOGGER
+      elsif defined?(Rails.logger)
+        Rails.logger
+      else
+        Logger.new(STDOUT)
+      end
+    end
+
   end
 end

data/lib/simplejob/worker.rb

@@ -1,5 +1,3 @@
-require "active_support/core_ext/hash"
-
 module SimpleJob
   class Worker < Client
     def start(opts, &proc)
@@ -15,9 +13,16 @@ module SimpleJob
 
         # start processing jobs
         start_handler_loop
+
+        log.info "[worker] Started"
       end
     end
 
+    def stop
+      super
+      log.info "[worker] Stopped"
+    end
+
     def handle(key, &proc)
       # bind the message to the queue
       bind(@queue, key)

data/lib/simplejob.rb

@@ -1,5 +1,7 @@
+require "amqp"
 require "json"
 require "logger"
+require "active_support/core_ext/hash"
 
 require "simplejob/client"
 require "simplejob/worker"
@@ -9,15 +11,9 @@ module SimpleJob
   # Send a work request
   def self.send(topic, props = {})
     Client.start do
-      raise "Message properties should be a Hash" unless props.kind_of?(Hash)
-      log.info "[simplejob] New job: #{topic}, #{props.inspect}"
-      publish(topic, props.to_json)
+      send(topic, props)
       stop
     end
   end
 
 end
-
-def log
-  Logger.new(STDOUT)
-end

data/simplejob.gemspec

@@ -0,0 +1,70 @@
+# 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{simplejob}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Ken Pratt}]
+  s.date = %q{2011-05-06}
+  s.description = %q{A simple AMQP-backed job queuing system.}
+  s.email = %q{ken@kenpratt.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "examples/basic/README.md",
+    "examples/basic/consumer.rb",
+    "examples/basic/producer.rb",
+    "examples/chained_jobs/README.md",
+    "examples/chained_jobs/consumer.rb",
+    "examples/chained_jobs/producer.rb",
+    "examples/multiple_jobs/README.md",
+    "examples/multiple_jobs/drink_consumer.rb",
+    "examples/multiple_jobs/food_consumer.rb",
+    "examples/multiple_jobs/producer.rb",
+    "examples/wildcard_handlers/README.md",
+    "examples/wildcard_handlers/consumer.rb",
+    "examples/wildcard_handlers/producer.rb",
+    "examples/wildcard_handlers/wiretap.rb",
+    "lib/simplejob.rb",
+    "lib/simplejob/client.rb",
+    "lib/simplejob/worker.rb",
+    "simplejob.gemspec",
+    "test/helper.rb",
+    "test/test_simplejob.rb"
+  ]
+  s.homepage = %q{http://github.com/kenpratt/simplejob}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.1}
+  s.summary = %q{Painless job queueing.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.1"])
+      s.add_runtime_dependency(%q<json>, [">= 1.5.1"])
+      s.add_runtime_dependency(%q<amqp>, ["= 0.7.1"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0.1"])
+      s.add_dependency(%q<json>, [">= 1.5.1"])
+      s.add_dependency(%q<amqp>, ["= 0.7.1"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0.1"])
+    s.add_dependency(%q<json>, [">= 1.5.1"])
+    s.add_dependency(%q<amqp>, ["= 0.7.1"])
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: simplejob
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ken Pratt
@@ -83,6 +83,9 @@ files:
 - examples/basic/README.md
 - examples/basic/consumer.rb
 - examples/basic/producer.rb
+- examples/chained_jobs/README.md
+- examples/chained_jobs/consumer.rb
+- examples/chained_jobs/producer.rb
 - examples/multiple_jobs/README.md
 - examples/multiple_jobs/drink_consumer.rb
 - examples/multiple_jobs/food_consumer.rb
@@ -94,6 +97,7 @@ files:
 - lib/simplejob.rb
 - lib/simplejob/client.rb
 - lib/simplejob/worker.rb
+- simplejob.gemspec
 - test/helper.rb
 - test/test_simplejob.rb
 homepage: http://github.com/kenpratt/simplejob