qup 1.1.0

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

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'qup/shared_queue_examples'
+require 'qup/adapter/kestrel_context'
+
+describe 'Qup::Adapter::Kestrel::Queue', :kestrel => true do
+  include_context "Qup::Adapter::Kestrel"
+  include_context "Qup::Queue"
+  it_behaves_like Qup::QueueAPI
+end

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

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'qup/shared_topic_examples'
+require 'qup/adapter/kestrel_context'
+
+describe 'Qup::Adapter::Kestrel::Topic', :kestrel => true do
+  include_context "Qup::Adapter::Kestrel"
+  include_context "Qup::Topic"
+  it_behaves_like Qup::TopicAPI
+end

data/spec/qup/adapter/kestrel_context.rb

@@ -0,0 +1,8 @@
+# The Shared Context that all the Kestrel tests need to run.
+# It is assumed that there is a Kestrel server running on localhost port 22133
+shared_context "Qup::Adapter::Kestrel" do
+  let( :uri     ) { URI.parse( "kestrel://localhost:22133/" )   }
+  let( :adapter ) { ::Qup::Adapter::Kestrel.new( uri )          }
+end
+
+

data/spec/qup/adapter/kestrel_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'qup/shared_adapter_examples'
+require 'qup/adapter/kestrel_context'
+
+describe 'Qup::Adapter::Kestrel', :kestrel => true do
+  include_context "Qup::Adapter::Kestrel"
+  it_behaves_like Qup::Adapter
+end

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

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'qup/shared_queue_examples'
+require 'qup/adapter/maildir_context'
+
+describe 'Qup::Adapter::Maildir::Queue', :maildir => true do
+  include_context "Qup::Adapter::Maildir"
+  include_context "Qup::Queue"
+  it_behaves_like Qup::QueueAPI
+end

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

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'qup/shared_topic_examples'
+require 'qup/adapter/maildir_context'
+
+describe 'Qup::Adapter::Maildir::Topic', :maildir => true  do
+  include_context "Qup::Adapter::Maildir"
+  include_context "Qup::Topic"
+  it_behaves_like Qup::TopicAPI
+end

data/spec/qup/adapter/maildir_context.rb

@@ -0,0 +1,10 @@
+# The common context needed for all the Maildir Adapter tests.
+#
+# All the maildir tests will be run in the 'path' below
+shared_context 'Qup::Adapter::Maildir' do
+  let( :path    ) { temp_dir( "qup-maildir" )          }
+  let( :uri     ) { URI.parse( "maildir://#{path}" )   }
+
+  # Needed to support the Shared Examples
+  let( :adapter ) { ::Qup::Adapter::Maildir.new( uri ) }
+end

data/spec/qup/adapter/maildir_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'qup/shared_adapter_examples'
+require 'qup/adapter/maildir_context'
+
+describe 'Qup::Adapter::Maildir', :maildir => true do
+  include_context "Qup::Adapter::Maildir"
+  it_behaves_like ::Qup::Adapter
+end

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

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'qup/shared_queue_examples'
+require 'qup/adapter/redis_context'
+
+describe 'Qup::Adapter::Redis::Queue', :redis => true do
+  include_context "Qup::Adapter::Redis"
+  include_context "Qup::Queue"
+  it_behaves_like Qup::QueueAPI
+end

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

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'qup/shared_topic_examples'
+require 'qup/adapter/redis_context'
+
+describe 'Qup::Adapter::Redis::Topic', :redis => true  do
+  include_context "Qup::Adapter::Redis"
+  include_context "Qup::Topic"
+  it_behaves_like Qup::TopicAPI
+end

data/spec/qup/adapter/redis_context.rb

@@ -0,0 +1,6 @@
+# The shared context that all the Redis tests need to run.
+# It is assumed that there is a Redis server running on localhost port 6379
+shared_context "Qup::Adapter::Redis" do
+  let( :uri     ) { URI.parse( "redis://localhost:6379/" ) }
+  let( :adapter ) { ::Qup::Adapter::Redis.new( uri )       }
+end

data/spec/qup/adapter/redis_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'qup/shared_adapter_examples'
+require 'qup/adapter/redis_context'
+
+describe 'Qup::Adapter::Redis', :redis => true do
+  include_context "Qup::Adapter::Redis"
+  it_behaves_like Qup::Adapter
+end

data/spec/qup/adapter_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+class Qup::AdapterTest < Qup::Adapter
+  register :quptest
+end
+
+describe 'Adapter Registration' do
+  it 'registers an adapter' do
+    Qup::Adapters['quptest'].should eq Qup::AdapterTest
+  end
+end
+
+describe "Not Implementing the Adapter API" do
+  let( :api ) { Qup::AdapterTest.new }
+
+  %w[ close closed? ].each do |method|
+    it "##{method} kaboom!" do
+      lambda { api.send( method ) }.should raise_error( NotImplementedError, "please implement '#{method}'" )
+    end
+  end
+
+  %w[ queue topic ].each do |method|
+    it "##{method} kaboom!" do
+      lambda { api.send( method, 'foo' ) }.should raise_error( NotImplementedError, "please implement '#{method}'" )
+    end
+  end
+
+end

data/spec/qup/consumer_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Qup::Consumer do
+
+  let( :path     ) { temp_dir( "qup-consumer" )      }
+  let( :queue    ) { ::Qup::Adapter::Maildir::Queue.new( path, 'bar' ) }
+  let( :producer ) { queue.producer                  }
+  let( :consumer ) { queue.consumer                  }
+
+  before do
+    producer.produce( 'consumption' )
+  end
+
+  after do
+    FileUtils.rm_rf( path )
+  end
+
+  it "consumes an item from the queue" do
+    msg = consumer.consume
+    msg.data.should eq 'consumption'
+    queue.acknowledge msg
+    queue.depth.should eq 0
+  end
+
+  it "acknowledges messages it has consumed" do
+    msg = consumer.consume
+    msg.data.should eq 'consumption'
+    queue.depth.should eq 1
+    consumer.acknowledge( msg )
+    queue.depth.should eq 0
+  end
+
+  it "consumes auto-acknowledges msgs in a block" do
+    consumer.consume do |msg|
+      msg.data.should eq 'consumption'
+    end
+    queue.depth.should eq 0
+  end
+
+end

data/spec/qup/message_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Qup::Message do
+  let( :message ) { Qup::Message.new( "my unique key", "some data" ) }
+
+  it "has a key" do
+    message.key.should == 'my unique key'
+  end
+
+  it 'has data' do
+    message.data.should == 'some data'
+  end
+end

data/spec/qup/producer_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Qup::Producer do
+
+  let( :path     ) { temp_dir( "qup-producer" )      }
+  let( :queue    ) { ::Qup::Adapter::Maildir::Queue.new( path, 'baz' ) }
+  let( :producer ) { queue.producer                  }
+
+  after do
+    FileUtils.rm_rf( path )
+  end
+
+  it "produces items onto the queue" do
+    queue.depth.should eq 0
+    producer.produce( 'production' )
+    queue.depth.should eq 1
+  end
+end

data/spec/qup/queue_api_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+class Qup::QueueAPITest
+  include Qup::QueueAPI
+end
+
+describe "Not Implementing the Queue API" do
+  let( :api ) { Qup::QueueAPITest.new }
+
+  %w[ name depth flush destroy consume ].each do |method|
+    it "##{method} kaboom!" do
+      lambda { api.send( method ) }.should raise_error( NotImplementedError, "please implement '#{method}'" )
+    end
+  end
+
+  %w[ produce acknowledge ].each do |method|
+    it "##{method} kaboom!" do
+      lambda { api.send( method, nil ) }.should raise_error( NotImplementedError, "please implement '#{method}'" )
+    end
+  end
+end

data/spec/qup/session_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe Qup::Session do
+
+  let( :path    ) { temp_dir( "qup-session" ) }
+  let( :uri     ) { "maildir://#{path}"       }
+  let( :session ) { ::Qup::Session.new( uri ) }
+
+  after do
+    FileUtils.rm_rf( path )
+  end
+
+  it "has a uri" do
+    session.uri.to_s.should == "maildir:#{path}"
+  end
+
+  it 'can be closed' do
+    session.closed?.should be_false
+    session.close
+    session.closed?.should be_true
+  end
+
+  describe '#open' do
+    it 'returns a new session' do
+      s = Qup::Session.open( uri )
+      s.closed?.should be_false
+    end
+
+    it 'yields a new session' do
+      Qup::Session.open( uri ) do |s|
+        s.closed?.should be_false
+      end
+    end
+
+    it 'closes a session at the end of the block' do
+      save_s = nil
+      Qup::Session.open( uri ) do |s|
+        s.closed?.should be_false
+        save_s = s
+      end
+      save_s.closed?.should be_true
+    end
+  end
+
+  describe '#queue' do
+    it "can return a Queue" do
+      q = session.queue( 'foo' )
+      q.name.should == 'foo'
+    end
+
+    it 'can yield a Queue' do
+      session.queue( 'foo' ) do |q|
+        q.name.should == 'foo'
+      end
+    end
+
+    it 'raises an error if accessing a closed Session' do
+      session.close
+      lambda { session.queue( 'boom' ) }.should raise_error( Qup::Session::ClosedError, /Session (.*) is closed/ )
+    end
+  end
+
+
+  describe '#topic' do
+    it "can return a Topic" do
+      t = session.topic('t')
+      t.name.should == 't'
+    end
+
+    it 'can yiled a Topic' do
+      session.topic('t') do |t|
+        t.name.should == 't'
+      end
+    end
+
+    it 'raises an error if accessing a closed Session' do
+      session.close
+      lambda { session.topic( 'boom' ) }.should raise_error( Qup::Session::ClosedError, /Session (.*) is closed/ )
+    end
+  end
+end

data/spec/qup/shared_adapter_examples.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+# The Adapter share context requires that the context is include in define:
+#
+#   let( :adapter )
+#
+shared_examples Qup::Adapter do
+  it 'is registered as an adapter' do
+    Qup::Adapters[uri.scheme].should eq adapter.class
+  end
+
+  it 'can be closed' do
+    adapter.closed?.should be_false
+    adapter.close
+    adapter.closed?.should be_true
+  end
+
+  it 'can create a QueueAPI-like object' do
+    q = adapter.queue( 'q' )
+    q.should be_kind_of( Qup::QueueAPI )
+    q.name.should eq 'q'
+  end
+
+  it 'can create a QueueAPI-like object' do
+    t = adapter.topic( 't' )
+    t.should be_kind_of( Qup::TopicAPI )
+    t.name.should eq 't'
+  end
+end

data/spec/qup/shared_queue_examples.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+# The Queue share context requires that the context is include in define:
+#
+#   let( :adapter )
+#
+shared_context "Qup::Queue" do
+
+  let( :queue ) { adapter.queue( 'foo' ) }
+
+  after do
+    queue.destroy
+  end
+
+end
+
+shared_examples Qup::QueueAPI do
+
+  it "has a name" do
+    queue.name.should eq 'foo'
+  end
+
+  it "#produce" do
+    queue.depth.should eq 0
+    queue.produce( "a new message" )
+    queue.depth.should eq 1
+  end
+
+  it "#flush" do
+    10.times { |x| queue.produce( "message #{x}" ) }
+    queue.depth.should eq 10
+    queue.flush
+    queue.depth.should eq 0
+  end
+
+  describe '#consume' do
+    before do
+      queue.produce( "consumeable message" )
+      queue.depth.should eq 1
+    end
+
+    it 'normally' do
+      msg = queue.consume
+      msg.data.should eq "consumeable message"
+    end
+
+    it 'with block it auto acknowledges' do
+      queue.consume do |msg|
+        msg.data.should eq 'consumeable message'
+      end
+    end
+  end
+
+  describe "#acknowledge" do
+    it "acks a message" do
+      queue.produce( "acknowledgeable message" )
+      queue.depth.should eq 1
+
+      msg = queue.consume
+      msg.data.should eq "acknowledgeable message"
+
+      queue.acknowledge( msg )
+      queue.depth.should eq 0
+    end
+
+    it "raises an error if you attempt to to acknowledge an unconsumed message" do
+      msg = queue.produce( 'unconsumed' )
+      lambda { queue.acknowledge( msg ) }.should raise_error(Qup::Error)
+    end
+  end
+end

data/spec/qup/shared_topic_examples.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+# The Queue share context requires that the context is include in define:
+#
+#   let( :adapter )
+#
+shared_context "Qup::Topic" do
+
+  before do
+    @topic = adapter.topic( 'topic' )
+  end
+
+  after do
+    @topic.destroy
+  end
+end
+
+
+shared_examples Qup::TopicAPI do
+
+  it "has a name" do
+    @topic.name.should == 'topic'
+  end
+
+  it "creates publisher" do
+    p = @topic.publisher
+    p.topic.should eq @topic
+  end
+
+
+  describe "subscribers" do
+    before do
+      @subs = []
+      3.times do |x|
+        @subs << @topic.subscriber( "sub-#{x}")
+      end
+    end
+
+    after do
+      @subs.each { |s| s.unsubscribe }
+    end
+
+    it "are counted" do
+      @topic.subscriber_count.should eq 3
+    end
+
+    it "each receives a copy of the message" do
+      p = @topic.publisher
+      p.publish( "hi all" )
+
+      @subs.each do |sub|
+        msg = sub.consume
+        msg.data.should eq 'hi all'
+      end
+    end
+  end
+end