qup 1.1.0 → 1.2.0

data/HISTORY.rdoc

@@ -1,9 +1,14 @@
 = Changelog
 
-== Version 1.0.0 - 2012-03-10
+== Version 1.2.0 - 2012-03-17
 
-* Initial public release
+* Persistent subscriptions for the Redis Adapter (thanks aniero)
 
 == Version 1.1.0 - 2012-03-12
 
 * Addition of a Redis Adapter (thanks aniero)
+
+== Version 1.0.0 - 2012-03-10
+
+* Initial public release
+

data/README.rdoc

@@ -8,9 +8,10 @@ Qup is a generalized API for Message Queue and Publish/Subscribe messaging
 patterns with the ability to plug in an appropriate messaging infrastructure
 based upon your needs.
 
-Qup ships with support for {Kestrel}[https://github.com/robey/kestrel] and a
-filesystem infrastructure based on {Maildir}[https://rubygems.org/gems/maildir].
-Additional Adapters will be developed as needs arise. {Please submit an
+Qup ships with support for {Kestrel}[https://github.com/robey/kestrel],
+{Redis}[http://redis.io], and a filesystem infrastructure based on
+{Maildir}[https://rubygems.org/gems/maildir]. Additional Adapters will be
+developed as needs arise. {Please submit an
 Issue}[https://github.com/copiousfreetime/qup/issues] to have a new Adapter
 created. Pull requests gladly accepted.
 

data/Rakefile

@@ -62,6 +62,7 @@ end
 # RDoc
 #------------------------------------------------------------------------------
 begin
+  gem 'rdoc' # otherwise we get the wrong task from stdlib
   require 'rdoc/task'
   RDoc::Task.new do |t|
     t.markup   = 'tomdoc'
@@ -237,7 +238,7 @@ BEGIN {
   This = OpenStruct.new
   desc = Util.section_of( 'README.rdoc', 'DESCRIPTION')
   This.summary     = desc.first
-  This.description = desc.join("\n\n")
+  This.description = desc.join(" ").tr("\n", ' ').gsub(/[{}]/,'').gsub(/\[[^\]]+\]/,'') # strip rdoc
 
 
   This.exclude_from_manifest = %r/tmp$|\.(git|DS_Store)|^(doc|coverage|pkg)|\.gemspec$|\.swp$|\.jar|\.rvmrc$|~$/

data/lib/qup.rb

@@ -1,6 +1,6 @@
 module Qup
   # The Current Version of the library
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 
   class Error < StandardError; end
 

data/lib/qup/adapter/redis/queue.rb

@@ -9,12 +9,14 @@ class Qup::Adapter::Redis
 
     # Internal: create a new Queue
     #
-    # uri  - the connection uri for the Redis Client
-    # name - the String name of the Queue
+    # uri        - the connection uri for the Redis Client
+    # name       - the String name of the Queue
+    # topic_name - (optional) the String name of a parent topic
     #
     # Returns a new Queue.
-    def initialize( uri, name )
-      super
+    def initialize( uri, name, topic_name = nil )
+      super uri, name
+      @topic_name = topic_name
       @open_messages = {}
     end
 
@@ -25,6 +27,7 @@ class Qup::Adapter::Redis
     # Returns nothing.
     def destroy
       @client.del name
+      @client.srem @topic_name, name if @topic_name
     end
 
     # Internal: Empty the queue
@@ -73,7 +76,7 @@ class Qup::Adapter::Redis
     #
     # Returns a Message
     def consume(&block)
-      queue_name, data = @client.brpop @name, 0 # blocking pop
+      queue_name, data = @client.brpop name, 0 # blocking pop
       message = ::Qup::Message.new( data.object_id, data )
       @open_messages[message.key] = message
       if block_given? then

data/lib/qup/adapter/redis/topic.rb

@@ -11,17 +11,6 @@ class Qup::Adapter::Redis
   class Topic < Connection
     include Qup::TopicAPI
 
-    # Internal: create a new Topic
-    #
-    # uri  - the connection uri for the Redis Client
-    # name - the String name of the Topic
-    #
-    # Returns a new Topic.
-    def initialize(uri, name)
-      super
-      @subscribers = Hash.new
-    end
-
     # Internal: Creates a Publisher for the Topic
     #
     # Returns a new Publisher
@@ -29,7 +18,7 @@ class Qup::Adapter::Redis
       ::Qup::Publisher.new( self )
     end
 
-    # Internal: Create a subscriber for the Topic
+    # Internal: Create and register a subscriber for the Topic
     #
     # name - the String name of the subscriber
     #
@@ -38,14 +27,17 @@ class Qup::Adapter::Redis
     #
     # Returns a Subscriber
     def subscriber(name)
-      ::Qup::Subscriber.new( self, subscriber_queue_for(name) )
+      subscriber_name = "#{@name}.#{name}"
+      @client.sadd @name, subscriber_name
+      queue = ::Qup::Adapter::Redis::Queue.new(@uri, subscriber_name, @name)
+      ::Qup::Subscriber.new( self, queue )
     end
 
     # Internal: Return the number of Subscribers to this Topic
     #
     # Returns integer
     def subscriber_count
-      @subscribers.size
+      subscribers.size
     end
 
     # Internal: Publish a Message to all the Subscribers
@@ -54,8 +46,8 @@ class Qup::Adapter::Redis
     #
     # Returns nothing
     def publish( message )
-      @subscribers.values.each do |subscriber|
-        subscriber.produce message
+      subscribers.each do |subscriber|
+        @client.lpush subscriber, message
       end
     end
 
@@ -63,14 +55,12 @@ class Qup::Adapter::Redis
     private
     #######
 
-    # Private: create and register new sub-Queue for the given subscriber
-    #
-    # name - the name of the subscriber
+    # Private: retrieve the current list of subscribers
     #
-    # Returns a Queue
-    def subscriber_queue_for(name)
-      @subscribers[name] ||=
-        ::Qup::Adapter::Redis::Queue.new(@uri, "#{@name}-#{name}")
+    # Returns an array of subscriber queue names
+    def subscribers
+      @client.smembers @name
     end
+
   end
 end

data/lib/qup/session.rb

@@ -7,6 +7,7 @@ module Qup
   #
   #   Session.new( 'maildir:///tmp/qup' )
   #   Session.new( 'kestrel://user:pass@host:port/' )
+  #   Session.new( 'redis://host:port' )
   #
   #   session.queue( 'foo' ) # => Queue
   #   session.topic( 'bar' ) # => Topic

data/spec/qup/adapter/redis/queue_spec.rb

@@ -6,4 +6,28 @@ describe 'Qup::Adapter::Redis::Queue', :redis => true do
   include_context "Qup::Adapter::Redis"
   include_context "Qup::Queue"
   it_behaves_like Qup::QueueAPI
+
+  context "when initialized with a parent topic's name" do
+    let(:redis) { Redis.new :host => uri.host, :port => uri.port }
+    let(:queue) { Qup::Adapter::Redis::Queue.new(uri, "test", "parent") }
+
+    before do
+      redis.del "parent"
+      redis.sadd "parent", "test"
+    end
+
+    after do
+      redis.del "parent"
+      redis.client.disconnect
+    end
+
+    describe "#destroy" do
+      it "removes its name from the parent topic's subscriber set" do
+        redis.smembers("parent").should == ["test"]
+        queue.destroy
+        redis.smembers("parent").should == []
+      end
+    end
+
+  end
 end

data/spec/qup/adapter/redis/topic_spec.rb

@@ -6,4 +6,24 @@ describe 'Qup::Adapter::Redis::Topic', :redis => true  do
   include_context "Qup::Adapter::Redis"
   include_context "Qup::Topic"
   it_behaves_like Qup::TopicAPI
+
+  describe "#subscriber" do
+
+    let(:topic)      { adapter.topic "test" }
+    let(:subscriber) { topic.subscriber "testing" }
+
+    before do
+      topic && subscriber # create and register the subscriber
+    end
+
+    after do
+      topic.destroy
+    end
+
+    it "unregisters itself from the Topic when unsubscribed" do
+      lambda do
+        subscriber.unsubscribe
+      end.should change(topic, :subscriber_count).by(-1)
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: qup
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: 
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Jeremy Hinegardner
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-12 00:00:00 Z
+date: 2012-03-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: maildir
@@ -145,16 +145,7 @@ dependencies:
         version: "3.12"
   type: :development
   version_requirements: *id008
-description: |-
-  Qup is a generalized API for Message Queue and Publish/Subscribe messaging
-  patterns with the ability to plug in an appropriate messaging infrastructure
-  based upon your needs.
-  
-  Qup ships with support for {Kestrel}[https://github.com/robey/kestrel] and a
-  filesystem infrastructure based on {Maildir}[https://rubygems.org/gems/maildir].
-  Additional Adapters will be developed as needs arise. {Please submit an
-  Issue}[https://github.com/copiousfreetime/qup/issues] to have a new Adapter
-  created. Pull requests gladly accepted.
+description: Qup is a generalized API for Message Queue and Publish/Subscribe messaging patterns with the ability to plug in an appropriate messaging infrastructure based upon your needs. Qup ships with support for Kestrel, Redis, and a filesystem infrastructure based on Maildir. Additional Adapters will be developed as needs arise. Please submit an Issue to have a new Adapter created. Pull requests gladly accepted.
 email: jeremy@copiousfreetime.org
 executables: []