stomp_out 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f12f905dba95872de613a615e4b4aa0e4207554
-  data.tar.gz: b9884ea302138b02faf1150b29ccbf98475b88d6
+  metadata.gz: 0cc602c974a465dd13ce66f3592b59a822521816
+  data.tar.gz: 3f296599ba021a4c246b162e6742b29ebe96f087
 SHA512:
-  metadata.gz: 9dfcbd1d503e016e37ff944467bffbaa6af0c0653659fbc74102dbccd390a4a06c77372ae94d16cd98f05fd5fc07a5c688a73618c8dadc582f439afe4b664a9f
-  data.tar.gz: 95b7efa0be620bac871a4f59c4bdc8ac6fb625c73ff2eb1b1bc66cea8e070b8e4c0b9d845fe999dd56c52ca0ef0b9b5ae8f93025e0cf1205f5b3e90aa57a7a9d
+  metadata.gz: 922df4ff83adace96a0efd77f3b064eae0f25911bac2c645b26a16ee53616293da29767d81b945b00d1b68164a3e959778ab160046e5fdf4b0292d2722f26c45
+  data.tar.gz: 3518eb6cf0c298d801f0921f5758d4fbf259813fe3d76164edb5d9ca61aa599ecc13a0d951a8d15bce4c543b3d12a675640c58a535f173cc9ef635d200e81f08

data/CHANGELOG.rdoc

@@ -6,3 +6,8 @@ Initial commit
 
 Made gem testable under travis and added build status to README
 Enabled Server#on_connect to override the session_id it is passed
+
+=== 0.1.2 (2015-02-09)
+
+Generate session and message IDs incrementally rather than using UUID
+Handle acks IDs in 1.0/1.1 when message IDs not unique, e.g., on resend

data/README.rdoc

@@ -80,7 +80,6 @@ and to consume messages:
 
 = Dependencies
 
-The simple_uuid gem is used by the Server for generating subscription identifiers.
 The eventmachine gem is used only if the STOMP heartbeat feature is used.
 The the json gem is used by the Client only if a content-type is "application/json"
 and the :auto_json option is enabled.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/stomp_out/client.rb

@@ -46,7 +46,20 @@ module StompOut
 
     MIN_SEND_HEARTBEAT = 5000
 
-    attr_reader :version, :session_id, :server_name, :host, :heartbeat
+    # [String] version of STOMP chosen for session
+    attr_reader :version
+
+    # [String] session_id assigned to session
+    attr_reader :session_id
+
+    # [String] name assigned to server
+    attr_reader :server_name
+
+    # [String] host to which client is connecting
+    attr_reader :host
+
+    # [Heartbeat] heartbeat generator and monitor
+    attr_reader :heartbeat
 
     # Create STOMP client
     #

data/lib/stomp_out/server.rb

@@ -19,8 +19,6 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-require 'simple_uuid'
-
 module StompOut
 
   # Abstract base class for STOMP server for use with an existing client connection, such
@@ -57,7 +55,20 @@ module StompOut
     MIN_SEND_HEARTBEAT = 5000
     DESIRED_RECEIVE_HEARTBEAT = 60000
 
-    attr_reader :version, :session_id, :server_name, :heartbeat
+    # [Integer] value of last generated session ID for class
+    @@last_session_id = 0
+
+    # [String] version of STOMP chosen for session
+    attr_reader :version
+
+    # [String] session_id assigned to session
+    attr_reader :session_id
+
+    # [String] name assigned to server
+    attr_reader :server_name
+
+    # [Heartbeat] heartbeat generator and monitor
+    attr_reader :heartbeat
 
     # Create STOMP server
     #
@@ -71,6 +82,7 @@ module StompOut
       @options = options
       @ack_id = 0
       @ack_ids = {} # message-id is key
+      @message_id = 0
       @subscribe_id = 0
       @subscribes = {} # destination is key
       @server_name = options[:name] + (options[:version] ? "/#{options[:version]}" : "") if options[:name]
@@ -250,18 +262,19 @@ module StompOut
     # - may set other application-specific headers
     #
     # @param [Hash] headers for message per requirements above but with "message-id"
-    #   defaulting to generated UUID and "ack" defaulting to generated ID if not specified
+    #   defaulting to generated ID and "ack" defaulting to generated ID if not specified
     # @param [String] body of message
     #
     # @return [Array] message ID and ack ID; latter is nil if ack is in "auto" mode
     #
     # @raise [ProtocolError] not connected
-    # @raise [ApplicationError] subscription not found, subscription does not match destination
+    # @raise [ApplicationError] subscription not found, subscription does not match destination,
+    #   non-unique message ID
     def message(headers, body)
       raise ProtocolError.new("Not connected") unless @connected
       frame = Frame.new(nil, (headers && headers.dup) || {})
       destination, subscribe_id = frame.require(@version, "destination" => [], "subscription" => ["1.0"])
-      message_id = frame.headers["message-id"] ||= SimpleUUID::UUID.new.to_guid
+      message_id = frame.headers["message-id"] ||= (@message_id += 1).to_s
 
       ack_id = nil
       if (subscribe = @subscribes[destination])
@@ -272,10 +285,11 @@ module StompOut
           # Create ack ID if there is none so that user of this server can rely
           # on always receiving an ack ID (as opposed to a message ID) on ack/nack
           # independent of STOMP version in use
-          ack_id = if @version < "1.2"
-            @ack_ids[message_id] = frame.headers.delete("ack") || (@ack_id += 1).to_s
+          if @version < "1.2"
+            ack_id = frame.headers.delete("ack") || (@ack_id += 1).to_s
+            @ack_ids[message_id] = (@ack_ids[message_id] || []) << ack_id
           else
-            frame.headers["ack"] ||= (@ack_id += 1).to_s
+            ack_id = frame.headers["ack"] ||= (@ack_id += 1).to_s
           end
         end
       else
@@ -380,7 +394,7 @@ module StompOut
         headers["heart-beat"] = [@heartbeat.outgoing_rate, @heartbeat.incoming_rate].join(",")
       end
       headers["server"] = @server_name if @server_name
-      default_session_id = SimpleUUID::UUID.new.to_guid
+      default_session_id = self.class.next_session_id
       if (result = on_connect(frame, frame.headers["login"], frame.headers["passcode"], host, default_session_id))
         @connected = true
         @session_id = (result.is_a?(String) || result.is_a?(Integer)) ? result.to_s : default_session_id
@@ -485,7 +499,7 @@ module StompOut
     # @raise [ProtocolError] missing header
     def receive_ack(frame)
       id, message_id = frame.require(@version, "id" => ["1.0", "1.1"], "message-id" => ["1.2"])
-      on_ack(frame, id || @ack_ids.delete(message_id))
+      on_ack(frame, id || to_ack(message_id))
       true
     end
 
@@ -501,7 +515,7 @@ module StompOut
     def receive_nack(frame)
       raise ProtocolError.new("Invalid command", frame) if @version == "1.0"
       id, message_id = frame.require(@version, "id" => ["1.0", "1.1"], "message-id" => ["1.2"])
-      on_nack(frame, id || @ack_ids.delete(message_id))
+      on_nack(frame, id || to_ack(message_id))
       true
     end
 
@@ -666,6 +680,32 @@ module StompOut
       version
     end
 
+    # Convert message ID to ack ID
+    # Allow for the possibility of a message being resent before being acknowledged
+    # (or message IDs not being unique), in which case arbitrarily convert to oldest ack ID
+    #
+    # @param [String] message_id to be converted
+    #
+    # @return [String] ack ID
+    #
+    # @raise [ApplicationError] message ID unknown
+    def to_ack(message_id)
+      if (ids = @ack_ids[message_id])
+        id = ids.shift
+        @ack_ids.delete(message_id) if ids.empty?
+        id
+      else
+        raise ApplicationError.new("Unknown 'message-id': #{message_id.inspect}")
+      end
+    end
+
+    # Generate next session ID
+    #
+    # @return [String] session ID
+    def self.next_session_id
+      (@@last_session_id += 1).to_s
+    end
+
   end # Server
 
 end # StompOut

data/stomp_out.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: stomp_out 0.1.1 ruby lib
+# stub: stomp_out 0.1.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "stomp_out"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Lee Kirchhoff"]
-  s.date = "2015-02-06"
+  s.date = "2015-02-09"
   s.description = "This implementation of STOMP is aimed at environments where a network connection, such as a WebSocket or TCP socket, is created and then raw data from that connection is passed to/from the STOMP client or server messaging layer provided by this gem."
   s.email = "support@rightscale.com"
   s.extra_rdoc_files = [
@@ -48,7 +48,6 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<json>, ["~> 1.4"])
-      s.add_runtime_dependency(%q<simple_uuid>, ["~> 0.2"])
       s.add_development_dependency(%q<rake>, ["~> 10.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
       s.add_development_dependency(%q<ruby-debug>, [">= 0"])
@@ -56,7 +55,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<pry-byebug>, [">= 0"])
     else
       s.add_dependency(%q<json>, ["~> 1.4"])
-      s.add_dependency(%q<simple_uuid>, ["~> 0.2"])
       s.add_dependency(%q<rake>, ["~> 10.0"])
       s.add_dependency(%q<jeweler>, ["~> 2.0"])
       s.add_dependency(%q<ruby-debug>, [">= 0"])
@@ -65,7 +63,6 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<json>, ["~> 1.4"])
-    s.add_dependency(%q<simple_uuid>, ["~> 0.2"])
     s.add_dependency(%q<rake>, ["~> 10.0"])
     s.add_dependency(%q<jeweler>, ["~> 2.0"])
     s.add_dependency(%q<ruby-debug>, [">= 0"])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stomp_out
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Lee Kirchhoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: simple_uuid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement