stomp 1.2.4 → 1.2.5

data/test/test_helper.rb

@@ -13,30 +13,43 @@ rescue NameError => ne
   RUBY_ENGINE = "unknown"
 end
 
-# Helper routines
+=begin
+
+  Test helper methods.
+
+=end
 module TestBase
+
+  # Get user
   def user
     ENV['STOMP_USER'] || "guest"
   end
+
+  # Gete passcode
   def passcode
     ENV['STOMP_PASSCODE'] || "guest"
   end
+
   # Get host
   def host
     ENV['STOMP_HOST'] || "localhost"
   end
+
   # Get port
   def port
     (ENV['STOMP_PORT'] || 61613).to_i
   end
+
   # Get SSL port
   def ssl_port
     (ENV['STOMP_SSLPORT'] || 61612).to_i
   end
+
   # Helper for minitest on 1.9
   def caller_method_name
     parse_caller(caller(2).first).last
   end
+
   # Helper for minitest on 1.9
   def parse_caller(at)
     if /^(.+?):(\d+)(?::in `(.*)')?/ =~ at
@@ -48,12 +61,14 @@ module TestBase
     end
   end
 
+  # Get a Stomp Connection.
   def get_connection()
     ch = get_conn_headers()
     conn = Stomp::Connection.open(user, passcode, host, port, false, 5, ch)
     conn
   end
 
+  # Get a Stomp SSL Connection.
   def get_ssl_connection()
     ch = get_conn_headers()
     ssl_params = Stomp::SSLParams.new # S/B safe for all Ruby versions tested
@@ -66,6 +81,7 @@ module TestBase
     conn
   end
 
+  # Get a Stomp Client.
   def get_client()
     hash = { :hosts => [ 
           {:login => user, :passcode => passcode, :host => host, :port => port},
@@ -77,6 +93,7 @@ module TestBase
     client
   end
 
+  # Get a connection headers hash.
   def get_conn_headers()
     ch = {}
     if ENV['STOMP_TEST11']
@@ -92,6 +109,7 @@ module TestBase
     ch
   end
 
+  # Subscribe to a destination.
   def conn_subscribe(dest, headers = {})
     if @conn.protocol >= Stomp::SPL_11
       headers[:id] = @conn.uuid() unless headers[:id]
@@ -99,8 +117,7 @@ module TestBase
     @conn.subscribe dest, headers
   end
 
-  # Test helper methods
-
+  # Get a dynamic destination name.
   def make_destination
     name = caller_method_name unless name
     qname = ENV['STOMP_DOTQUEUE'] ? "/queue/test.ruby.stomp." + name : "/queue/test/ruby/stomp/" + name

data/test/test_message.rb

@@ -11,7 +11,12 @@ $:.unshift(File.dirname(__FILE__))
 # Test Ruby 1.8 with $KCODE='U'
 #
 require 'test_helper'
-#
+
+=begin
+
+  Main class for testing Stomp::Message.
+
+=end
 class TestMessage < Test::Unit::TestCase
   include TestBase
   #
@@ -87,7 +92,7 @@ class TestMessage < Test::Unit::TestCase
 		end
   end
 
-	#
+	# Test various valid and invalid frames.
 	def test_0040_msg_create
 		#
 		assert_raise(Stomp::Error::InvalidFormat) {
@@ -132,7 +137,7 @@ class TestMessage < Test::Unit::TestCase
 
 	end
 
-	# Multiple headers with the same key
+	# Test multiple headers with the same key
 	def test_0050_mh_msg_create
     aframe = bframe = nil
 		assert_nothing_raised {

data/test/test_ssl.rb

@@ -4,6 +4,11 @@ $:.unshift(File.dirname(__FILE__))
 
 require 'test_helper'
 
+=begin
+
+  Main class for testing Stomp::SSLParams.
+
+=end
 class TestSSL < Test::Unit::TestCase
   include TestBase
   
@@ -19,7 +24,7 @@ class TestSSL < Test::Unit::TestCase
     assert @conn.open?
   end
 
-  #
+  # Test SSLParams basic.
   def test_ssl_0010_parms
     ssl_params = Stomp::SSLParams.new
     assert ssl_params.ts_files.nil?
@@ -28,7 +33,7 @@ class TestSSL < Test::Unit::TestCase
     assert ssl_params.fsck.nil?
   end
 
-  #
+  # Test using correct parameters.
   def test_ssl_0020_noraise
     assert_nothing_raised {
       ssl_parms = Stomp::SSLParams.new(:cert_file => "dummy1", :key_file => "dummy2")
@@ -41,7 +46,8 @@ class TestSSL < Test::Unit::TestCase
         :cert_file => "dummy1", :key_file => "dummy2")
     }
   end
-  #
+
+  # Test using incorrect / incomplete parameters.
   def test_ssl_0030_raise
     assert_raise(Stomp::Error::SSLClientParamsError) {
       ssl_parms = Stomp::SSLParams.new(:cert_file => "dummy1")
@@ -51,7 +57,7 @@ class TestSSL < Test::Unit::TestCase
     }
   end
 
-  #
+  # Test that :fsck works.
   def test_ssl_0040_fsck
     assert_raise(Stomp::Error::SSLNoCertFileError) {
       ssl_parms = Stomp::SSLParams.new(:cert_file => "dummy1", 

data/test/tlogger.rb

@@ -1,22 +1,22 @@
 # -*- encoding: utf-8 -*-
 
+require 'logger'	# use the standard Ruby logger .....
+
 =begin
 
-Callback logger for tests.
+Callback logger for Stomp 1.1 heartbeat tests.
 
 =end
-
-require 'logger'	# use the standard Ruby logger .....
-
 class Tlogger
-  #
+
+  # Initialize a callback logger class.
   def initialize(init_parms = nil)
     @log = Logger::new(STDOUT)		# User preference
     @log.level = Logger::DEBUG		# User preference
     @log.info("Logger initialization complete.")
   end
 
-  # Log connecting events
+  # Log connecting events.
   def on_connecting(parms)
     begin
       @log.debug "Connecting: #{info(parms)}"
@@ -25,7 +25,7 @@ class Tlogger
     end
   end
 
-  # Log connected events
+  # Log connected events.
   def on_connected(parms)
     begin
       @log.debug "Connected: #{info(parms)}"
@@ -34,7 +34,7 @@ class Tlogger
     end
   end
 
-  # Log connectfail events
+  # Log connectfail events.
   def on_connectfail(parms)
     begin
       @log.debug "Connect Fail #{info(parms)}"
@@ -43,7 +43,7 @@ class Tlogger
     end
   end
 
-  # Log disconnect events
+  # Log disconnect events.
   def on_disconnect(parms)
     begin
       @log.debug "Disconnected #{info(parms)}"
@@ -52,7 +52,7 @@ class Tlogger
     end
   end
 
-  # Log miscellaneous errors
+  # Log miscellaneous errors.
   def on_miscerr(parms, errstr)
     begin
       @log.debug "Miscellaneous Error #{info(parms)}"
@@ -62,7 +62,7 @@ class Tlogger
     end
   end
 
-  # Subscribe
+  # Log subscribes.
   def on_subscribe(parms, headers)
     begin
       @log.debug "Subscribe Parms #{info(parms)}"
@@ -72,7 +72,7 @@ class Tlogger
     end
   end
 
-  # Publish
+  # Log publishes.
   def on_publish(parms, message, headers)
     begin
       @log.debug "Publish Parms #{info(parms)}"
@@ -83,7 +83,7 @@ class Tlogger
     end
   end
 
-  # Receive
+  # Log receives.
   def on_receive(parms, result)
     begin
       @log.debug "Receive Parms #{info(parms)}"
@@ -139,7 +139,7 @@ class Tlogger
 
   def info(parms)
     #
-    # Available in the Hash:
+    # Available in the parms Hash:
     # parms[:cur_host]
     # parms[:cur_port]
     # parms[:cur_login]
@@ -148,8 +148,9 @@ class Tlogger
     # parms[:cur_recondelay]
     # parms[:cur_parseto]
     # parms[:cur_conattempts]
+    # parms[:openstat]
     #
-    "Host: #{parms[:cur_host]}, Port: #{parms[:cur_port]}, Login: Port: #{parms[:cur_login]}, Passcode: #{parms[:cur_passcode]}" 
+    "Host: #{parms[:cur_host]}, Port: #{parms[:cur_port]}, Login: #{parms[:cur_login]}, Passcode: #{parms[:cur_passcode]}" 
   end
 end # of class
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stomp
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 2
-  - 4
-  version: 1.2.4
+  - 5
+  version: 1.2.5
 platform: ruby
 authors: 
 - Brian McCallister
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-25 00:00:00 -04:00
+date: 2012-08-04 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,8 +48,58 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
+- CHANGELOG.rdoc
 - LICENSE
 - README.rdoc
+- examples/client11_ex1.rb
+- examples/client11_putget1.rb
+- examples/conn11_ex1.rb
+- examples/conn11_ex2.rb
+- examples/conn11_hb1.rb
+- examples/consumer.rb
+- examples/get11conn_ex1.rb
+- examples/get11conn_ex2.rb
+- examples/logexamp.rb
+- examples/logexamp_ssl.rb
+- 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
+- examples/ssl_uc2_ciphers.rb
+- examples/ssl_uc3.rb
+- examples/ssl_uc3_ciphers.rb
+- examples/ssl_uc4.rb
+- examples/ssl_uc4_ciphers.rb
+- examples/ssl_ucx_default_ciphers.rb
+- examples/stomp11_common.rb
+- examples/topic_consumer.rb
+- examples/topic_publisher.rb
+- lib/client/utils.rb
+- lib/connection/heartbeats.rb
+- lib/connection/netio.rb
+- lib/connection/utf8.rb
+- lib/connection/utils.rb
+- lib/stomp.rb
+- lib/stomp/client.rb
+- lib/stomp/codec.rb
+- lib/stomp/connection.rb
+- lib/stomp/constants.rb
+- lib/stomp/errors.rb
+- lib/stomp/ext/hash.rb
+- lib/stomp/message.rb
+- lib/stomp/sslparams.rb
+- lib/stomp/version.rb
+- test/test_client.rb
+- test/test_codec.rb
+- test/test_connection.rb
+- test/test_connection1p.rb
+- test/test_helper.rb
+- test/test_message.rb
+- test/test_ssl.rb
+- test/tlogger.rb
 files: 
 - CHANGELOG.rdoc
 - LICENSE
@@ -83,6 +133,11 @@ files:
 - examples/stomp11_common.rb
 - examples/topic_consumer.rb
 - examples/topic_publisher.rb
+- lib/client/utils.rb
+- lib/connection/heartbeats.rb
+- lib/connection/netio.rb
+- lib/connection/utf8.rb
+- lib/connection/utils.rb
 - lib/stomp.rb
 - lib/stomp/client.rb
 - lib/stomp/codec.rb