websocket_parser 0.0.5 → 0.0.6

data/README.md

@@ -19,7 +19,32 @@ Or install it yourself as:
 
     $ gem install websocket_parser
 
-## Usage
+## Usage. TMTOWTDI.
+
+### Use return values
+
+The simplest way to use the websocket parser is to create a new one, fetch
+it with data and call the parse methods.
+
+```ruby
+require 'websocket_parser'
+
+parser = WebSocket::Parser.new
+
+parser.append data
+
+parser.parse # return next message or nil
+parser.parse_all # return all parsed messages
+
+```
+
+The returned messages are instances of WebSocket::Message and can be either text messages
+or control frames. Check WebSocket::Message#type to know the kind of a message.
+
+### Use callbacks
+
+In addition to return values, you can register callbacks to get notified when a certain event
+happens.
 
 ```ruby
 require 'websocket_parser'

data/lib/websocket/client_handshake.rb

@@ -33,6 +33,10 @@ module WebSocket
       return true
     end
 
+    def accept_response
+      ServerHandshake.new(response_headers)
+    end
+
     def response_headers
       websocket_key = headers['Sec-Websocket-Key']
       {
@@ -42,8 +46,13 @@ module WebSocket
       }
     end
 
-    def accept_response
-      ServerHandshake.new(response_headers)
+    def to_data
+      data = "#{method.to_s.upcase} #{uri.path} HTTP/#{version}#{CRLF}"
+      @headers.each do |field, value|
+        data << "#{field}: #{value}#{CRLF}"
+      end
+      data << CRLF
+      data
     end
   end
 end

data/lib/websocket/parser.rb

@@ -25,6 +25,8 @@ module WebSocket
   # for more info on the frame format see: http://tools.ietf.org/html/rfc6455#section-5
   #
   class Parser
+    attr_writer :on_message, :on_error, :on_close, :on_ping, :on_pong
+
     def initialize
       @data =  ''.force_encoding("ASCII-8BIT")
       @state = :header
@@ -50,19 +52,37 @@ module WebSocket
       @on_pong = callback
     end
 
-    def receive(data)
+    # Stores the data in a buffer for later parsing
+    def append(data)
       @data << data
+    end
 
+    # Receive data and parse it return an array of parsed messages
+    def receive(data)
+      append(data) && next_messages
+    end
+
+    alias_method :<<, :receive
+
+    # Parse all messages in buffer
+    def next_messages
+      Array.new.tap do |messages|
+        while msg = next_message do
+           messages << msg
+         end
+      end
+    end
+
+    # Parse next message in buffer
+    def next_message
       read_header         if @state == :header
       read_payload_length if @state == :payload_length
       read_mask_key       if @state == :mask
       read_payload        if @state == :payload
 
-      process_frame if @state == :complete
+      @state == :complete ? process_frame! : nil
     end
 
-    alias_method :<<, :receive
-
     private
 
     def read_header
@@ -74,7 +94,7 @@ module WebSocket
 
     def read_payload_length
       @payload_length = if message_size == :small
-         payload_length_field
+        payload_length_field
       else
         read_extended_payload_length
       end
@@ -86,7 +106,7 @@ module WebSocket
 
     def read_extended_payload_length
       if message_size == :medium && @data.size >= 2
-         unpack_bytes(2,'S<')
+        unpack_bytes(2,'S<')
       elsif message_size == :large && @data.size >= 4
         unpack_bytes(8,'Q<')
       end
@@ -121,21 +141,23 @@ module WebSocket
       [:close, :ping, :pong].include?(opcode)
     end
 
-    def process_frame
+    def process_frame!
       if @current_message
         @current_message << @payload
       else
         @current_message = @payload
       end
 
-      if fin?
-        process_message
-      end
+      completed_message = fin? ? @current_message :nil
+
+      process_message! if fin?
 
       reset_frame!
+
+      completed_message
     end
 
-    def process_message
+    def process_message!
       case opcode
       when :text
         @on_message.call(@current_message.force_encoding("UTF-8")) if @on_message
@@ -151,7 +173,6 @@ module WebSocket
 
         @on_close.call(status, message) if @on_close
       end
-
       @current_message = nil
     end
 

data/lib/websocket/server_handshake.rb

@@ -1,7 +1,5 @@
 module WebSocket
   class ServerHandshake < Http::Response
-    CRLF = "\r\n"
-
     def initialize(headers = {})
       @headers = headers
     end
@@ -20,6 +18,7 @@ module WebSocket
       end
 
       data << CRLF
+      data
     end
   end
 end

data/lib/websocket/version.rb

@@ -1,3 +1,3 @@
 module WebSocket
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/websocket_parser.rb

@@ -11,6 +11,7 @@ module WebSocket
 
   PROTOCOL_VERSION = 13 # RFC 6455
   GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
+  CRLF = "\r\n"
 
   # see http://tools.ietf.org/html/rfc6455#section-11.8
   OPCODES = {

data/spec/websocket/parser_spec.rb

@@ -26,6 +26,19 @@ describe WebSocket::Parser do
     received_messages.first.should == 'Once upon a time'
   end
 
+  it "returns parsed messages on parse" do
+    msg1 = WebSocket::Message.new('Now is the winter of our discontent').to_data
+    msg2 = WebSocket::Message.new('Made glorious summer by this sun of York').to_data
+
+    messages = parser << msg1.slice!(0,5)
+    messages.should be_empty # We don't have a complete message yet
+
+    messages = parser << msg1 + msg2
+
+    messages[0].should == 'Now is the winter of our discontent'
+    messages[1].should == 'Made glorious summer by this sun of York'
+  end
+
   it "can receive a message in parts" do
     data = WebSocket::Message.new('Once upon a time').to_data
     parser << data.slice!(0, 5)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -97,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1607326669801376036
+      hash: 2454613231888263104
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1607326669801376036
+      hash: 2454613231888263104
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23