stomp 1.1.7 → 1.1.8

data/CHANGELOG.rdoc

@@ -1,3 +1,14 @@
+== 1.1.8 2010-16-05
+
+* Set KEEPALIVE on connection socket options
+* Attempt to support JRuby more robustly (poll remains broken)
+* Switch to ruby supplied IO#ready?
+* Test enhancements for suppress_content_length header
+* Miscellaneous small documentation updates
+* Add parse_timeout parameter for use with hashed logins 
+* Allow connection to hosts with a - (dash) in the host name
+* Add limit parameter to thread joins
+
 == 1.1.7 2010-09-01
 
 * Binary parse of raw STOMP frame

data/README.rdoc

@@ -1,10 +1,15 @@
 ==README
 
-http://stomp.rubyforge.org/
+* (http://gitorious.org/projects/stomp/)
+* (https://github.com/morellon/stomp/)
+* (http://stomp.rubyforge.org/)
 
 ===Overview
 
-An implementation of the Stomp protocol (http://stomp.codehaus.org/Protocol) for Ruby.
+An implementation of the Stomp protocol for Ruby. See:
+
+* [STOMP 1.0] (http://stomp.codehaus.org/Protocol)
+* [STOMP 1.0 and 1.1 Draft] (http://stomp.github.com/index.html)
 
 
 ===Example Usage
@@ -27,7 +32,7 @@ An implementation of the Stomp protocol (http://stomp.codehaus.org/Protocol) for
       p msg
     end
 
-===Hash Example Usage
+===Hash Login Example Usage
 
   hash = {
       :hosts => [
@@ -44,7 +49,8 @@ An implementation of the Stomp protocol (http://stomp.codehaus.org/Protocol) for
       :randomize => false,
       :backup => false,
       :timeout => -1,
-      :connect_headers => {}
+      :connect_headers => {},
+      :parse_timeout => 5,
     }
     
     # for client
@@ -58,25 +64,29 @@ An implementation of the Stomp protocol (http://stomp.codehaus.org/Protocol) for
 
 Up until March 2009 the project was maintained and primarily developed by Brian McCallister. 
 
-The project is now maintained by Johan Sørensen <johan@johansorensen.com>
+The project is now maintained by Johan Sørensen <johan@johansorensen.com> and others.
 
 ===Source Code
 
+  https://github.com/morellon/stomp/
   http://gitorious.org/projects/stomp/
   http://github.com/js/stomp/
 
 ===Project urls
 
 Project Home :
+
   http://gitorious.org/projects/stomp/
   http://rubyforge.org/projects/stomp/
 
 Stomp Protocol Info :
+
+  http://stomp.github.com/index.html
   http://stomp.codehaus.org/Protocol
 
 = Contributors
 
-The following people have contributed to Stomp (ordered by commits):
+The following people have contributed to Stomp:
 
 * Brian McCaliister
 * Glenn Rempe <glenn@rempe.us>
@@ -89,3 +99,6 @@ The following people have contributed to Stomp (ordered by commits):
 * Tony Garnock-Jones <tonyg@lshift.net>
 * chirino
 * Stefan Saasen
+* Neil Wilson
+* Dinesh Majrekar
+

data/Rakefile

@@ -31,9 +31,11 @@ begin
     gem.version = Stomp::Version::STRING
     gem.summary = %Q{Ruby client for the Stomp messaging protocol}
     gem.description = %Q{Ruby client for the Stomp messaging protocol}
-    gem.email = ["brianm@apache.org", 'marius@stones.com', 'morellon@gmail.com']
-    gem.homepage = "http://stomp.codehaus.org/"
-    gem.authors = ["Brian McCallister", 'Marius Mathiesen', 'Thiago Morello']
+    gem.email = ["brianm@apache.org", 'marius@stones.com', 'morellon@gmail.com',
+       'allard.guy.m@gmail.com' ]
+    gem.homepage = "https://rubygems.org/gems/stomp"
+    gem.authors = ["Brian McCallister", 'Marius Mathiesen', 'Thiago Morello',
+        'Guy M. Allard']
     gem.add_development_dependency "rspec", '>= 2.3'
   end
   Jeweler::GemcutterTasks.new
@@ -43,7 +45,7 @@ end
 
 desc 'Run the specs'
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.spec_opts = ['--colour']
+  t.rspec_opts = ['--colour']
   t.pattern = 'spec/**/*_spec.rb'
 end
 

data/lib/stomp/client.rb

@@ -47,13 +47,13 @@ module Stomp
         
         @reliable = true
         
-      elsif login =~ /^stomp:\/\/(([\w\.]+):(\w+)@)?([\w\.]+):(\d+)/ # e.g. stomp://login:passcode@host:port or stomp://host:port
+      elsif login =~ /^stomp:\/\/#{url_regex}/ # e.g. stomp://login:passcode@host:port or stomp://host:port
         @login = $2 || ""
         @passcode = $3 || ""
         @host = $4
         @port = $5.to_i
         @reliable = false
-      elsif login =~ /^failover:(\/\/)?\(stomp(\+ssl)?:\/\/(([\w\.]*):(\w*)@)?([\w\.]+):(\d+)(,stomp(\+ssl)?:\/\/(([\w\.]*):(\w*)@)?([\w\.]+):(\d+)\))+(\?(.*))?$/ # e.g. failover://(stomp://login1:passcode1@localhost:61616,stomp://login2:passcode2@remotehost:61617)?option1=param
+      elsif login =~ /^failover:(\/\/)?\(stomp(\+ssl)?:\/\/#{url_regex}(,stomp(\+ssl)?:\/\/#{url_regex}\))+(\?(.*))?$/ # e.g. failover://(stomp://login1:passcode1@localhost:61616,stomp://login2:passcode2@remotehost:61617)?option1=param
 
         first_host = {}
         first_host[:ssl] = !$2.nil?
@@ -104,8 +104,8 @@ module Stomp
 
     # Join the listener thread for this client,
     # generally used to wait for a quit signal
-    def join
-      @listener_thread.join
+    def join(limit = nil)
+      @listener_thread.join(limit)
     end
 
     # Begin a transaction by name
@@ -241,6 +241,11 @@ module Stomp
         id
       end
       
+       # e.g. login:passcode@host:port or host:port
+      def url_regex
+        '(([\w\.\-]*):(\w*)@)?([\w\.\-]+):(\d+)'
+      end
+      
       def parse_hosts(url)
         hosts = []
         

data/lib/stomp/connection.rb

@@ -1,5 +1,6 @@
 require 'socket'
 require 'timeout'
+require 'io/wait'
 
 module Stomp
 
@@ -39,7 +40,9 @@ module Stomp
     #     :max_reconnect_attempts => 0,
     #     :randomize => false,
     #     :backup => false,
-    #     :timeout => -1
+    #     :timeout => -1,
+    #     :connect_headers => {},
+    #     :parse_timeout => 5,
     #   }
     #
     #   e.g. c = Connection.new(hash)
@@ -68,6 +71,7 @@ module Stomp
         @connect_headers = connect_headers
         @ssl = false
         @parameters = nil
+        @parse_timeout = 5		# To override, use hashed parameters
       end
       
       # Use Mutexes:  only one lock per each thread
@@ -89,7 +93,7 @@ module Stomp
       @reliable = true
       @reconnect_delay = @parameters[:initial_reconnect_delay]
       @connect_headers = @parameters[:connect_headers]
-      
+      @parse_timeout =  @parameters[:parse_timeout]
       #sets the first host to connect
       change_host
     end
@@ -148,7 +152,9 @@ module Stomp
         :max_reconnect_attempts => 0,
         :randomize => false,
         :backup => false,
-        :timeout => -1
+        :timeout => -1,
+        # Parse Timeout
+        :parse_timeout => 5
       }
       
       default_params.merge(params)
@@ -346,10 +352,12 @@ module Stomp
       def _receive( read_socket )
         @read_semaphore.synchronize do
           line = read_socket.gets
+
           return nil if line.nil?
 
-          # If the reading hangs for more than 5 seconds, abort the parsing process
-          Timeout::timeout(5, Stomp::Error::PacketParsingTimeout) do
+          # 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
             # Reads the beginning of the message until it runs into a empty line
             message_header = ''
             begin
@@ -368,15 +376,24 @@ module Stomp
               raise Stomp::Error::InvalidMessageLength unless parse_char(read_socket.getc) == "\0"
             # Else reads, the rest of the message until the first \0
             else
-              message_body += char while read_socket.ready? && (char = parse_char(read_socket.getc)) != "\0"
+              message_body += char while (char = parse_char(read_socket.getc)) != "\0"
             end
 
-            # If the buffer isn't empty, reads the next char and returns it to the buffer
-            # unless it's a \n
-            if read_socket.ready?
+            # If the buffer isn't empty, reads trailing new lines.
+            # Note: experiments with JRuby seem to show that .ready? never
+            # returns true.  This means that this code to drain trailing new
+            # lines never runs using JRuby.
+            while read_socket.ready?
               last_char = read_socket.getc
-              read_socket.ungetc(last_char) if parse_char(last_char) != "\n"
+              break unless last_char
+              if parse_char(last_char) != "\n"
+                read_socket.ungetc(last_char)
+                break
+              end
             end
+            # And so, a JRuby hack.  Remove any new lines at the start of the 
+            # next buffer.
+            message_header.gsub!(/^\n?/, "")
 
             # Adds the excluded \n and \0 and tries to create a new message with it
             Message.new(message_header + "\n" + message_body + "\0")
@@ -424,10 +441,6 @@ module Stomp
       
       def open_tcp_socket
         tcp_socket = TCPSocket.open @host, @port
-        def tcp_socket.ready?
-          r,w,e = IO.select([self],nil,nil,0)
-          ! r.nil?
-        end
 
         tcp_socket
       end
@@ -473,7 +486,8 @@ module Stomp
         close_socket
         
         @closed = false
-        
+        # Use keepalive
+        used_socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
         used_socket
       end
       

data/lib/stomp/errors.rb

@@ -6,6 +6,12 @@ module Stomp
       end
     end
 
+    class InvalidServerCommand < RuntimeError
+      def message
+        "Invalid command from server"
+      end
+    end
+
     class InvalidMessageLength < RuntimeError
       def message
         "Invalid content length received"

data/lib/stomp/message.rb

@@ -26,7 +26,7 @@ module Stomp
 
 			# Extract working copies of each frame part
 			work_command = frame[0..command_index-1]
-			raise Stomp::Error::InvalidFormat, 'nil command' unless @@allowed_commands.include?(work_command)
+			raise Stomp::Error::InvalidServerCommand, "invalid command: #{work_command.inspect}" unless @@allowed_commands.include?(work_command)
 			#
 			work_headers = frame[command_index+1..headers_index-1]
 			raise Stomp::Error::InvalidFormat, 'nil headers' unless work_headers

data/lib/stomp/version.rb

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

data/spec/client_spec.rb

@@ -114,14 +114,32 @@ describe Stomp::Client do
 
   end
 
+  describe "(created with non-authenticating stomp:// URL and a host with a '-')" do
+
+    before(:each) do
+      @client = Stomp::Client.new('stomp://foo-bar:12345')
+    end
+
+    it "should properly parse the URL provided" do
+      @client.login.should eql('')
+      @client.passcode.should eql('')
+      @client.host.should eql('foo-bar')
+      @client.port.should eql(12345)
+      @client.reliable.should be_false
+    end
+
+    it_should_behave_like "standard Client"
+
+  end
+  
   describe "(created with authenticating stomp:// URL and non-TLD host)" do
 
     before(:each) do
-      @client = Stomp::Client.new('stomp://testlogin:testpasscode@foobar:12345')
+      @client = Stomp::Client.new('stomp://test-login:testpasscode@foobar:12345')
     end
 
     it "should properly parse the URL provided" do
-      @client.login.should eql('testlogin')
+      @client.login.should eql('test-login')
       @client.passcode.should eql('testpasscode')
       @client.host.should eql('foobar')
       @client.port.should eql(12345)
@@ -132,6 +150,24 @@ describe Stomp::Client do
 
   end
 
+  describe "(created with authenticating stomp:// URL and a host with a '-')" do
+
+    before(:each) do
+      @client = Stomp::Client.new('stomp://test-login:testpasscode@foo-bar:12345')
+    end
+
+    it "should properly parse the URL provided" do
+      @client.login.should eql('test-login')
+      @client.passcode.should eql('testpasscode')
+      @client.host.should eql('foo-bar')
+      @client.port.should eql(12345)
+      @client.reliable.should be_false
+    end
+
+    it_should_behave_like "standard Client"
+
+  end
+
   describe "(created with non-authenticating stomp:// URL and TLD host)" do
 
     before(:each) do

data/spec/connection_spec.rb

@@ -16,6 +16,7 @@ describe Stomp::Connection do
       :randomize => false,
       :backup => false,
       :timeout => -1,
+      :parse_timeout => 5,
       :connect_headers => {}
     }
         
@@ -27,8 +28,8 @@ describe Stomp::Connection do
     
     # clone() does a shallow copy, we want a deep one so we can garantee the hosts order
     normal_parameters = Marshal::load(Marshal::dump(@parameters))
-    
-    @tcp_socket = mock(:tcp_socket, :close => nil, :puts => nil, :write => nil)
+
+    @tcp_socket = mock(:tcp_socket, :close => nil, :puts => nil, :write => nil, :setsockopt => nil)
     TCPSocket.stub!(:open).and_return @tcp_socket
     @connection = Stomp::Connection.new(normal_parameters)
   end
@@ -47,7 +48,8 @@ describe Stomp::Connection do
         "maxReconnectAttempts" => 0,
         "randomize" => false,
         "backup" => false,
-        "timeout" => -1
+        "timeout" => -1,
+        "parse_timeout" => 5,
       }
       
       @connection = Stomp::Connection.new(used_hash)
@@ -196,7 +198,7 @@ describe Stomp::Connection do
       
       before(:each) do
         ssl_parameters = {:hosts => [{:login => "login2", :passcode => "passcode2", :host => "remotehost", :ssl => true}]}
-        @ssl_socket = mock(:ssl_socket, :puts => nil, :write => nil)
+        @ssl_socket = mock(:ssl_socket, :puts => nil, :write => nil, :setsockopt => nil)
         
         TCPSocket.should_receive(:open).and_return @tcp_socket
         OpenSSL::SSL::SSLSocket.should_receive(:new).and_return(@ssl_socket)
@@ -260,6 +262,7 @@ describe Stomp::Connection do
           :randomize => false,
           :backup => false,
           :timeout => -1,
+          :parse_timeout => 5,
           :connect_headers => {}
         }
         
@@ -288,6 +291,7 @@ describe Stomp::Connection do
           :randomize => true,
           :backup => false,
           :timeout => -1,
+          :parse_timeout => 20,
           :connect_headers => {:lerolero => "ronaldo"},
           :dead_letter_queue => "queue/Error",
           :max_redeliveries => 10

data/stomp.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stomp}
-  s.version = "1.1.7"
+  s.version = "1.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Brian McCallister", "Marius Mathiesen", "Thiago Morello"]
-  s.date = %q{2011-01-14}
+  s.authors = ["Brian McCallister", "Marius Mathiesen", "Thiago Morello", "Guy M. Allard"]
+  s.date = %q{2011-03-16}
   s.description = %q{Ruby client for the Stomp messaging protocol}
-  s.email = ["brianm@apache.org", "marius@stones.com", "morellon@gmail.com"]
+  s.email = ["brianm@apache.org", "marius@stones.com", "morellon@gmail.com", "allard.guy.m@gmail.com"]
   s.executables = ["catstomp", "stompcat"]
   s.extra_rdoc_files = [
     "LICENSE",
@@ -44,7 +44,7 @@ Gem::Specification.new do |s|
     "test/test_helper.rb",
     "test/test_message.rb"
   ]
-  s.homepage = %q{http://stomp.codehaus.org/}
+  s.homepage = %q{https://rubygems.org/gems/stomp}
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Ruby client for the Stomp messaging protocol}

data/test/test_connection.rb

@@ -20,6 +20,20 @@ class TestStomp < Test::Unit::TestCase
     assert_not_nil @conn
   end
 
+  def test_no_length
+    @conn.subscribe make_destination
+    #
+    @conn.publish make_destination, "test_stomp#test_no_length",
+      { :suppress_content_length => true }
+    msg = @conn.receive
+    assert_equal "test_stomp#test_no_length", msg.body
+    #
+    @conn.publish make_destination, "test_stomp#test_\000_length",
+      { :suppress_content_length => true }
+    msg2 = @conn.receive
+    assert_equal "test_stomp#test_", msg2.body
+  end
+
   def test_explicit_receive
     @conn.subscribe make_destination
     @conn.publish make_destination, "test_stomp#test_explicit_receive"

data/test/test_message.rb

@@ -79,7 +79,7 @@ class TestMessageKcode < Test::Unit::TestCase
 			aframe = Stomp::Message.new("command\nheaders\n\njunk")
 		}
 		#
-		assert_raise(Stomp::Error::InvalidFormat) {
+		assert_raise(Stomp::Error::InvalidServerCommand) {
 			aframe = Stomp::Message.new("junkcommand\nheaders\n\njunk\0\n\n")
 		}
 		#
@@ -95,6 +95,10 @@ class TestMessageKcode < Test::Unit::TestCase
 			aframe = Stomp::Message.new("MESSAGE\nh1:val1\n\njunk\0\n")
 		}
 		#
+		assert_nothing_raised {
+			aframe = Stomp::Message.new("MESSAGE\nh2:val2\n\n\0")
+		}
+		#
 		assert_nothing_raised {
 			aframe = Stomp::Message.new("RECEIPT\nh1:val1\n\njunk\0\n")
 		}

metadata

@@ -5,18 +5,19 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 1
-  - 7
-  version: 1.1.7
+  - 8
+  version: 1.1.8
 platform: ruby
 authors: 
 - Brian McCallister
 - Marius Mathiesen
 - Thiago Morello
+- Guy M. Allard
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-01-14 00:00:00 -05:00
+date: 2011-03-16 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,6 +39,7 @@ email:
 - brianm@apache.org
 - marius@stones.com
 - morellon@gmail.com
+- allard.guy.m@gmail.com
 executables: 
 - catstomp
 - stompcat
@@ -73,7 +75,7 @@ files:
 - test/test_helper.rb
 - test/test_message.rb
 has_rdoc: true
-homepage: http://stomp.codehaus.org/
+homepage: https://rubygems.org/gems/stomp
 licenses: []
 
 post_install_message: