stomp 1.2.16 → 1.3.0

data/lib/stomp/connection.rb

@@ -113,7 +113,7 @@ module Stomp
         @parameters = nil
         @parse_timeout = 5		# To override, use hashed parameters
         @connect_timeout = 0	# To override, use hashed parameters
-        @logger = nil     		# To override, use hashed parameters
+        @logger = Stomp::NullLogger.new	# To override, use hashed parameters
         @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
@@ -142,14 +142,13 @@ module Stomp
     # hashed_initialize prepares a new connection with a Hash of initialization
     # parameters.
     def hashed_initialize(params)
-
       @parameters = refine_params(params)
       @reliable =  @parameters[:reliable]
       @reconnect_delay = @parameters[:initial_reconnect_delay]
       @connect_headers = @parameters[:connect_headers]
       @parse_timeout =  @parameters[:parse_timeout]
       @connect_timeout =  @parameters[:connect_timeout]
-      @logger =  @parameters[:logger]
+      @logger = @parameters[:logger] || Stomp::NullLogger.new
       @autoflush = @parameters[:autoflush]
       @closed_check = @parameters[:closed_check]
       @hbser = @parameters[:hbser]
@@ -184,9 +183,7 @@ module Stomp
       headers = headers.symbolize_keys
       headers[:transaction] = name
       _headerCheck(headers)
-      if @logger && @logger.respond_to?(:on_begin)
-        @logger.on_begin(log_params, headers)
-      end
+      @logger.on_begin(log_params, headers)
       transmit(Stomp::CMD_BEGIN, headers)
     end
 
@@ -217,9 +214,7 @@ module Stomp
           headers[:'message-id'] = message_id
       end
       _headerCheck(headers)
-      if @logger && @logger.respond_to?(:on_ack)
-        @logger.on_ack(log_params, headers)
-      end
+      @logger.on_ack(log_params, headers)
       transmit(Stomp::CMD_ACK, headers)
     end
 
@@ -243,9 +238,7 @@ module Stomp
           raise Stomp::Error::SubscriptionRequiredError unless headers[:subscription]
       end
       _headerCheck(headers)
-      if @logger && @logger.respond_to?(:on_nack)
-        @logger.on_nack(log_params, headers)
-      end
+      @logger.on_nack(log_params, headers)
       transmit(Stomp::CMD_NACK, headers)
     end
 
@@ -255,9 +248,7 @@ module Stomp
       headers = headers.symbolize_keys
       headers[:transaction] = name
       _headerCheck(headers)
-      if @logger && @logger.respond_to?(:on_commit)
-        @logger.on_commit(log_params, headers)
-      end
+      @logger.on_commit(log_params, headers)
       transmit(Stomp::CMD_COMMIT, headers)
     end
 
@@ -267,9 +258,7 @@ module Stomp
       headers = headers.symbolize_keys
       headers[:transaction] = name
       _headerCheck(headers)
-      if @logger && @logger.respond_to?(:on_abort)
-        @logger.on_abort(log_params, headers)
-      end
+      @logger.on_abort(log_params, headers)
       transmit(Stomp::CMD_ABORT, headers)
     end
 
@@ -284,9 +273,7 @@ module Stomp
         headers[:id] = subId if headers[:id].nil?
       end
       _headerCheck(headers)
-      if @logger && @logger.respond_to?(:on_subscribe)
-        @logger.on_subscribe(log_params, headers)
-      end
+      @logger.on_subscribe(log_params, headers)
 
       # Store the subscription so that we can replay if we reconnect.
       if @reliable
@@ -309,9 +296,7 @@ module Stomp
         headers[:id] = subId unless headers[:id]
       end
       _headerCheck(headers)
-      if @logger && @logger.respond_to?(:on_unsubscribe)
-        @logger.on_unsubscribe(log_params, headers)
-      end
+      @logger.on_unsubscribe(log_params, headers)
       transmit(Stomp::CMD_UNSUBSCRIBE, headers)
       if @reliable
         subId = dest if subId.nil?
@@ -327,9 +312,7 @@ module Stomp
       headers = headers.symbolize_keys
       headers[:destination] = destination
       _headerCheck(headers)
-      if @logger && @logger.respond_to?(:on_publish)
-        @logger.on_publish(log_params, message, headers)
-      end
+      @logger.on_publish(log_params, message, headers)
       transmit(Stomp::CMD_SEND, headers, message)
     end
 
@@ -392,9 +375,7 @@ module Stomp
       end
       transmit(Stomp::CMD_DISCONNECT, headers)
       @disconnect_receipt = receive if headers[:receipt]
-      if @logger && @logger.respond_to?(:on_disconnect)
-        @logger.on_disconnect(log_params)
-      end
+      @logger.on_disconnect(log_params)
       close_socket
     end
 
@@ -417,11 +398,9 @@ module Stomp
       super_result = __old_receive()
       if super_result.nil? && @reliable && !closed?
         errstr = "connection.receive returning EOF as nil - resetting connection.\n"
-        if @logger && @logger.respond_to?(:on_miscerr)
-          @logger.on_miscerr(log_params, "es_recv: " + errstr)
-        else
-          $stderr.print errstr
-        end
+        @logger.on_miscerr(log_params, "es_recv: " + errstr)
+        $stderr.print errstr
+
         # !!! This initiates a re-connect !!!
         # The call to __old_receive() will in turn call socket().  Before
         # that we should change the target host, otherwise the host that
@@ -438,9 +417,7 @@ module Stomp
         @closed = true
         warn 'warning: broker sent EOF, and connection not reliable' unless defined?(Test)
       end
-      if @logger && @logger.respond_to?(:on_receive)
-        @logger.on_receive(log_params, super_result)
-      end
+      @logger.on_receive(log_params, super_result)
       return super_result
     end
 

data/lib/stomp/errors.rb

@@ -221,6 +221,57 @@ module Stomp
       end
     end
 
+    class StompException < RuntimeError; end
+
+    class BrokerException < StompException
+      attr_reader :headers, :message, :receipt_id, :broker_backtrace
+
+      def initialize(message)
+        @message          = message.headers.delete('message')
+        @receipt_id       = message.headers.delete('receipt-id') || 'no receipt id'
+        @headers          = message.headers
+        @broker_backtrace = message.body
+      end
+    end
+
+    class ProducerFlowControlException < BrokerException
+      attr_reader :producer_id, :dest_name
+
+      def initialize(message)
+        super(message)
+        msg_headers = /.*producer\s+\((.*)\).*to\s+prevent\s+flooding\s+([^\s]*)\.\s+/i.match(@message)
+
+        @producer_id = msg_headers && msg_headers[1]
+        @dest_name   = msg_headers && msg_headers[2]
+      end
+    end
+
+    class ProtocolException < BrokerException
+      def initialize(message)
+        super(message)
+      end
+    end
+
+    class StartTimeoutException < StompException
+      def initialize(timeout)
+        @timeout = timeout
+      end
+
+      def message
+        "Client failed to start in #{@timeout} seconds"
+      end
+    end
+
+    class ReadReceiptTimeoutException < StompException
+      def initialize(timeout)
+        @timeout = timeout
+      end
+
+      def message
+        "Read receipt not received after #{@timeout} seconds"
+      end
+    end
+
   end # module Error
 
 end # module Stomp

data/lib/stomp/null_logger.rb

@@ -0,0 +1,28 @@
+module Stomp
+  class NullLogger
+    def on_miscerr(parms, error_msg)
+      $stderr.print parms
+      $stderr.print error_msg
+    end
+
+    def on_connecting(parms); end
+    def on_connected(parms); end
+    def on_connectfail(parms); end
+    def on_disconnect(parms); end
+    def on_subscribe(parms, headers); end
+    def on_unsubscribe(parms, headers); end
+    def on_publish(parms, message, headers); end
+    def on_receive(parms, result); end
+    def on_begin(parms, headers); end
+    def on_ack(parms, headers); end
+    def on_nack(parms, headers); end
+    def on_commit(parms, headers); end
+    def on_abort(parms, headers); end
+    def on_hbread_fail(parms, ticker_data); end
+    def on_hbwrite_fail(parms, ticker_data); end
+    def on_ssl_connecting(parms); end
+    def on_ssl_connected(parms); end
+    def on_ssl_connectfail(parms); end
+    def on_hbfire(parms, srind, curt); end
+  end
+end

data/{examples → lib/stomp}/slogger.rb

@@ -51,13 +51,25 @@ require 'logger'	# use the standard Ruby logger .....
 # Callback parameters: are a copy of the @parameters instance variable for
 # the Stomp::Connection.
 #
-class Slogger
+class Slogger < Stomp::NullLogger
 
   # Initialize a new callback logger instance.
   def initialize(init_parms = nil)
+    _init
+    @log.info("Logger initialization complete.")
+  end
+
+  def _init
     @log = Logger::new(STDOUT)		# User preference
     @log.level = Logger::DEBUG		# User preference
-    @log.info("Logger initialization complete.")
+  end
+
+  def marshal_dump
+    []
+  end
+
+  def marshal_load(array)
+    _init
   end
 
   # Log connecting events

data/lib/stomp/version.rb

@@ -5,8 +5,8 @@ module Stomp
   # Define the gem version.
   module Version  #:nodoc: all
     MAJOR = 1
-    MINOR = 2
-    PATCH = 16
+    MINOR = 3
+    PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/spec/client_spec.rb

@@ -5,8 +5,10 @@ require 'client_shared_examples'
 
 
 describe Stomp::Client do
+  let(:null_logger) { double("mock Stomp::NullLogger") }
 
   before(:each) do
+    Stomp::NullLogger.stub(:new).and_return(null_logger)
     @mock_connection = double('connection', :autoflush= => true)
     Stomp::Connection.stub(:new).and_return(@mock_connection)
   end
@@ -130,6 +132,7 @@ describe Stomp::Client do
                                                               :passcode => 'testpassword',
                                                               :host => 'localhost',
                                                               :port => 12345}],
+                                                  :logger => null_logger,
                                                   :reliable => false)
       Stomp::Client.new('testlogin', 'testpassword', 'localhost', '12345', false)
     end
@@ -139,7 +142,6 @@ describe Stomp::Client do
   end
 
   describe "(created with non-authenticating stomp:// URL and non-TLD host)" do
-
     before(:each) do
       @client = Stomp::Client.new('stomp://foobar:12345')
     end
@@ -149,6 +151,7 @@ describe Stomp::Client do
                                                               :passcode => '',
                                                               :host => 'foobar',
                                                               :port => 12345}],
+                                                  :logger => null_logger,
                                                   :reliable => false)
       Stomp::Client.new('stomp://foobar:12345')
     end
@@ -168,6 +171,7 @@ describe Stomp::Client do
                                                               :passcode => '',
                                                               :host => 'foo-bar',
                                                               :port => 12345}],
+                                                  :logger => null_logger,
                                                   :reliable => false)
       Stomp::Client.new('stomp://foo-bar:12345')
     end
@@ -187,6 +191,7 @@ describe Stomp::Client do
                                                               :passcode => 'testpasscode',
                                                               :host => 'foobar',
                                                               :port => 12345}],
+                                                  :logger => null_logger,
                                                   :reliable => false)
       Stomp::Client.new('stomp://test-login:testpasscode@foobar:12345')
     end
@@ -206,6 +211,7 @@ describe Stomp::Client do
                                                               :passcode => 'testpasscode',
                                                               :host => 'foo-bar',
                                                               :port => 12345}],
+                                                  :logger => null_logger,
                                                   :reliable => false)
       Stomp::Client.new('stomp://test-login:testpasscode@foo-bar:12345')
     end
@@ -228,6 +234,7 @@ describe Stomp::Client do
                                                               :passcode => '',
                                                               :host => 'host.foobar.com',
                                                               :port => 12345}],
+                                                  :logger => null_logger,
                                                   :reliable => false)
       Stomp::Client.new('stomp://host.foobar.com:12345')
     end
@@ -247,6 +254,7 @@ describe Stomp::Client do
                                                               :passcode => 'testpasscode',
                                                               :host => 'host.foobar.com',
                                                               :port => 12345}],
+                                                  :logger => null_logger,
                                                   :reliable => false)
       Stomp::Client.new('stomp://testlogin:testpasscode@host.foobar.com:12345')
     end
@@ -276,6 +284,8 @@ describe Stomp::Client do
         {:login => "login1", :passcode => "passcode1", :host => "localhost", :port => 61616, :ssl => false},
         {:login => "login2", :passcode => "passcode2", :host => "remotehost", :port => 61617, :ssl => false}
       ]
+
+      @parameters.merge!({:logger => null_logger})
       
       Stomp::Connection.should_receive(:new).with(@parameters)
       
@@ -292,6 +302,8 @@ describe Stomp::Client do
         {:login => "login3", :passcode => "passcode3", :host => "remotehost2", :port => 61618, :ssl => false}
       ]
       
+      @parameters.merge!({:logger => null_logger})
+      
       Stomp::Connection.should_receive(:new).with(@parameters)
       
       client = Stomp::Client.new(url)
@@ -306,6 +318,8 @@ describe Stomp::Client do
         {:login => "", :passcode => "", :host => "remotehost", :port => 61617, :ssl => false}
       ]
       
+      @parameters.merge!({:logger => null_logger})
+      
       Stomp::Connection.should_receive(:new).with(@parameters)
       
       client = Stomp::Client.new(url)
@@ -320,6 +334,8 @@ describe Stomp::Client do
         {:login => "", :passcode => "", :host => "remotehost", :port => 61617, :ssl => false}
       ]
       
+      @parameters.merge!({:logger => null_logger})
+      
       Stomp::Connection.should_receive(:new).with(@parameters)
       
       client = Stomp::Client.new(url)
@@ -349,6 +365,8 @@ describe Stomp::Client do
         {:login => "login2", :passcode => "passcode2", :host => "remotehost", :port => 61617, :ssl => false}
       ]
       
+      @parameters.merge!({:logger => null_logger})
+      
       Stomp::Connection.should_receive(:new).with(@parameters)
       
       client = Stomp::Client.new(url)
@@ -357,4 +375,24 @@ describe Stomp::Client do
     
   end
 
+
+  describe '#error_listener' do
+    context 'on getting a ResourceAllocationException' do
+      let(:message) do
+        message = Stomp::Message.new('')
+        message.body = "javax.jms.ResourceAllocationException: Usage"
+        message.headers = {'message' => %q{message = "Usage Manager Memory Limit reached. Stopping producer (ID:producer) to prevent flooding queue://errors. See } }
+        message.command = Stomp::CMD_ERROR
+        message
+      end
+  
+      it 'should handle ProducerFlowControlException errors by raising' do
+        expect do
+          @client = Stomp::Client.new
+          @error_listener = @client.instance_variable_get(:@error_listener)
+          @error_listener.call(message)
+        end.to raise_exception(Stomp::Error::ProducerFlowControlException)
+      end
+    end
+  end
 end

data/spec/connection_spec.rb

@@ -29,6 +29,7 @@ describe Stomp::Connection do
       :max_hbrlck_fails => 0,
       :fast_hbs_adjust => 0.0,
       :connread_timeout => 0,
+      :tcp_nodelay => true,
    }
         
     #POG:
@@ -353,6 +354,7 @@ describe Stomp::Connection do
           :max_hbrlck_fails => 0,
           :fast_hbs_adjust => 0.0,
           :connread_timeout => 0,
+          :tcp_nodelay => true,
         }
         
         used_hash =  {
@@ -393,6 +395,7 @@ describe Stomp::Connection do
           :max_hbrlck_fails => 456,
           :fast_hbs_adjust => 0.2,
           :connread_timeout => 42,
+          :tcp_nodelay => true,
         }
         
         @connection = Stomp::Connection.new(used_hash)

data/stomp.gemspec

@@ -4,14 +4,13 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{stomp}
-  s.version = "1.2.16"
-  s.license = "Apache 2.0"
+  s.name = "stomp"
+  s.version = "1.3.0"
 
   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-08-19}
-  s.description = %q{Ruby client for the Stomp messaging protocol.  Note that this gem is no longer supported on rubyforge.}
+  s.date = "2013-09-30"
+  s.description = "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 = [
@@ -31,7 +30,6 @@ Gem::Specification.new do |s|
     "examples/publisher.rb",
     "examples/put11conn_ex1.rb",
     "examples/putget11_rh1.rb",
-    "examples/slogger.rb",
     "examples/ssl_uc1.rb",
     "examples/ssl_uc1_ciphers.rb",
     "examples/ssl_uc2.rb",
@@ -57,8 +55,11 @@ Gem::Specification.new do |s|
     "lib/stomp/errors.rb",
     "lib/stomp/ext/hash.rb",
     "lib/stomp/message.rb",
+    "lib/stomp/null_logger.rb",
+    "lib/stomp/slogger.rb",
     "lib/stomp/sslparams.rb",
     "lib/stomp/version.rb",
+    "test/test_anonymous.rb",
     "test/test_client.rb",
     "test/test_codec.rb",
     "test/test_connection.rb",
@@ -89,7 +90,6 @@ Gem::Specification.new do |s|
     "examples/publisher.rb",
     "examples/put11conn_ex1.rb",
     "examples/putget11_rh1.rb",
-    "examples/slogger.rb",
     "examples/ssl_uc1.rb",
     "examples/ssl_uc1_ciphers.rb",
     "examples/ssl_uc2.rb",
@@ -115,6 +115,8 @@ Gem::Specification.new do |s|
     "lib/stomp/errors.rb",
     "lib/stomp/ext/hash.rb",
     "lib/stomp/message.rb",
+    "lib/stomp/null_logger.rb",
+    "lib/stomp/slogger.rb",
     "lib/stomp/sslparams.rb",
     "lib/stomp/version.rb",
     "notes/heartbeat_readme.txt",
@@ -124,6 +126,7 @@ Gem::Specification.new do |s|
     "spec/message_spec.rb",
     "spec/spec_helper.rb",
     "stomp.gemspec",
+    "test/test_anonymous.rb",
     "test/test_client.rb",
     "test/test_codec.rb",
     "test/test_connection.rb",
@@ -134,14 +137,14 @@ Gem::Specification.new do |s|
     "test/test_urlogin.rb",
     "test/tlogger.rb"
   ]
-  s.homepage = %q{https://github.com/stompgem/stomp}
+  s.homepage = "https://github.com/stompgem/stomp"
+  s.licenses = ["Apache 2.0"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Ruby client for the Stomp messaging protocol}
+  s.rubygems_version = "2.0.5"
+  s.summary = "Ruby client for the Stomp messaging protocol"
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 2.3"])