stomp 1.3.2 → 1.3.3

data/lib/client/utils.rb

@@ -13,7 +13,8 @@ module Stomp
       return false unless params.is_a?(Hash)
 
       @parameters = params
-      @parameters[:reliable] = true
+      # Do not override user choice of false.
+      @parameters[:reliable] = true unless @parameters[:reliable] == false
 
       true
     end
@@ -87,14 +88,28 @@ module Stomp
       hosts
     end
 
-    # A very basic check of required arguments.
+    # A sanity check of required arguments.
     def check_arguments!()
-      first_host = @parameters && @parameters[:hosts] && @parameters[:hosts].first
-
-      raise ArgumentError if first_host.nil?
-      raise ArgumentError if first_host[:host].nil? || first_host[:host].empty?
-      raise ArgumentError if first_host[:port].nil? || first_host[:port] == '' || first_host[:port] < 1 || first_host[:port] > 65535
+      raise ArgumentError.new("missing :hosts parameter") unless @parameters[:hosts]
+      raise ArgumentError.new("invalid :hosts type") unless @parameters[:hosts].is_a?(Array)
+      @parameters[:hosts].each do |hv|
+        # Validate port requested
+        raise ArgumentError.new("empty :port value in #{hv.inspect}") if hv[:port] == ''
+        unless hv[:port].nil? 
+          tpv = hv[:port].to_i
+          raise ArgumentError.new("invalid :port value=#{tpv} from #{hv.inspect}") if tpv < 1 || tpv > 65535
+        end
+        # Validate host requested (no validation here.  if nil or '', localhost will
+        # be used in #Connection.)
+      end
       raise ArgumentError unless @parameters[:reliable].is_a?(TrueClass) || @parameters[:reliable].is_a?(FalseClass)
+      #
+      if @parameters[:reliable] && @start_timeout > 0
+        warn "WARN detected :reliable == true and :start_timeout > 0"
+        warn "WARN this may cause incorrect fail-over behavior"
+        warn "WARN use :start_timeout => 0 to correct"
+        warn "WARN !! :start_timeout default will change to 0 in the next release"
+      end
     end
 
     # filter_options returns a new Hash of filtered options.

data/lib/connection/netio.rb

@@ -171,7 +171,7 @@ module Stomp
           end
         end
         _wire_write(used_socket,"")
-        used_socket.write body
+        used_socket.write body unless body == ''
         used_socket.write "\0"
         used_socket.flush if autoflush
 
@@ -306,6 +306,10 @@ module Stomp
         lp = log_params.clone
         lp[:ssl_exception] = ex
         slog(:on_ssl_connectfail, lp)
+        if ssl
+          # shut down the TCP socket - we just failed to do the SSL handshake in time
+          ssl.close
+        end
         #
         raise # Reraise
       end

data/lib/stomp/client.rb

@@ -81,11 +81,10 @@ module Stomp
         parse_failover_url(login) ||
         parse_positional_params(login, passcode, host, port, reliable)
 
-      check_arguments!()
-
       @logger = @parameters[:logger] ||= Stomp::NullLogger.new
+      @start_timeout = @parameters[:start_timeout] || 10.0
+      check_arguments!()
 
-      @start_timeout = @parameters[:start_timeout] || 10
       begin
         timeout(@start_timeout) {
           create_error_handler

data/lib/stomp/connection.rb

@@ -192,6 +192,8 @@ module Stomp
     # Begin starts a transaction, and requires a name for the transaction
     def begin(name, headers = {})
       raise Stomp::Error::NoCurrentConnection if @closed_check && closed?
+      raise Stomp::Error::ProtocolErrorEmptyHeaderKey if headers.has_key?("")
+      raise Stomp::Error::ProtocolErrorEmptyHeaderValue if @protocol == Stomp::SPL_10 && headers.has_value?("")
       headers = headers.symbolize_keys
       headers[:transaction] = name
       _headerCheck(headers)
@@ -205,6 +207,8 @@ module Stomp
     # 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::ProtocolErrorEmptyHeaderKey if headers.has_key?("")
+      raise Stomp::Error::ProtocolErrorEmptyHeaderValue if @protocol == Stomp::SPL_10 && headers.has_value?("")
       raise Stomp::Error::MessageIDRequiredError if message_id.nil? || message_id == ""
       headers = headers.symbolize_keys
 
@@ -234,6 +238,7 @@ module Stomp
     def nack(message_id, headers = {})
       raise Stomp::Error::NoCurrentConnection if @closed_check && closed?
       raise Stomp::Error::UnsupportedProtocolError if @protocol == Stomp::SPL_10
+      raise Stomp::Error::ProtocolErrorEmptyHeaderKey if headers.has_key?("")
       raise Stomp::Error::MessageIDRequiredError if message_id.nil? || message_id == ""
       headers = headers.symbolize_keys
       case @protocol
@@ -257,6 +262,8 @@ module Stomp
     # Commit commits a transaction by name.
     def commit(name, headers = {})
       raise Stomp::Error::NoCurrentConnection if @closed_check && closed?
+      raise Stomp::Error::ProtocolErrorEmptyHeaderKey if headers.has_key?("")
+      raise Stomp::Error::ProtocolErrorEmptyHeaderValue if @protocol == Stomp::SPL_10 && headers.has_value?("")
       headers = headers.symbolize_keys
       headers[:transaction] = name
       _headerCheck(headers)
@@ -267,6 +274,8 @@ module Stomp
     # Abort aborts a transaction by name.
     def abort(name, headers = {})
       raise Stomp::Error::NoCurrentConnection if @closed_check && closed?
+      raise Stomp::Error::ProtocolErrorEmptyHeaderKey if headers.has_key?("")
+      raise Stomp::Error::ProtocolErrorEmptyHeaderValue if @protocol == Stomp::SPL_10 && headers.has_value?("")
       headers = headers.symbolize_keys
       headers[:transaction] = name
       _headerCheck(headers)
@@ -278,6 +287,8 @@ module Stomp
     # For Stomp 1.1+ a session unique subscription ID is also required.
     def subscribe(name, headers = {}, subId = nil)
       raise Stomp::Error::NoCurrentConnection if @closed_check && closed?
+      raise Stomp::Error::ProtocolErrorEmptyHeaderKey if headers.has_key?("")
+      raise Stomp::Error::ProtocolErrorEmptyHeaderValue if @protocol == Stomp::SPL_10 && headers.has_value?("")
       headers = headers.symbolize_keys
       headers[:destination] = name
       if @protocol >= Stomp::SPL_11
@@ -301,6 +312,8 @@ module Stomp
     # For Stomp 1.1+ a session unique subscription ID is also required.
     def unsubscribe(dest, headers = {}, subId = nil)
       raise Stomp::Error::NoCurrentConnection if @closed_check && closed?
+      raise Stomp::Error::ProtocolErrorEmptyHeaderKey if headers.has_key?("")
+      raise Stomp::Error::ProtocolErrorEmptyHeaderValue if @protocol == Stomp::SPL_10 && headers.has_value?("")
       headers = headers.symbolize_keys
       headers[:destination] = dest
       if @protocol >= Stomp::SPL_11
@@ -321,6 +334,8 @@ module Stomp
     # Accepts a transaction header ( :transaction => 'some_transaction_id' ).
     def publish(destination, message, headers = {})
       raise Stomp::Error::NoCurrentConnection if @closed_check && closed?
+      raise Stomp::Error::ProtocolErrorEmptyHeaderKey if headers.has_key?("")
+      raise Stomp::Error::ProtocolErrorEmptyHeaderValue if @protocol == Stomp::SPL_10 && headers.has_value?("")
       headers = headers.symbolize_keys
       headers[:destination] = destination
       _headerCheck(headers)
@@ -379,6 +394,8 @@ module Stomp
     # will be received.
     def disconnect(headers = {})
       raise Stomp::Error::NoCurrentConnection if @closed_check && closed?
+      raise Stomp::Error::ProtocolErrorEmptyHeaderKey if headers.has_key?("")
+      raise Stomp::Error::ProtocolErrorEmptyHeaderValue if @protocol == Stomp::SPL_10 && headers.has_value?("")
       headers = headers.symbolize_keys
       _headerCheck(headers)
       if @protocol >= Stomp::SPL_11

data/lib/stomp/errors.rb

@@ -71,6 +71,23 @@ module Stomp
       end
     end
 
+    # ProtocolErrorEmptyHeaderKey is raised if:
+    # * Any header key is empty ("")
+    class ProtocolErrorEmptyHeaderKey < RuntimeError
+      def message
+        "Empty header key"
+      end
+    end
+
+    # ProtocolErrorEmptyHeaderValue is raised if:
+    # * Any header value is empty ("") *and*
+    # * Connection protocol level == 1.0
+    class ProtocolErrorEmptyHeaderValue < RuntimeError
+      def message
+        "Empty header value, STOMP 1.0"
+      end
+    end
+
     # ProtocolError11p - base class of 1.1 CONNECT errors
     class ProtocolError11p < RuntimeError
       def message

data/lib/stomp/message.rb

@@ -85,6 +85,9 @@ module Stomp
         end
       end
 
+      raise Stomp::Error::ProtocolErrorEmptyHeaderKey if self.headers.has_key?("")
+      raise Stomp::Error::ProtocolErrorEmptyHeaderValue if (!protocol11p) && self.headers.has_value?("")
+
       body_length = -1
 
       if self.headers['content-length']

data/lib/stomp/version.rb

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

data/stomp.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stomp}
-  s.version = "1.3.2"
+  s.version = "1.3.3"
 
   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{2013-12-08}
+  s.date = %q{2014-08-10}
   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

@@ -640,6 +640,33 @@ class TestClient < Test::Unit::TestCase
     end
   end
 
+  # test issue99, OK values
+  def test_cli_iss99_ok
+    return unless host() == "localhost" && port() == 61613
+    @client.close
+    #
+    ok_vals = dflt_data_ok()
+    ok_vals.each do |hsv|
+      assert_nothing_raised {
+        cli = Stomp::Client.open(hsv)
+        cli.close
+      }
+    end
+  end
+
+  # test issue99, exception values
+  def test_cli_iss99_ex
+    return unless host() == "localhost" && port() == 61613
+    @client.close
+    #
+    ex_vals = dflt_data_ex()
+    ex_vals.each do |hsv|
+      assert_raise ArgumentError do
+        cli = Stomp::Client.open(hsv)
+      end
+    end
+  end
+
   private
     def message_text
       name = caller_method_name unless name

data/test/test_connection.rb

@@ -231,7 +231,7 @@ class TestConnection < Test::Unit::TestCase
   
   # Test that a connection frame is present.
   def test_connection_frame
-  	assert_not_nil @conn.connection_frame
+    assert_not_nil @conn.connection_frame
   end
   
   # Test messages with multiple line ends.
@@ -519,5 +519,107 @@ class TestConnection < Test::Unit::TestCase
     end
   end
 
+  # Test that methods detect an empty header key.
+  def test_empty_header_key
+    #
+    bad_headers = {"a" => "11", "" => "emptykey", :c => "ccc"}
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderKey do
+      @conn.ack("dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderKey do
+      @conn.nack("dummy_data", bad_headers)
+    end if @conn.protocol != Stomp::SPL_10
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderKey do
+      @conn.begin("dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderKey do
+      @conn.commit("dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderKey do
+      @conn.abort("dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderKey do
+      @conn.subscribe("dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderKey do
+      @conn.unsubscribe("dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderKey do
+      @conn.publish("dummy_data","dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderKey do
+      @conn.disconnect(bad_headers)
+    end
+  end
+
+  # Test that methods detect an empty header value.
+  # STOMP 1.0 only.
+  def test_empty_header_value
+    if @conn.protocol != Stomp::SPL_10
+      assert true
+      return
+    end
+    #
+    bad_headers = {"a" => "11", "hdra" => "", :c => "ccc"}
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderValue do
+      @conn.ack("dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderValue do
+      @conn.nack("dummy_data", bad_headers)
+    end if @conn.protocol != Stomp::SPL_10
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderValue do
+      @conn.begin("dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderValue do
+      @conn.commit("dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderValue do
+      @conn.abort("dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderValue do
+      @conn.subscribe("dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderValue do
+      @conn.unsubscribe("dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderValue do
+      @conn.publish("dummy_data","dummy_data", bad_headers)
+    end
+    #
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderValue do
+      @conn.disconnect(bad_headers)
+    end
+  end
+
+  # test issue99, OK values
+  def test_con_iss99_ok
+    return unless host() == "localhost" && port() == 61613
+    #
+    ok_vals = dflt_data_ok()
+    ok_vals.each do |hsv|
+      assert_nothing_raised {
+        conn = Stomp::Connection.new(hsv)
+        conn.disconnect
+      }
+    end
+  end
+
 end
 

data/test/test_helper.rb

@@ -184,5 +184,58 @@ module TestBase
     jr = defined?(RUBY_ENGINE) && RUBY_ENGINE =~ /jruby/ ? true : false
   end
 
+  # OK Data For Default Tests
+  def dflt_data_ok()
+    [
+       #
+       {  :hosts => [
+          {:login => 'guest', :passcode => 'guest', :host => "localhost", :port => 61613, :ssl => false},
+          ],
+       :reliable => false,
+       },
+       #
+       {  :hosts => [
+          {:login => 'guest', :passcode => 'guest', :ssl => false},
+          ],
+       :reliable => false,
+       },
+       #
+       {  :hosts => [
+          {:login => 'guest', :passcode => 'guest', :port => 61613, :ssl => false},
+          ],
+       :reliable => false,
+       },
+       #
+       {  :hosts => [
+          {:login => 'guest', :passcode => 'guest', :host => "localhost" , :ssl => false},
+          ],
+       :reliable => false,
+       },
+       #
+       {  :hosts => [
+          {:login => 'guest', :passcode => 'guest', :host => '' , :ssl => false},
+          ],
+       :reliable => false,
+       },
+    ]
+  end
+
+  # Exception Data For Default Tests
+  def dflt_data_ex()
+    [
+      {},
+      {:hosts => 123},
+      {  :hosts => [
+        {:login => 'guest', :passcode => 'guest', :host => "localhost", :port => '' , :ssl => false},
+        ],
+      :reliable => false,
+      },
+      {  :hosts => [
+        {:login => 'guest', :passcode => 'guest', :host => "localhost", :port => -1 , :ssl => false},
+        ],
+      :reliable => false,
+      },
+    ]
+  end
 end
 

data/test/test_message.rb

@@ -172,5 +172,37 @@ class TestMessage < Test::Unit::TestCase
     assert_equal "val1", bframe.headers["h2"][2], "Expected val1"
   end
 
+	# Test headers with empty key / value
+	def test_0060_hdr_ekv
+    #
+    amsg = "MESSAGE\n" +
+      "h1:val1\n" +
+      ":val3\n" +
+      "h2:val2\n" +
+      "\n" +
+      "payload" +
+      "\0\n"
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderKey do
+      aframe = Stomp::Message.new(amsg, false)
+    end
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderKey do
+      aframe = Stomp::Message.new(amsg, true)
+    end
+    #
+    amsg = "MESSAGE\n" +
+      "h1:val1\n" +
+      "h2:val3\n" +
+      "h3:\n" +
+      "\n" +
+      "payload" +
+      "\0\n"
+    assert_raise Stomp::Error::ProtocolErrorEmptyHeaderValue do
+      aframe = Stomp::Message.new(amsg, false)
+    end
+    assert_nothing_raised {
+      aframe = Stomp::Message.new(amsg, true)
+    }
+  end
+
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stomp
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 1
   - 3
-  - 2
-  version: 1.3.2
+  - 3
+  version: 1.3.3
 platform: ruby
 authors: 
 - Brian McCallister
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-12-08 00:00:00 -05:00
+date: 2014-08-10 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency