onstomp 1.0.2 → 1.0.3

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changes
 
+## 1.0.3
+* change how failover spawns new connections when failing over.
+
 ## 1.0.2
 * allow failover clients to be constructed from regular OnStomp::Client
   instances, allowing fully configured SSL connections.

data/Gemfile

@@ -5,4 +5,5 @@ gemspec
 
 group :development do
   gem 'rdiscount'
+  gem 'erubis'
 end

data/extra_doc/API.md

@@ -17,7 +17,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#abort abort}</td>
       <td>
-        <code>abort(tx_id, headers={})</code>
+        <code>abort(tx_id, headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -25,7 +25,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#ack ack}</td>
       <td>
-        <code>ack(message_frame, headers={})</code>
+        <code>ack(message_frame, headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -33,7 +33,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#ack ack}</td>
       <td>
-        <code>ack(message_id, headers={})</code>
+        <code>ack(message_id, headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #fbb;">false</td>
@@ -41,7 +41,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#ack ack}</td>
       <td>
-        <code>ack(message_id, subscription_id, headers={})</code>
+        <code>ack(message_id, subscription_id, headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -201,7 +201,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#begin begin}</td>
       <td>
-        <code>begin(tx_id, headers={})</code>
+        <code>begin(tx_id, headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -217,7 +217,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#commit commit}</td>
       <td>
-        <code>commit(tx_id, headers={})</code>
+        <code>commit(tx_id, headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -225,7 +225,7 @@
     <tr>
       <td>{OnStomp::Client#connect connect}</td>
       <td>
-        <code>connect(headers={})</code>
+        <code>connect(headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -241,7 +241,7 @@
     <tr>
       <td>{OnStomp::Client#disconnect disconnect}</td>
       <td>
-        <code>disconnect_with_flush(headers={})</code>
+        <code>disconnect_with_flush(headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -249,7 +249,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#disconnect disconnect}</td>
       <td>
-        <code>disconnect(headers={})</code>
+        <code>disconnect(headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -257,7 +257,7 @@
     <tr>
       <td>{OnStomp::Client#disconnect_with_flush disconnect_with_flush}</td>
       <td>
-        <code>disconnect_with_flush(headers={})</code>
+        <code>disconnect_with_flush(headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -265,7 +265,7 @@
     <tr>
       <td>{OnStomp::Client#initialize initialize}</td>
       <td>
-        <code>initialize(uri, options={})</code>
+        <code>initialize(uri, options=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -273,7 +273,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#nack nack}</td>
       <td>
-        <code>nack(message_id, subscription_id, heders={})</code>
+        <code>nack(message_id, subscription_id, heders=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #fbb;">false</td>
       <td style="background-color: #bfb;">true</td>
@@ -281,7 +281,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#nack nack}</td>
       <td>
-        <code>nack(message_frame, headers={})</code>
+        <code>nack(message_frame, headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #fbb;">false</td>
       <td style="background-color: #bfb;">true</td>
@@ -441,7 +441,7 @@
     <tr>
       <td>{OnStomp::Client#open open}</td>
       <td>
-        <code>connect(headers={})</code>
+        <code>connect(headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -449,7 +449,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#puts puts}</td>
       <td>
-        <code>send(dest, body, headers={}, &cb)</code>
+        <code>send(dest, body, headers=&lt;optional hash&gt;, &cb)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -457,7 +457,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#send send}</td>
       <td>
-        <code>send(dest, body, headers={}, &cb)</code>
+        <code>send(dest, body, headers=&lt;optional hash&gt;, &cb)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -465,7 +465,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#subscribe subscribe}</td>
       <td>
-        <code>subscribe(dest, headers={}, &cb)</code>
+        <code>subscribe(dest, headers=&lt;optional hash&gt;, &cb)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -473,7 +473,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#unsubscribe unsubscribe}</td>
       <td>
-        <code>unsubscribe(id, headers={})</code>
+        <code>unsubscribe(id, headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>
@@ -481,7 +481,7 @@
     <tr>
       <td>{OnStomp::Interfaces::FrameMethods#unsubscribe unsubscribe}</td>
       <td>
-        <code>unsubscribe(subscribe_frame, headers={})</code>
+        <code>unsubscribe(subscribe_frame, headers=&lt;optional hash&gt;)</code>
       </td>
       <td style="background-color: #bfb;">true</td>
       <td style="background-color: #bfb;">true</td>

data/extra_doc/API.md.erb

@@ -20,7 +20,7 @@
     <tr>
       <td>{<%= meth[:yard_link] %> <%= meth[:name]%>}</td>
       <td>
-        <code><%= meth[:signature] %></code>
+        <code><%= meth[:signature].gsub('{}', '&lt;optional hash&gt;') %></code>
       </td>
     <% meth[:protocols].each do |proto| %>
       <td style="background-color: #<%= proto ? 'bfb' : 'fbb' %>;"><%= proto %></td>

data/lib/onstomp/components/frame.rb

@@ -43,16 +43,16 @@ class OnStomp::Components::Frame
   #   frame['other header'] = 42 #=> '42'
   def []=(name, val); @headers[name] = val; end
   
-  # If a +content-length+ header is set, returns it after converting it to
+  # If a `content-length` header is set, returns it after converting it to
   # an integer.
   # @return [Fixnum, nil]
   def content_length
     header?(:'content-length') ? @headers[:'content-length'].to_i : nil
   end
   
-  # If a +content-type+ header is set, splits it into three parts: type,
-  # subtype and charset. If any component of the +content-type+ is missing,
-  # its value will be `nil` in the returned triple. If the +content-type+
+  # If a `content-type` header is set, splits it into three parts: type,
+  # subtype and charset. If any component of the `content-type` is missing,
+  # its value will be `nil` in the returned triple. If the `content-type`
   # header is not set or does not match {OnStomp::Components::Frame::CONTENT_TYPE_REG}
   # all values in the triple will be `nil`.
   # @return [Array<String,nil>]
@@ -77,7 +77,7 @@ class OnStomp::Components::Frame
   alias :headers? :all_headers?
   
   # Returns the heart-beat configuration specified in this frame's headers.
-  # If a +heart-beat+ header is not set, [0, 0] will be returned. Otherwise,
+  # If a `heart-beat` header is not set, [0, 0] will be returned. Otherwise,
   # the header value will be split on ',' and each component will be converted
   # to a non-negative integer.
   # @return [[Fixnum,Fixnum]] pair of non-negative integers that specify
@@ -89,7 +89,7 @@ class OnStomp::Components::Frame
     end
   end
   
-  # Sets this frame's +content-length+ header to match the byte-length of
+  # Sets this frame's `content-length` header to match the byte-length of
   # its body, if the body has been set.
   # @return <Fixnum,nil>
   def force_content_length

data/lib/onstomp/components/uri.rb

@@ -12,7 +12,7 @@ module OnStomp::Components::URI
     def onstomp_socket_type; :tcp; end
   end
   
-  # A URI class for representing URIs with a 'stomp+ssl' scheme.
+  # A URI class for representing URIs with a `stomp+ssl` scheme.
   class STOMP_SSL < STOMP
     # The default port to use for these kinds of URI objects when none has
     # been specified.

data/lib/onstomp/connections/base.rb

@@ -14,7 +14,7 @@ class OnStomp::Connections::Base
   
   # Creates a new connection using the given {#socket} object and
   # {OnStomp::Client client}. The {#socket} object will generally be a `TCPSocket`
-  # or an +OpenSSL::SSL::SSLSocket+ and must support the methods `read_nonblock`
+  # or an `OpenSSL::SSL::SSLSocket` and must support the methods `read_nonblock`
   # `write_nonblock`, and `close`.
   # @param [TCPSocket,OpenSSL::SSL::SSLSocket] socket
   # @param [OnStomp::Client] client
@@ -146,14 +146,21 @@ class OnStomp::Connections::Base
   # sent to the head of the write buffer to be processed first the next time
   # this method is invoked.
   def io_process_write
-    if @write_buffer.length > 0 && IO.select(nil, [socket], nil, 0.1)
-      to_shift = @write_buffer.length / 3
-      written = 0
-      while written < MAX_BYTES_PER_WRITE
-        data, frame = shift_write_buffer
-        break unless data && connected?
-        begin
-          w = socket.write_nonblock(data)
+    begin
+      if @write_buffer.length > 0 && IO.select(nil, [socket], nil, 0.1)
+        to_shift = @write_buffer.length / 3
+        written = 0
+        while written < MAX_BYTES_PER_WRITE
+          data, frame = shift_write_buffer
+          break unless data && connected?
+          begin
+            w = socket.write_nonblock(data)
+          rescue Errno::EINTR, Errno::EAGAIN, Errno::EWOULDBLOCK
+            # writing will either block, or cannot otherwise be completed,
+            # put data back and try again some other day
+            unshift_write_buffer data, frame
+            break
+          end
           written += w
           @last_transmitted_at = Time.now
           if w < data.length
@@ -162,16 +169,11 @@ class OnStomp::Connections::Base
             yield frame if block_given?
             client.dispatch_transmitted frame
           end
-        rescue Errno::EINTR, Errno::EAGAIN, Errno::EWOULDBLOCK
-          # writing will either block, or cannot otherwise be completed,
-          # put data back and try again some other day
-          unshift_write_buffer data, frame
-          break
-        rescue Exception
-          triggered_close $!.message, :terminated
-          raise
         end
       end
+    rescue Exception
+      triggered_close $!.message, :terminated
+      raise
     end
     if @write_buffer.empty? && @closing
       triggered_close 'client disconnected'
@@ -183,23 +185,26 @@ class OnStomp::Connections::Base
   # to the end of a read buffer, which is then sent to the connection's
   # {OnStomp::Connections::Serializers serializer} for processing.
   def io_process_read
-    if connected? && IO.select([socket], nil, nil, 0.1)
-      begin
-        data = socket.read_nonblock(MAX_BYTES_PER_READ)
-        @read_buffer << data
-        @last_received_at = Time.now
-        serializer.bytes_to_frame(@read_buffer) do |frame|
-          yield frame if block_given?
-          client.dispatch_received frame
+    begin
+      if connected? && IO.select([socket], nil, nil, 0.1)
+        if data = socket.read_nonblock(MAX_BYTES_PER_READ)
+          @read_buffer << data
+          @last_received_at = Time.now
+          serializer.bytes_to_frame(@read_buffer) do |frame|
+            yield frame if block_given?
+            client.dispatch_received frame
+          end
+        else
+          triggered_close $!.message, :terminated
         end
-      rescue Errno::EINTR, Errno::EAGAIN, Errno::EWOULDBLOCK
-        # do not
-      rescue EOFError
-        triggered_close $!.message
-      rescue Exception
-        triggered_close $!.message, :terminated
-        raise
       end
+    rescue Errno::EINTR, Errno::EAGAIN, Errno::EWOULDBLOCK
+      # do not
+    rescue EOFError
+      triggered_close $!.message
+    rescue Exception
+      triggered_close $!.message, :terminated
+      raise
     end
   end
   
@@ -207,7 +212,7 @@ class OnStomp::Connections::Base
   def triggered_close msg, *evs
     @connection_up = false
     @closing = false
-    socket.close
+    socket.close rescue nil
     evs.each { |ev| trigger_connection_event ev, msg }
     trigger_connection_event :closed, msg
     @write_buffer.clear

data/lib/onstomp/connections/serializers/stomp_1.rb

@@ -71,7 +71,7 @@ module OnStomp::Connections::Serializers::Stomp_1
     end
   end
   
-  # Adds the substring +data[0...idx]+ to the parser's accumulator,
+  # Adds the substring `data[0...idx]` to the parser's accumulator,
   # unshifts the remaining data back onto the buffer, and calls `meth`
   # with the parser's accumulated string.
   # @param [Array<String>] buffer

data/lib/onstomp/connections/serializers/stomp_1_1.rb

@@ -64,7 +64,7 @@ class OnStomp::Connections::Serializers::Stomp_1_1
       unescape_header(str[(col+1)..-1]) ]
   end
   
-  # Forces the frame's body to match the charset specified in its +content-type+
+  # Forces the frame's body to match the charset specified in its `content-type`
   # header, if applicable.
   # @param [OnStomp::Components::Frame] frame
   def prepare_parsed_frame frame
@@ -94,7 +94,7 @@ class OnStomp::Connections::Serializers::Stomp_1_1
       f.body.force_encoding(charset)
       f
     end
-    # Set an appropriate +content-type+ header with `charset` parameter for
+    # Set an appropriate `content-type` header with `charset` parameter for
     # frames with a text body
     # @note No-op for Ruby 1.8.x
     # @param [OnStomp::Components::Frame] f

data/lib/onstomp/failover/client.rb

@@ -19,12 +19,12 @@ class OnStomp::Failover::Client
   # @return [Class]
   attr_configurable_buffer :buffer
   # The delay in seconds to wait between connection retries.
-  # Defaults to +10+.
+  # Defaults to `10`
   # @return [Fixnum]
   attr_configurable_int :retry_delay, :default => 10
   # The maximum number of times to retry connecting during a reconnect
   # loop. A non-positive number will force the failover client to try to
-  # reconnect indefinitely. Defaults to +0+
+  # reconnect indefinitely. Defaults to `0`
   # @return [Fixnum]
   attr_configurable_int :retry_attempts, :default => 0
   # Whether or not to randomize the {#client_pool} before connecting through
@@ -50,6 +50,14 @@ class OnStomp::Failover::Client
     @connection = nil
     @frame_buffer = buffer.new self
     @disconnecting = false
+    @retry_thread = Thread.new do
+      until @disconnecting
+        Thread.stop
+        @client_mutex.synchronize {
+          reconnect unless @disconnecting
+        }
+      end
+    end
   end
   
   # Returns true if there is an {#active_client} and it is
@@ -69,7 +77,7 @@ class OnStomp::Failover::Client
   # @return [self]
   def connect
     @disconnecting = false
-    unless reconnect
+    unless @client_mutex.synchronize { reconnect }
       raise OnStomp::Failover::MaximumRetriesExceededError
     end
     self
@@ -78,43 +86,35 @@ class OnStomp::Failover::Client
   # Ensures that a connection is properly established, then invokes
   # {OnStomp::Client#disconnect disconnect} on the {#active_client}
   def disconnect *args, &block
-    return unless active_client
-    # If we're not connected, let `reconnect` handle it.
-    #@disconnecting = [args, block]
-    #if connected?
+    if active_client
+      Thread.pass until connected?
       @client_mutex.synchronize do
         @disconnecting = true
         active_client.disconnect *args, &block
       end
-    #end
+    end
   end
   
   private
   def reconnect
-    @client_mutex.synchronize do
-      attempt = 1
-      until connected? || retry_exceeded?(attempt)
-        sleep_for_retry attempt
-        begin
-          trigger_failover_retry :before, attempt
-          @active_client = client_pool.next_client
-          # `reconnect` could be called again within the marked range.
-          active_client.connect # <--- From here
-          @connection = active_client.connection
-        rescue Exception
-          trigger_failover_event :connect_failure, :on, active_client, $!.message
-        end
-        trigger_failover_retry :after, attempt
-        attempt += 1
+    attempt = 1
+    until connected? || retry_exceeded?(attempt)
+      sleep_for_retry attempt
+      begin
+        trigger_failover_retry :before, attempt
+        @active_client = client_pool.next_client
+        # `reconnect` could be called again within the marked range.
+        active_client.connect # <--- From here
+        @connection = active_client.connection
+      rescue Exception
+        trigger_failover_event :connect_failure, :on, active_client, $!.message
       end
-      connected?.tap do |b|
-        b && trigger_failover_event(:connected, :on, active_client)
-        #if @disconnecting.is_a?(Array)
-        #  args, block = @disconnect
-        #  active_client.disconnect *args, &block
-        #end
-      end # <--- Until here
+      trigger_failover_retry :after, attempt
+      attempt += 1
     end
+    connected?.tap do |b|
+      b && trigger_failover_event(:connected, :on, active_client)
+    end # <--- Until here
   end
   
   def retry_exceeded? attempt
@@ -128,9 +128,14 @@ class OnStomp::Failover::Client
   def create_client_pool hosts
     @client_pool = pool.new hosts
     on_connection_closed do |client, *_|
-      unless @disconnecting
-        trigger_failover_event(:lost, :on, active_client)
-        reconnect
+      if client == active_client
+        unless @disconnecting
+          trigger_failover_event(:lost, :on, active_client)
+          # Wake up the reconnect thread. This ensures that subsequent
+          # connections are all spawned from the same source.
+          # Previously, we re-spawned here and that was rather problematic.
+          @retry_thread.run
+        end
       end
     end
   end

data/lib/onstomp/failover/failover_configurable.rb

@@ -23,9 +23,9 @@ module OnStomp::Failover::FailoverConfigurable
     
     # Creates readable and writeable attributes that are automatically
     # converted into boolean values. Assigning the attributes any of
-    # `true`, +'true'+, +'1'+ or +1+ will set the attribute to `true`, all
+    # `true`, `'true'`, `'1'` or `1` will set the attribute to `true`, all
     # other values with be treated as `false`. This method will also alias
-    # the reader methods with +attr_name?+
+    # the reader methods with `attr_name?`
     def attr_configurable_bool *args, &block
       trans = attr_configurable_wrap lambda { |v|
         [true, 'true', '1', 1].include?(v) }, block

data/lib/onstomp/failover/failover_events.rb

@@ -4,8 +4,8 @@
 module OnStomp::Failover::FailoverEvents
   include OnStomp::Interfaces::EventManager
   
-  # We do this one using +class << self+ instead of the +self.included+ hook
-  # because we need 'create_client_event_method+ immediately.
+  # We do this one using `class << self` instead of the `self.included` hook
+  # because we need `create_client_event_method` immediately.
   class << self
     # Creates a forwarded binding for client events.
     def create_client_event_method name
@@ -83,6 +83,11 @@ module OnStomp::Failover::FailoverEvents
   # @yieldparam [OnStomp::Failover::Client] failover
   # @yieldparam [OnStomp::Client] client
   create_event_methods :failover_connected, :on
+  # Binds a callback to be invoked when the maximum retries has been
+  # exceeded.
+  # @yield [failover] callback invoked when event is triggered
+  # @yieldparam [OnStomp::Failover::Client] failover
+  create_event_methods :failover_retries_exceeded, :on
   
   # Triggers a failover retry event
   def trigger_failover_retry pref, attempt

data/lib/onstomp/failover/uri.rb

@@ -27,12 +27,12 @@ module OnStomp::Failover::URI
     class << self
       # Parses a failover URI string or an array of URIs into a
       # {OnStomp::Failover::URI::FAILOVER} object. Ruby's URI parser works
-      # fine with +failover:(uri1,uri2,..)?params=..+ style URIs, but chokes
-      # on +failover://uri1,uri2,..+ forms. This method gives us a bit more
+      # fine with `failover:(uri1,uri2,..)?params=..` style URIs, but chokes
+      # on `failover://uri1,uri2,..` forms. This method gives us a bit more
       # flexibility.
-      # @note If you are using the +open-uri+ extension with `failover`, you
-      #   MUST use the +failover:(uri1,uri2,..)+ form because +open-uri+
-      #   relies on +URI.parse+ to convert strings into `URI` objects.
+      # @note If you are using the `open-uri` extension with `failover`, you
+      #   MUST use the `failover:(uri1,uri2,..)` form because `open-uri`
+      #   relies on `URI.parse` to convert strings into `URI` objects.
       # @overload parse(str)
       #   @param [String] str
       #   @return [FAILOVER]

data/lib/onstomp/failover.rb

@@ -3,7 +3,7 @@
 # Namespace for failover extensions.
 module OnStomp::Failover
   # Raised if the supplied failover: URI is not properly formatted as
-  # +failover:(uri,uri,...)?optionalParams=values+
+  # `failover:(uri,uri,...)?optionalParams=values`
   class InvalidFailoverURIError < OnStomp::OnStompError; end
   
   # Raised if the maximum number of retries is exceed when calling

data/lib/onstomp/interfaces/client_events.rb

@@ -158,7 +158,7 @@ module OnStomp::Interfaces::ClientEvents
   end
   
   # Triggers the :before_receiving event and the
-  # `before` prefixed frame specific event (eg: +:before_error+).
+  # `before` prefixed frame specific event (eg: `:before_error`).
   # @param [OnStomp::Components::Frame] f
   def trigger_before_receiving f
     trigger_event :before_receiving, f, self
@@ -166,7 +166,7 @@ module OnStomp::Interfaces::ClientEvents
   end
   
   # Triggers the :after_receiving event and the
-  # `on` prefixed frame specific event (eg: +:on_message+)
+  # `on` prefixed frame specific event (eg: `:on_message`)
   # @param [OnStomp::Components::Frame] f
   def trigger_after_receiving f
     trigger_event :after_receiving, f, self
@@ -174,7 +174,7 @@ module OnStomp::Interfaces::ClientEvents
   end
   
   # Triggers the :before_transmitting event and the
-  # `before` prefixed frame specific event (eg: +:before_disconnect+).
+  # `before` prefixed frame specific event (eg: `:before_disconnect`).
   # @param [OnStomp::Components::Frame] f
   def trigger_before_transmitting f
     trigger_event :before_transmitting, f, self
@@ -182,7 +182,7 @@ module OnStomp::Interfaces::ClientEvents
   end
   
   # Triggers the :after_transmitting event and the
-  # `on` prefixed frame specific event (eg: +:on_send+).
+  # `on` prefixed frame specific event (eg: `:on_send`).
   # @param [OnStomp::Components::Frame] f
   def trigger_after_transmitting f
     trigger_event :after_transmitting, f, self

data/lib/onstomp/interfaces/connection_events.rb

@@ -12,7 +12,7 @@ module OnStomp::Interfaces::ConnectionEvents
   # @yield [client, connection] callback invoked when event is triggered
   # @yieldparam [OnStomp::Client] client
   # @yieldparam [OnStomp::Connections::Base] connection that triggered
-  #   the event (in general the same as +client.connection+)
+  #   the event (in general the same as `client.connection`)
   create_event_methods :established, :on
   # @api gem:1 STOMP:1.1
   # Binds a callback to be invoked when a connection has been died due to
@@ -21,7 +21,7 @@ module OnStomp::Interfaces::ConnectionEvents
   # @yield [client, connection] callback invoked when event is triggered
   # @yieldparam [OnStomp::Client] client
   # @yieldparam [OnStomp::Connections::Base] connection that triggered
-  #   the event (in general the same as +client.connection+)
+  #   the event (in general the same as `client.connection`)
   create_event_methods :died, :on
   # @api gem:1 STOMP:1.0,1.1
   # Binds a callback to be invoked when a connection has been terminated
@@ -29,7 +29,7 @@ module OnStomp::Interfaces::ConnectionEvents
   # @yield [client, connection] callback invoked when event is triggered
   # @yieldparam [OnStomp::Client] client
   # @yieldparam [OnStomp::Connections::Base] connection that triggered
-  #   the event (in general the same as +client.connection+)
+  #   the event (in general the same as `client.connection`)
   create_event_methods :terminated, :on
   # @api gem:1 STOMP:1.0,1.1
   # Binds a callback to be invoked when a connection has been closed, either
@@ -39,7 +39,7 @@ module OnStomp::Interfaces::ConnectionEvents
   # @yield [client, connection] callback invoked when event is triggered
   # @yieldparam [OnStomp::Client] client
   # @yieldparam [OnStomp::Connections::Base] connection that triggered
-  #   the event (in general the same as +client.connection+)
+  #   the event (in general the same as `client.connection`)
   create_event_methods :closed, :on
   
   # @endgroup

data/lib/onstomp/interfaces/frame_methods.rb

@@ -64,7 +64,7 @@ module OnStomp::Interfaces::FrameMethods
   # @api gem:1 STOMP:1.0,1.1* [+ack:client-individual]
   # Transmits a SUBSCRIBE frame generated by the client's connection. Depending
   # upon the connection, a subscription can be set to various MESSAGE
-  # acknowledgement modes by setting the +:ack+ header.
+  # acknowledgement modes by setting the `:ack` header.
   # STOMP 1.0 and STOMP 1.1 connections support:
   # * :ack => 'auto'
   #   The broker assumes that MESSAGE frames received through the
@@ -239,6 +239,7 @@ module OnStomp::Interfaces::FrameMethods
   # @api gem:1 STOMP:1.0,1.1! [+subscription:id]
   # Transmits an ACK frame generated by the client's connection.
   # @overload ack(message_frame, headers={})
+  #   Generates an ACK frame for the given MESSAGE frame.
   #   @api gem:1 STOMP:1.0,1.1
   #   @note Users should use this form whenever possible as it will work
   #     with STOMP 1.0 and 1.1 connections.
@@ -246,6 +247,7 @@ module OnStomp::Interfaces::FrameMethods
   #     acknowledge.
   #   @param [{#to_sym => #to_s}] headers additional headers to include in
   #     the frame
+  #   @return [OnStomp::Components::Frame]
   #   @example
   #     client.subscribe '/queue/test', :ack => 'client' do |m|
   #       if m[:'x-of-interest-to-me'] == 'hells yes'
@@ -253,13 +255,15 @@ module OnStomp::Interfaces::FrameMethods
   #       end
   #     end
   # @overload ack(message_id, headers={})
+  #   Generates an ACK frame for the given `message-id`.
   #   @api gem:1 STOMP:1.0
   #   @note This form will raise an `ArgumentError` with STOMP 1.1 connections
   #     as a subscription ID is also required to ACK a received MESSAGE.
-  #   @param [String] message_id +message-id+ header of MESSAGE frame to
+  #   @param [String] message_id `message-id` header of MESSAGE frame to
   #     acknowledge.
   #   @param [{#to_sym => #to_s}] headers additional headers to include in
   #     the frame
+  #   @return [OnStomp::Components::Frame]
   #   @example
   #     client.subscribe '/queue/test', :ack => 'client' do |m|
   #       if m[:'x-of-interest-to-me'] == 'hells yes'
@@ -267,15 +271,17 @@ module OnStomp::Interfaces::FrameMethods
   #       end
   #     end
   # @overload ack(message_id, subscription_id, headers={})
+  #   Generates an ACK frame for the given `message-id` and `subscription`.
   #   @api gem:1 STOMP:1.0,1.1
   #   @note This form should be used with STOMP 1.1 connections when it is
   #     not possible to provide the actual MESSAGE frame.
-  #   @param [String] message_id +message-id+ header of MESSAGE frame to
+  #   @param [String] message_id `message-id` header of MESSAGE frame to
   #     acknowledge.
   #   @param [String] subscription_id `subscription` header of MESSAGE frame to
   #     acknowledge.
   #   @param [{#to_sym => #to_s}] headers additional headers to include in
   #     the frame
+  #   @return [OnStomp::Components::Frame]
   #   @example
   #     client.subscribe '/queue/test', :ack => 'client' do |m|
   #       if m[:'x-of-interest-to-me'] == 'hells yes'
@@ -303,6 +309,7 @@ module OnStomp::Interfaces::FrameMethods
   #     un-acknowledge.
   #   @param [{#to_sym => #to_s}] headers additional headers to include in
   #     the frame
+  #   @return [OnStomp::Components::Frame]
   #   @example
   #     client.subscribe '/queue/test', :ack => 'client' do |m|
   #       if m[:'x-of-interest-to-me'] == 'hells no!'
@@ -310,12 +317,14 @@ module OnStomp::Interfaces::FrameMethods
   #       end
   #     end
   # @overload nack(message_id, subscription_id, heders={})
-  #   @param [String] message_id +message-id+ header of MESSAGE frame to
+  #   Generates a NACK frame for the given `message-id` and `subscription`.
+  #   @param [String] message_id `message-id` header of MESSAGE frame to
   #     un-acknowledge.
   #   @param [String] subscription_id `subscription` header of MESSAGE frame to
   #     un-acknowledge.
   #   @param [{#to_sym => #to_s}] headers additional headers to include in
   #     the frame
+  #   @return [OnStomp::Components::Frame]
   #   @example
   #     client.subscribe '/queue/test', :ack => 'client' do |m|
   #       if m[:'x-of-interest-to-me'] == 'hells no!'

data/lib/onstomp/version.rb

@@ -7,7 +7,7 @@ module OnStomp
   # Minor / feature version
   MINOR = 0
   # Patch version
-  PATCH = 2
+  PATCH = 3
   # Complete version
   VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
 end

data/onstomp.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   
   s.required_ruby_version = '>= 1.8.7'
-  s.has_rdoc = 'yard'
+  #s.has_rdoc = 'yard'
   s.add_development_dependency('rspec', '~> 2.4.0')
   s.add_development_dependency('simplecov', '>= 0.3.0')
   s.add_development_dependency('yard', '>= 0.6.0')

data/spec/onstomp/full_stacks/failover_spec.rb

@@ -58,7 +58,7 @@ describe OnStomp::Failover, "full stack test", :fullstack => true, :failover =>
       end
       client.unsubscribe sub, :'x-onstomp-real-client' => client.active_client.uri
       client.commit 't-1234', :'x-onstomp-real-client' => client.active_client.uri
-      
+      #Thread.pass until client.connected?
       client.disconnect :'x-onstomp-real-client' => client.active_client.uri
       brokers.each(&:join)
       brokers.first.frames_received.map(&:command).should == ["CONNECT", "SEND", "BEGIN", "SEND", "SUBSCRIBE"]
@@ -96,7 +96,7 @@ describe OnStomp::Failover, "full stack test", :fullstack => true, :failover =>
       end
       client.unsubscribe sub, :'x-onstomp-real-client' => client.active_client.uri
       client.commit 't-1234', :'x-onstomp-real-client' => client.active_client.uri
-      
+      #Thread.pass until client.connected?
       client.disconnect :'x-onstomp-real-client' => client.active_client.uri
       brokers.each(&:join)
       brokers.first.frames_received.map(&:command).should == ["CONNECT", "SEND", "BEGIN", "SEND", "SUBSCRIBE"]

data/spec/onstomp/full_stacks/open-uri_spec.rb

@@ -4,7 +4,7 @@ require File.expand_path('../test_broker', __FILE__)
 
 describe OnStomp::OpenURI, "full stack test", :fullstack => true, :openuri => true do
   let(:broker) {
-    TestBroker.new
+    TestBroker.new 10101
   }
   before(:each) do
     broker.start
@@ -15,7 +15,7 @@ describe OnStomp::OpenURI, "full stack test", :fullstack => true, :openuri => tr
   
   describe "opening URIs" do
     it "should deliver some SEND frames" do
-      open("stomp://localhost/queue/onstomp/open-uri/test") do |c|
+      open("stomp://localhost:10101/queue/onstomp/open-uri/test") do |c|
         c.send "Test Message 1"
         c.send "Another Test Message"
       end
@@ -25,7 +25,7 @@ describe OnStomp::OpenURI, "full stack test", :fullstack => true, :openuri => tr
     end
     
     it "should receive the some MESSAGE frames" do
-      open("stomp://localhost/queue/onstomp/open-uri/test") do |c|
+      open("stomp://localhost:10101/queue/onstomp/open-uri/test") do |c|
         c.send "Test Message 1"
         c.send "Another Test Message"
         c.send "Last Message"

data/spec/support/frame_matchers.rb

@@ -29,7 +29,6 @@ end
 
 RSpec::Matchers.define :be_a_transaction_scope do |tx_id|
   match do |actual|
-    $stdout.puts "Checking transaction? #{tx_id.inspect}"
     type_check = actual.is_a?(OnStomp::Components::Scopes::TransactionScope)
     tx_id ? type_check && actual.transaction == tx_id : type_check
   end

metadata

@@ -2,7 +2,7 @@
 name: onstomp
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - Ian D. Eccles
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-09 00:00:00 -04:00
-default_executable: 
+date: 2011-04-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -195,7 +194,6 @@ files:
 - spec/support/frame_matchers.rb
 - spec/support/shared_frame_method_examples.rb
 - yard_extensions.rb
-has_rdoc: yard
 homepage: http://github.com/meadvillerb/onstomp
 licenses: []
 
@@ -219,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: onstomp-core
-rubygems_version: 1.6.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Client for message queues implementing the Stomp protocol interface.
@@ -287,3 +285,4 @@ test_files:
 - spec/support/custom_argument_matchers.rb
 - spec/support/frame_matchers.rb
 - spec/support/shared_frame_method_examples.rb
+has_rdoc: