stomp 1.1.10 → 1.2.0

data/CHANGELOG.rdoc

@@ -1,3 +1,20 @@
+== 1.2.0 2011-14-12
+
+* Stomp 1.1 protocol support.  A significant change.  Please test existing 1.0 code well.  See the examples directory for 1.1 examples.
+* Accept :reliable in a Stomp::Client connection hash
+* Add connect timeout with hashed parameters
+* Do not allow calls after close/disconnect
+* Enhance supported logger callbacks
+* Fix subscription id in find_listener
+* Start to bootstrap STOMP 1.1 support
+
+== 1.1.10 2011-07-11
+
+* Fixes for JRuby support
+* Fix EOF error on disconnect
+* Refactoring and additional test
+* Set up tests for use of RabbitMQ
+
 == 1.1.9 2011-15-06
 
 * Support wildcard destinations

data/README.rdoc

@@ -8,9 +8,11 @@
 
 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)
+* [STOMP 1.0 and 1.1] (http://stomp.github.com/index.html)
 
+===New
+
+Support of Stomp protocol level 1.1 is announced as of gem version 1.2.0.
 
 ===Example Usage
 
@@ -83,7 +85,6 @@ Project Home :
 Stomp Protocol Info :
 
   http://stomp.github.com/index.html
-  http://stomp.codehaus.org/Protocol
 
 = Contributors
 
@@ -104,4 +105,11 @@ The following people have contributed to Stomp:
 * Dinesh Majrekar
 * Kiall Mac Innes
 * Rob Skaggs
+* Tom May
+* Lucas Hills
+* Chris Needham
+* R.I. Pienaar
+* tworker
+
+
 

data/Rakefile

@@ -30,10 +30,10 @@ begin
     gem.name = "stomp"
     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.description = %Q{Ruby client for the Stomp messaging protocol.  Note that this gem is no longer supported on rubyforge.}
     gem.email = ["brianm@apache.org", 'marius@stones.com', 'morellon@gmail.com',
        'allard.guy.m@gmail.com' ]
-    gem.homepage = "https://rubygems.org/gems/stomp"
+    gem.homepage = "https://github.com/morellon/stomp"
     gem.authors = ["Brian McCallister", 'Marius Mathiesen', 'Thiago Morello',
         'Guy M. Allard']
     gem.add_development_dependency "rspec", '>= 2.3'

data/bin/catstomp

@@ -18,13 +18,13 @@ begin; require 'rubygems'; rescue; end
 require 'stomp'
 
 #
-# This simple script is inspired by the netcat utility.  It allows you to send
+# This simple script is inspired by the netcat utility.  It allows you to publish
 # input into this process to stomp destination.
 #
 # Usage: catstomp (destination-name)
 #
 # Example: ls | catstomp /topic/foo
-#   Would send the output of the ls command to the stomp destination /topic/foo
+#   Would publish the output of the ls command to the stomp destination /topic/foo
 #
 begin
 
@@ -47,7 +47,7 @@ begin
     @headers['reply-to'] = $*[1] if $*[1] != nil
 
     STDIN.each_line { |line|
-        @conn.send @destination, line, @headers
+        @conn.publish @destination, line, @headers
     }
 
 rescue

data/examples/client11_ex1.rb

@@ -0,0 +1,78 @@
+#
+# The current require dance for different Ruby versions.
+# Change this to suit your requirements.
+#
+if Kernel.respond_to?(:require_relative)
+  require_relative("./stomp11_common")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "stomp11_common"
+end
+include Stomp11Common
+#
+# Stomp 1.1 Client Example 1
+# ==============================
+#
+# Purpose: to demonstrate a clientect and disclientect sequence using Stomp 1.1
+# with the Stomp#client intreface.
+#
+# Note: Stomp#client does not provide a positional set of parameters that
+# contain a 'clientect_headers' parameter.  To use the Stomp#client interface
+# you _must_ use a 'hashed' set of parameters.
+#
+# Create connection headers
+# =========================
+#
+# The two headers used here are _required_ by the specification.
+#
+client_hdrs = {"accept-version" => "1.1",    # Demand a 1.1 connection (use a CSV list if you will consider multiple versions)
+      "host" => virt_host,                 # The 1.1 vhost (could be different than connection host)
+    }                                      # No heartbeats here:  there will be none for this connection
+#
+# Create the connect hash.
+# ========================
+#
+client_hash = { :hosts => [ 
+      {:login => login, :passcode => passcode, :host => host, :port => port},
+      ],
+      :connect_headers => client_hdrs,
+    }
+#
+# Get a connection
+# ================
+#
+client = Stomp::Client.new(client_hash)
+puts "Connection complete"
+#
+# Let's just do some sanity checks, and look around.
+#
+raise "Connection failed!!" unless client.open?
+#
+# Is this really a 1.1 conection? (For clients, 'protocol' is a public method.
+# The value will be '1.0' for those types of connections.)
+#
+raise "Unexpected protocol level" if client.protocol() != Stomp::SPL_11
+#
+# The broker _could_ have returned an ERROR frame (unlikely).
+# For clients, 'connection_frame' is a public method.
+#
+raise "Connect error: #{client.connection_frame().body}" if client.connection_frame().command == Stomp::CMD_ERROR
+#
+# Examine the CONNECT response (the connection_frame()).
+#
+puts "Connected Headers required to be present:"
+puts "Connect version - \t#{client.connection_frame().headers['version']}"
+puts
+puts "Connected Headers that are optional:"
+puts "Connect broker - \t\t#{client.connection_frame().headers['broker']}"
+puts "Session ID - \t\t\t#{client.connection_frame().headers['session']}"
+puts "Server requested heartbeats - \t#{client.connection_frame().headers['heart-beat']}"
+#
+# Finally close
+# =============
+#
+client.close   # Business as usual, just like 1.0
+puts "Disclientect complete"
+
+
+

data/examples/client11_putget1.rb

@@ -0,0 +1,57 @@
+#
+# The current require dance for different Ruby versions.
+# Change this to suit your requirements.
+#
+if Kernel.respond_to?(:require_relative)
+  require_relative("./stomp11_common")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "stomp11_common"
+end
+include Stomp11Common
+#
+# Stomp 1.1 Client Putter/Getter Example 1
+# ========================================
+#
+# This is much like sending and receiving with a Stomp::Connection.
+#
+client_hdrs = {"accept-version" => "1.1",    # Demand a 1.1 connection (use a CSV list if you will consider multiple versions)
+      "host" => virt_host,                 # The 1.1 vhost (could be different than connection host)
+    }                                      # No heartbeats here:  there will be none for this connection
+#
+client_hash = { :hosts => [ 
+      {:login => login, :passcode => passcode, :host => host, :port => port},
+      ],
+      :connect_headers => client_hdrs,
+    }
+#
+client = Stomp::Client.new(client_hash)
+puts "Connection complete"
+#
+raise "Unexpected protocol level" if client.protocol() != Stomp::SPL_11
+#
+qname = "/queue/client.nodea.nodeb.nodec"
+data = "message payload: #{Time.now.to_f}"
+headers = {}
+# Send it
+client.publish qname, data
+# Receive 
+uuid = client.uuid() # uuid for Stomp::Client is a public method
+message = nil
+# Clients must pass a receive block.  This is business as usual, required for 1.0.
+# For 1.1, a unique subscription id is required.
+client.subscribe(qname, {'id' => uuid}) {|m| 
+  message = m
+}
+sleep 0.1 until message # Wait for completion
+# Unsubscribe, with the unique id
+client.unsubscribe qname,  {'id' => uuid}
+# Sanity checks for this example ....
+raise "Unexpected data" if data != message.body
+raise "Bad subscription header" if uuid != message.headers['subscription']
+#
+client.close   # Business as usual, just like 1.0
+puts "Disclientect complete"
+
+
+

data/examples/conn11_ex1.rb

@@ -0,0 +1,101 @@
+#
+# The current require dance for different Ruby versions.
+# Change this to suit your requirements.
+#
+if Kernel.respond_to?(:require_relative)
+  require_relative("./stomp11_common")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "stomp11_common"
+end
+include Stomp11Common
+#
+# Stomp 1.1 Connection Example 1
+# ==============================
+#
+# Purpose: to demonstrate a connect and disconnect sequence using Stomp 1.1.
+#
+# Note: this example assumes that you have at least the 1.1.11 gem release 
+# installed.
+#
+# When you:
+#
+# * Use a Stomp 1.1 compliant broker
+# * Want a Stomp 1.1 level connection and functionality
+#
+# then your code *must* specifically request that environment.
+#
+# You need to supply all of the normal values expected of course:
+#
+# * login - the user name
+# * passcode - the password
+# * host - the host to connect to
+# * port - the port to connect to
+#
+# Additionaly you are required to supply the 1.1 connection data as documented
+# in the Stomp 1.1 specification: http://stomp.github.com/stomp-specification-1.1.html
+# You are urged to become familiar with the spec.  It is a short document.
+#
+# This includes:
+#
+# * The Stomp version(s) you wish the broker to consider
+# * The broker vhost to connect to
+#
+# You may optionally specify other 1.1 data:
+#
+# * heartbeat request
+#
+# Using the stomp gem, you specify this data in the "connect_headers" Hash
+# parameter.
+#
+# So .........
+#
+# Create connection headers
+# =========================
+#
+# The two headers used here are _required_ by the specification.
+#
+conn_hdrs = {"accept-version" => "1.1",    # Demand a 1.1 connection (use a CSV list if you will consider multiple versions)
+      "host" => virt_host,                 # The 1.1 vhost (could be different than connection host)
+    }                                      # No heartbeats here:  there will be none for this connection
+#
+# Get a connection
+# ================
+#
+conn = Stomp::Connection.new(login, passcode, host, port,   # Normal connect parms
+  false,      # Not reliable, the default
+  5,          # Connect redelay, the default
+  conn_hdrs)  # The 1.1 connection parameters
+puts "Connection complete"
+#
+# Let's just do some sanity checks, and look around.
+#
+raise "Connection failed!!" unless conn.open?
+#
+# Is this really a 1.1 conection? ('protocol' is a read only connection
+# instance variable. The value will be '1.0' for those types of connections.)
+#
+raise "Unexpected protocol level" if conn.protocol != Stomp::SPL_11
+#
+# The broker _could_ have returned an ERROR frame (unlikely).
+#
+raise "Connect error: #{conn.connection_frame.body}" if conn.connection_frame.command == Stomp::CMD_ERROR
+#
+# Examine the CONNECT response (the connection_frame).
+#
+puts "Connected Headers required to be present:"
+puts "Connect version - \t#{conn.connection_frame.headers['version']}"
+puts
+puts "Connected Headers that are optional:"
+puts "Connect broker - \t\t#{conn.connection_frame.headers['broker']}"
+puts "Session ID - \t\t\t#{conn.connection_frame.headers['session']}"
+puts "Server requested heartbeats - \t#{conn.connection_frame.headers['heart-beat']}"
+#
+# Finally disconnect
+# ==================
+#
+conn.disconnect   # Business as usual, just like 1.0
+puts "Disconnect complete"
+
+
+

data/examples/conn11_ex2.rb

@@ -0,0 +1,75 @@
+#
+# The current require dance for different Ruby versions.
+# Change this to suit your requirements.
+#
+if Kernel.respond_to?(:require_relative)
+  require_relative("./stomp11_common")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "stomp11_common"
+end
+include Stomp11Common
+#
+# Stomp 1.1 Connection Example 1
+# ==============================
+#
+# Purpose: to demonstrate a connect and disconnect sequence using Stomp 1.1.
+#
+# This example is like the 'conn11_ex1.rb' example except that a 'hashed'
+# connect request is made.
+#
+# Create connection headers
+# =========================
+#
+# The two headers used here are _required_ by the specification.
+#
+conn_hdrs = {"accept-version" => "1.1",    # Demand a 1.1 connection (use a CSV list if you will consider multiple versions)
+      "host" => virt_host,                 # The 1.1 vhost (could be different than connection host)
+    }                                      # No heartbeats here:  there will be none for this connection
+#
+# Create the connect hash.
+# ========================
+#
+conn_hash = { :hosts => [ 
+      {:login => login, :passcode => passcode, :host => host, :port => port},
+      ],
+      :connect_headers => conn_hdrs,
+    }
+#
+# Get a connection
+# ================
+#
+conn = Stomp::Connection.new(conn_hash)
+puts "Connection complete"
+#
+# Let's just do some sanity checks, and look around.
+#
+raise "Connection failed!!" unless conn.open?
+#
+# Is this really a 1.1 conection? ('protocol' is a read only connection
+# instance variable. The value will be '1.0' for those types of connections.)
+#
+raise "Unexpected protocol level" if conn.protocol != Stomp::SPL_11
+#
+# The broker _could_ have returned an ERROR frame (unlikely).
+#
+raise "Connect error: #{conn.connection_frame.body}" if conn.connection_frame.command == Stomp::CMD_ERROR
+#
+# Examine the CONNECT response (the connection_frame).
+#
+puts "Connected Headers required to be present:"
+puts "Connect version - \t#{conn.connection_frame.headers['version']}"
+puts
+puts "Connected Headers that are optional:"
+puts "Connect broker - \t\t#{conn.connection_frame.headers['broker']}"
+puts "Session ID - \t\t\t#{conn.connection_frame.headers['session']}"
+puts "Server requested heartbeats - \t#{conn.connection_frame.headers['heart-beat']}"
+#
+# Finally disconnect
+# ==================
+#
+conn.disconnect   # Business as usual, just like 1.0
+puts "Disconnect complete"
+
+
+

data/examples/conn11_hb1.rb

@@ -0,0 +1,46 @@
+#
+# The current require dance for different Ruby versions.
+# Change this to suit your requirements.
+#
+if Kernel.respond_to?(:require_relative)
+  require_relative("./stomp11_common")
+  require_relative("./slogger")
+else
+  $LOAD_PATH << File.dirname(__FILE__)
+  require "stomp11_common"
+  require "slogger"
+end
+include Stomp11Common
+#
+# Stomp 1.1 Heartbeat Example 1
+# =============================
+#
+# Purpose: to demonstrate that heart beats can work.
+#
+# Create connection headers
+# =========================
+#
+conn_hdrs = {"accept-version" => "1.1",    # 1.1
+      "host" => virt_host,                 # vhost
+      "heart-beat" => "5000,10000",        # heartbeats
+    }
+# Create a logger for demonstration purposes
+logger = Slogger.new
+# Connect
+conn = Stomp::Connection.new(login, passcode, host, port,   # Normal connect parms
+  false,      # Not reliable, the default
+  5,          # Connect redelay, the default
+  conn_hdrs)  # The 1.1 connection parameters
+puts "Connection complete"
+#
+raise "Unexpected protocol level" if conn.protocol != Stomp::SPL_11
+#
+conn.set_logger(logger) # Connection uses a logger
+sleep 65
+conn.set_logger(nil)    # No logging
+#
+conn.disconnect   # Get out
+puts "Disconnect complete"
+
+
+