websocket_parser 0.0.6 → 0.1.0

data/README.md

@@ -21,10 +21,10 @@ Or install it yourself as:
 
 ## Usage. TMTOWTDI.
 
-### Use return values
+### 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.
+it with data and query it for new messages.
 
 ```ruby
 require 'websocket_parser'
@@ -33,13 +33,17 @@ parser = WebSocket::Parser.new
 
 parser.append data
 
-parser.parse # return next message or nil
-parser.parse_all # return all parsed messages
+parser.next_message  # return next message or nil
+parser.next_messages # return an array with all parsed messages
+
+# To send a message:
+
+socket << WebSocket::Message.new('Hi there!').to_data
 
 ```
 
-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.
+Only text or binary messages are returned on the parse methods. To intercept
+control frames use the parser's callbacks.
 
 ### Use callbacks
 
@@ -78,10 +82,6 @@ end
 
 parser << socket.read(4096)
 
-# To send a message:
-
-socket << WebSocket::Message.new('Hi there!').to_data
-
 ```
 
 ## Status

data/lib/websocket/client_handshake.rb

@@ -13,11 +13,6 @@ module WebSocket
     end
 
     def valid?
-      if headers['Connection'].downcase != 'upgrade'
-        errors << 'Not connection upgrade'
-        return false
-      end
-
       if headers['Upgrade'].downcase != 'websocket'
         errors << 'Connection upgrade is not for websocket'
         return false

data/lib/websocket/parser.rb

@@ -81,6 +81,13 @@ module WebSocket
       read_payload        if @state == :payload
 
       @state == :complete ? process_frame! : nil
+
+    rescue StandardError => ex
+      if @on_error
+        @on_error.call(ex.message)
+      else
+        raise ex
+      end
     end
 
     private
@@ -106,9 +113,13 @@ module WebSocket
 
     def read_extended_payload_length
       if message_size == :medium && @data.size >= 2
-        unpack_bytes(2,'S<')
+        size = unpack_bytes(2,'S<')
+        ParserError.new("Wrong payload length. Expected to be greater than 125") unless size > 125
+        size
       elsif message_size == :large && @data.size >= 4
-        unpack_bytes(8,'Q<')
+        size = unpack_bytes(8,'Q<')
+         ParserError.new("Wrong payload length. Expected to be greater than 65535") unless size > 65_535
+        size
       end
     end
 
@@ -137,6 +148,10 @@ module WebSocket
       @data.slice!(0,num).unpack(format).first
     end
 
+    def message_frame?
+      [:text, :binary].include?(opcode)
+    end
+
     def control_frame?
       [:close, :ping, :pong].include?(opcode)
     end
@@ -148,9 +163,13 @@ module WebSocket
         @current_message = @payload
       end
 
-      completed_message = fin? ? @current_message :nil
+      completed_message = if fin? && message_frame?
+        @current_message
+      else
+        nil
+      end
 
-      process_message! if fin?
+      fin? ? process_message! : opcode # store the opcode
 
       reset_frame!
 
@@ -160,7 +179,10 @@ module WebSocket
     def process_message!
       case opcode
       when :text
-        @on_message.call(@current_message.force_encoding("UTF-8")) if @on_message
+        msg = @current_message.force_encoding("UTF-8")
+        raise ParserError.new('Payload data is not valid UTF-8') unless msg.valid_encoding?
+
+        @on_message.call(msg) if @on_message
       when :binary
         @on_message.call(@current_message) if @on_message
       when :ping
@@ -173,6 +195,9 @@ module WebSocket
 
         @on_close.call(status, message) if @on_close
       end
+
+      # Reset message
+      @opcode = nil
       @current_message = nil
     end
 
@@ -183,7 +208,12 @@ module WebSocket
     end
 
     def opcode
-      @opcode ||= OPCODES[@first_byte & 0b00001111]
+      @opcode ||= begin
+        num = @first_byte & 0b00001111
+        opcode = OPCODES[num]
+        raise ParserError.new("Unknown opcode #{num}") unless opcode
+        opcode
+      end
     end
 
     def masked?

data/lib/websocket/version.rb

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

data/lib/websocket_parser.rb

@@ -9,6 +9,8 @@ require "websocket/parser"
 module WebSocket
   extend self
 
+  class WebSocket::ParserError < StandardError; end
+
   PROTOCOL_VERSION = 13 # RFC 6455
   GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
   CRLF = "\r\n"

data/spec/websocket/parser_spec.rb

@@ -39,6 +39,13 @@ describe WebSocket::Parser do
     messages[1].should == 'Made glorious summer by this sun of York'
   end
 
+  it "does not return control frames" do
+    msg = WebSocket::Message.close(1001, 'Goodbye!').to_data
+
+    messages = parser << msg
+    messages.should be_empty
+  end
+
   it "can receive a message in parts" do
     data = WebSocket::Message.new('Once upon a time').to_data
     parser << data.slice!(0, 5)
@@ -85,26 +92,6 @@ describe WebSocket::Parser do
     received_messages.first.should == text
   end
 
-  it "can receive multiframe messages" do
-    frame1 = WebSocket::Message.new("It is a truth universally acknowledged,", :continuation)
-    frame2 = WebSocket::Message.new("that a single man in possession of a good fortune,", :continuation)
-    frame3 = WebSocket::Message.new("must be in want of a wife.")
-
-    parser << frame1.to_data
-
-    received_messages.should be_empty
-
-    parser << frame2.to_data
-
-    received_messages.should be_empty
-
-    parser << frame3.to_data
-
-    received_messages.first.should == "It is a truth universally acknowledged," +
-    "that a single man in possession of a good fortune," +
-    "must be in want of a wife."
-  end
-
   it "recognizes a ping message" do
     parser << WebSocket::Message.ping.to_data
 
@@ -141,4 +128,58 @@ describe WebSocket::Parser do
 
     received_messages.first.should == 'Once upon a time'
   end
+
+  context "examples from the spec" do
+    # These are literal examples from the spec
+
+    it "recognizes single-frame unmasked text message" do
+      parser << [0x81, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f].pack('C*')
+
+      received_messages.first.should == 'Hello'
+    end
+
+    it "recognizes single-frame masked text message" do
+      parser << [0x81, 0x85, 0x37, 0xfa, 0x21, 0x3d, 0x7f, 0x9f, 0x4d, 0x51, 0x58].pack('C*')
+
+      received_messages.first.should == 'Hello'
+    end
+
+    it "recognizes a fragmented unmasked text message" do
+      parser << [0x01, 0x03, 0x48, 0x65, 0x6c].pack('C*') # contains "Hel"
+
+      received_messages.should be_empty
+
+      parser << [0x80, 0x02, 0x6c, 0x6f].pack('C*') # contains "lo"
+
+      received_messages.first.should == 'Hello'
+    end
+
+    it "recognizes an unnmasked ping request" do
+      parser << [0x89, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f].pack('C*')
+
+      received_pings.size.should == 1
+    end
+
+    it "recognizes a masked pong response" do
+      parser << [0x8a, 0x85, 0x37, 0xfa, 0x21, 0x3d, 0x7f, 0x9f, 0x4d, 0x51, 0x58].pack('C*')
+
+      received_pongs.size.should == 1
+    end
+
+    it "recognizes 256 bytes binary message in a single unmasked frame" do
+      data = Array.new(256) { rand(256) }.pack('c*')
+      parser << [0x82, 0x7E, 0x0100].pack('CCS<') + data
+
+      received_messages.first.should == data
+    end
+
+    it "recoginzes 64KiB binary message in a single unmasked frame" do
+      data = Array.new(65536) { rand(256) }.pack('c*')
+      parser << [0x82, 0x7F, 0x0000000000010000].pack('CCQ<') + data
+
+      received_messages.first.should == data
+    end
+  end
+
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: websocket_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-09 00:00:00.000000000 Z
+date: 2012-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -97,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2454613231888263104
+      hash: -2916391695898748825
 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: 2454613231888263104
+      hash: -2916391695898748825
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23