stomp 1.2.4 → 1.2.5

data/lib/stomp/constants.rb

@@ -2,28 +2,28 @@
 
 module Stomp
 
-	# Client side
-	CMD_CONNECT     = "CONNECT"
-	CMD_STOMP       = "STOMP"
-	CMD_DISCONNECT  = "DISCONNECT"
-	CMD_SEND        = "SEND"
-	CMD_SUBSCRIBE   = "SUBSCRIBE"
-	CMD_UNSUBSCRIBE = "UNSUBSCRIBE"
-	CMD_ACK         = "ACK"
-	CMD_NACK        = "NACK"
-	CMD_BEGIN       = "BEGIN"
-	CMD_COMMIT      = "COMMIT"
-	CMD_ABORT       = "ABORT"
+  # Client side
+  CMD_CONNECT     = "CONNECT"
+  CMD_STOMP       = "STOMP"
+  CMD_DISCONNECT  = "DISCONNECT"
+  CMD_SEND        = "SEND"
+  CMD_SUBSCRIBE   = "SUBSCRIBE"
+  CMD_UNSUBSCRIBE = "UNSUBSCRIBE"
+  CMD_ACK         = "ACK"
+  CMD_NACK        = "NACK"
+  CMD_BEGIN       = "BEGIN"
+  CMD_COMMIT      = "COMMIT"
+  CMD_ABORT       = "ABORT"
 
-	# Server side
-	CMD_CONNECTED = "CONNECTED"
-	CMD_MESSAGE   = "MESSAGE"
-	CMD_RECEIPT   = "RECEIPT"
-	CMD_ERROR     = "ERROR"
+  # Server side
+  CMD_CONNECTED = "CONNECTED"
+  CMD_MESSAGE   = "MESSAGE"
+  CMD_RECEIPT   = "RECEIPT"
+  CMD_ERROR     = "ERROR"
 
-	# Protocols
-	SPL_10 = "1.0"
-	SPL_11 = "1.1"
+  # Protocols
+  SPL_10 = "1.0"
+  SPL_11 = "1.1"
 
   # Stomp 1.0 and 1.1
   SUPPORTED = [SPL_10, SPL_11]
@@ -38,44 +38,63 @@ module Stomp
   # New line
   #
   NL = "\n"
-	NL_ASCII = 0x0a
+  NL_ASCII = 0x0a
   #
   # Back Slash
   #
   BACK_SLASH = "\\"
-	BACK_SLASH_ASCII = 0x5c
+  BACK_SLASH_ASCII = 0x5c
   #
   # Literal colon
   #
   LITERAL_COLON = ":"
-	COLON_ASCII = 0x3a
+  COLON_ASCII = 0x3a
   #
   # Literal letter c
   #
   LITERAL_C = "c"
-	C_ASCII = 0x63
+  C_ASCII = 0x63
   #
   # Literal letter n
   #
   LITERAL_N = "n"
-	N_ASCII = 0x6e
+  N_ASCII = 0x6e
   #
   # Codec from/to values.
   #
   ENCODE_VALUES = [
-	  "\\\\", "\\", # encoded, decoded
-	  "\\" + "n", "\n",
-	  "\\c", ":",
+    "\\\\", "\\", # encoded, decoded
+    "\\" + "n", "\n",
+    "\\c", ":",
   ]
 
   #
   DECODE_VALUES = [
-	  "\\\\\\\\", "\\", # encoded, decoded
-	  "\\" + "n", "\n",
-	  "\\c", ":",
+    "\\\\\\\\", "\\", # encoded, decoded
+    "\\" + "n", "\n",
+    "\\c", ":",
   ]
 
-  DEFAULT_CIPHERS = [["DHE-RSA-AES256-SHA", "TLSv1/SSLv3", 256, 256], ["DHE-DSS-AES256-SHA", "TLSv1/SSLv3", 256, 256], ["AES256-SHA", "TLSv1/SSLv3", 256, 256], ["EDH-RSA-DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["EDH-DSS-DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], ["DHE-RSA-AES128-SHA", "TLSv1/SSLv3", 128, 128], ["DHE-DSS-AES128-SHA", "TLSv1/SSLv3", 128, 128], ["AES128-SHA", "TLSv1/SSLv3", 128, 128], ["RC4-SHA", "TLSv1/SSLv3", 128, 128], ["RC4-MD5", "TLSv1/SSLv3", 128, 128], ["EDH-RSA-DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], ["EDH-DSS-DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], 
-["DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], ["EXP-EDH-RSA-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-EDH-DSS-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], ["EXP-RC2-CBC-MD5", "TLSv1/SSLv3", 40, 128], ["EXP-RC4-MD5", "TLSv1/SSLv3", 40, 128]]
+  DEFAULT_CIPHERS = [
+    ["DHE-RSA-AES256-SHA", "TLSv1/SSLv3", 256, 256], 
+    ["DHE-DSS-AES256-SHA", "TLSv1/SSLv3", 256, 256], 
+    ["AES256-SHA", "TLSv1/SSLv3", 256, 256], 
+    ["EDH-RSA-DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], 
+    ["EDH-DSS-DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], 
+    ["DES-CBC3-SHA", "TLSv1/SSLv3", 168, 168], 
+    ["DHE-RSA-AES128-SHA", "TLSv1/SSLv3", 128, 128], 
+    ["DHE-DSS-AES128-SHA", "TLSv1/SSLv3", 128, 128], 
+    ["AES128-SHA", "TLSv1/SSLv3", 128, 128], 
+    ["RC4-SHA", "TLSv1/SSLv3", 128, 128], 
+    ["RC4-MD5", "TLSv1/SSLv3", 128, 128], 
+    ["EDH-RSA-DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], 
+    ["EDH-DSS-DES-CBC-SHA", "TLSv1/SSLv3", 56, 56],
+    ["DES-CBC-SHA", "TLSv1/SSLv3", 56, 56], 
+    ["EXP-EDH-RSA-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], 
+    ["EXP-EDH-DSS-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], 
+    ["EXP-DES-CBC-SHA", "TLSv1/SSLv3", 40, 56], 
+    ["EXP-RC2-CBC-MD5", "TLSv1/SSLv3", 40, 128], 
+    ["EXP-RC4-MD5", "TLSv1/SSLv3", 40, 128],
+  ]
 
 end

data/lib/stomp/errors.rb

@@ -1,139 +1,190 @@
 # -*- encoding: utf-8 -*-
 
 module Stomp
+
+  # Module level container for Stomp gem error classes.
   module Error
+
+    # InvalidFormat is raised if:
+    # * During frame parsing if a malformed frame is detected.
     class InvalidFormat < RuntimeError
       def message
         "Invalid message - invalid format"
       end
     end
 
+    # InvalidServerCommand is raised if:
+    # * An invalid STOMP COMMAND is received from the server.
     class InvalidServerCommand < RuntimeError
       def message
         "Invalid command from server"
       end
     end
 
+    # InvalidMessageLength is raised if:
+    # * An invalid message length is detected during a frame read.
     class InvalidMessageLength < RuntimeError
       def message
         "Invalid content length received"
       end
     end
 
+    # PacketParsingTimeout is raised if:
+    # * A frame read has started, but does not complete in 5 seconds.
+    # * Use :parse_timeout connect parameter to override the timeout.
     class PacketParsingTimeout < RuntimeError
       def message
         "Packet parsing timeout"
       end
     end
 
+    # SocketOpenTimeout is raised if:
+    # * A timeout occurs during a socket open.
     class SocketOpenTimeout < RuntimeError
       def message
         "Socket open timeout"
       end
     end
 
+    # NoCurrentConnection is raised if:
+    # * Any method is called when a current connection does not exist.
     class NoCurrentConnection < RuntimeError
       def message
         "no current connection exists"
       end
     end
-    
+
+    # MaxReconnectAttempts is raised if:
+    # * The maximum number of retries has been reached for a reliable connection.
     class MaxReconnectAttempts < RuntimeError
       def message
         "Maximum number of reconnection attempts reached"
       end
     end
-    
+
+    # DuplicateSubscription is raised if:
+    # * A duplicate subscription ID is detected in the current session.
     class DuplicateSubscription < RuntimeError
       def message
         "duplicate subscriptions are disallowed"
       end
     end
-    
+
+    # ProtocolErrorConnect is raised if:
+    # * Incomplete Stomp 1.1 headers are detectd during a connect.
     class ProtocolErrorConnect < RuntimeError
       def message
         "protocol error on CONNECT"
       end
     end
-    
+
+    # UnsupportedProtocolError is raised if:
+    # * No supported Stomp protocol levels are detected during a connect.
     class UnsupportedProtocolError < RuntimeError
       def message
         "unsupported protocol level(s)"
       end
     end
-    
+
+    # InvalidHeartBeatHeaderError is raised if:
+    # * A "heart-beat" header is present, but the values are malformed.
     class InvalidHeartBeatHeaderError < RuntimeError
       def message
         "heart-beat header value is malformed"
       end
     end
 
+    # SubscriptionRequiredError is raised if:
+    # * No subscription id is specified for a Stomp 1.1 subscribe.
     class SubscriptionRequiredError < RuntimeError
       def message
         "a valid subscription id header is required"
       end
     end
 
+    # UTF8ValidationError is raised if:
+    # * Stomp 1.1 headers are not valid UTF8.
     class UTF8ValidationError < RuntimeError
       def message
         "header is invalid UTF8"
       end
     end
 
+    # MessageIDRequiredError is raised if:
+    # * No messageid parameter is specified for ACK or NACK.
     class MessageIDRequiredError < RuntimeError
       def message
         "a valid message id is required for ACK/NACK"
       end
     end
 
+    # SSLClientParamsError is raised if:
+    # * Incomplete SSLParams are specified for an SSL connect.
     class SSLClientParamsError < RuntimeError
       def message
         "certificate and key files are both required"
       end
     end
 
+    # StompServerError is raised if:
+    # * Invalid (nil) data is received from the Stomp server.
     class StompServerError < RuntimeError
       def message
         "Connected, header read is nil, is this really a Stomp Server?"
       end
     end
 
+    # SSLNoKeyFileError is raised if:
+    # * A supplied key file does not exist.
     class SSLNoKeyFileError < RuntimeError
       def message
         "client key file does not exist"
       end
     end
 
+    # SSLUnreadableKeyFileError is raised if:
+    # * A supplied key file is not readable.
     class SSLUnreadableKeyFileError < RuntimeError
       def message
         "client key file can not be read"
       end
     end
 
+    # SSLNoCertFileError is raised if:
+    # * A supplied SSL cert file does not exist.
     class SSLNoCertFileError < RuntimeError
       def message
         "client cert file does not exist"
       end
     end
 
+    # SSLUnreadableCertFileError is raised if:
+    # * A supplied SSL cert file is not readable.
     class SSLUnreadableCertFileError < RuntimeError
       def message
         "client cert file can not be read"
       end
     end
 
+    # SSLNoTruststoreFileError is raised if:
+    # * A supplied SSL trust store file does not exist.
     class SSLNoTruststoreFileError < RuntimeError
       def message
         "a client truststore file does not exist"
       end
     end
 
+    # SSLUnreadableTruststoreFileError is raised if:
+    # * A supplied SSL trust store file is not readable.
     class SSLUnreadableTruststoreFileError < RuntimeError
       def message
         "a client truststore file can not be read"
       end
     end
 
+    # LoggerConnectionError is not raised by the gem.  It may be 
+    # raised by client logic in callback logger methods to signal
+    # that a connection should not proceed.
     class LoggerConnectionError < RuntimeError
     end
 

data/lib/stomp/ext/hash.rb

@@ -1,10 +1,13 @@
 # -*- encoding: utf-8 -*-
 
 class ::Hash
+
+  # Returns self with keys uncamelized and converted to symbols.
   def uncamelize_and_symbolize_keys
     self.uncamelize_and_stringify_keys.symbolize_keys
   end
 
+  # Returns self with keys uncamelized and converted to strings.
   def uncamelize_and_stringify_keys
     uncamelized = {}
     self.each_pair do |key, value|
@@ -15,6 +18,7 @@ class ::Hash
     uncamelized
   end
 
+  # Returns self with all keys symbolized.
   def symbolize_keys
     symbolized = {}
     self.each_pair do |key, value|

data/lib/stomp/message.rb

@@ -2,39 +2,54 @@
 
 module Stomp
 
-  # Container class for frames, misnamed technically
+  # Message is a container class for frames.  Misnamed technically.
   class Message
-    attr_accessor :command, :headers, :body, :original
 
-		@@allowed_commands = [ Stomp::CMD_CONNECTED, Stomp::CMD_MESSAGE, Stomp::CMD_RECEIPT, Stomp::CMD_ERROR ]
+    public
 
+    # The COMMAND value.
+    attr_accessor :command
+
+    # The Headers Hash.
+    attr_accessor :headers
+
+    # The message Body.
+    attr_accessor :body
+
+    # The original input(s).
+    attr_accessor :original
+
+    # Commands that are allowed from the wire per the specifications.
+    @@allowed_commands = [ Stomp::CMD_CONNECTED, Stomp::CMD_MESSAGE, Stomp::CMD_RECEIPT, Stomp::CMD_ERROR ]
+
+    # initialize returns a Message from a raw physical frame.
     def initialize(frame, protocol11p = false)
-			# p [ "00", frame, frame.encoding ]
+      # p [ "00", frame, frame.encoding ]
       # Set default empty values
       self.command = ''
       self.headers = {}
       self.body = ''
       self.original = frame
       return self if is_blank?(frame)
-			# Figure out where individual parts of the frame begin and end.
-			command_index = frame.index("\n")
-			raise Stomp::Error::InvalidFormat, 'command index' unless command_index
-			#
-			headers_index = frame.index("\n\n", command_index+1)
-			raise Stomp::Error::InvalidFormat, 'headers index' unless headers_index
-			#
-			lastnull_index = frame.rindex("\0")
-			raise Stomp::Error::InvalidFormat, 'lastnull index' unless lastnull_index
-
-			# Extract working copies of each frame part
-			work_command = frame[0..command_index-1]
-			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
-			#
-			work_body = frame[headers_index+2..lastnull_index-1]
-			raise Stomp::Error::InvalidFormat, 'nil body' unless work_body
+      # Figure out where individual parts of the frame begin and end.
+      command_index = frame.index("\n")
+      raise Stomp::Error::InvalidFormat, 'command index' unless command_index
+      #
+      headers_index = frame.index("\n\n", command_index+1)
+      raise Stomp::Error::InvalidFormat, 'headers index' unless headers_index
+      #
+      lastnull_index = frame.rindex("\0")
+      raise Stomp::Error::InvalidFormat, 'lastnull index' unless lastnull_index
+
+      # Extract working copies of each frame part
+      work_command = frame[0..command_index-1]
+      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
+      #
+      work_body = frame[headers_index+2..lastnull_index-1]
+      raise Stomp::Error::InvalidFormat, 'nil body' unless work_body
       # Set the frame values
       if protocol11p
         work_command.force_encoding(Stomp::UTF8) if work_command.respond_to?(:force_encoding)
@@ -42,7 +57,7 @@ module Stomp
       self.command = work_command
       work_headers.split("\n").map do |value|
         parsed_value = value.match /^([\r|\w|-]*):(.*)$/
-				raise Stomp::Error::InvalidFormat, 'parsed header value' unless parsed_value
+        raise Stomp::Error::InvalidFormat, 'parsed header value' unless parsed_value
         #
         pk = parsed_value[1]
         pv = parsed_value[2]
@@ -71,7 +86,7 @@ module Stomp
       end
 
       body_length = -1
-		
+
       if self.headers['content-length']
         body_length = self.headers['content-length'].to_i
         raise Stomp::Error::InvalidMessageLength if work_body.length != body_length
@@ -79,18 +94,23 @@ module Stomp
       self.body = work_body[0..body_length]
     end
 
+    # to_s returns a string prepresentation of this Message
     def to_s
       "<Stomp::Message headers=#{headers.inspect} body='#{body}' command='#{command}' >"
     end
 
+    private
+
+    # is_blank? tests if a data value is nil or empty.
+    def is_blank?(value)
+      value.nil? || (value.respond_to?(:empty?) && value.empty?)
+    end
+
+    # empty? tests if a Message has any blank parts.
     def empty?
       is_blank?(command) && is_blank?(headers) && is_blank?(body)
     end
 
-    private
-      def is_blank?(value)
-        value.nil? || (value.respond_to?(:empty?) && value.empty?)
-      end
   end
 
 end

data/lib/stomp/sslparams.rb

@@ -1,72 +1,84 @@
-#  -*-  encoding:  utf-8  -*-
-
-module  Stomp
-    #
-    #  ==  Purpose
-    #
-    #  Parameters  for  STOMP  ssl  connections.
-    #
-    class  SSLParams
-        #  The  trust  store  files.    Normally  the  certificate  of  the  CA  that  signed
-        #  the  server's  certificate.    One  file  name,  or  a  CSV  list  of  file  names.
-        attr_accessor  :ts_files
-        #  The  client  certificate  file.
-        attr_accessor  :cert_file
-        #  The  client  private  key  file.
-        attr_accessor  :key_file
-        #  The  client  private  key  password.
-        attr_accessor  :key_password
-        #  SSL  Connect  Verify  Result.    The  result  of  the  handshake.
-        attr_accessor  :verify_result
-        #  The  certificate  of  the  connection  peer  (the  server),  received  during
-        #  the  handshake.
-        attr_accessor  :peer_cert
-        #  Optional  list  of  SSL  ciphers  to  be  used.    In  the  format  documented  for
-        #  Ruby's  OpenSSL.
-        attr_accessor  :ciphers
-        #  Abcolute  command  to  use  Ruby  default  ciphers
-        attr_reader  :use_ruby_ciphers
-        #  Back  reference  to  the  OpenSSL::SSL::SSLContext  instance,  gem  sets  before  connect
-        attr_accessor  :ctx  #  Set  by  the  gem  during  connect,  before  the  callbacks
-        # Client  wants  file  existance  check  now. true/value or false/nil
-        attr_reader  :fsck  #
-        #
-        def  initialize(opts={})
-
-          #  Server  authentication  parameters
-          @ts_files  =  opts[:ts_files]      #  A  trust  store  file,  normally  a  CA's  cert
-          #  or  a  CSV  list  of  cert  file  names
-
-          #  Client  authentication  parameters
-          @cert_file  =  opts[:cert_file]                  #  Client  cert
-          @key_file  =  opts[:key_file]                      #  Client  key
-          @key_password  =  opts[:key_password]                      #  Client  key password
-          #
-          raise  Stomp::Error::SSLClientParamsError if @cert_file.nil?  &&  !@key_file.nil?
-          raise  Stomp::Error::SSLClientParamsError if !@cert_file.nil?  &&  @key_file.nil?
-          #
-          @ciphers  =  opts[:ciphers]
-          @use_ruby_ciphers  =  opts[:use_ruby_ciphers]  ?  opts[:use_ruby_ciphers]  :  false
-          #
-          if  opts[:fsck]
-            if  @cert_file
-              raise  Stomp::Error::SSLNoCertFileError if !File::exists?(@cert_file)
-              raise  Stomp::Error::SSLUnreadableCertFileError if !File::readable?(@cert_file)
-            end
-            if  @key_file
-              raise  Stomp::Error::SSLNoKeyFileError if !File::exists?(@key_file)
-              raise  Stomp::Error::SSLUnreadableKeyFileError if !File::readable?(@key_file)
-            end
-            if  @ts_files
-              tsa  =  @ts_files.split(",")
-              tsa.each  do  |fn|
-                raise  Stomp::Error::SSLNoTruststoreFileError if !File::exists?(fn)
-                raise  Stomp::Error::SSLUnreadableTruststoreFileError if !File::readable?(fn)
-              end
-            end
-          end
-        end
-    end  #  of  class  SSLParams
-
-end  #  of  module  Stomp
+# -*- encoding: utf-8 -*-
+
+module Stomp
+ #
+ # == Purpose
+ #
+ # Parameters for STOMP ssl connections.
+ #
+ class SSLParams
+
+  # The trust store files. Normally the certificate of the CA that signed
+  # the server's certificate. One file name, or a CSV list of file names.
+  attr_accessor :ts_files
+
+  # The client certificate file.
+  attr_accessor :cert_file
+
+  # The client private key file.
+  attr_accessor :key_file
+
+  # The client private key password.
+  attr_accessor :key_password
+
+  # SSL Connect Verify Result.  The result of the handshake.
+  attr_accessor :verify_result
+
+  # The certificate of the connection peer (the server), received during
+  # the handshake.
+  attr_accessor :peer_cert
+
+  # Optional list of SSL ciphers to be used.  In the format documented for
+  # Ruby's OpenSSL.
+  attr_accessor :ciphers
+
+  # Absolute command to use Ruby default ciphers.
+  attr_reader :use_ruby_ciphers
+
+  # Back reference to the OpenSSL::SSL::SSLContext instance, gem sets before connect.
+  attr_accessor :ctx # Set by the gem during connect, before the callbacks
+
+  # Client wants file existance check on initialize. true/value or false/nil.
+  attr_reader :fsck #
+
+  # initialize returns a valid set of SSLParams or raises an error.
+  def initialize(opts={})
+
+   # Server authentication parameters
+   @ts_files = opts[:ts_files]   # A trust store file, normally a CA's cert
+   # or a CSV list of cert file names
+
+   # Client authentication parameters
+   @cert_file = opts[:cert_file]         # Client cert
+   @key_file = opts[:key_file]           # Client key
+   @key_password = opts[:key_password]           # Client key password
+   #
+   raise Stomp::Error::SSLClientParamsError if @cert_file.nil? && !@key_file.nil?
+   raise Stomp::Error::SSLClientParamsError if !@cert_file.nil? && @key_file.nil?
+   #
+   @ciphers = opts[:ciphers]
+   @use_ruby_ciphers = opts[:use_ruby_ciphers] ? opts[:use_ruby_ciphers] : false
+   #
+   if opts[:fsck]
+    if @cert_file
+     raise Stomp::Error::SSLNoCertFileError if !File::exists?(@cert_file)
+     raise Stomp::Error::SSLUnreadableCertFileError if !File::readable?(@cert_file)
+    end
+    if @key_file
+     raise Stomp::Error::SSLNoKeyFileError if !File::exists?(@key_file)
+     raise Stomp::Error::SSLUnreadableKeyFileError if !File::readable?(@key_file)
+    end
+    if @ts_files
+     tsa = @ts_files.split(",")
+     tsa.each do |fn|
+      raise Stomp::Error::SSLNoTruststoreFileError if !File::exists?(fn)
+      raise Stomp::Error::SSLUnreadableTruststoreFileError if !File::readable?(fn)
+     end
+    end
+   end
+  end
+
+ end # of class SSLParams
+
+end # of module Stomp
 

data/lib/stomp/version.rb

@@ -1,10 +1,12 @@
 # -*- encoding: utf-8 -*-
 
 module Stomp
+
+  # Define the gem version.
   module Version  #:nodoc: all
     MAJOR = 1
     MINOR = 2
-    PATCH = 4
+    PATCH = 5
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end
 end

data/lib/stomp.rb

@@ -15,15 +15,24 @@
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
 
-require 'stomp/constants' # Constants first
-require 'stomp/ext/hash'
-require 'stomp/connection'
-require 'stomp/client'
-require 'stomp/message'
-require 'stomp/version'
-require 'stomp/errors'
-require 'stomp/codec'
-require 'stomp/sslparams'
+require 'stomp/constants'       # Constants first
+require 'stomp/ext/hash'        # #Hash additions
+require 'stomp/connection'      # Main Stomp#Connection
+require 'stomp/client'          # Main Stomp#Client
+require 'stomp/message'         # Stomp#Message
+require 'stomp/version'         # Stomp#Version#STRING
+require 'stomp/errors'          # All Stomp# exceptions
+require 'stomp/codec'           # Stomp 1.1 codec
+require 'stomp/sslparams'       # Stomp SSL support
+
+# Private methods in #Client
+require 'client/utils'          # private Client Utility methods
+
+# Private methods in #Connection
+require 'connection/utils'      # private Connection Utility methods
+require 'connection/netio'      # private Network io methods
+require 'connection/heartbeats' # private 1.1+ heartbeat related methods
+require 'connection/utf8'       # private 1.1+ UTF8 related methods
 
 module Stomp
 end