simple_queues 1.0.3 → 1.0.4

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 pkg/*
 doc/*
+dump.rdb

data/README.textile

@@ -13,8 +13,8 @@ h2. Usage
 <pre><code>require "simple_queues"
 Queues = SimpleQueues::Redis.new
 
-Queues.enqueue :pages_to_crawl, {:url => "http://blog.teksol.info"}.to_json
-Queues.enqueue :pages_to_crawl, {:url => "http://techcrunch.com"}.to_json
+Queues.enqueue :pages_to_crawl, :url => "http://blog.teksol.info"
+Queues.enqueue :pages_to_crawl, :url => "http://techcrunch.com"
 
 # In another process
 
@@ -34,6 +34,27 @@ loop do
 end
 <code></pre>
 
+h1. Multiple Queues
+
+Sometimes, you want to dequeue from multiple queues simultaneously, and react appropriately. When that happens, you need to use the <code>#on_dequeue</code> method:
+
+<pre><code>require "simple_queues"
+Queues = SimpleQueues::Redis.new
+
+$running = true
+Queues.on_dequeue :crawler_controls do |message|
+  $running = false if message["command"] == "quit"
+end
+
+Queues.on_dequeue :pages_to_crawl do |message|
+  # Handle crawling a page
+end
+
+while $running do
+  Queues.dequeue_with_timeout 5 #seconds
+end
+</code></pre>
+
 h2. LICENSE
 
 (The MIT License)

data/lib/simple_queues/redis.rb

@@ -11,10 +11,12 @@ module SimpleQueues
     end
 
     def serialize(message)
+      raise ArgumentError, "message must be non-nil" if message.nil?
+      raise ArgumentError, "message must be respond to #to_json" unless message.respond_to?(:to_json)
       message.to_json
     end
 
-    def unserialize(message)
+    def deserialize(message)
       JSON.parse(message) if message
     end
 
@@ -25,7 +27,9 @@ module SimpleQueues
     # @return No useful value.
     # @raise ArgumentError Whenever the queue name or the message are nil, or the queue name is empty.
     def enqueue(queue_name, message)
-      @redis.rpush(q_name(queue_name), serialize(message))
+      msg = serialize(message)
+      @redis.rpush(q_name(queue_name), msg)
+      msg
     end
 
     # Dequeues a message, and waits forever for one to arrive.
@@ -48,12 +52,12 @@ module SimpleQueues
     # Dequeues a message, or returns +nil+ if the timeout is exceeded.
     #
     # @param queue_name [String, Symbol] The queue name to read from.
-    # @param timeout [#to_i] The number of seconds to wait before returning nil.
+    # @param timeout [#to_f] The number of seconds to wait before returning nil.
     # @return [String, nil] The first message in the queue, or nil if the timeout was exceeded.
     # @raise ArgumentError If +queue_name+ is nil or the empty String.
     def dequeue_with_timeout(queue_name, timeout)
-      queue, result = @redis.blpop(q_name(queue_name), timeout)
-      unserialize(result)
+      queue, result = @redis.blpop(q_name(queue_name), timeout.to_i)
+      deserialize(result)
     end
 
   private

data/lib/simple_queues/version.rb

@@ -1,3 +1,3 @@
 module SimpleQueues
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/spec/enqueueing_spec.rb

@@ -14,6 +14,12 @@ describe SimpleQueues::Redis, "enqueue" do
     queue.enqueue("q", "message")
   end
 
+  it "should return the serialized message" do
+    redis.should_receive(:rpush).twice
+    queue.enqueue("q", "whatever").should == queue.serialize("whatever")
+    queue.enqueue("q", {:message => "whatever"}).should == queue.serialize(:message => "whatever")
+  end
+
   it "should reject invalid queue names" do
     lambda { queue.enqueue(nil, "") }.should raise_error(ArgumentError)
     lambda { queue.enqueue("", "") }.should raise_error(ArgumentError)

data/spec/redis_integration_spec.rb

@@ -5,25 +5,28 @@ describe SimpleQueues::Redis, "enqueue" do
     SimpleQueues::Redis.new
   end
 
+  before(:each) do
+    queue.clear(:test)
+  end
+
   it "communicates with Redis as expected" do
     obj = {"hello" => 42}
     queue.enqueue(:test, obj)
-    queue.dequeue_with_timeout(:test, 2).should == obj
-    queue.dequeue_with_timeout(:test, 2).should == nil
+    queue.dequeue_with_timeout(:test, 1).should == obj
+    queue.dequeue_with_timeout(:test, 1).should == nil
   end
 
   it "clears the queue" do
-    queue.enqueue(:test, 42)
+    queue.enqueue(:test, :yada => "whatever")
     queue.clear(:test)
-    queue.dequeue_with_timeout(:test, 1).should == nil
+    queue.size(:test).should be_zero
   end
 
   it "returns the queue size" do
-    queue.clear(:test)
     queue.enqueue(:test, 42)
     queue.enqueue(:test, 42)
     queue.enqueue(:test, 42)
     queue.enqueue(:test, 42)
     queue.size(:test).should == 4
   end
-end
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: simple_queues
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 3
-  version: 1.0.3
+  prerelease: 
+  version: 1.0.4
 platform: ruby
 authors: 
 - "Fran\xC3\xA7ois Beausoleil"
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-26 00:00:00 -05:00
+date: 2011-03-22 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,8 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -38,8 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -51,8 +43,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id003
@@ -64,8 +54,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id004
@@ -77,8 +65,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id005
@@ -121,21 +107,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Simple enqueue/dequeue API for working with queues