stomp 1.2.6 → 1.2.7

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+== 1.2.7 20121102
+
+* Stomp 1.2 support (see http://stomp.github.com)
+* Reset reconnect_delay to default value upon successful reconnect
+* Enhance tests for Stomp 1.2
+
 == 1.2.6 20120913
 
 * Provide ability to eliminate checks for closed in protocol methods

data/README.rdoc

@@ -6,10 +6,11 @@
 
 An implementation of the Stomp protocol for Ruby. See:
 
-* [STOMP 1.0 and 1.1] (http://stomp.github.com/index.html)
+* [STOMP 1.0, 1.1, and 1.2] (http://stomp.github.com/index.html)
 
 ===New
 
+* Gem version 1.2.7. Stomp 1.2 support and miscellaneous fixes. See _CHANGELOG.rdoc_ for details.
 * Gem version 1.2.6. Miscellaneous fixes and changes. See _CHANGELOG.rdoc_ for details.
 * Gem version 1.2.5. Restructure. Forks with modifcations will be affected. See _CHANGELOG.rdoc_ for details.
 * Gem version 1.2.4. Stomp 1.1 heartbeat fix, autoflush capability, miscellaneous fixes.
@@ -38,12 +39,15 @@ See _CHANGELOG.rdoc_ for details.
       :back_off_multiplier => 2,          # next delay multiplier
       :max_reconnect_attempts => 0,       # retry forever, use # for maximum attempts
       :randomize => false,                # do not radomize hosts hash before reconnect
+      :connect_timeout => 0,              # Timeout for TCP/TLS connects, use # for max seconds
       :connect_headers => {},             # user supplied CONNECT headers (req'd for Stomp 1.1+)
       :parse_timeout => 5,                # receive / read timeout, secs
       :logger => nil,                     # user suplied callback logger instance
       :dmh => false,                      # do not support multihomed IPV4 / IPV6 hosts during failover
       :closed_check => true,              # check first if closed in each protocol method
       :hbser => false,                    # raise on heartbeat send exception
+      :stompconn => false,                # Use STOMP instead of CONNECT
+      :usecrlf => false,                  # Use CRLF command and header line ends (1.2+)
     }
     
     # for client

data/lib/connection/netio.rb

@@ -26,6 +26,9 @@ module Stomp
           end
         end
         return nil if line.nil?
+        # p [ "wiredatain_01", line ]
+        line = _normalize_line_end(line) if @protocol >= Stomp::SPL_12
+
         # If the reading hangs for more than X seconds, abort the parsing process.
         # X defaults to 5.  Override allowed in connection hash parameters.
         Timeout::timeout(@parse_timeout, Stomp::Error::PacketParsingTimeout) do
@@ -34,7 +37,9 @@ module Stomp
           begin
             message_header += line
             line = read_socket.gets
+            # p [ "wiredatain_02", line ]
             raise Stomp::Error::StompServerError if line.nil?
+            line = _normalize_line_end(line) if @protocol >= Stomp::SPL_12
           end until line =~ /^\s?\n$/
 
           # Checks if it includes content_length header
@@ -87,6 +92,19 @@ module Stomp
       end
     end
 
+    # Normalize line ends because 1.2+ brokers can send 'mixed mode' headers, i.e.:
+    # - Some headers end with '\n'
+    # - Other headers end with '\r\n'
+    def _normalize_line_end(line)
+      return line unless @usecrlf
+      # p [ "nleln", line ]
+      line_len = line.respond_to?(:bytesize) ? line.bytesize : line.length
+      last2 = line[line_len-2...line_len]
+      # p [ "nlel2", last2 ]
+      return line unless last2 == "\r\n"
+      return line[0...line_len-2] + "\n"
+    end
+
     # transmit logically puts a Message on the wire.
     def transmit(command, headers = {}, body = '')
       # The transmit may fail so we may need to retry.
@@ -131,17 +149,17 @@ module Stomp
         # Lets send this header in the message, so it can maintain state when using unreceive
         headers[:'content-length'] = "#{body_length_bytes}" unless headers[:suppress_content_length]
         headers[:'content-type'] = "text/plain; charset=UTF-8" unless headers[:'content-type']
-        used_socket.puts command
+        _wire_write(used_socket,command)
         headers.each do |k,v|
           if v.is_a?(Array)
             v.each do |e|
-              used_socket.puts "#{k}:#{e}"
+              _wire_write(used_socket,"#{k}:#{e}")
             end
           else
-            used_socket.puts "#{k}:#{v}"
+            _wire_write(used_socket,"#{k}:#{v}")
           end
         end
-        used_socket.puts
+        _wire_write(used_socket,"")
         used_socket.write body
         used_socket.write "\0"
         used_socket.flush if autoflush
@@ -153,6 +171,19 @@ module Stomp
       end
     end
 
+    # Use CRLF if protocol is >= 1.2, and the client requested CRLF
+    def _wire_write(sock, data)
+      # p [ "debug_01", @protocol, @usecrlf ]
+      if @protocol >= Stomp::SPL_12 && @usecrlf
+        wiredata = "#{data}#{Stomp::CR}#{Stomp::LF}"
+        # p [ "wiredataout_01:", wiredata ]
+        sock.write(wiredata)
+      else
+        # p [ "wiredataout_02:", "#{data}\n" ]
+        sock.puts data
+      end
+    end
+
     # open_tcp_socket opens a TCP socket.
     def open_tcp_socket()
       tcp_socket = nil
@@ -295,6 +326,9 @@ module Stomp
       close_socket
 
       @closed = false
+      if @parameters # nil in some rspec tests
+        @reconnect_delay = @parameters[:initial_reconnect_delay] ? @parameters[:initial_reconnect_delay] : 0.01
+      end
       # Use keepalive
       used_socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
       used_socket
@@ -307,7 +341,11 @@ module Stomp
       headers[:login] = @login
       headers[:passcode] = @passcode
       _pre_connect
-      _transmit(used_socket, "CONNECT", headers)
+      if !@hhas10 && @stompconn
+        _transmit(used_socket, Stomp::CMD_STOMP, headers)
+      else
+        _transmit(used_socket, Stomp::CMD_CONNECT, headers)
+      end
       @connection_frame = _receive(used_socket)
       _post_connect
       @disconnect_receipt = nil

data/lib/connection/utils.rb

@@ -65,11 +65,13 @@ module Stomp
       raise Stomp::Error::ProtocolErrorConnect if (!@connect_headers[:"accept-version"] && @connect_headers[:host])
       return unless (@connect_headers[:"accept-version"] && @connect_headers[:host]) # 1.0
       # Try 1.1 or greater
+      @hhas10 = false
       okvers = []
       avers = @connect_headers[:"accept-version"].split(",")
       avers.each do |nver|
         if Stomp::SUPPORTED.index(nver)
           okvers << nver
+          @hhas10 = true if nver == Stomp::SPL_10
         end
       end
       raise Stomp::Error::UnsupportedProtocolError if okvers == []
@@ -166,6 +168,7 @@ module Stomp
         # Closed check logic
         :closed_check => true,
         :hbser => false,
+        :stompconn => false,
       }
 
       res_params = default_params.merge(params)

data/lib/stomp/client.rb

@@ -52,6 +52,11 @@ module Stomp
     #     :connect_headers => {},
     #     :parse_timeout => 5,
     #     :logger => nil,
+    #     :dmh => false,
+    #     :closed_check => true,
+    #     :hbser => false,
+    #     :stompconn => false,
+    #     :usecrlf => false,
     #   }
     #
     #   e.g. c = Stomp::Client.new(hash)
@@ -218,7 +223,11 @@ module Stomp
       if block_given?
         headers['receipt'] = register_receipt_listener lambda {|r| yield r}
       end
-      @connection.ack(message.headers['message-id'], headers)
+      if protocol() == Stomp::SPL_12
+        @connection.ack(message.headers['ack'], headers)
+      else
+        @connection.ack(message.headers['message-id'], headers)
+      end
     end
 
     # Stomp 1.1+ NACK.

data/lib/stomp/connection.rb

@@ -63,6 +63,8 @@ module Stomp
     #     :dmh => false,
     #     :closed_check => true,
     #     :hbser => false,
+    #     :stompconn => false,
+    #     :usecrlf => false,
     #   }
     #
     #   e.g. c = Stomp::Connection.new(hash)
@@ -102,6 +104,8 @@ module Stomp
         @autoflush = false    # To override, use hashed parameters or setter
         @closed_check = true  # Run closed check in each protocol method
         @hbser = false        # Raise if heartbeat send exception
+        @stompconn = false    # If true, use STOMP rather than CONNECT
+        @usecrlf = false      # If true, use \r\n as line ends (1.2 only)
         warn "login looks like a URL, do you have the correct parameters?" if @login =~ /:\/\//
       end
 
@@ -132,6 +136,8 @@ module Stomp
       @autoflush = @parameters[:autoflush]
       @closed_check = @parameters[:closed_check]
       @hbser = @parameters[:hbser]
+      @stompconn = @parameters[:stompconn]
+      @usecrlf = @parameters[:usecrlf]
       #sets the first host to connect
       change_host
     end
@@ -162,14 +168,29 @@ module Stomp
 
     # Acknowledge a message, used when a subscription has specified
     # client acknowledgement i.e. connection.subscribe("/queue/a", :ack => 'client').
-    # Accepts a transaction header ( :transaction => 'some_transaction_id' )
+    # Accepts an optional transaction header ( :transaction => 'some_transaction_id' )
+    # Behavior is protocol level dependent, see the specifications or comments below.
     def ack(message_id, headers = {})
       raise Stomp::Error::NoCurrentConnection if @closed_check && closed?
       raise Stomp::Error::MessageIDRequiredError if message_id.nil? || message_id == ""
       headers = headers.symbolize_keys
-      headers[:'message-id'] = message_id
-      if @protocol >= Stomp::SPL_11
-        raise Stomp::Error::SubscriptionRequiredError unless headers[:subscription]
+
+      case @protocol
+        when Stomp::SPL_12
+          # The ACK frame MUST include an id header matching the ack header 
+          # of the MESSAGE being acknowledged.
+          headers[:id] = message_id
+        when Stomp::SPL_11
+          # ACK has two REQUIRED headers: message-id, which MUST contain a value 
+          # matching the message-id for the MESSAGE being acknowledged and 
+          # subscription, which MUST be set to match the value of the subscription's 
+          # id header.
+          headers[:'message-id'] = message_id
+          raise Stomp::Error::SubscriptionRequiredError unless headers[:subscription]
+        else # Stomp::SPL_10
+          # ACK has one required header, message-id, which must contain a value 
+          # matching the message-id for the MESSAGE being acknowledged.
+          headers[:'message-id'] = message_id
       end
       _headerCheck(headers)
       transmit(Stomp::CMD_ACK, headers)
@@ -181,8 +202,19 @@ module Stomp
       raise Stomp::Error::UnsupportedProtocolError if @protocol == Stomp::SPL_10
       raise Stomp::Error::MessageIDRequiredError if message_id.nil? || message_id == ""
       headers = headers.symbolize_keys
-      headers[:'message-id'] = message_id
-      raise Stomp::Error::SubscriptionRequiredError unless headers[:subscription]
+      case @protocol
+        when Stomp::SPL_12
+          # The ACK frame MUST include an id header matching the ack header 
+          # of the MESSAGE being acknowledged.
+          headers[:id] = message_id
+        else # Stomp::SPL_11 only
+          # ACK has two REQUIRED headers: message-id, which MUST contain a value 
+          # matching the message-id for the MESSAGE being acknowledged and 
+          # subscription, which MUST be set to match the value of the subscription's 
+          # id header.
+          headers[:'message-id'] = message_id
+          raise Stomp::Error::SubscriptionRequiredError unless headers[:subscription]
+      end
       _headerCheck(headers)
       transmit(Stomp::CMD_NACK, headers)
     end

data/lib/stomp/constants.rb

@@ -24,9 +24,10 @@ module Stomp
   # Protocols
   SPL_10 = "1.0"
   SPL_11 = "1.1"
+  SPL_12 = "1.2"
 
   # Stomp 1.0 and 1.1
-  SUPPORTED = [SPL_10, SPL_11]
+  SUPPORTED = [SPL_10, SPL_11, SPL_12]
 
   # 1.9 Encoding Name
   UTF8 = "UTF-8"
@@ -40,6 +41,16 @@ module Stomp
   NL = "\n"
   NL_ASCII = 0x0a
   #
+  # Line Feed (New Line)
+  #
+  LF = "\n"
+  LF_ASCII = 0x0a
+  #
+  # New line
+  #
+  CR = "\r"
+  CR_ASCII = 0x0d
+  #
   # Back Slash
   #
   BACK_SLASH = "\\"
@@ -65,6 +76,7 @@ module Stomp
   ENCODE_VALUES = [
     "\\\\", "\\", # encoded, decoded
     "\\" + "n", "\n",
+    "\\" + "r", "\r",
     "\\c", ":",
   ]
 
@@ -72,6 +84,7 @@ module Stomp
   DECODE_VALUES = [
     "\\\\\\\\", "\\", # encoded, decoded
     "\\" + "n", "\n",
+    "\\" + "r", "\r",
     "\\c", ":",
   ]
 

data/lib/stomp/version.rb

@@ -6,7 +6,7 @@ module Stomp
   module Version  #:nodoc: all
     MAJOR = 1
     MINOR = 2
-    PATCH = 6
+    PATCH = 7
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/spec/connection_spec.rb

@@ -23,6 +23,8 @@ describe Stomp::Connection do
       :dmh => false,
       :closed_check => true,
       :hbser => false,
+      :stompconn => false,
+      :usecrlf => false,
     }
         
     #POG:
@@ -70,7 +72,7 @@ describe Stomp::Connection do
       @connection.publish "/queue", "message", :suppress_content_length => false
     end    
   end
-  
+
   describe "(created using a hash)" do
     it "should uncamelize and symbolize the main hash keys" do
       used_hash = {
@@ -86,7 +88,8 @@ describe Stomp::Connection do
         "maxReconnectAttempts" => 0,
         "randomize" => false,
         "connect_timeout" => 0,
-        "parse_timeout" => 5
+        "parse_timeout" => 5,
+        "usecrlf" => false,
       }
       
       @connection = Stomp::Connection.new(used_hash)
@@ -148,7 +151,7 @@ describe Stomp::Connection do
         @connection.publish "/queue", "сообщение"  # 'сообщение' is 'message' in Russian
       end
     end
-    
+
     describe "when unacknowledging a message" do
       
       before :each do
@@ -237,7 +240,7 @@ describe Stomp::Connection do
       end
     
     end
-    
+
     describe "when sending a nil message body" do
       it "should should not raise an error" do
         @connection = Stomp::Connection.new("niluser", "nilpass", "localhost", 61613)
@@ -334,6 +337,7 @@ describe Stomp::Connection do
           :dmh => false,
           :closed_check => true,
           :hbser => false,
+          :stompconn => false,
         }
         
         used_hash =  {
@@ -369,6 +373,8 @@ describe Stomp::Connection do
           :dmh => false,
           :closed_check => true,
           :hbser => false,
+          :stompconn => false,
+          :usecrlf => false,
         }
         
         @connection = Stomp::Connection.new(used_hash)
@@ -420,5 +426,6 @@ describe Stomp::Connection do
       
     end
   end
+
 end
 

data/stomp.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stomp}
-  s.version = "1.2.6"
+  s.version = "1.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian McCallister", "Marius Mathiesen", "Thiago Morello", "Guy M. Allard"]
-  s.date = %q{2012-10-05}
+  s.date = %q{2012-11-02}
   s.description = %q{Ruby client for the Stomp messaging protocol.  Note that this gem is no longer supported on rubyforge.}
   s.email = ["brianm@apache.org", "marius@stones.com", "morellon@gmail.com", "allard.guy.m@gmail.com"]
   s.executables = ["catstomp", "stompcat"]

data/test/test_client.rb

@@ -40,13 +40,14 @@ class TestClient < Test::Unit::TestCase
     assert_equal message_text, received.body
     receipt = nil
     ack_headers = {}
-    if @client.protocol > Stomp::SPL_10
+    if @client.protocol == Stomp::SPL_11 # 1.1 only
       ack_headers["subscription"] = received.headers["subscription"]
     end
     @client.acknowledge(received, ack_headers) {|r| receipt = r}
     sleep 0.01 until receipt
     assert_not_nil receipt.headers['receipt-id']
-  end unless ENV['STOMP_RABBIT']
+    checkEmsg(@client)
+  end unless ENV['STOMP_RABBIT'] # TODO: why does Rabbit 1.1 fail ?
 
   # Test Client subscribe
   def test_asynch_subscribe
@@ -56,6 +57,7 @@ class TestClient < Test::Unit::TestCase
     sleep 0.01 until received
 
     assert_equal message_text, received.body
+    checkEmsg(@client)
   end
 
   # Test not ACKing messages.
@@ -78,6 +80,7 @@ class TestClient < Test::Unit::TestCase
     assert_equal message_text, received2.body
     assert_equal received.body, received2.body
     assert_equal received.headers['message-id'], received2.headers['message-id'] unless ENV['STOMP_RABBIT']
+    checkEmsg(@client)
   end unless RUBY_ENGINE =~ /jruby/
 
   # Test obtaining a RECEIPT via a listener.
@@ -90,6 +93,7 @@ class TestClient < Test::Unit::TestCase
     @client.subscribe(make_destination) {|m| message = m}
     sleep 0.1 until message
     assert_equal message_text, message.body
+    checkEmsg(@client)
   end
 
   # Test requesting a receipt on disconnect.
@@ -110,6 +114,7 @@ class TestClient < Test::Unit::TestCase
     sleep 0.01 until message
 
     assert_equal message_text, message.body
+    checkEmsg(@client)
   end
 
   # Test that Client subscribe requires a block.
@@ -117,6 +122,7 @@ class TestClient < Test::Unit::TestCase
     assert_raise(RuntimeError) do
       @client.subscribe make_destination
     end
+    checkEmsg(@client)
   end unless RUBY_ENGINE =~ /jruby/
 
   # Test transaction publish.
@@ -130,6 +136,7 @@ class TestClient < Test::Unit::TestCase
     sleep 0.01 until message
 
     assert_equal message_text, message.body
+    checkEmsg(@client)
   end
 
   # Test transaction publish and abort.
@@ -146,6 +153,7 @@ class TestClient < Test::Unit::TestCase
     @client.subscribe(make_destination) {|m| message = m}
     sleep 0.01 until message
     assert_equal "second_message", message.body
+    checkEmsg(@client)
   end unless RUBY_ENGINE =~ /jruby/
 
   # Test transaction publish and abort, receive with new client.
@@ -172,7 +180,7 @@ class TestClient < Test::Unit::TestCase
       message = nil
       @client.abort 'tx1'
     }
-
+    checkEmsg(@client)
     # lets recreate the connection
     teardown
     setup
@@ -192,13 +200,18 @@ class TestClient < Test::Unit::TestCase
     assert_equal message_text, message.body
     assert_nothing_raised {
     @client.begin 'tx2'
-      if @client.protocol() == Stomp::SPL_10
-        @client.acknowledge message, :transaction => 'tx2'
-      else
-        @client.acknowledge message, :transaction => 'tx2', :subscription => sid
+      case @client.protocol()
+        when Stomp::SPL_10
+          @client.acknowledge message, :transaction => 'tx2'
+        when Stomp::SPL_11
+          @client.acknowledge message, :transaction => 'tx2', :subscription => sid
+        else
+          # Skip 1.2+ for now.  Current 1.2 broker appears to think this is 
+          # already ACK'd.
       end
       @client.commit 'tx2'
     }
+    checkEmsg(@client)
   end
 
   # Test that subscription destinations must be unique for a Client.
@@ -208,6 +221,7 @@ class TestClient < Test::Unit::TestCase
     assert_raise(RuntimeError) do
       @client.subscribe(subscribe_dest) {|m| nil }
     end
+    checkEmsg(@client)
   end
 
   # Test that subscription IDs must be unique for a Client.
@@ -217,6 +231,7 @@ class TestClient < Test::Unit::TestCase
     assert_raise(RuntimeError) do
       @client.subscribe(subscribe_dest, {'id' => 'myid'}) {|m| nil }
     end
+    checkEmsg(@client)
   end
 
   # Test that subscription IDs must be unique for a Client, mixed id specification.
@@ -226,6 +241,7 @@ class TestClient < Test::Unit::TestCase
     assert_raise(RuntimeError) do
       @client.subscribe(subscribe_dest, {:id => 'myid'}) {|m| nil }
     end
+    checkEmsg(@client)
   end
 
   # Test wildcard subscribe.  Primarily for AMQ.
@@ -256,7 +272,7 @@ class TestClient < Test::Unit::TestCase
       end
     end
     assert results.all?{|a| a == true }
-
+    checkEmsg(@client)
   end unless ENV['STOMP_NOWILD']
 
   # Test wildcard subscribe with >.  Primarily for AMQ.
@@ -291,6 +307,7 @@ class TestClient < Test::Unit::TestCase
       end
     end
     assert results.all?{|a| a == true }
+    checkEmsg(@client)
   end unless ENV['STOMP_NOWILD'] || ENV['STOMP_DOTQUEUE']
 
   # Test transaction with client side redilivery.
@@ -323,18 +340,26 @@ class TestClient < Test::Unit::TestCase
     assert_not_nil message
     assert_equal message_text, message.body
 
-    @client.begin 'tx2'
-    if @client.protocol() == Stomp::SPL_10
-      @client.acknowledge message, :transaction => 'tx2'
-    else
-      @client.acknowledge message, :transaction => 'tx2', :subscription => sid
-    end
-    @client.commit 'tx2'
+    assert_nothing_raised {
+      @client.begin 'tx2'
+      case @client.protocol()
+        when Stomp::SPL_10
+          @client.acknowledge message, :transaction => 'tx2'
+        when Stomp::SPL_11
+          @client.acknowledge message, :transaction => 'tx2', :subscription => sid
+        else
+          # Skip 1.2+ for now.  Current 1.2 broker appears to think this is 
+          # already ACK'd.
+      end
+      @client.commit 'tx2'
+    }
+    checkEmsg(@client)
   end
 
   # Test that a connection frame is received.
   def test_connection_frame
   	assert_not_nil @client.connection_frame
+    checkEmsg(@client)
   end unless RUBY_ENGINE =~ /jruby/
 
   # Test basic unsubscribe.
@@ -358,7 +383,7 @@ class TestClient < Test::Unit::TestCase
     if @client.protocol() == Stomp::SPL_10
       client.unsubscribe dest
     else
-      client.unsubscribe dest, :subscription => sid
+      client.unsubscribe dest, :id => sid
     end
     client.close
     #  Same message should remain on the queue.  Receive it again with ack=>auto.
@@ -375,6 +400,7 @@ class TestClient < Test::Unit::TestCase
     end
     assert_equal to_send, message_copy.body, "second body check"
     assert_equal message.headers['message-id'], message_copy.headers['message-id'], "header check" unless ENV['STOMP_RABBIT']
+    checkEmsg(@client)
   end
 
   # Test subscribe from a worker thread.
@@ -397,6 +423,7 @@ class TestClient < Test::Unit::TestCase
     @client.publish(dest, message_text)
     sleep 1
     assert_not_nil msg
+    checkEmsg(@client)
   end unless RUBY_ENGINE =~ /jruby/
 
   # Test subscribe from multiple worker threads.
@@ -448,6 +475,7 @@ class TestClient < Test::Unit::TestCase
       sleep sleep_incr
     end
     assert_equal @max_msgs, msg_ctr
+    checkEmsg(@client)
   end
 
   # Test that methods detect no client connection is present.

data/test/test_codec.rb

@@ -50,12 +50,16 @@ class TestCodec < Test::Unit::TestCase
     test_data = [
     	[ "\\\\", "\\" ],
     	["\\n", "\n"],
+    	["\\r", "\r"],
 	    ["\\c", ":"],
 	    ["\\\\\\n\\c", "\\\n:"],
+	    ["\\\\\\r\\c", "\\\r:"],
 	    ["\\c\\n\\\\", ":\n\\"],
+	    ["\\c\\r\\\\", ":\r\\"],
 	    ["\\\\\\c", "\\:"],
 	    ["c\\cc", "c:c"],
 	    ["n\\nn", "n\nn"],
+	    ["r\\rr", "r\rr"],
       ]
     #
     test_data.each do |s|
@@ -73,6 +77,8 @@ class TestCodec < Test::Unit::TestCase
     test_data = [
     	[ "a\\\\b", "a\\b" ],
       [ "\\\\\\n\\c", "\\\n:" ],
+      [ "\\\\\\r\\c", "\\\r:" ],
+      [ "\\rr\\\\\\n\\c", "\rr\\\n:" ],
       ]
     #
     test_data.each do |s|

data/test/test_connection.rb

@@ -53,6 +53,7 @@ class TestConnection < Test::Unit::TestCase
     else
       assert_equal "test_stomp#test_\000_length", msg2.body
     end
+    checkEmsg(@conn)
   end unless ENV['STOMP_RABBIT']
 
   # Test direct / explicit receive.
@@ -68,6 +69,7 @@ class TestConnection < Test::Unit::TestCase
     conn_subscribe make_destination, :receipt => "abc"
     msg = @conn.receive
     assert_equal "abc", msg.headers['receipt-id']
+    checkEmsg(@conn)
   end
 
   # Test asking for a receipt on disconnect.
@@ -80,23 +82,62 @@ class TestConnection < Test::Unit::TestCase
     }
   end
 
-  # Test ACKs using symbols for header keys.
-  def test_client_ack_with_symbol
-    if @conn.protocol == Stomp::SPL_10
-      @conn.subscribe make_destination, :ack => :client
-    else
-      sid = @conn.uuid()
-      @conn.subscribe make_destination, :ack => :client, :id => sid
+  # Test ACKs for Stomp 1.0
+  def test_client_ack_with_symbol_10
+    if @conn.protocol != Stomp::SPL_10
+      assert true
+      return
     end
-    @conn.publish make_destination, "test_stomp#test_client_ack_with_symbol"
+    queue = make_destination()
+    @conn.subscribe queue, :ack => :client
+    @conn.publish queue, "test_stomp#test_client_ack_with_symbol_10"
     msg = @conn.receive
     assert_nothing_raised {
-      if @conn.protocol == Stomp::SPL_10
-        @conn.ack msg.headers['message-id']
-      else
-        @conn.ack msg.headers['message-id'], :subscription => sid
-      end
+      # ACK has one required header, message-id, which must contain a value 
+      # matching the message-id for the MESSAGE being acknowledged.
+      @conn.ack msg.headers['message-id']
+    }
+    checkEmsg(@conn)
+  end
+
+  # Test ACKs for Stomp 1.1
+  def test_client_ack_with_symbol_11
+    if @conn.protocol != Stomp::SPL_11
+      assert true
+      return
+    end
+    sid = @conn.uuid()
+    queue = make_destination()
+    @conn.subscribe queue, :ack => :client, :id => sid
+    @conn.publish queue, "test_stomp#test_client_ack_with_symbol_11"
+    msg = @conn.receive
+    assert_nothing_raised {
+      # ACK has two REQUIRED headers: message-id, which MUST contain a value 
+      # matching the message-id for the MESSAGE being acknowledged and 
+      # subscription, which MUST be set to match the value of the subscription's 
+      # id header.
+      @conn.ack msg.headers['message-id'], :subscription => sid
     }
+    checkEmsg(@conn)
+  end
+
+  # Test ACKs for Stomp 1.2
+  def test_client_ack_with_symbol_12
+    if @conn.protocol != Stomp::SPL_12
+      assert true
+      return
+    end
+    sid = @conn.uuid()
+    queue = make_destination()
+    @conn.subscribe queue, :ack => :client, :id => sid
+    @conn.publish queue, "test_stomp#test_client_ack_with_symbol_11"
+    msg = @conn.receive
+    assert_nothing_raised {
+      # The ACK frame MUST include an id header matching the ack header 
+      # of the MESSAGE being acknowledged.
+      @conn.ack msg.headers['ack']
+    }
+    checkEmsg(@conn)
   end
 
   # Test a message with 0x00 embedded in the body.
@@ -105,6 +146,7 @@ class TestConnection < Test::Unit::TestCase
     @conn.publish make_destination, "a\0"
     msg = @conn.receive
     assert_equal "a\0" , msg.body
+    checkEmsg(@conn)
   end
 
   # Test connection open checking.
@@ -176,6 +218,7 @@ class TestConnection < Test::Unit::TestCase
     @conn.publish make_destination, "a\0"
     msg = @conn.receive
     assert_instance_of Stomp::Message , msg
+    checkEmsg(@conn)
   end
 
   # Test converting a Message to a string.
@@ -184,6 +227,7 @@ class TestConnection < Test::Unit::TestCase
     @conn.publish make_destination, "a\0"
     msg = @conn.receive
     assert_match /^<Stomp::Message headers=/ , msg.to_s
+    checkEmsg(@conn)
   end
   
   # Test that a connection frame is present.
@@ -202,6 +246,7 @@ class TestConnection < Test::Unit::TestCase
 
     assert_equal "a\n\n", msg_a.body
     assert_equal "b\n\na\n\n", msg_b.body
+    checkEmsg(@conn)
   end
 
   # Test publishing multiple messages.
@@ -214,6 +259,7 @@ class TestConnection < Test::Unit::TestCase
 
     assert_equal "a\0", msg_a.body
     assert_equal "b\0", msg_b.body
+    checkEmsg(@conn)
   end
 
   def test_thread_hang_one
@@ -230,6 +276,7 @@ class TestConnection < Test::Unit::TestCase
     sleep 1
     assert_not_nil received
     assert_equal message, received.body
+    checkEmsg(@conn)
   end
 
   # Test polling with a single thread.
@@ -251,6 +298,7 @@ class TestConnection < Test::Unit::TestCase
     sleep max_sleep+1
     assert_not_nil received
     assert_equal message, received.body
+    checkEmsg(@conn)
   end
 
   # Test receiving with multiple threads.
@@ -289,6 +337,7 @@ class TestConnection < Test::Unit::TestCase
       sleep sleep_incr
     end
     assert_equal @max_msgs, msg_ctr
+    checkEmsg(@conn)
   end unless RUBY_ENGINE =~ /jruby/
 
   # Test polling with multiple threads.
@@ -333,6 +382,7 @@ class TestConnection < Test::Unit::TestCase
       sleep sleep_incr
     end
     assert_equal @max_msgs, msg_ctr
+    checkEmsg(@conn)
   end unless RUBY_ENGINE =~ /jruby/
 
   # Test using a nil body.
@@ -343,7 +393,8 @@ class TestConnection < Test::Unit::TestCase
     }
     conn_subscribe dest
     msg = @conn.receive
-    assert_equal "", msg.body    
+    assert_equal "", msg.body
+    checkEmsg(@conn)
   end
 
   # Test transaction message sequencing.
@@ -361,6 +412,7 @@ class TestConnection < Test::Unit::TestCase
     @conn.commit "txA"
     msg = @conn.receive
     assert_equal "txn message", msg.body
+    checkEmsg(@conn)
   end
 
   # Test duplicate subscriptions.
@@ -373,6 +425,7 @@ class TestConnection < Test::Unit::TestCase
     assert_raise Stomp::Error::DuplicateSubscription do
       conn_subscribe dest
     end
+    checkEmsg(@conn)
   end
 
   # Test nil 1.1 connection parameters.
@@ -382,6 +435,7 @@ class TestConnection < Test::Unit::TestCase
     assert_nothing_raised do
       @conn = Stomp::Connection.open(user, passcode, host, port, false, 5, nil)
     end
+    checkEmsg(@conn)
   end
 
   # Basic NAK test.
@@ -391,18 +445,29 @@ class TestConnection < Test::Unit::TestCase
         @conn.nack "dummy msg-id"
       end
     else
-      sid = @conn.uuid()
       dest = make_destination
-      @conn.subscribe dest, :ack => :client, :id => sid
       smsg = "test_stomp#test_nack01: #{Time.now.to_f}"
-      @conn.publish make_destination, smsg
+      @conn.publish dest, smsg
+      #
+      sid = @conn.uuid()
+      @conn.subscribe dest, :ack => :client, :id => sid
       msg = @conn.receive
       assert_equal smsg, msg.body
-      assert_nothing_raised {
-        @conn.nack msg.headers["message-id"], :subscription => sid
-        sleep 0.05 # Give racy brokers a chance to handle the last nack before unsubscribe
-        @conn.unsubscribe dest, :id => sid
-      }
+      case @conn.protocol
+        when Stomp::SPL_12
+          assert_nothing_raised {
+            @conn.nack msg.headers["ack"]
+            sleep 0.05 # Give racy brokers a chance to handle the last nack before unsubscribe
+            @conn.unsubscribe dest, :id => sid
+          }
+        else # Stomp::SPL_11
+          assert_nothing_raised {
+            @conn.nack msg.headers["message-id"], :subscription => sid
+            sleep 0.05 # Give racy brokers a chance to handle the last nack before unsubscribe
+            @conn.unsubscribe dest, :id => sid
+          }
+      end
+
       # phase 2
       teardown()
       setup()
@@ -410,6 +475,7 @@ class TestConnection < Test::Unit::TestCase
       @conn.subscribe dest, :ack => :auto, :id => sid
       msg2 = @conn.receive
       assert_equal smsg, msg2.body
+      checkEmsg(@conn)
     end
   end unless ENV['STOMP_AMQ11'] # AMQ sends NACK'd messages to a DLQ
 
@@ -443,5 +509,6 @@ class TestConnection < Test::Unit::TestCase
     }
     c.disconnect if c
   end
+
 end
 

data/test/test_connection1p.rb

@@ -244,7 +244,7 @@ class TestConnection1P < Test::Unit::TestCase
   # - RabbitMQ does not emit repeated headers under any circumstances
   # - AMQ 5.6 does not emit repeated headers under any circumstances
   # Pure luck that this runs against AMQ at present.
-  def test_conn_1p_0120
+  def test_conn_1p_0124
     dest = make_destination
     msg = "payload: #{Time.now.to_f}"
     shdrs = { "key1" => "val1", "key2" => "val2",
@@ -259,7 +259,7 @@ class TestConnection1P < Test::Unit::TestCase
     received = @conn.receive
     assert_equal msg, received.body
     if @conn.protocol != Stomp::SPL_10
-      assert_equal shdrs["key3"], received.headers["key3"] unless ENV['STOMP_RABBIT']
+      assert_equal shdrs["key3"], received.headers["key3"] unless ENV['STOMP_RABBIT'] || ENV['STOMP_AMQ11']
     else
       assert_equal "kv3", received.headers["key3"]
     end
@@ -268,7 +268,7 @@ class TestConnection1P < Test::Unit::TestCase
   end
 
   # Test frozen headers.
-  def test_conn_1p_0120
+  def test_conn_1p_0127
     dest = make_destination
     sid = @conn.uuid()
     sid.freeze
@@ -297,7 +297,7 @@ class TestConnection1P < Test::Unit::TestCase
   end if ENV['STOMP_HB11LONG']
 
   # Test heartbeats with send and receive.
-  def test_conn_1p_0130
+  def test_conn_1p_0135
     #
     cha = {:host => "localhost", "accept-version" => "1.1"}
     cha[:host] = "/" if ENV['STOMP_RABBIT']
@@ -357,5 +357,5 @@ private
     assert conn.hbrecv_count > 0
   end
 
-end if ENV['STOMP_TEST11']
+end if ENV['STOMP_TEST11p']
 

data/test/test_helper.rb

@@ -64,7 +64,15 @@ module TestBase
   # Get a Stomp Connection.
   def get_connection()
     ch = get_conn_headers()
-    conn = Stomp::Connection.open(user, passcode, host, port, false, 5, ch)
+    hash = { :hosts => [ 
+      {:login => user, :passcode => passcode, :host => host, :port => port, :ssl => nil},
+      ],
+      :reliable => false,
+      :connect_headers => ch,
+      :stompconn => get_stomp_conn(),
+      :usecrlf => get_crlf(),
+    }
+    conn = Stomp::Connection.open(hash)
     conn
   end
 
@@ -75,7 +83,9 @@ module TestBase
     hash = { :hosts => [ 
       {:login => user, :passcode => passcode, :host => host, :port => ssl_port, :ssl => ssl_params},
       ],
-      :connect_headers => ch
+      :connect_headers => ch,
+      :stompconn => get_stomp_conn(),
+      :usecrlf => get_crlf(),
     }
     conn = Stomp::Connection.new(hash)
     conn
@@ -86,7 +96,9 @@ module TestBase
     hash = { :hosts => [ 
           {:login => user, :passcode => passcode, :host => host, :port => port},
           ],
-          :connect_headers => get_conn_headers()
+          :connect_headers => get_conn_headers(),
+          :stompconn => get_stomp_conn(),
+          :usecrlf => get_crlf(),
         }
 
     client = Stomp::Client.new(hash)
@@ -96,12 +108,14 @@ module TestBase
   # Get a connection headers hash.
   def get_conn_headers()
     ch = {}
-    if ENV['STOMP_TEST11']
+    if ENV['STOMP_TEST11p']
       #
-      if Stomp::SUPPORTED.index(ENV['STOMP_TEST11'])
-        ch['accept-version'] = ENV['STOMP_TEST11']
+      raise "Invalid 1.1 plus test protocol" if ENV['STOMP_TEST11p'] == Stomp::SPL_10
+      #
+      if Stomp::SUPPORTED.index(ENV['STOMP_TEST11p'])
+        ch['accept-version'] = ENV['STOMP_TEST11p']
       else
-        ch['accept-version'] = Stomp::SPL_11
+        ch['accept-version'] = Stomp::SPL_11 # Just use 1.1
       end
       #
       ch['host'] = ENV['STOMP_RABBIT'] ? "/" : host
@@ -109,6 +123,20 @@ module TestBase
     ch
   end
 
+  # Determine if tests should use STOMP instead of CONNECT
+  def get_stomp_conn()
+    usc = false
+    usc = true if ENV['STOMP_TEST11p'] && Stomp::SUPPORTED.index(ENV['STOMP_TEST11p']) && ENV['STOMP_TEST11p'] >= Stomp::SPL_11 && ENV['STOMP_CONN']
+    usc
+  end
+
+  # Determine if tests should \r\n as line ends
+  def get_crlf()
+    ucr = false
+    ucr = true if ENV['STOMP_TEST11p'] && Stomp::SUPPORTED.index(ENV['STOMP_TEST11p']) && ENV['STOMP_TEST11p'] >= Stomp::SPL_12 && ENV['STOMP_CRLF']
+    ucr
+  end
+
   # Subscribe to a destination.
   def conn_subscribe(dest, headers = {})
     if @conn.protocol >= Stomp::SPL_11
@@ -123,5 +151,13 @@ module TestBase
     qname = ENV['STOMP_DOTQUEUE'] ? "/queue/test.ruby.stomp." + name : "/queue/test/ruby/stomp/" + name
   end
 
+  #
+  def checkEmsg(cc)
+    m = cc.poll
+    if m
+      assert m.command != Stomp::CMD_ERROR
+    end
+  end
+
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stomp
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 1
   - 2
-  - 6
-  version: 1.2.6
+  - 7
+  version: 1.2.7
 platform: ruby
 authors: 
 - Brian McCallister
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-05 00:00:00 -04:00
+date: 2012-11-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency