stomper 0.4 → 1.0.0

data/lib/stomper/frame_reader.rb

@@ -0,0 +1,73 @@
+module Stomper
+  # Deserializes Stomp Frames from an input stream.
+  # Any object that responds appropriately to +getc+, +gets+
+  # and +read+ can be used as the input stream.
+  module FrameReader
+    # Receives the next Stomp Frame from the socket stream
+    def receive_frame
+      command = read_command
+      headers = read_headers
+      body = read_body(headers[:'content-length'])
+      Stomper::Frames::ServerFrame.build(command, headers, body)
+    end
+
+    private
+    def read_command
+      command = ''
+      while(command.size == 0)
+        command = gets(Stomper::Frames::LINE_DELIMITER).chomp!
+      end
+      command
+    end
+
+    def read_headers
+      headers = {}
+      loop do
+        line = gets(Stomper::Frames::LINE_DELIMITER).chomp!
+        break if line.size == 0
+        if (delim = line.index(':'))
+          headers[ line[0..(delim-1)].to_sym ] = line[(delim+1)..-1]
+        end
+      end
+      headers
+    end
+
+    def read_body(body_len)
+      body_len &&= body_len.strip.to_i
+      if body_len
+        read_fixed_body(body_len)
+      else
+        read_null_terminated_body
+      end
+    end
+
+    def read_null_terminated_body
+      body = ''
+      while next_byte = get_body_byte
+        body << next_byte.chr
+      end
+      body
+    end
+
+    def read_fixed_body(num_bytes)
+      body = read(num_bytes)
+      raise MalformedFrameError if get_body_byte
+      body
+    end
+
+    def get_body_byte
+      next_byte = get_ord
+      (next_byte == Stomper::Frames::TERMINATOR) ? nil : next_byte
+    end
+    
+    if String.method_defined?(:ord)
+      def get_ord
+        getc.ord
+      end
+    else
+      def get_ord
+        getc
+      end
+    end
+  end
+end

data/lib/stomper/frame_writer.rb

@@ -0,0 +1,21 @@
+module Stomper
+  # Serializes Stomp Frames to an output stream.
+  # Any object that responds appropriately to +write+
+  # can be used as the input stream.
+  module FrameWriter
+    # Writes a Stomp Frame to the underlying output stream.
+    def transmit_frame(frame)
+      write([ frame.command, Stomper::Frames::LINE_DELIMITER,
+        serialize_headers(frame.headers), Stomper::Frames::LINE_DELIMITER,
+        frame.body, Stomper::Frames::TERMINATOR.chr].join)
+    end
+
+    private
+    def serialize_headers(headers)
+      headers.inject("") do |acc, (key, val)|
+        acc << "#{key}#{Stomper::Frames::HEADER_DELIMITER}#{val}#{Stomper::Frames::LINE_DELIMITER}"
+        acc
+      end
+    end
+  end
+end

data/lib/stomper/frames.rb

@@ -1,4 +1,27 @@
-require 'stomper/frames/headers'
+module Stomper
+  # This module holds all known encapsulations of
+  # frames that are part of the Stomp Protocol specification.
+  module Frames
+    HEADER_DELIMITER = ':'
+    TERMINATOR = 0
+    LINE_DELIMITER = "\n"
+
+    class IndirectFrame #:nodoc:
+      attr_reader :headers, :body
+
+      def initialize(headers={}, body=nil, command=nil)
+        @command = command && command.to_s.upcase
+        @headers = headers.dup
+        @body = body
+      end
+
+      def command
+        @command ||= self.class.name.split("::").last.upcase
+      end
+    end
+  end
+end
+
 require 'stomper/frames/client_frame'
 require 'stomper/frames/server_frame'
 require 'stomper/frames/abort'
@@ -14,11 +37,3 @@ require 'stomper/frames/receipt'
 require 'stomper/frames/send'
 require 'stomper/frames/subscribe'
 require 'stomper/frames/unsubscribe'
-
-module Stomper
-  # This module holds all known encapsulations of
-  # frames that are part of the
-  # {Stomp Protocol Specification}[http://stomp.codehaus.org/Protocol]
-  module Frames
-  end
-end

data/lib/stomper/frames/abort.rb

@@ -1,13 +1,9 @@
 module Stomper
   module Frames
-    # Encapsulates an "ACK" frame from the Stomp Protocol.
-    #
-    # See the {Stomp Protocol Specification}[http://stomp.codehaus.org/Protocol]
-    # for more details.
+    # Encapsulates an "ABORT" frame from the Stomp Protocol.
     class Abort < Stomper::Frames::ClientFrame
       def initialize(transaction_id, headers={})
-        super('ABORT', headers)
-        @headers.transaction = transaction_id
+        super(headers.merge(:transaction => transaction_id))
       end
     end
   end

data/lib/stomper/frames/ack.rb

@@ -1,13 +1,9 @@
 module Stomper
   module Frames
     # Encapsulates an "ACK" frame from the Stomp Protocol.
-    #
-    # See the {Stomp Protocol Specification}[http://stomp.codehaus.org/Protocol]
-    # for more details.
     class Ack < Stomper::Frames::ClientFrame
       def initialize(message_id, headers={})
-        super('ACK', headers)
-        @headers["message-id"] = message_id
+        super(headers.merge({ :'message-id' => message_id }))
       end
 
       # Creates a new Ack instance that corresponds to an acknowledgement
@@ -18,7 +14,7 @@ module Stomper
       # +message+ will be injected into the newly created Ack object's headers.
       def self.ack_for(message, headers = {})
         if message.is_a?(Message)
-          headers['transaction'] = message.headers.transaction if message.headers.transaction
+          headers[:transaction] = message.headers[:transaction] if message.headers[:transaction]
           new(message.id, headers)
         else
           new(message.to_s)

data/lib/stomper/frames/begin.rb

@@ -1,13 +1,10 @@
 module Stomper
   module Frames
     # Encapsulates a "BEGIN" frame from the Stomp Protocol.
-    #
-    # See the {Stomp Protocol Specification}[http://stomp.codehaus.org/Protocol]
-    # for more details.
     class Begin < Stomper::Frames::ClientFrame
       def initialize(transaction_id, headers={})
-        super('BEGIN', headers)
-        @headers.transaction = transaction_id
+        super(headers.merge(:transaction => transaction_id))
+        @headers[:transaction] = transaction_id
       end
     end
   end

data/lib/stomper/frames/client_frame.rb

@@ -1,11 +1,7 @@
 module Stomper
   module Frames
     # Encapsulates a client side frame for the Stomp Protocol.
-    #
-    # See the {Stomp Protocol Specification}[http://stomp.codehaus.org/Protocol]
-    # for more details.
-    class ClientFrame
-      attr_reader :headers, :body, :command
+    class ClientFrame < IndirectFrame
 
       # Creates a new ClientFrame instance with the specified +command+,
       # +headers+ and +body+.
@@ -14,14 +10,12 @@ module Stomper
       # generated for this particular frame instance.  This key can be
       # specified in the +headers+ parameter of any of the subclasses of ClientFrame,
       # and it will be interpretted in the same fashion.
-      def initialize(command, headers={}, body=nil)
-        @command = command
+      def initialize(headers={}, body=nil, command = nil)
         @generate_content_length = headers.delete(:generate_content_length)
-        @headers = Headers.new(headers)
-        @body = body
+        super(headers, body, command)
       end
 
-      # If +bool+ false or nil, this frame instance will not attempt to
+      # If +bool+ is false or nil, this frame instance will not attempt to
       # automatically generate a content-length header.  This is useful when
       # dealing with ActiveMQ as a stomp message broker, which will treat incoming
       # messages lacking a content-length header as +TextMessage+s and
@@ -38,15 +32,15 @@ module Stomper
         @generate_content_length.nil? ? self.class.generate_content_length? : @generate_content_length
       end
 
-      # Converts the frame instance into a valid string representation of the
-      # desired command according to the specifications of the
-      # {Stomp Protocol}[http://stomp.codehaus.org/Protocol]
-      #
-      # This is where the content-length header is generated if the frame
-      # has a body of non-zero length and generate_content_length? is true.
-      def to_stomp
-        @headers["content-length"] = str_size(@body) if @body && !@body.empty? && generate_content_length?
-        "#{@command}\n#{@headers.to_stomp}\n#{@body}\0"
+
+      # Returns the headers for this frame, including a +content-length+ header
+      # set to the size of the current body, if +generate_content_length?+ is
+      # not false.
+      def headers
+        if generate_content_length? && @body && !@body.empty?
+          @headers[:'content-length'] ||= body_size
+        end
+        @headers
       end
 
       class << self
@@ -60,7 +54,8 @@ module Stomper
         # method, or true if no value has been set (thus, defaults to true.)
         #
         # The precedence for resolving whether or not a content-length header
-        # is generated by the to_stomp method is: check the instance setting,
+        # is generated by the +headers+ method is:
+        # check the instance setting,
         # if it has not been set, defer to the class setting, if it hasn't
         # been set, default to true.
         def generate_content_length?
@@ -69,16 +64,24 @@ module Stomper
           end
           @generate_content_length
         end
+
+        def inherited(client_frame) #:nodoc:
+          declared_frames << { :class => client_frame, :command => client_frame.name.split("::").last.downcase.to_sym }
+        end
+
+        def declared_frames
+          @declared_frames ||= []
+        end
       end
 
       private
-      def str_size(str)
-        if str.respond_to?(:bytesize)
-          def str_size(strng); strng.bytesize; end
-          str.bytesize
-        else
-          def str_size(strng); strng.size; end
-          str.size
+      if String.method_defined?(:bytesize)
+        def body_size
+          @body.bytesize
+        end
+      else
+        def body_size
+          @body.size
         end
       end
     end

data/lib/stomper/frames/commit.rb

@@ -1,13 +1,9 @@
 module Stomper
   module Frames
     # Encapsulates a "COMMIT" frame from the Stomp Protocol.
-    #
-    # See the {Stomp Protocol Specification}[http://stomp.codehaus.org/Protocol]
-    # for more details.
     class Commit < Stomper::Frames::ClientFrame
       def initialize(transaction_id, headers={})
-        super('COMMIT', headers)
-        @headers.transaction = transaction_id
+        super(headers.merge({ :transaction => transaction_id }))
       end
     end
   end

data/lib/stomper/frames/connect.rb

@@ -1,14 +1,9 @@
 module Stomper
   module Frames
     # Encapsulates a "CONNECT" frame from the Stomp Protocol.
-    #
-    # See the {Stomp Protocol Specification}[http://stomp.codehaus.org/Protocol]
-    # for more details.
     class Connect < Stomper::Frames::ClientFrame
-      def initialize(username='', password='', headers={})
-        super('CONNECT', headers)
-        @headers.login = username
-        @headers.passcode = password
+      def initialize(login='', passcode='', headers={})
+        super(headers.merge({ :login => login, :passcode => passcode }))
       end
     end
   end

data/lib/stomper/frames/connected.rb

@@ -1,26 +1,29 @@
 module Stomper
   module Frames
     # Encapsulates a "CONNECTED" server side frame for the Stomp Protocol.
-    #
-    # See the {Stomp Protocol Specification}[http://stomp.codehaus.org/Protocol]
-    # for more details.
     class Connected < Stomper::Frames::ServerFrame
-      # This class is a factory for incoming 'CONNECTED' commands.
-      factory_for :connected
 
       # Builds a Connected frame instance with the supplied
       # +headers+ and +body+
       def initialize(headers, body)
-        super('CONNECTED', headers, body)
+        super(headers, body)
       end
 
       # A convenience method that returns the value of
       # the session header, if it is set.
       #
       # This value can also be accessed as:
-      # frame.headers.session or frame.headers['session'] or frame.headers[:session]
+      # frame.headers[:session]
       def session
-        @headers.session
+        @headers[:session]
+      end
+
+      def perform
+        # TODO: I want the frames, particularly the server frames, to know
+        # 'what to do' when they are received.  For instance, when a CONNECTED
+        # frame is received, the connection it is received on should be marked
+        # as being "connected".  This way we can get rid of the various conditional
+        # behavior based on Frame classes in connection and client.
       end
     end
   end

data/lib/stomper/frames/disconnect.rb

@@ -1,12 +1,9 @@
 module Stomper
   module Frames
     # Encapsulates a "DISCONNECT" frame from the Stomp Protocol.
-    #
-    # See the {Stomp Protocol Specification}[http://stomp.codehaus.org/Protocol]
-    # for more details.
     class Disconnect < Stomper::Frames::ClientFrame
       def initialize(headers={})
-        super('DISCONNECT', headers)
+        super(headers)
       end
     end
   end

data/lib/stomper/frames/error.rb

@@ -1,25 +1,20 @@
 module Stomper
   module Frames
     # Encapsulates an "ERROR" server side frame for the Stomp Protocol.
-    #
-    # See the {Stomp Protocol Specification}[http://stomp.codehaus.org/Protocol]
-    # for more details.
     class Error < Stomper::Frames::ServerFrame
-      # This class is a factory for all incoming ERROR frames.
-      factory_for :error
 
       # Creates a new Error frame with the supplied +headers+ and +body+
       def initialize(headers, body)
-        super('ERROR', headers, body)
+        super(headers, body)
       end
 
       # Returns the message responsible for the generation of this Error frame,
       # if applicable.
       #
       # This is a convenience method for:
-      # frame.headers[:message], frame.headers['message'], or frame.headers.message
+      # frame.headers[:message]
       def message
-        @headers.message
+        @headers[:message]
       end
     end
   end

data/lib/stomper/frames/message.rb

@@ -1,22 +1,17 @@
 module Stomper
   module Frames
     # Encapsulates a "MESSAGE" server side frame for the Stomp Protocol.
-    #
-    # See the {Stomp Protocol Specification}[http://stomp.codehaus.org/Protocol]
-    # for more details.
     class Message < Stomper::Frames::ServerFrame
-      # This class is the factory for all MESSAGE frames received.
-      factory_for :message
 
       # Creates a new message frame with the given +headers+ and +body+
       def initialize(headers, body)
-        super('MESSAGE', headers, body)
+        super(headers, body)
       end
 
       # Returns the message id generated by the stomp broker.
       #
       # This is a convenience method for:
-      # frame.headers[:'message-id'] or frame.headers['message-id']
+      # frame.headers[:'message-id']
       def id
         @headers[:'message-id']
       end
@@ -24,20 +19,29 @@ module Stomper
       # Returns the destination from which this message was delivered.
       #
       # This is a convenience method for:
-      # frame.headers.destination, frame.headers['destination'], or
       # frame.headers[:destination]
       def destination
-        @headers.destination
+        @headers[:destination]
       end
 
       # Returns the name of the subscription which is responsible for the
       # client having received this message.
       #
       # This is a convenience method for:
-      # frame.headers.subscription, frame.headers['subscription'] or
       # frame.headers[:subscription]
       def subscription
-        @headers.subscription
+        @headers[:subscription]
+      end
+
+      def perform
+        # TODO: I want the frames, particularly the server frames, to know
+        # 'what to do' when they are received.  For instance, when a MESSAGE
+        # frame is received, the message should be applied to all
+        # stored subscriptions on the receiving connection.  This will
+        # remove the conditional branching in the Client class, and provide
+        # a more flexible means of adding additional behaviors, instead of
+        # relying on what is sure to become a giant case statement in Client
+        # if we must change state on other Frames later.
       end
     end
   end