stomp 1.1.10 → 1.2.0

data/lib/stomp/constants.rb

@@ -0,0 +1,78 @@
+# -*- encoding: utf-8 -*-
+
+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"
+
+	# Server side
+	CMD_CONNECTED = "CONNECTED"
+	CMD_MESSAGE   = "MESSAGE"
+	CMD_RECEIPT   = "RECEIPT"
+	CMD_ERROR     = "ERROR"
+
+	# Protocols
+	SPL_10 = "1.0"
+	SPL_11 = "1.1"
+
+  # To be: No 1.1 yet
+  SUPPORTED = [SPL_10, SPL_11]
+
+  # 1.9 Encoding Name
+  UTF8 = "UTF-8"
+  #
+  # Octet 0
+  #
+  NULL = "\0"
+  #
+  # New line
+  #
+  NL = "\n"
+	NL_ASCII = 0x0a
+  #
+  # Back Slash
+  #
+  BACK_SLASH = "\\"
+	BACK_SLASH_ASCII = 0x5c
+  #
+  # Literal colon
+  #
+  LITERAL_COLON = ":"
+	COLON_ASCII = 0x3a
+  #
+  # Literal letter c
+  #
+  LITERAL_C = "c"
+	C_ASCII = 0x63
+  #
+  # Literal letter n
+  #
+  LITERAL_N = "n"
+	N_ASCII = 0x6e
+  #
+  # Codec from/to values.
+  #
+  ENCODE_VALUES = [
+	  "\\\\", "\\", # encoded, decoded
+	  "\\" + "n", "\n",
+	  "\\c", ":",
+  ]
+
+  #
+  DECODE_VALUES = [
+	  "\\\\\\\\", "\\", # encoded, decoded
+	  "\\" + "n", "\n",
+	  "\\c", ":",
+  ]
+
+end

data/lib/stomp/errors.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Stomp
   module Error
     class InvalidFormat < RuntimeError
@@ -23,11 +25,67 @@ module Stomp
         "Packet parsing timeout"
       end
     end
+
+    class SocketOpenTimeout < RuntimeError
+      def message
+        "Socket open timeout"
+      end
+    end
+
+    class NoCurrentConnection < RuntimeError
+      def message
+        "no current connection exists"
+      end
+    end
     
     class MaxReconnectAttempts < RuntimeError
       def message
         "Maximum number of reconnection attempts reached"
       end
     end
-  end
-end
+    
+    class DuplicateSubscription < RuntimeError
+      def message
+        "duplicate subscriptions are disallowed"
+      end
+    end
+    
+    class ProtocolErrorConnect < RuntimeError
+      def message
+        "protocol error on CONNECT"
+      end
+    end
+    
+    class UnsupportedProtocolError < RuntimeError
+      def message
+        "unsupported protocol level(s)"
+      end
+    end
+    
+    class InvalidHeartBeatHeaderError < RuntimeError
+      def message
+        "heart-beat header value is malformed"
+      end
+    end
+
+    class SubscriptionRequiredError < RuntimeError
+      def message
+        "a valid subscription id header is required"
+      end
+    end
+
+    class UTF8ValidationError < RuntimeError
+      def message
+        "header is invalid UTF8"
+      end
+    end
+
+    class MessageIDRequiredError < RuntimeError
+      def message
+        "a valid message id is required for ACK/NACK"
+      end
+    end
+
+  end # module Error
+end # module Stomp
+

data/lib/stomp/ext/hash.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 class ::Hash
   def uncamelize_and_symbolize_keys
     self.uncamelize_and_stringify_keys.symbolize_keys
@@ -21,4 +23,4 @@ class ::Hash
 
     symbolized
   end unless self.method_defined?(:symbolize_keys)
-end
+end

data/lib/stomp/message.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Stomp
 
   # Container class for frames, misnamed technically
@@ -6,8 +8,8 @@ module Stomp
 
 		@@allowed_commands = [ 'CONNECTED', 'MESSAGE', 'RECEIPT', 'ERROR' ]
 
-    def initialize(frame)
-			# p frame
+    def initialize(frame, protocol11p = false)
+			# p [ "00", frame, frame.encoding ]
       # Set default empty values
       self.command = ''
       self.headers = {}
@@ -34,11 +36,38 @@ module Stomp
 			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)
+      end
       self.command = work_command
       work_headers.split("\n").map do |value|
         parsed_value = value.match /^([\w|-]*):(.*)$/
 				raise Stomp::Error::InvalidFormat, 'parsed header value' unless parsed_value
-        self.headers[parsed_value[1].strip] = parsed_value[2].strip if parsed_value
+        #
+        pk = parsed_value[1]
+        pv = parsed_value[2]
+        #
+        if protocol11p
+          pk.force_encoding(Stomp::UTF8) if pk.respond_to?(:force_encoding)
+          pv.force_encoding(Stomp::UTF8) if pv.respond_to?(:force_encoding)
+          # Stomp 1.1+ - Servers may put multiple values for a single key on the wire.
+          # If so, we support reading those, and passing them to the user.
+          if self.headers[pk]
+            if self.headers[pk].is_a?(Array) # The 3rd and any subsequent ones for this key
+              self.headers[pk] << pv
+            else
+              # The 2nd one for this key
+              tv = self.headers[pk] + ""
+              self.headers[pk] = []
+              self.headers[pk] << tv << pv
+            end
+          else
+            self.headers[pk] = pv # The 1st one for this key
+          end
+        else
+          # Stomp 1.0
+          self.headers[pk.strip] = pv.strip unless self.headers[pk.strip] # Only receive the 1st one
+        end
       end
 
       body_length = -1

data/lib/stomp/version.rb

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

data/spec/client_shared_examples.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'spec_helper'
 
 shared_examples_for "standard Client" do

data/spec/client_spec.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'spec_helper'
 require 'client_shared_examples'
 

data/spec/connection_spec.rb

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# -*- encoding: utf-8 -*-
+
 require 'spec_helper'
 
 describe Stomp::Connection do
@@ -9,6 +10,7 @@ describe Stomp::Connection do
         {:login => "login1", :passcode => "passcode1", :host => "localhost", :port => 61616, :ssl => false},
         {:login => "login2", :passcode => "passcode2", :host => "remotehost", :port => 61617, :ssl => false}
       ],
+      :reliable => true,
       :initial_reconnect_delay => 0.01,
       :max_reconnect_delay => 30.0,
       :use_exponential_back_off => true,
@@ -16,7 +18,7 @@ describe Stomp::Connection do
       :max_reconnect_attempts => 0,
       :randomize => false,
       :backup => false,
-      :timeout => -1,
+      :connect_timeout => 0,
       :parse_timeout => 5,
       :connect_headers => {}
     }
@@ -42,6 +44,7 @@ describe Stomp::Connection do
           {:login => "login2", :passcode => "passcode2", :host => "remotehost", :port => 61617, :ssl => false},
           {:login => "login1", :passcode => "passcode1", :host => "localhost", :port => 61616, :ssl => false}
         ],
+        "reliable" => true,
         "initialReconnectDelay" => 0.01,
         "maxReconnectDelay" => 30.0,
         "useExponentialBackOff" => true,
@@ -49,17 +52,14 @@ describe Stomp::Connection do
         "maxReconnectAttempts" => 0,
         "randomize" => false,
         "backup" => false,
-        "timeout" => -1,
+        "connect_timeout" => 0,
         "parse_timeout" => 5,
       }
       
       @connection = Stomp::Connection.new(used_hash)
       @connection.instance_variable_get(:@parameters).should == @parameters
     end
-    
-    it "should be reliable" do
-      @connection.instance_variable_get(:@reliable).should be_true
-    end
+   
     it "should start with first host in array" do
       @connection.instance_variable_get(:@host).should == "localhost"
     end
@@ -74,6 +74,25 @@ describe Stomp::Connection do
       @connection = Stomp::Connection.new hash
       @connection.instance_variable_get(:@port).should == 61613
     end
+
+    context "should be able pass reliable as part of hash" do
+      it "should be false if reliable is set to false" do
+        hash = @parameters.merge({:reliable => false })
+        connection = Stomp::Connection.new(hash)
+        connection.instance_variable_get(:@reliable).should be_false
+      end
+      
+      it "should be true if reliable is set to true" do
+        hash = @parameters.merge({:reliable => true })
+        connection = Stomp::Connection.new(hash)
+        connection.instance_variable_get(:@reliable).should be_true
+      end
+      
+      it "should be true if reliable is not set" do
+        connection = Stomp::Connection.new(@parameters)
+        connection.instance_variable_get(:@reliable).should be_true
+      end
+    end
     
     context "when dealing with content-length header" do
       it "should not suppress it when receiving :suppress_content_length => false" do
@@ -269,6 +288,7 @@ describe Stomp::Connection do
             # Once connected the host is sent to the end of array
             {:login => "login1", :passcode => "passcode1", :host => "localhost", :port => 61616, :ssl => false}
           ],
+          :reliable => true,
           :initial_reconnect_delay => 0.01,
           :max_reconnect_delay => 30.0,
           :use_exponential_back_off => true,
@@ -276,7 +296,7 @@ describe Stomp::Connection do
           :max_reconnect_attempts => 0,
           :randomize => false,
           :backup => false,
-          :timeout => -1,
+          :connect_timeout => 0,
           :parse_timeout => 5,
           :connect_headers => {}
         }
@@ -305,7 +325,8 @@ describe Stomp::Connection do
           :max_reconnect_attempts => 10,
           :randomize => true,
           :backup => false,
-          :timeout => -1,
+          :reliable => false,
+          :connect_timeout => 0,
           :parse_timeout => 20,
           :connect_headers => {:lerolero => "ronaldo"},
           :dead_letter_queue => "queue/Error",

data/spec/message_spec.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'spec_helper'
 
 describe Stomp::Message do

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'rspec'
 dir = File.dirname(__FILE__)
 lib_path = File.expand_path("#{dir}/../lib")

data/stomp.gemspec

@@ -4,13 +4,13 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{stomp}
-  s.version = "1.1.10"
+  s.name = "stomp"
+  s.version = "1.2.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{2011-11-07}
-  s.description = %q{Ruby client for the Stomp messaging protocol}
+  s.date = "2011-12-15"
+  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 = [
@@ -24,13 +24,27 @@ Gem::Specification.new do |s|
     "Rakefile",
     "bin/catstomp",
     "bin/stompcat",
+    "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/publisher.rb",
+    "examples/put11conn_ex1.rb",
+    "examples/putget11_rh1.rb",
     "examples/slogger.rb",
+    "examples/stomp11_common.rb",
+    "examples/topic_consumer.rb",
+    "examples/topic_publisher.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",
@@ -42,32 +56,19 @@ Gem::Specification.new do |s|
     "spec/spec_helper.rb",
     "stomp.gemspec",
     "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_message.rb",
+    "test/tlogger.rb"
   ]
-  s.homepage = %q{https://rubygems.org/gems/stomp}
+  s.homepage = "https://github.com/morellon/stomp"
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Ruby client for the Stomp messaging protocol}
-  s.test_files = [
-    "examples/consumer.rb",
-    "examples/logexamp.rb",
-    "examples/publisher.rb",
-    "examples/slogger.rb",
-    "spec/client_shared_examples.rb",
-    "spec/client_spec.rb",
-    "spec/connection_spec.rb",
-    "spec/message_spec.rb",
-    "spec/spec_helper.rb",
-    "test/test_client.rb",
-    "test/test_connection.rb",
-    "test/test_helper.rb",
-    "test/test_message.rb"
-  ]
+  s.rubygems_version = "1.8.11"
+  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
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then