stomper 0.3.0

data/spec/frames/headers_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+module Stomper::Frames
+  describe Headers do
+    before(:each) do
+      @headers = Headers.new
+    end
+
+    it "should set a header by a string key, accessible by all" do
+      @test_value = "a test"
+      @headers['testing'] = @test_value
+      @headers['testing'].should == @test_value
+      @headers[:testing].should == @test_value
+      @headers.testing.should == @test_value
+      @headers.send(:testing).should == @test_value
+    end
+
+    it "should set a header by a symbol key, accessible by all" do
+      @test_value = "another test"
+      @headers[:some_key] = @test_value
+      @headers['some_key'].should == @test_value
+      @headers[:some_key].should == @test_value
+      @headers.some_key.should == @test_value
+      @headers.send(:some_key).should == @test_value
+    end
+
+    it "should set a header by a method, accessible by all" do
+      @test_value = "yet more testing"
+      @headers.another_key = @test_value
+      @headers['another_key'].should == @test_value
+      @headers[:another_key].should == @test_value
+      @headers.another_key.should == @test_value
+      @headers.send(:another_key).should == @test_value
+    end
+
+    it "should override the default id getter and provide a setter" do
+      @test_value = "my id"
+      @headers.id = @test_value
+      @headers.id.should == @test_value
+      @headers['id'].should == @test_value
+      @headers[:id].should == @test_value
+      @headers.send(:id).should == @test_value
+    end
+
+    it "should provide method to convert to stomp compatible headers" do
+      @headers.to_stomp.should be_empty
+      @headers.ack = 'auto'
+      @headers.destination = '/queue/test/1'
+      @headers.to_stomp.should == "ack:auto\ndestination:/queue/test/1\n"
+    end
+
+
+  end
+end

data/spec/frames/server_frame_spec.rb

@@ -0,0 +1,86 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+module Stomper
+  module Frames
+    describe ServerFrame do
+      before(:each) do
+        @server_frame = ServerFrame.new("SERVER COMMAND")
+      end
+
+      it "should provide a method for subclasses to register the command they handle" do
+        ServerFrame.should respond_to(:factory_for)
+      end
+
+      it "should build an appropriate object for a given server frame" do
+        @built_frame = ServerFrame.build("MESSAGE", {'message-id' => 'msg-001' ,'transaction' => 'tx-test', 'subscription' => 'sub-test'}, "message body")
+        @built_frame.should be_an_instance_of(Message)
+        @built_frame.headers.transaction.should == "tx-test"
+        @built_frame.headers.subscription.should == "sub-test"
+        @built_frame.headers[:'message-id'].should == "msg-001"
+        @built_frame.body.should == "message body"
+        @built_frame = ServerFrame.build("AN UNKNOWN COMMAND", {:a_header => "test"}, "a body")
+        @built_frame.should be_an_instance_of(ServerFrame)
+        @built_frame.command.should == "AN UNKNOWN COMMAND"
+        @built_frame.headers.a_header.should == "test"
+        @built_frame.body.should == "a body"
+        class MockServerFrame < ServerFrame
+          factory_for :testing
+          def initialize(headers, body)
+            super('TESTING', headers, body)
+          end
+        end
+        @built_frame = ServerFrame.build("TESTING", {:a_header => "test"}, "a body")
+        @built_frame.should be_an_instance_of(MockServerFrame)
+        @built_frame.headers.a_header.should == "test"
+        @built_frame.body.should == "a body"
+      end
+
+      describe "server frames" do
+        describe Connected do
+          it "should be registered" do
+            @server_frame = ServerFrame.build("CONNECTED", {:a_header => 'test'}, "test body")
+            @server_frame.should be_an_instance_of(Connected)
+            @server_frame.headers.a_header.should == "test"
+            @server_frame.body.should == "test body"
+          end
+        end
+        describe Error do
+          it "should be registered" do
+            @server_frame = ServerFrame.build("ERROR", {:a_header => 'test'}, "test body")
+            @server_frame.should be_an_instance_of(Error)
+            @server_frame.headers.a_header.should == "test"
+            @server_frame.body.should == "test body"
+          end
+        end
+        describe Message do
+          it "should be registered" do
+            @server_frame = ServerFrame.build("MESSAGE", {:a_header => 'test'}, "test body")
+            @server_frame.should be_an_instance_of(Message)
+            @server_frame.headers.a_header.should == "test"
+            @server_frame.body.should == "test body"
+          end
+
+          it "should provide the convenience attributes" do
+            @message = Message.new({:destination => '/queue/testing', :subscription => 'sub-001', :'message-id' => 'msg-001'}, "test body")
+            @message.id.should == "msg-001"
+            @message.destination.should == "/queue/testing"
+            @message.subscription.should == "sub-001"
+          end
+        end
+        describe Receipt do
+          it "should be registered" do
+            @server_frame = ServerFrame.build("RECEIPT", {:a_header => 'test'}, "test body")
+            @server_frame.should be_an_instance_of(Receipt)
+            @server_frame.headers.a_header.should == "test"
+            @server_frame.body.should == "test body"
+          end
+
+          it "should provide the convenience attributes" do
+            @receipt = Receipt.new({:'receipt-id' => 'who the receipt is for'}, "test body")
+            @receipt.for.should == "who the receipt is for"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/shared_connection_examples.rb

@@ -0,0 +1,84 @@
+shared_examples_for "All Client Connections" do
+  describe "connection initializers" do
+    describe "from uri" do
+      it "should accept the stomp:/// uri (no host specified)" do
+        lambda { @connection.class.new("stomp:///") }.should_not raise_error
+      end
+
+      it "should accept a uri specifying just the host" do
+        lambda { @connection.class.new("stomp://localhost/") }.should_not raise_error
+      end
+
+      it "should accept a uri specifying host and port" do
+        lambda { @connection.class.new("stomp://localhost:61613/") }.should_not raise_error
+      end
+
+      it "should accept a uri specifying host, port and credentials" do
+        lambda { @connection.class.new("stomp://test_user:s3cr3tz@localhost:61613/") }.should_not raise_error
+      end
+
+      it "should accept a uri specifying a secure connection" do
+        lambda { @connection.class.new("stomp+ssl://localhost") }.should_not raise_error
+      end
+
+      it "should not accept a bogus URI" do
+        lambda { @connection.class.new("stomp://localhost:garbage") }.should raise_error
+      end
+
+    end
+  end
+
+  describe "connection control" do
+    it "should provide the appropriate all connection control and status methods" do
+      @connection.should respond_to(:connect)
+      @connection.should respond_to(:disconnect)
+      @connection.should respond_to(:close)
+      @connection.should respond_to(:connected?)
+    end
+
+    it "should not report it is connected after close is called" do
+      @connection.connect
+      @connection.connected?.should be_true
+      @connection.close
+      @connection.connected?.should be_false
+    end
+    
+    it "should not report it is connected after disconnect is called" do
+      @connection.connect
+      @connection.connected?.should be_true
+      @connection.disconnect
+      @connection.connected?.should be_false
+    end
+  end
+
+  describe "connection IO" do
+    it "should provide methods for receiving frames and writing frames" do
+      @connection.should respond_to(:transmit)
+      @connection.should respond_to(:receive)
+    end
+    it "should transmit frames" do
+      @connection.connect
+      @frame = nil
+      @connection.transmit(Stomper::Frames::Subscribe.new("/topic/test_topic"))
+      @connection.transmit(Stomper::Frames::Send.new("/topic/test_topic", "hello"))
+      @frame = @connection.receive while @frame.nil?
+      @frame.should be_an_instance_of(Stomper::Frames::Message)
+      @frame.body.should == "hello"
+    end
+  end
+
+  describe "secure connection" do
+    before(:each) do
+      @secure_connection = @connection.class.new("stomp+ssl:///")
+    end
+    it "should transmit frames" do
+      @connection.connect
+      @frame = nil
+      @connection.transmit(Stomper::Frames::Subscribe.new("/topic/test_topic"))
+      @connection.transmit(Stomper::Frames::Send.new("/topic/test_topic", "hello"))
+      @frame = @connection.receive while @frame.nil?
+      @frame.should be_an_instance_of(Stomper::Frames::Message)
+      @frame.body.should == "hello"
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+#begin
+#  require 'spec'
+#rescue LoadError
+#  require 'rubygems'
+#  #gem 'rspec'
+#  require 'spec'
+#end
+
+require 'stomper'
+

data/spec/subscription_spec.rb

@@ -0,0 +1,157 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+module Stomper
+  describe Subscription do
+    before(:each) do
+      @subscription = Subscription.new("/queue/test/1", 'subscription-1')
+    end
+
+    describe "basic expectations" do
+      it "should be constructable from a parameter list, providing sensible defaults for omitted arguments" do
+        @subscription.destination.should == "/queue/test/1"
+        @subscription.ack.should == :auto
+        @subscription.selector.should be_nil
+
+        @subscription = Subscription.new("/queue/test/2", 'subscription-1', 'client', 'a > 3')
+        @subscription.destination.should == "/queue/test/2"
+        @subscription.ack.should == :client
+        @subscription.selector.should == 'a > 3'
+      end
+
+      it "should be constructable from a hash, providing sensible defaults for omitted arguments" do
+        @subscription = Subscription.new({ :destination => '/queue/test/2' })
+        @subscription.destination.should == "/queue/test/2"
+        @subscription.ack.should == :auto
+
+        @subscription = Subscription.new({:destination => "/queue/test/3", :ack => :client, :id => 'subscription-3', :selector => 'b < 10' })
+        @subscription.destination.should == "/queue/test/3"
+        @subscription.ack.should == :client
+        @subscription.id.should_not be_nil
+        @subscription.selector.should == "b < 10"
+      end
+
+      it "should use the specified ID for subscribing and unsubscribing" do
+        @subscription.id.should_not be_nil
+        @subscription.id.should_not be_empty
+        @subscription.id.should == @subscription.to_subscribe.id
+        @subscription.id.should == @subscription.to_unsubscribe.id
+      end
+
+      it "should provide a meaningful ID when the ack mode is not auto" do
+        @client_ack_subscription = Subscription.new("/queue/test/1",nil,'client')
+        @client_ack_subscription.id.should_not be_nil
+      end
+
+      it "should provide a meaningful ID when the selector is specified" do
+        @selector_subscription = Subscription.new("/queue/test/1",nil,'auto',"a > 3.5")
+        @selector_subscription.id.should_not be_nil
+      end
+
+      it "should provide a SUBSCRIBE frame" do
+        @subscription.should respond_to(:to_subscribe)
+        @frame = @subscription.to_subscribe
+        @frame.destination.should == "/queue/test/1"
+        @frame.id.should_not be_nil
+        @frame.ack.should == "auto"
+      end
+    end
+
+    describe "message acceptance" do
+      it "should accept a message without a subscription header only when the subscription is 'naive'" do
+        @matching_subscription_1 = Subscription.new("/queue/test/1")
+        @matching_subscription_2 = Subscription.new("/queue/test/1", nil, :auto)
+        @message = Stomper::Frames::Message.new({'destination' => '/queue/test/1'},"test message")
+        @subscription.accepts?(@message).should be_false
+        @matching_subscription_1.accepts?(@message).should be_true
+        @matching_subscription_2.accepts?(@message).should be_true
+      end
+
+      it "should be able to accept messages by destination" do
+        @non_matching_subscription = Subscription.new("/queue/test/another")
+        @message = Stomper::Frames::Message.new({'destination' => '/queue/test/1', 'subscription' => @subscription.id},"test message")
+        @subscription.accepts?(@message).should be_true
+        @non_matching_subscription.accepts?(@message).should be_false
+      end
+
+      it "should accept messages only if the same destination and subscription" do
+        @alternate_subscription = Subscription.new("/queue/test/1", 'subscription-2')
+        @message = Stomper::Frames::Message.new({'destination' => '/queue/test/1', 'subscription' => @subscription.id},"test message")
+        @subscription.accepts?(@message).should be_true
+        @alternate_subscription.accepts?(@message).should be_false
+      end
+
+      it "should accept messages by the subscription id if the message has a subscription" do
+        @non_matching_subscription = Subscription.new("/queue/test/1")
+        @message = Stomper::Frames::Message.new({'destination' => '/queue/test/1', 'subscription' => @subscription.id},"test message")
+        @subscription.accepts?(@message).should be_true
+        @non_matching_subscription.accepts?(@message).should be_false
+      end
+
+      it "should not accept messages with the same destination when its ack mode is not 'auto' and no subscription header was specified" do
+        @non_matching_subscription = Subscription.new("/queue/test/1", nil, 'client')
+        @message = Stomper::Frames::Message.new({'destination' => '/queue/test/1'},"test message")
+        @non_matching_subscription.accepts?(@message).should be_false
+      end
+
+      it "should not accept messages with the same destination when it has a selector and no subscription header was specified" do
+        @non_matching_subscription = Subscription.new("/queue/test/1", nil, 'auto', 'rating > 3.0')
+        @message = Stomper::Frames::Message.new({'destination' => '/queue/test/1'},"test message")
+        @non_matching_subscription.accepts?(@message).should be_false
+      end
+
+      # Either insist that the #id method return something meaningful in non-trivial situations
+      # as part of the expected behavior of the interface, or change this test!
+      # We now insist on it, so this test is valid.
+      it "should accept messages when it has a selector and the subscription header was specified" do
+        @non_matching_subscription = Subscription.new("/queue/test/1", nil, 'auto', 'rating > 3.0')
+        # To test this without insisting that the #id field be equivalent to the subscribe frame's header
+        # go this way:
+
+        @message = Stomper::Frames::Message.new({'destination' => '/queue/test/1', 'subscription' => @non_matching_subscription.id},"test message")
+        @non_matching_subscription.accepts?(@message).should be_true
+      end
+    end
+
+    describe "message delivery" do
+      it "should call its callback when an applicable message arrives for its destination" do
+        called_back = false
+        @subscription_with_block = Subscription.new("/queue/test/1", 'subscription-test') do |msg|
+          called_back = (msg == @message)
+        end
+        @message = Stomper::Frames::Message.new({'destination' => '/queue/test/1', 'subscription' => @subscription_with_block.id},"test message")
+        @subscription_with_block.perform(@message)
+        called_back.should be_true
+      end
+
+      it "should not call its callback when given a message for a different destination" do
+        called_back = false
+        @message = Stomper::Frames::Message.new({'destination' => '/queue/test/1'},"test message")
+        @subscription_with_block = Subscription.new("/queue/test/another", 'subscription-test') do |msg|
+          called_back = (msg == @message)
+        end
+        @subscription_with_block.perform(@message)
+        called_back.should be_false
+      end
+
+      it "should call its callback when a message arrives for its subscription id" do
+        called_back = false
+        @subscription_with_block = Subscription.new("/queue/test/another", 'subscription-test') do |msg|
+          called_back = (msg == @message)
+        end
+        @message = Stomper::Frames::Message.new({'destination' => '/queue/test/1', 'subscription' => @subscription_with_block.id},"test message")
+        @subscription_with_block.perform(@message)
+        called_back.should be_true
+      end
+
+      it "should not call its callback when a message arrives for its subscription id, even on the same " do
+        called_back = false
+        @message = Stomper::Frames::Message.new({'destination' => '/queue/test/1', 'subscription' => 'subscription-not-test'},"test message")
+        @subscription_with_block = Subscription.new("/queue/test/another", 'subscription-test') do |msg|
+          called_back = (msg == @message)
+        end
+        @subscription_with_block.perform(@message)
+        called_back.should be_false
+      end
+    end
+  end
+end

data/spec/subscriptions_spec.rb

@@ -0,0 +1,148 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+module Stomper
+  describe Subscriptions do
+    before(:each) do
+      @subscriptions = Subscriptions.new
+    end
+
+    describe "adding subscriptions" do
+      it "should add a subscription given a subscription object" do
+        @subscriptions << Subscription.new('/queue/test/3', 'subscription-3', nil, 'b < 10')
+        @subscriptions.size.should == 1
+        @subscriptions.first.destination.should == "/queue/test/3"
+        @subscriptions.first.ack.should == :auto
+        @subscriptions.first.selector.should == 'b < 10'
+        @subscriptions.first.id.should_not be_nil
+      end
+    end
+
+    describe "enumerable" do
+      it "should provide an each method" do
+        @subscriptions.should respond_to(:each)
+      end
+      it "should be enumerable" do
+        @subscriptions.is_a?(Enumerable).should be_true
+      end
+    end
+
+    describe "thread safe" do
+      # How do you test this?
+      it "should synchronize adding subscriptions" do
+        @subscriptions << Subscription.new("/queue/test/1")
+        @subscriptions << Subscription.new("/queue/test/2")
+        @subscriptions << Subscription.new("/queue/test/3")
+        Thread.new { sleep(0.1); @subscriptions << Subscription.new("/queue/test/4") }
+        # In general, this next step should execute before the thread has a chance to
+        # but the sleep in the map should mean that our thread gets woken up before
+        # map finishes.  However, destinations should NEVER contain "/queue/test/4"
+        # because map should be synchronized.
+        destinations = @subscriptions.map { |sub| sleep(0.1); sub.destination }
+        destinations.size.should == 3
+        destinations.should == ['/queue/test/1', '/queue/test/2', '/queue/test/3']
+        @subscriptions.size.should == 4
+        @subscriptions.last.destination.should == "/queue/test/4"
+      end
+
+      it "should synchronize removing subscriptions" do
+        @subscriptions << Subscription.new("/queue/test/1")
+        @subscriptions << Subscription.new("/queue/test/2")
+        @subscriptions << Subscription.new("/queue/test/3")
+        Thread.new { sleep(0.1); @subscriptions.remove("/queue/test/1") }
+        # In general, this next step should execute before the thread has a chance to
+        # but the sleep in the map should mean that our thread gets woken up before
+        # map finishes.  However, destinations should NEVER contain "/queue/test/4"
+        # because map should be synchronized.
+        destinations = @subscriptions.map { |sub| sleep(0.1); sub.destination }
+        destinations.size.should == 3
+        destinations.should == ['/queue/test/1', '/queue/test/2', '/queue/test/3']
+        @subscriptions.size.should == 2
+        @subscriptions.first.destination.should == "/queue/test/2"
+      end
+
+    end
+
+    describe "message delivery" do
+      it "should deliver messages to matching subscriptions" do
+        received_1 = false
+        received_2 = false
+        received_3 = false
+        @subscriptions << Subscription.new("/queue/test/1") { |msg| received_1 = true }
+        @subscriptions << Subscription.new("/queue/test/1", 'subscription-2') { |msg| received_2 = true }
+        @subscriptions << Subscription.new("/queue/test/2") { |msg| received_3 = true }
+        @message = Stomper::Frames::Message.new({'destination' => '/queue/test/1'},"test message")
+        @subscriptions.perform(@message)
+        received_1.should be_true
+        received_2.should be_false
+        received_3.should be_false
+      end
+    end
+
+    describe "unsubscribing" do
+      it "should remove all naive subscriptions when unsubscribing with a string destination" do
+        @removed_subscriptions = [Subscription.new("/queue/test/1"), Subscription.new("/queue/test/1")]
+        @removed_subscriptions.each { |sub| @subscriptions << sub }
+        @subscriptions << Subscription.new("/queue/test/2")
+        @subscriptions << Subscription.new("/queue/test/1", 'subscription-4')
+        @to_remove = @subscriptions.remove("/queue/test/1")
+        @subscriptions.size.should == 2
+        @subscriptions.should_not include(@removed_subscriptions.first)
+        @subscriptions.should_not include(@removed_subscriptions.last)
+        @to_remove.size.should == 2
+        @to_remove.should include(@removed_subscriptions.first)
+        @to_remove.should include(@removed_subscriptions.last)
+      end
+      it "should remove all subscriptions that accept messages for a supplied subscription ID" do
+        @removed_subscription = Subscription.new("/queue/test/1", 'subscription-4')
+        @subscriptions << Subscription.new("/queue/test/1")
+        @subscriptions << Subscription.new("/queue/test/1")
+        @subscriptions << Subscription.new("/queue/test/2")
+        @subscriptions << @removed_subscription
+        @to_remove = @subscriptions.remove(nil, @removed_subscription.id)
+        @subscriptions.size.should == 3
+        @subscriptions.should_not include(@removed_subscription)
+        @to_remove.size.should == 1
+        @to_remove.should include(@removed_subscription)
+      end
+      it "should remove subscriptions as expected when parameter is a hash specifying the ID" do
+        @removed_subscription = Subscription.new("/queue/test/1", 'subscription-4')
+        @subscriptions << Subscription.new("/queue/test/1")
+        @subscriptions << Subscription.new("/queue/test/1")
+        @subscriptions << Subscription.new("/queue/test/2")
+        @subscriptions << @removed_subscription
+        @to_remove = @subscriptions.remove({ :id => @removed_subscription.id })
+        @subscriptions.size.should == 3
+        @subscriptions.should_not include(@removed_subscription)
+        @to_remove.size.should == 1
+        @to_remove.should include(@removed_subscription)
+      end
+      it "should remove subscriptions as expected when parameter is a hash specifying the destination" do
+        @removed_subscriptions = [Subscription.new("/queue/test/1"), Subscription.new("/queue/test/1")]
+        @removed_subscriptions.each { |sub| @subscriptions << sub }
+        @subscriptions << Subscription.new("/queue/test/2")
+        @subscriptions << Subscription.new("/queue/test/1", 'subscription-4')
+        @to_remove = @subscriptions.remove( { :destination => "/queue/test/1" })
+        @subscriptions.size.should == 2
+        @subscriptions.should_not include(@removed_subscriptions.first)
+        @subscriptions.should_not include(@removed_subscriptions.last)
+        @to_remove.size.should == 2
+        @to_remove.should include(@removed_subscriptions.first)
+        @to_remove.should include(@removed_subscriptions.last)
+      end
+      it "should remove subscriptions as expected when parameter is a Subscription" do
+        @removed_subscription = Subscription.new("/queue/test/1", 'subscription-4')
+        @subscriptions << Subscription.new("/queue/test/1")
+        @subscriptions << Subscription.new("/queue/test/1")
+        @subscriptions << Subscription.new("/queue/test/2")
+        @subscriptions << @removed_subscription
+        @to_remove = @subscriptions.remove(@removed_subscription)
+        @to_remove.size.should == 1
+        @to_remove.should include(@removed_subscription)
+        @to_remove = @subscriptions.remove(Subscription.new("/queue/test/1", nil, :client))
+        @to_remove.should be_empty
+        @subscriptions.size.should == 3
+        @subscriptions.should_not include(@removed_subscription)
+      end
+    end
+  end
+end