stomp 1.4.1 → 1.4.2

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Stomp Gem Change Log
 
+## 1.4.2 20160820
+
+* Refine SSL examples.
+* Address issue #124 with additional RDOC.
+* spec for Stomp::Client - check that headers passed to connection contain 
+  required values as well as given custom and that given hash is not modified.
+* Stomp::Client now does not modify given headers hash
+* spec description enhancement.
+* fix build_subscription_id - symbol and string were mixed up.
+* STOMP_TESTSSL flag should enable all SSL tests.
+* Add a basic Gemfile.
+* Fix a memory leak in receipt implementation.
+* Add unit test helper script.
+
 ## 1.4.1 20160623
 
 * Add call to #post_connection_check to normal SSL processing.  This change

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '~> 0.8.2'

data/README.md

@@ -93,6 +93,7 @@ A Stomp URL must begin with 'stomp://' and can be in one of the following forms:
 
 See _CHANGELOG.rdoc_ for details.
 
+* Gem version 1.4.2. Fix memory leak, and others !: see CHANGELOG.md for details.
 * Gem version 1.4.1. Important SSL changes !: see CHANGELOG.md for details.
 * Gem version 1.4.0. Note: Change sementics of :parse_timeout, see CHANGELOG.md for details.
 * Gem version 1.3.5. Miscellaneous fixes, see CHANGELOG.rdoc for details.
@@ -291,7 +292,7 @@ Thiago Morello
 2009-12-25
 </td>
 <td style="border: 1px solid black;padding-left: 10px;" >
-(0362)
+(0369)
 </td>
 <td style="border: 1px solid black;padding-left: 10px;" >
 <span style="font-weight: bold;" >
@@ -706,5 +707,60 @@ Wayne Robinson
  / wayne.robinson@gmail.com
 </td>
 </tr>
+<tr>
+<td style="border: 1px solid black;padding-left: 10px;" >
+2016-07-12
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+(0006)
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+<span style="font-weight: bold;" >
+Nikolay Khasanov
+</span>
+ / nkhasanov@groupon.com
+</td>
+</tr>
+<tr>
+<td style="border: 1px solid black;padding-left: 10px;" >
+2016-07-16
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+(0004)
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+<span style="font-weight: bold;" >
+GitHub
+</span>
+ / noreply@github.com
+</td>
+</tr>
+<tr>
+<td style="border: 1px solid black;padding-left: 10px;" >
+2016-06-02
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+(0001)
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+<span style="font-weight: bold;" >
+Ryan Rosenblum
+</span>
+ / ryan.rosenblum@gmail.com
+</td>
+</tr>
+<tr>
+<td style="border: 1px solid black;padding-left: 10px;" >
+2016-08-17
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+(0002)
+</td>
+<td style="border: 1px solid black;padding-left: 10px;" >
+<span style="font-weight: bold;" >
+Alexandre Moutot
+</span>
+ / a.moutot@alphalink.fr
+</td>
+</tr>
 </table>
-

data/examples/ssl_common.rb

@@ -0,0 +1,73 @@
+# -*- encoding: utf-8 -*-
+
+#
+# Common Stomp 1.1 code.
+#
+require "rubygems" if RUBY_VERSION < "1.9"
+require "stomp"
+#
+module SSLCommon
+
+	# CA Data.
+
+  # CA file location/directory.  Change or specify.
+	# This is the author's default.
+  def ca_loc()
+		ENV['CA_FLOC'] || "/ad3/gma/sslwork/2013-extended-02" # The CA cert location
+  end
+  # CA file.  Change or specify.
+	# This is the author's default.
+  def ca_cert()
+		ENV['CA_FILE'] || "TestCA.crt" # The CA cert File
+  end
+  # CA private key file.  Change or specify.
+	# This is the author's default.
+	# This file should not be exposed to the outside world.
+	# Not currently used in stomp examples.
+  def ca_key()
+		ENV['CA_KEY'] || nil # The CA private key File
+  end
+
+	# Client Data.
+
+  # Client file location/directory.  Change or specify.
+	# This is the author's default.
+  def cli_loc()
+		ENV['CLI_FLOC'] || "/ad3/gma/sslwork/2013-extended-02" # The client cert location
+  end
+  # Client cert file.  Change or specify.
+	# This is the author's default.
+  def cli_cert()
+		ENV['CLI_FILE'] || "client.crt" # The client cert File
+  end
+  # Client private keyfile.  Change or specify.
+	# This is the author's default.
+	# This file should not be exposed to the outside world.
+  def cli_key()
+		ENV['CLI_KEY'] || nil # The client private key File
+  end
+
+	# Server Data.
+
+  # Server file location/directory.  Change or specify.
+	# This is the author's default.
+	# Not currently used in stomp examples.
+  def svr_loc()
+		ENV['SVR_FLOC'] || "/ad3/gma/sslwork/2013-extended-02" # The server cert location
+  end
+  # Server cert file.  Change or specify.
+	# This is the author's default.
+	# Not currently used in stomp examples.
+  def svr_cert()
+		ENV['SVR_FILE'] || "server.crt" # The server cert File
+  end
+  # Server private keyfile.  Change or specify.
+	# This is the author's default.
+	# This file should not be exposed to the outside world.
+	# Not currently used in stomp examples.
+  def svr_key()
+		ENV['SVR_KEY'] || nil # The server private key File
+  end
+
+end
+

data/examples/ssl_uc1.rb

@@ -3,8 +3,14 @@
 #
 # Reference: https://github.com/stompgem/stomp/wiki/extended-ssl-overview
 #
-require "rubygems"
-require "stomp"
+#
+if Kernel.respond_to?(:require_relative)
+  require_relative("./ssl_common")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "ssl_common"
+end
+include SSLCommon
 #
 # == SSL Use Case 1 - server does *not* authenticate client, client does *not* authenticate server
 #
@@ -20,7 +26,7 @@ require "stomp"
 #
 class ExampleSSL1
   # Initialize.
-  def initialize
+  def initialize		# Change the following as needed.
 		@host = ENV['STOMP_HOST'] ? ENV['STOMP_HOST'] : "localhost"
 		@port = ENV['STOMP_PORT'] ? ENV['STOMP_PORT'].to_i : 61612
   end

data/examples/ssl_uc1_ciphers.rb

@@ -3,8 +3,13 @@
 #
 # Reference: https://github.com/stompgem/stomp/wiki/extended-ssl-overview
 #
-require "rubygems"
-require "stomp"
+if Kernel.respond_to?(:require_relative)
+  require_relative("./ssl_common")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "ssl_common"
+end
+include SSLCommon
 #
 # == SSL Use Case 1 - User Supplied Ciphers
 #
@@ -15,7 +20,9 @@ require "stomp"
 #
 class ExampleSSL1C
   # Initialize.
-  def initialize
+  def initialize		# Change the following as needed.
+		@host = ENV['STOMP_HOST'] ? ENV['STOMP_HOST'] : "localhost"
+		@port = ENV['STOMP_PORT'] ? ENV['STOMP_PORT'].to_i : 61612
   end
   # Run example.
   def run
@@ -27,7 +34,7 @@ class ExampleSSL1C
     # SSL Use Case 1
     #
     hash = { :hosts => [
-        {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => ssl_opts},
+        {:login => 'guest', :passcode => 'guest', :host => @host, :port => @port, :ssl => ssl_opts},
       ],
       :reliable => false, # YMMV, to test this in a sane manner
     }

data/examples/ssl_uc2.rb

@@ -3,8 +3,13 @@
 #
 # Reference: https://github.com/stompgem/stomp/wiki/extended-ssl-overview
 #
-require "rubygems"
-require "stomp"
+if Kernel.respond_to?(:require_relative)
+  require_relative("./ssl_common")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "ssl_common"
+end
+include SSLCommon
 #
 # == SSL Use Case 2 - server does *not* authenticate client, client *does* authenticate server
 #
@@ -21,8 +26,7 @@ require "stomp"
 class ExampleSSL2
   # Initialize.
   def initialize
-		# Change the following to the location of the cert file(s).
-		@cert_loc = "/ad3/gma/sslwork/2013"
+		# Change the following as needed.
 		@host = ENV['STOMP_HOST'] ? ENV['STOMP_HOST'] : "localhost"
 		@port = ENV['STOMP_PORT'] ? ENV['STOMP_PORT'].to_i : 61612
   end
@@ -32,8 +36,8 @@ class ExampleSSL2
 
     ts_flist = []
 
-    # Possibly change the cert file(s) name(s) here.
-		ts_flist << "#{@cert_loc}/TestCA.crt"
+    # Possibly change/override the cert data here.
+		ts_flist << "#{ca_loc()}/#{ca_cert()}"
 
     ssl_opts = Stomp::SSLParams.new(:ts_files => ts_flist.join(","), 
       :fsck => true)

data/examples/ssl_uc2_ciphers.rb

@@ -3,8 +3,13 @@
 #
 # Reference: https://github.com/stompgem/stomp/wiki/extended-ssl-overview
 #
-require "rubygems"
-require "stomp"
+if Kernel.respond_to?(:require_relative)
+  require_relative("./ssl_common")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "ssl_common"
+end
+include SSLCommon
 #
 # == SSL Use Case 2 - User Supplied Ciphers
 #
@@ -15,7 +20,9 @@ require "stomp"
 #
 class ExampleSSL2C
   # Initialize.
-  def initialize
+  def initialize		# Change the following as needed.
+		@host = ENV['STOMP_HOST'] ? ENV['STOMP_HOST'] : "localhost"
+		@port = ENV['STOMP_PORT'] ? ENV['STOMP_PORT'].to_i : 61612
   end
   # Run example.
   def run
@@ -25,8 +32,8 @@ class ExampleSSL2C
     #
     ts_flist = []
 
-    # Change the following to the location of your CA's signed certificate.
-    ts_flist << "/home/gmallard/sslwork/2013/TestCA.crt"
+    # Possibly change/override the cert data here.
+    ts_flist << "#{ca_loc()}/#{ca_cert()}"
 
     ssl_opts = Stomp::SSLParams.new(:ts_files => ts_flist.join(","), 
       :ciphers => ciphers_list,
@@ -34,7 +41,7 @@ class ExampleSSL2C
     )
     #
     hash = { :hosts => [
-        {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => ssl_opts},
+        {:login => 'guest', :passcode => 'guest', :host => @host, :port => @port, :ssl => ssl_opts},
       ],
       :reliable => false, # YMMV, to test this in a sane manner
     }

data/examples/ssl_uc3.rb

@@ -3,8 +3,13 @@
 #
 # Reference: https://github.com/stompgem/stomp/wiki/extended-ssl-overview
 #
-require "rubygems"
-require "stomp"
+if Kernel.respond_to?(:require_relative)
+  require_relative("./ssl_common")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "ssl_common"
+end
+include SSLCommon
 #
 # == SSL Use Case 3 - server *does* authenticate client, client does *not* authenticate server
 #
@@ -23,8 +28,7 @@ require "stomp"
 class ExampleSSL3
   # Initialize.
   def initialize
-		# Change the following to the location of the cert file(s).
-		@cert_loc = "/ad3/gma/sslwork/2013"
+		# Change the following as needed.
 		@host = ENV['STOMP_HOST'] ? ENV['STOMP_HOST'] : "localhost"
 		@port = ENV['STOMP_PORT'] ? ENV['STOMP_PORT'].to_i : 61612
   end
@@ -34,8 +38,8 @@ class ExampleSSL3
 
     # Possibly change the cert file(s) name(s) here.    
     ssl_opts = Stomp::SSLParams.new(
-      :key_file => "#{@cert_loc}/client.key", # the client's private key
-      :cert_file => "#{@cert_loc}/client.crt", # the client's signed certificate
+      :key_file => "#{cli_loc()}/#{pck()}", # the client's private key, private data
+      :cert_file => "#{cli_loc()}/#{cli_cert()}", # the client's signed certificate
       :fsck => true # Check that the files exist first
     )
 
@@ -53,6 +57,13 @@ class ExampleSSL3
     # puts "SSL Peer Certificate:\n#{ssl_opts.peer_cert}"
     c.disconnect
   end
+
+	private
+
+	def pck()
+		"client.key"
+	end
+
 end
 #
 e = ExampleSSL3.new

data/examples/ssl_uc3_ciphers.rb

@@ -3,8 +3,13 @@
 #
 # Reference: https://github.com/stompgem/stomp/wiki/extended-ssl-overview
 #
-require "rubygems"
-require "stomp"
+if Kernel.respond_to?(:require_relative)
+  require_relative("./ssl_common")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "ssl_common"
+end
+include SSLCommon
 #
 # == SSL Use Case 3 - User Supplied Ciphers
 #
@@ -15,7 +20,9 @@ require "stomp"
 #
 class ExampleSSL3C
   # Initialize.
-  def initialize
+  def initialize		# Change the following as needed.
+		@host = ENV['STOMP_HOST'] ? ENV['STOMP_HOST'] : "localhost"
+		@port = ENV['STOMP_PORT'] ? ENV['STOMP_PORT'].to_i : 61612
   end
   # Run example.
   def run
@@ -23,18 +30,15 @@ class ExampleSSL3C
     #
     # SSL Use Case 3
     #
-    # Change the following:
-    # * location of your client's signed certificate
-    # * location of tour client's private key.
+    # Possibly change the cert file(s) name(s) here.    
     ssl_opts = Stomp::SSLParams.new(
-      :key_file => "/home/gmallard/sslwork/2013/client.key", # the client's private key
-      :cert_file => "/home/gmallard/sslwork/2013/client.crt", # the client's signed certificate
-      :fsck => true, # Check that the files exist first
-      :ciphers => ciphers_list
+      :key_file => "#{cli_loc()}/#{pck()}", # the client's private key, private data
+      :cert_file => "#{cli_loc()}/#{cli_cert()}", # the client's signed certificate
+      :fsck => true # Check that the files exist first
     )
     #
     hash = { :hosts => [
-        {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => ssl_opts},
+        {:login => 'guest', :passcode => 'guest', :host => @host, :port => @port, :ssl => ssl_opts},
       ],
       :reliable => false, # YMMV, to test this in a sane manner
     }
@@ -46,6 +50,13 @@ class ExampleSSL3C
     # puts "SSL Peer Certificate:\n#{ssl_opts.peer_cert}"
     c.disconnect
   end
+
+	private
+
+	def pck()
+		"client.key"
+	end
+
 end
 #
 e = ExampleSSL3C.new

data/examples/ssl_uc4.rb

@@ -3,8 +3,13 @@
 #
 # Reference: https://github.com/stompgem/stomp/wiki/extended-ssl-overview
 #
-require "rubygems"
-require "stomp"
+if Kernel.respond_to?(:require_relative)
+  require_relative("./ssl_common")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "ssl_common"
+end
+include SSLCommon
 #
 # == SSL Use Case 4 - server *does* authenticate client, client *does* authenticate server
 #
@@ -23,8 +28,7 @@ require "stomp"
 class ExampleSSL4
   # Initialize.
   def initialize
-		# Change the following to the location of the cert file(s).
-		@cert_loc = "/ad3/gma/sslwork/2013"
+		# Change the following as needed.
 		@host = ENV['STOMP_HOST'] ? ENV['STOMP_HOST'] : "localhost"
 		@port = ENV['STOMP_PORT'] ? ENV['STOMP_PORT'].to_i : 61612
   end
@@ -34,9 +38,9 @@ class ExampleSSL4
 
     # Possibly change the cert file(s) name(s) here.    
     ssl_opts = Stomp::SSLParams.new(
-      :key_file => "#{@cert_loc}/client.key", # The client's private key
-      :cert_file => "#{@cert_loc}/client.crt", # The client's signed certificate
-      :ts_files => "#{@cert_loc}/TestCA.crt", # The CA's signed sertificate
+      :key_file => "#{cli_loc()}/#{pck()}", # the client's private key, private data
+      :cert_file => "#{cli_loc()}/#{cli_cert()}", # the client's signed certificate
+      :ts_files => "#{ca_loc()}/#{ca_cert()}", # The CA's signed sertificate
       :fsck => true # Check that files exist first
     )
     #
@@ -53,6 +57,13 @@ class ExampleSSL4
     # puts "SSL Peer Certificate:\n#{ssl_opts.peer_cert}"
     c.disconnect
   end
+
+	private
+
+	def pck()
+		"client.key"
+	end
+
 end
 #
 e = ExampleSSL4.new

data/examples/ssl_uc4_ciphers.rb

@@ -3,8 +3,13 @@
 #
 # Reference: https://github.com/stompgem/stomp/wiki/extended-ssl-overview
 #
-require "rubygems"
-require "stomp"
+if Kernel.respond_to?(:require_relative)
+  require_relative("./ssl_common")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "ssl_common"
+end
+include SSLCommon
 #
 # == SSL Use Case 4 - User Supplied Ciphers
 #
@@ -15,7 +20,9 @@ require "stomp"
 #
 class ExampleSSL4C
   # Initialize.
-  def initialize
+  def initialize		# Change the following as needed.
+		@host = ENV['STOMP_HOST'] ? ENV['STOMP_HOST'] : "localhost"
+		@port = ENV['STOMP_PORT'] ? ENV['STOMP_PORT'].to_i : 61612
   end
   # Run example.
   def run
@@ -23,20 +30,16 @@ class ExampleSSL4C
     #
     # SSL Use Case 4
     #
-    # Change the following:
-    # * location of the client's private key
-    # * location of the client's signed certificate
-    # * location of the server's CA signed certificate
+    # Possibly change the cert file(s) name(s) here.    
     ssl_opts = Stomp::SSLParams.new(
-      :key_file => "/home/gmallard/sslwork/2013/client.key", # The client's private key
-      :cert_file => "/home/gmallard/sslwork/2013/client.crt", # The client's signed certificate
-      :ts_files => "/home/gmallard/sslwork/2013/TestCA.crt", # The CA's signed sertificate
-      :fsck => true, # Check that files exist first
-      :ciphers => ciphers_list
+      :key_file => "#{cli_loc()}/#{pck()}", # the client's private key, private data
+      :cert_file => "#{cli_loc()}/#{cli_cert()}", # the client's signed certificate
+      :ts_files => "#{ca_loc()}/#{ca_cert()}", # The CA's signed sertificate
+      :fsck => true # Check that files exist first
     )
     #
     hash = { :hosts => [
-        {:login => 'guest', :passcode => 'guest', :host => 'localhost', :port => 61612, :ssl => ssl_opts},
+        {:login => 'guest', :passcode => 'guest', :host => @host, :port => @port, :ssl => ssl_opts},
       ],
       :reliable => false, # YMMV, to test this in a sane manner
     }
@@ -48,6 +51,13 @@ class ExampleSSL4C
     # puts "SSL Peer Certificate:\n#{ssl_opts.peer_cert}"
     c.disconnect
   end
+
+	private
+
+	def pck()
+		"client.key"
+	end
+
 end
 #
 e = ExampleSSL4C.new

data/lib/client/utils.rb

@@ -72,10 +72,13 @@ module Stomp
     # setting an id in the SUBSCRIPTION header is described in the stomp protocol docs:
     # http://stomp.github.com/
     def set_subscription_id_if_missing(destination, headers)
-      headers[:id] = headers[:id] ? headers[:id] : headers['id']
-      if headers[:id] == nil
-        headers[:id] = Digest::SHA1.hexdigest(destination)
-      end
+      headers[:id] = build_subscription_id(destination, headers)
+    end
+
+    def build_subscription_id(destination, headers)
+      return headers[:id] until headers[:id].nil?
+      return headers['id'] until headers['id'].nil?
+      Digest::SHA1.hexdigest(destination)
     end
 
     # Parse a stomp URL.
@@ -156,7 +159,10 @@ module Stomp
 
     def find_receipt_listener(message)
       listener = @receipt_listeners[message.headers['receipt-id']]
-      listener.call(message) if listener
+      if listener
+         listener.call(message)
+         @receipt_listeners.delete(message.headers['receipt-id'])
+      end
     end
 
     def create_listener_maps

data/lib/stomp/client.rb

@@ -118,6 +118,7 @@ module Stomp
                         Stomp::Error::BrokerException.new(error)
                     end
 
+        @receipt_listeners.delete(error.headers['receipt-id']) if error.headers['receipt-id']
         client_thread.raise exception
       end
     end
@@ -173,7 +174,7 @@ module Stomp
       # use subscription id to correlate messages to subscription. As described in
       # the SUBSCRIPTION section of the protocol: http://stomp.github.com/.
       # If no subscription id is provided, generate one.
-      set_subscription_id_if_missing(destination, headers)
+      headers = headers.merge(:id => build_subscription_id(destination, headers))
       if @listeners[headers[:id]]
         raise "attempting to subscribe to a queue with a previous subscription"
       end
@@ -183,7 +184,7 @@ module Stomp
 
     # Unsubscribe from a subscription by name.
     def unsubscribe(name, headers = {})
-      set_subscription_id_if_missing(name, headers)
+      headers = headers.merge(:id => build_subscription_id(name, headers))
       @connection.unsubscribe(name, headers)
       @listeners[headers[:id]] = nil
     end
@@ -203,7 +204,7 @@ module Stomp
         replay_list << message
       end
       if block_given?
-        headers['receipt'] = register_receipt_listener lambda {|r| yield r}
+        headers = headers.merge(:receipt => register_receipt_listener(lambda {|r| yield r}))
       end
       context = ack_context_for(message, headers)
       @connection.ack context[:message_id], context[:headers]
@@ -224,7 +225,7 @@ module Stomp
         when Stomp::SPL_12
          'ack'
         when Stomp::SPL_11
-         headers.merge!(:subscription => message.headers['subscription'])
+         headers = headers.merge(:subscription => message.headers['subscription'])
          'message-id'
         else
          'message-id'
@@ -243,7 +244,7 @@ module Stomp
     # Accepts a transaction header ( :transaction => 'some_transaction_id' ).
     def publish(destination, message, headers = {})
       if block_given?
-        headers['receipt'] = register_receipt_listener lambda {|r| yield r}
+        headers = headers.merge(:receipt => register_receipt_listener(lambda {|r| yield r}))
       end
       @connection.publish(destination, message, headers)
     end

data/lib/stomp/connection.rb

@@ -225,32 +225,51 @@ module Stomp
     end
 
     # Acknowledge a message, used when a subscription has specified
-    # client acknowledgement i.e. connection.subscribe("/queue/a", :ack => 'client').
-    # 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 = {})
+    # client acknowledgement e.g.:
+    #
+    #     connection.subscribe("/queue/a", :ack => 'client')
+    #
+    #     connection.subscribe("/queue/a", :ack => 'client-individual')
+    #
+    # as appropriate for the protocol level.
+    #
+    # Accepts an optional transaction header ( :transaction => 'some_transaction_id' ).
+    #
+    # When the connection protocol level is 1.0 or 1.1  the message_or_ack_id parameter
+    # should match the message-id header of the MESSAGE being acknowledged e.g.:
+    #
+    #     connection.ack(message.headers['message-id'])
+    #
+    # When the connection protocol level is 1.2 the message_or_ack_id parameter
+    # should match the ack header of the MESSAGE being acknowledged e.g.:
+    #
+    #     connection.ack(message.headers['ack'])
+    #
+    # In summary, the behavior is protocol level dependent, see the specifications
+    # and comments in the code.
+    def ack(message_or_ack_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 == ""
+      raise Stomp::Error::MessageIDRequiredError if message_or_ack_id.nil? || message_or_ack_id == ""
       headers = headers.symbolize_keys
 
       case @protocol
         when Stomp::SPL_12
-          # The ACK frame MUST include an id header matching the ack header 
+          # The ACK frame MUST include an "id" header matching the "ack" header 
           # of the MESSAGE being acknowledged.
-          headers[:id] = message_id
+          headers[:id] = message_or_ack_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 
+          # ACK has two REQUIRED headers: "message-id", which MUST contain a value 
+          # matching the message-id header of the MESSAGE being acknowledged and 
+          # "subscription", which MUST be set to match the value of SUBSCRIBE's 
           # id header.
-          headers[:'message-id'] = message_id
+          headers[:'message-id'] = message_or_ack_id
           raise Stomp::Error::SubscriptionRequiredError unless headers[:subscription]
         else # Stomp::SPL_10
-          # ACK has one required header, message-id, which must contain a value 
+          # 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
+          headers[:'message-id'] = message_or_ack_id
       end
       _headerCheck(headers)
       slog(:on_ack, log_params, headers)
@@ -258,23 +277,31 @@ module Stomp
     end
 
     # STOMP 1.1+ NACK.
-    def nack(message_id, headers = {})
+    #
+    # When the connection protocol level is 1.1  the message_or_ack_id parameter
+    # should match the message-id header of the MESSAGE being acknowledged.
+    #
+    # When the connection protocol level is 1.2 the message_or_ack_id parameter
+    # should match the ack header of the MESSAGE being acknowledged.
+    #
+    # Behavior is protocol level dependent, see the specifications and comments below.
+    def nack(message_or_ack_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 == ""
+      raise Stomp::Error::MessageIDRequiredError if message_or_ack_id.nil? || message_or_ack_id == ""
       headers = headers.symbolize_keys
       case @protocol
         when Stomp::SPL_12
           # The NACK frame MUST include an id header matching the ack header 
           # of the MESSAGE being acknowledged.
-          headers[:id] = message_id
+          headers[:id] = message_or_ack_id
         else # Stomp::SPL_11 only
           # NACK 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
+          headers[:'message-id'] = message_or_ack_id
           raise Stomp::Error::SubscriptionRequiredError unless headers[:subscription]
       end
       _headerCheck(headers)

data/lib/stomp/version.rb

@@ -4,9 +4,10 @@ module Stomp
 
   # Define the gem version.
   module Version  #:nodoc: all
-    MAJOR = 1
-    MINOR = 4
-    PATCH = 1
+    MAJOR =  1
+    MINOR =  4
+    PATCH = "2"
+    # PATCH = "2.plvl.001"
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/spec/client_spec.rb

@@ -402,4 +402,152 @@ describe Stomp::Client do
       end
     end
   end
+
+  describe '(used with custom headers)' do
+    before :each do
+      @client = Stomp::Client.new
+    end
+
+    def original_headers
+      {:custom_header => 'value'}
+    end
+
+    let(:connection_headers) { original_headers }
+    let(:headers) { original_headers }
+
+    shared_examples_for 'argument-safe method' do
+      describe 'given headers hash' do
+        subject { headers }
+        it 'is immutable' do
+          is_expected.to match(original_headers)
+        end
+      end
+    end
+
+    describe '#begin' do
+      before {
+        expect(@mock_connection).to receive(:begin).with('name', connection_headers)
+        @client.begin('name', headers)
+      }
+      it_behaves_like 'argument-safe method'
+    end
+
+    describe '#abort' do
+      before {
+        expect(@mock_connection).to receive(:abort).with('name', connection_headers)
+        @client.abort('name', headers)
+      }
+      it_behaves_like 'argument-safe method'
+    end
+
+    describe '#commit' do
+      before {
+        expect(@mock_connection).to receive(:commit).with('name', connection_headers)
+        @client.commit('name', headers)
+      }
+      it_behaves_like 'argument-safe method'
+    end
+
+    describe '#subscribe' do
+      let(:connection_headers) { original_headers.merge({:id => Digest::SHA1.hexdigest('destination')}) }
+      before {
+        expect(@mock_connection).to receive(:subscribe).with('destination', connection_headers)
+        @client.subscribe('destination', headers) {|dummy_subscriber| }
+      }
+      it_behaves_like 'argument-safe method'
+    end
+
+    describe '#unsubscribe' do
+      let(:connection_headers) { original_headers.merge({:id => Digest::SHA1.hexdigest('destination')}) }
+      before {
+        expect(@mock_connection).to receive(:unsubscribe).with('destination', connection_headers)
+        @client.unsubscribe('destination', headers) {|dummy_subscriber| }
+      }
+      it_behaves_like 'argument-safe method'
+    end
+
+    describe '#ack' do
+      describe 'with STOMP 1.0' do
+        let(:message) { double('message', :headers => {'message-id' => 'id'}) }
+        before {
+          allow(@client).to receive(:protocol).and_return(Stomp::SPL_10)
+          expect(@mock_connection).to receive(:ack).with('id', connection_headers)
+          @client.ack(message, headers)
+        }
+        it_behaves_like 'argument-safe method'
+      end
+      describe 'with STOMP 1.1' do
+        let(:message) { double('message', :headers => {'message-id' => 'id', 'subscription' => 'subscription_name'}) }
+        let(:connection_headers) { original_headers.merge({:subscription => 'subscription_name'}) }
+        before {
+          allow(@client).to receive(:protocol).and_return(Stomp::SPL_11)
+          expect(@mock_connection).to receive(:ack).with('id', connection_headers)
+          @client.ack(message, headers)
+        }
+        it_behaves_like 'argument-safe method'
+      end
+      describe 'with STOMP 1.2' do
+        let(:message) { double('message', :headers => {'ack' => 'id'}) }
+        before {
+          allow(@client).to receive(:protocol).and_return(Stomp::SPL_12)
+          expect(@mock_connection).to receive(:ack).with('id', connection_headers)
+          @client.ack(message, headers)
+        }
+        it_behaves_like 'argument-safe method'
+      end
+    end
+
+    describe '#nack' do
+      describe 'with STOMP 1.0' do
+        let(:message) { double('message', :headers => {'message-id' => 'id'}) }
+        before {
+          allow(@client).to receive(:protocol).and_return(Stomp::SPL_10)
+          expect(@mock_connection).to receive(:nack).with('id', connection_headers)
+          @client.nack(message, headers)
+        }
+        it_behaves_like 'argument-safe method'
+      end
+      describe 'with STOMP 1.1' do
+        let(:message) { double('message', :headers => {'message-id' => 'id', 'subscription' => 'subscription_name'}) }
+        let(:connection_headers) { original_headers.merge({:subscription => 'subscription_name'}) }
+        before {
+          allow(@client).to receive(:protocol).and_return(Stomp::SPL_11)
+          expect(@mock_connection).to receive(:nack).with('id', connection_headers)
+          @client.nack(message, headers)
+        }
+        it_behaves_like 'argument-safe method'
+      end
+      describe 'with STOMP 1.2' do
+        let(:message) { double('message', :headers => {'ack' => 'id'}) }
+        before {
+          allow(@client).to receive(:protocol).and_return(Stomp::SPL_12)
+          expect(@mock_connection).to receive(:nack).with('id', connection_headers)
+          @client.nack(message, headers)
+        }
+        it_behaves_like 'argument-safe method'
+      end
+    end
+
+    describe '#publish' do
+      describe 'without listener' do
+        let(:message) { double('message') }
+        before {
+          expect(@mock_connection).to receive(:publish).with('destination', message, connection_headers)
+          @client.publish('destination', message, headers)
+        }
+        it_behaves_like 'argument-safe method'
+      end
+      describe 'with listener' do
+        let(:message) { double('message') }
+        let(:connection_headers) { original_headers.merge({:receipt => 'receipt-uuid'}) }
+        before {
+          allow(@client).to receive(:uuid).and_return('receipt-uuid')
+          expect(@mock_connection).to receive(:publish).with('destination', message, connection_headers)
+          @client.publish('destination', message, headers) {|dummy_listener| }
+        }
+        it_behaves_like 'argument-safe method'
+      end
+    end
+
+  end
 end

data/stomp.gemspec

@@ -2,17 +2,15 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: stomp 1.4.1 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "stomp"
-  s.version = "1.4.1"
+  s.name = %q{stomp}
+  s.version = "1.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
   s.authors = ["Brian McCallister", "Marius Mathiesen", "Thiago Morello", "Guy M. Allard"]
-  s.date = "2016-06-23"
-  s.description = "Ruby client for the Stomp messaging protocol.  Note that this gem is no longer supported on rubyforge."
+  s.date = %q{2016-08-20}
+  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"]
   s.extra_rdoc_files = [
@@ -21,6 +19,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     "CHANGELOG.md",
+    "Gemfile",
     "LICENSE",
     "README.md",
     "Rakefile",
@@ -56,6 +55,7 @@ Gem::Specification.new do |s|
     "examples/publisher.rb",
     "examples/put11conn_ex1.rb",
     "examples/putget11_rh1.rb",
+    "examples/ssl_common.rb",
     "examples/ssl_ctxoptions.rb",
     "examples/ssl_newparm.rb",
     "examples/ssl_uc1.rb",
@@ -95,6 +95,7 @@ Gem::Specification.new do |s|
     "spec/spec_helper.rb",
     "stomp.gemspec",
     "test/.gitignore",
+    "test/funcs.sh",
     "test/test_anonymous.rb",
     "test/test_client.rb",
     "test/test_codec.rb",
@@ -104,22 +105,37 @@ Gem::Specification.new do |s|
     "test/test_message.rb",
     "test/test_ssl.rb",
     "test/test_urlogin.rb",
-    "test/tlogger.rb"
+    "test/tlogger.rb",
+    "test/unitst.sh"
   ]
-  s.homepage = "https://github.com/stompgem/stomp"
+  s.homepage = %q{https://github.com/stompgem/stomp}
   s.licenses = ["Apache-2.0"]
-  s.rubygems_version = "2.2.5"
-  s.summary = "Ruby client for the Stomp messaging protocol"
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby client for the Stomp messaging protocol}
 
   if s.respond_to? :specification_version then
-    s.specification_version = 4
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<stomp>, [">= 0"])
+      s.add_runtime_dependency(%q<rake>, ["~> 0.8.2"])
+      s.add_development_dependency(%q<rspec>, [">= 2.14.1"])
+      s.add_development_dependency(%q<rspec>, [">= 2.14.1"])
       s.add_development_dependency(%q<rspec>, [">= 2.14.1"])
     else
+      s.add_dependency(%q<stomp>, [">= 0"])
+      s.add_dependency(%q<rake>, ["~> 0.8.2"])
+      s.add_dependency(%q<rspec>, [">= 2.14.1"])
+      s.add_dependency(%q<rspec>, [">= 2.14.1"])
       s.add_dependency(%q<rspec>, [">= 2.14.1"])
     end
   else
+    s.add_dependency(%q<stomp>, [">= 0"])
+    s.add_dependency(%q<rake>, ["~> 0.8.2"])
+    s.add_dependency(%q<rspec>, [">= 2.14.1"])
+    s.add_dependency(%q<rspec>, [">= 2.14.1"])
     s.add_dependency(%q<rspec>, [">= 2.14.1"])
   end
 end

data/test/funcs.sh

@@ -0,0 +1,2 @@
+# ------------------------------------------------------------------------------
+

data/test/test_urlogin.rb

@@ -90,7 +90,7 @@ class TestURLLogins < Test::Unit::TestCase
       assert c.open?, url
       c.close
     end
-  end
+  end if ENV['STOMP_TESTSSL']
 
   # test failover:// with bad parameters
   def test_0020_failover_badparms()

data/test/unitst.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+#
+eval $DeBug
+# ------------------------------------------------------------------------------
+cmd_base=$(dirname $0)
+source $cmd_base/funcs.sh
+# ------------------------------------------------------------------------------
+pushd $cmd_base
+slist=$(ls -1 *.rb | grep -v helper | grep -v 1method)
+for rbf in $slist
+do
+	echo "ruby -I ../lib ${rbf}"
+	ruby -I ../lib $rbf
+done
+# ------------------------------------------------------------------------------
+popd
+set +x
+exit

metadata

@@ -1,9 +1,15 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: stomp
-version: !ruby/object:Gem::Version
-  version: 1.4.1
+version: !ruby/object:Gem::Version 
+  hash: 3
+  prerelease: false
+  segments: 
+  - 1
+  - 4
+  - 2
+  version: 1.4.2
 platform: ruby
-authors:
+authors: 
 - Brian McCallister
 - Marius Mathiesen
 - Thiago Morello
@@ -11,38 +17,105 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2016-08-20 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: stomp
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rake
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  requirement: *id002
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rspec
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 2
+        - 14
+        - 1
+        version: 2.14.1
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ">="
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 2
+        - 14
+        - 1
         version: 2.14.1
+  requirement: *id004
   type: :development
+- !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  name: rspec
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ">="
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 2
+        - 14
+        - 1
         version: 2.14.1
-description: Ruby client for the Stomp messaging protocol.  Note that this gem is
-  no longer supported on rubyforge.
-email:
+  requirement: *id005
+  type: :development
+description: Ruby client for the Stomp messaging protocol.  Note that this gem is no longer supported on rubyforge.
+email: 
 - brianm@apache.org
 - marius@stones.com
 - morellon@gmail.com
 - allard.guy.m@gmail.com
-executables:
+executables: 
 - catstomp
 - stompcat
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE
 - README.md
-files:
+files: 
 - CHANGELOG.md
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
@@ -78,6 +151,7 @@ files:
 - examples/publisher.rb
 - examples/put11conn_ex1.rb
 - examples/putget11_rh1.rb
+- examples/ssl_common.rb
 - examples/ssl_ctxoptions.rb
 - examples/ssl_newparm.rb
 - examples/ssl_uc1.rb
@@ -117,6 +191,7 @@ files:
 - spec/spec_helper.rb
 - stomp.gemspec
 - test/.gitignore
+- test/funcs.sh
 - test/test_anonymous.rb
 - test/test_client.rb
 - test/test_codec.rb
@@ -127,28 +202,40 @@ files:
 - test/test_ssl.rb
 - test/test_urlogin.rb
 - test/tlogger.rb
+- test/unitst.sh
+has_rdoc: true
 homepage: https://github.com/stompgem/stomp
-licenses:
+licenses: 
 - Apache-2.0
-metadata: {}
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
   - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Ruby client for the Stomp messaging protocol
 test_files: []
+

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: d2b75bd10087d8cb1789c73298bad9b9d9451128
-  data.tar.gz: 627b99bc57543821f249e888580658d9b738784a
-SHA512:
-  metadata.gz: 317386822ea243835a726e445e374146e72e467006af12d15c937d458fa219d8d77140cd08b7a112afa995cdb72c98b953476d06d5790f068346c72bbfef4ef6
-  data.tar.gz: 38d759077e04d9b0f8a35cd9af485692770a98d87b14930f582d71bfdd02a44fdd14813b46b62b5a7cdf03264c4dcd62b08271cc58cf56061c839edda3b7c080