websocket_parser 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8924e6562d9e92cf020064ec8856a1a0a24fa0f0
-  data.tar.gz: 4135ca151a1284fb741a6aa4cf6b0344608e07bc
+  metadata.gz: e45c5d450a8c75baa97f7c1019935ece33763c44
+  data.tar.gz: 1842fd255487115f5d66a135a073bcac3e8e3350
 SHA512:
-  metadata.gz: 3e63785361ded5ab54c8a127998a810529c6950eb2519b42318895c2e3abbb2d9a447accecbed2065f275fe6503eded4599c7053b4a8d99dedc79860cd06eb69
-  data.tar.gz: 23f4cefa767337afd3710fc30da0298486cf9fe50e10b791d4522828366b59f3925615e146733efac98cd1397e8bcc271c8bc8e529be6da96361361edb634a10
+  metadata.gz: 8e543dd1f7299e1e3b08d95085597b523bc46adf09824254b93db9042e3970d5c2600184435457fa059e2b6b0f4675971a6539a348a8aefac84149505cb93c2e
+  data.tar.gz: 4ec4c8e0e8c877009c6b29013e0ea9ff7745add5ba23ab75f3bda51c20d892e4dcc67733edd504ea8b8c287a2eeff5747ee45055131e0b5b680fdbb5ce9ff970

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 1.9.2
   - 1.9.3
   - jruby-19mode # JRuby in 1.9 mode
-  - rbx-19mode
+  - rbx
   - 2.0.0
+  - 2.1.0
 script: bundle exec rspec spec

data/Gemfile

@@ -2,5 +2,11 @@ source 'https://rubygems.org'
 
 gem 'jruby-openssl' if defined? JRUBY_VERSION
 
+platforms :rbx do
+  gem 'racc'
+  gem 'rubysl', '~> 2.0'
+  gem 'psych'
+end
+
 # Specify your gem's dependencies in websocket_parser.gemspec
 gemspec

data/README.md

@@ -73,11 +73,11 @@ parser.on_close do |status, message|
   socket << WebSocket::Message.close.to_data
   socket.close!
 
-  puts "Client closed connection. Status: #{status}. Reason: #{m}"
+  puts "Client closed connection. Status: #{status}. Reason: #{message}"
 end
 
-parser.on_ping do
-  socket << WebSocket::Message.pong.to_data
+parser.on_ping do |payload|
+  socket << WebSocket::Message.pong(payload).to_data
 end
 
 parser << socket.read(4096)

data/lib/websocket/parser.rb

@@ -30,6 +30,7 @@ module WebSocket
     def initialize
       @data =  ''.force_encoding("ASCII-8BIT")
       @state = :header
+      @current_message = nil
     end
 
     def on_message(&callback)
@@ -69,8 +70,8 @@ module WebSocket
     def next_messages
       Array.new.tap do |messages|
         while msg = next_message do
-           messages << msg
-         end
+          messages << msg
+        end
       end
     end
 
@@ -114,12 +115,12 @@ module WebSocket
 
     def read_extended_payload_length
       if message_size == :medium && @data.size >= 2
-        size = unpack_bytes(2,'S>')
+        size = unpack_bytes(2,'n')
         ParserError.new("Wrong payload length. Expected to be greater than 125") unless size > 125
         size
       elsif message_size == :large && @data.size >= 4
         size = unpack_bytes(8,'Q>')
-         ParserError.new("Wrong payload length. Expected to be greater than 65535") unless size > 65_535
+        ParserError.new("Wrong payload length. Expected to be greater than 65535") unless size > 65_535
         size
       end
     end
@@ -251,4 +252,4 @@ module WebSocket
       @payload        = nil
     end
   end
-end
+end

data/lib/websocket/version.rb

@@ -1,3 +1,3 @@
 module WebSocket
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/websocket_parser.rb

@@ -55,7 +55,7 @@ module WebSocket
     if payload_length > 65_535
       format += 'Q>'
     elsif payload_length > 125
-      format += 'S>'
+      format += 'n'
     end
 
     if masked

data/spec/spec_helper.rb

@@ -1,3 +1,7 @@
 require 'bundler/setup'
 require 'http'
-require 'websocket_parser'
+require 'websocket_parser'
+
+RSpec.configure do |config|
+  config.warnings = true
+end

data/spec/websocket/handshake_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe WebSocket::ClientHandshake do
-
   let :handshake_headers do
     {
       "Host"                   => "server.example.com",
@@ -23,8 +22,8 @@ describe WebSocket::ClientHandshake do
   it "can generate an accept response for the client" do
     response = client_handshake.accept_response
 
-    response.headers['Upgrade'].should == 'websocket'
-    response.headers['Connection'].should == 'Upgrade'
-    response.headers['Sec-WebSocket-Accept'].should == 's3pPLMBiTxaQ9kYGzzhZRbK+xOo='
+    response.headers['Upgrade'].should eq('websocket')
+    response.headers['Connection'].should eq('Upgrade')
+    response.headers['Sec-WebSocket-Accept'].should eq('s3pPLMBiTxaQ9kYGzzhZRbK+xOo=')
   end
-end
+end

data/spec/websocket/message_spec.rb

@@ -1,21 +1,51 @@
 require 'spec_helper'
 
 describe WebSocket::Message do
-
-  it "knows its binary representation" do
+  it "knows binary representation of messages with more than 65,535 bytes" do
     text = 1500.times.collect { 'All work and no play makes Jack a dull boy.' }.join("\n\n")
     message = WebSocket::Message.new(text)
     data = message.to_data
 
     # 2 bytes from header + 8 bytes from extended payload length + payload
-    data.size.should == 2 + 8 + text.length
+    data.size.should eq(2 + 8 + text.length)
 
     first_byte, second_byte, ext_length, payload = data.unpack("CCQ>a#{text.length}")
 
-    first_byte.should  == 0b10000001 # Text frame with FIN bit set
-    second_byte.should == 0b01111111 # Unmasked. Payload length 127.
-    ext_length.should  == text.length
-    payload.should     == text
+    first_byte.should  eq(0b10000001) # Text frame with FIN bit set
+    second_byte.should eq(0b01111111) # Unmasked. Payload length 127.
+    ext_length.should  eq(text.length)
+    payload.should     eq(text)
+  end
+
+  it "knows binary representation of messages between 126 and 65,535 bytes" do
+    text = '0'*127
+    data = WebSocket::Message.new(text).to_data
+
+    # 2 bytes from header + 2 bytes from extended payload length + payload
+    data.size.should eq(2 + 2 + text.length)
+    # extended payload length should respect endianness
+    data[2..3].should eq([0x00, 0x7F].pack('C*'))
+
+    first_byte, second_byte, ext_length, payload = data.unpack("CCna#{text.length}")
+
+    first_byte.should  eq(0b10000001) # Text frame with FIN bit set
+    second_byte.should eq(0b01111110) # Unmasked. Payload length 126.
+    ext_length.should  eq(text.length)
+    payload.should     eq(text)
+  end
+
+  it "knows binary representation of messages with less than 126 bytes" do
+    text = '0'*125
+    data = WebSocket::Message.new(text).to_data
+
+    # 2 bytes from header + payload
+    data.size.should eq(2 + text.length)
+
+    first_byte, second_byte, payload = data.unpack("CCa#{text.length}")
+
+    first_byte.should  eq(0b10000001) # Text frame with FIN bit set
+    second_byte.should eq(0b01111101) # Unmasked. Payload length 125.
+    payload.should     eq(text)
   end
 
   it "can be masked" do
@@ -30,10 +60,10 @@ describe WebSocket::Message do
   it "allows status codes for control frames" do
     msg = WebSocket::Message.close(1001, 'Bye')
 
-    msg.status_code.should == 1001
-    msg.payload.should == [1001, 'Bye'].pack('S<a*')
-    msg.status.should == :peer_going_away
-    msg.status_message.should == 'Bye'
+    msg.status_code.should eq(1001)
+    msg.payload.should eq([1001, 'Bye'].pack('S<a*'))
+    msg.status.should eq(:peer_going_away)
+    msg.status_message.should eq('Bye')
   end
 
   it "does not allow a status message without status code" do
@@ -44,7 +74,7 @@ describe WebSocket::Message do
     ping = WebSocket::Message.ping('Roman Ping Pong')
     pong = WebSocket::Message.pong(ping.payload)
 
-    pong.type.should    == :pong
-    pong.payload.should == 'Roman Ping Pong'
+    pong.type.should    eq(:pong)
+    pong.payload.should eq('Roman Ping Pong')
   end
-end
+end

data/spec/websocket/parser_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe WebSocket::Parser do
-
   let(:received_messages) { [] }
   let(:received_errors)   { [] }
   let(:received_closes)   { [] }
@@ -23,7 +22,7 @@ describe WebSocket::Parser do
   it "recognizes a text message" do
     parser << WebSocket::Message.new('Once upon a time').to_data
 
-    received_messages.first.should == 'Once upon a time'
+    received_messages.first.should eq('Once upon a time')
   end
 
   it "returns parsed messages on parse" do
@@ -35,8 +34,8 @@ describe WebSocket::Parser do
 
     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'
+    messages[0].should eq('Now is the winter of our discontent')
+    messages[1].should eq('Made glorious summer by this sun of York')
   end
 
   it "does not return control frames" do
@@ -54,7 +53,7 @@ describe WebSocket::Parser do
 
     parser << data
 
-    received_messages.first.should == 'Once upon a time'
+    received_messages.first.should eq('Once upon a time')
   end
 
   it "can receive succesive messages" do
@@ -64,52 +63,52 @@ describe WebSocket::Parser do
     parser << msg1.to_data
     parser << msg2.to_data
 
-    received_messages[0].should == 'Now is the winter of our discontent'
-    received_messages[1].should == 'Made glorious summer by this sun of York'
+    received_messages[0].should eq('Now is the winter of our discontent')
+    received_messages[1].should eq('Made glorious summer by this sun of York')
   end
 
   it "can receive medium size messages" do
     # Medium size messages has a payload length between 127 and 65_535 bytes
 
     text = 4.times.collect { 'All work and no play makes Jack a dull boy.' }.join("\n\n")
-    text.length.should > 127
-    text.length.should < 65_536
+    text.length.should be > 127
+    text.length.should be < 65_536
 
     parser << WebSocket::Message.new(text).to_data
-    received_messages.first.should == text
+    received_messages.first.should eq(text)
   end
 
   it "can receive large size messages" do
     # Large size messages has a payload length greater than 65_535 bytes
 
     text = 1500.times.collect { 'All work and no play makes Jack a dull boy.' }.join("\n\n")
-    text.length.should > 65_536
+    text.length.should be > 65_536
 
     parser << WebSocket::Message.new(text).to_data
 
     # Check lengths first to avoid gigantic error message
-    received_messages.first.length.should == text.length
-    received_messages.first.should == text
+    received_messages.first.length.should eq(text.length)
+    received_messages.first.should eq(text)
   end
 
   it "recognizes a ping message" do
     parser << WebSocket::Message.ping.to_data
 
-    received_pings.size.should == 1
+    received_pings.size.should eq(1)
   end
 
   it "recognizes a pong message" do
     parser << WebSocket::Message.pong.to_data
 
-    received_pongs.size.should == 1
+    received_pongs.size.should eq(1)
   end
 
   it "recognizes a close message with status code and message" do
     parser << WebSocket::Message.close(1001, 'Browser leaving page').to_data
 
     status, message = received_closes.first
-    status.should  == :peer_going_away # Status code 1001
-    message.should == 'Browser leaving page'
+    status.should  eq(:peer_going_away) # Status code 1001
+    message.should eq('Browser leaving page')
   end
 
   it "recognizes a close message without status code" do
@@ -126,7 +125,7 @@ describe WebSocket::Parser do
 
     parser << msg.to_data
 
-    received_messages.first.should == 'Once upon a time'
+    received_messages.first.should eq('Once upon a time')
   end
 
   context "examples from the spec" do
@@ -135,13 +134,13 @@ describe WebSocket::Parser do
     it "recognizes single-frame unmasked text message" do
       parser << [0x81, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f].pack('C*')
 
-      received_messages.first.should == 'Hello'
+      received_messages.first.should eq('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'
+      received_messages.first.should eq('Hello')
     end
 
     it "recognizes a fragmented unmasked text message" do
@@ -151,33 +150,33 @@ describe WebSocket::Parser do
 
       parser << [0x80, 0x02, 0x6c, 0x6f].pack('C*') # contains "lo"
 
-      received_messages.first.should == 'Hello'
+      received_messages.first.should eq('Hello')
     end
 
     it "recognizes an unnmasked ping request" do
       parser << [0x89, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f].pack('C*')
 
-      received_pings.size.should == 1
+      received_pings.size.should eq(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
+      received_pongs.size.should eq(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
+      parser << [0x82, 0x7E, 0x0100].pack('CCn') + data
 
-      received_messages.first.should == data
+      received_messages.first.should eq(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
+      received_messages.first.should eq(data)
     end
   end
-end
+end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: websocket_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Alberto Fernandez-Capel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2014-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: WebsocketParser is a RFC6455 compliant parser for websocket messages
@@ -59,8 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -85,17 +85,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Parse websockets messages in Ruby