faye-websocket 0.1.0

data/spec/faye/websocket/client_spec.rb

@@ -0,0 +1,146 @@
+# encoding=utf-8
+
+require "spec_helper"
+
+WebSocketSteps = EM::RSpec.async_steps do
+  def server(port, secure, &callback)
+    @server = EchoServer.new
+    @server.listen(port, secure)
+    @port = port
+    EM.add_timer(0.1, &callback)
+  end
+  
+  def stop(&callback)
+    @server.stop
+    EM.next_tick(&callback)
+  end
+  
+  def open_socket(url, &callback)
+    done = false
+    
+    resume = lambda do |open|
+      unless done
+        done = true
+        @open = open
+        callback.call
+      end
+    end
+    
+    @ws = Faye::WebSocket::Client.new(url)
+    
+    @ws.onopen  = lambda { |e| resume.call(true) }
+    @ws.onclose = lambda { |e| resume.call(false) }
+  end
+  
+  def close_socket(&callback)
+    @ws.onclose = lambda do |e|
+      @open = false
+      callback.call
+    end
+    @ws.close
+  end
+  
+  def check_open(&callback)
+    @open.should == true
+    callback.call
+  end
+  
+  def check_closed(&callback)
+    @open.should == false
+    callback.call
+  end
+  
+  def listen_for_message(&callback)
+    @ws.onmessage = lambda { |e| @message = e.data }
+    callback.call
+  end
+  
+  def send_message(&callback)
+    @ws.send("I expect this to be echoed")
+    EM.add_timer(0.1, &callback)
+  end
+  
+  def check_response(&callback)
+    @message.should == "I expect this to be echoed"
+    callback.call
+  end
+  
+  def check_no_response(&callback)
+    @message.should == nil
+    callback.call
+  end
+end
+
+describe Faye::WebSocket::Client do
+  include WebSocketSteps
+  
+  let(:plain_text_url) { "ws://0.0.0.0:8000/"  }
+  let(:secure_url)     { "wss://0.0.0.0:8000/" }
+  
+  before do
+    Thread.new { EM.run }
+    sleep(0.1) until EM.reactor_running?
+  end
+  
+  shared_examples_for "socket client" do
+    it "can open a connection" do
+      open_socket(socket_url)
+      check_open
+    end
+    
+    it "cannot open a connection to the wrong host" do
+      open_socket(blocked_url)
+      check_closed
+    end
+    
+    it "can close the connection" do
+      open_socket(socket_url)
+      close_socket
+      check_closed
+    end
+    
+    describe "in the OPEN state" do
+      before { open_socket(socket_url) }
+      
+      it "can send and receive messages" do
+        listen_for_message
+        send_message
+        check_response
+      end
+    end
+    
+    describe "in the CLOSED state" do
+      before do
+        open_socket(socket_url)
+        close_socket
+      end
+      
+      it "cannot send and receive messages" do
+        listen_for_message
+        send_message
+        check_no_response
+      end
+    end
+  end
+  
+  describe "with a plain-text server" do
+    let(:socket_url)  { plain_text_url }
+    let(:blocked_url) { secure_url }
+    
+    before { server 8000, false }
+    after  { sync ; stop }
+    
+    it_should_behave_like "socket client"
+  end
+  
+  describe "with a secure server" do
+    let(:socket_url)  { secure_url }
+    let(:blocked_url) { plain_text_url }
+    
+    before { server 8000, true }
+    after  { sync ; stop }
+    
+    it_should_behave_like "socket client"
+  end
+end
+

data/spec/faye/websocket/draft75_parser_spec.rb

@@ -0,0 +1,41 @@
+# encoding=utf-8
+
+require "spec_helper"
+
+describe Faye::WebSocket::Draft75Parser do
+  include EncodingHelper
+  
+  before do
+    @web_socket = mock Faye::WebSocket
+    @parser = Faye::WebSocket::Draft75Parser.new(@web_socket)
+  end
+  
+  describe :parse do
+    it "parses text frames" do
+      @web_socket.should_receive(:receive).with("Hello")
+      parse [0x00, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0xff]
+    end
+    
+    it "parses multibyte text frames" do
+      @web_socket.should_receive(:receive).with(encode "Apple = ")
+      parse [0x00, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf, 0xff]
+    end
+    
+    it "parses fragmented frames" do
+      @web_socket.should_receive(:receive).with("Hello")
+      parse [0x00, 0x48, 0x65, 0x6c]
+      parse [0x6c, 0x6f, 0xff]
+    end
+  end
+  
+  describe :frame do
+    it "returns the given string formatted as a WebSocket frame" do
+      bytes(@parser.frame "Hello").should == [0x00, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0xff]
+    end
+    
+    it "encodes multibyte characters correctly" do
+      message = encode "Apple = "
+      bytes(@parser.frame message).should == [0x00, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf, 0xff]
+    end
+  end
+end

data/spec/faye/websocket/protocol8_parser_spec.rb

@@ -0,0 +1,145 @@
+# encoding=utf-8
+
+require "spec_helper"
+
+describe Faye::WebSocket::Protocol8Parser do
+  include EncodingHelper
+  
+  before do
+    @web_socket = mock Faye::WebSocket
+    @parser = Faye::WebSocket::Protocol8Parser.new(@web_socket)
+  end
+  
+  describe :parse do
+    let(:mask) { (1..4).map { rand 255 } }
+    
+    def mask_message(*bytes)
+      output = []
+      bytes.each_with_index do |byte, i|
+        output[i] = byte ^ mask[i % 4]
+      end
+      output
+    end
+    
+    it "parses unmasked text frames" do
+      @web_socket.should_receive(:receive).with("Hello")
+      parse [0x81, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f]
+    end
+    
+    it "parses empty text frames" do
+      @web_socket.should_receive(:receive).with("")
+      parse [0x81, 0x00]
+    end
+    
+    it "parses fragmented text frames" do
+      @web_socket.should_receive(:receive).with("Hello")
+      parse [0x01, 0x03, 0x48, 0x65, 0x6c]
+      parse [0x80, 0x02, 0x6c, 0x6f]
+    end
+    
+    it "parses masked text frames" do
+      @web_socket.should_receive(:receive).with("Hello")
+      parse [0x81, 0x85] + mask + mask_message(0x48, 0x65, 0x6c, 0x6c, 0x6f)
+    end
+    
+    it "parses masked empty text frames" do
+      @web_socket.should_receive(:receive).with("")
+      parse [0x81, 0x80] + mask + mask_message()
+    end
+    
+    it "parses masked fragmented text frames" do
+      @web_socket.should_receive(:receive).with("Hello")
+      parse [0x01, 0x81] + mask + mask_message(0x48)
+      parse [0x80, 0x84] + mask + mask_message(0x65, 0x6c, 0x6c, 0x6f)
+    end
+    
+    it "closes the socket if the frame has an unrecognized opcode" do
+      @web_socket.should_receive(:close).with(1002, nil, false)
+      parse [0x83, 0x00]
+    end
+    
+    it "closes the socket if a close frame is received" do
+      @web_socket.should_receive(:close).with(1000, "Hello", false)
+      parse [0x88, 0x07, 0x03, 0xe8, 0x48, 0x65, 0x6c, 0x6c, 0x6f]
+    end
+    
+    it "parses unmasked multibyte text frames" do
+      @web_socket.should_receive(:receive).with(encode "Apple = ")
+      parse [0x81, 0x0b, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf]
+    end
+    
+    it "parses fragmented multibyte text frames" do
+      @web_socket.should_receive(:receive).with(encode "Apple = ")
+      parse [0x01, 0x0a, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3]
+      parse [0x80, 0x01, 0xbf]
+    end
+    
+    it "parses masked multibyte text frames" do
+      @web_socket.should_receive(:receive).with(encode "Apple = ")
+      parse [0x81, 0x8b] + mask + mask_message(0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf)
+    end
+    
+    it "parses masked fragmented multibyte text frames" do
+      @web_socket.should_receive(:receive).with(encode "Apple = ")
+      parse [0x01, 0x8a] + mask + mask_message(0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3)
+      parse [0x80, 0x81] + mask + mask_message(0xbf)
+    end
+    
+    it "parses unmasked medium-length text frames" do
+      @web_socket.should_receive(:receive).with("Hello" * 40)
+      parse [0x81, 0x7e, 0x00, 0xc8] + [0x48, 0x65, 0x6c, 0x6c, 0x6f] * 40
+    end
+    
+    it "parses masked medium-length text frames" do
+      @web_socket.should_receive(:receive).with("Hello" * 40)
+      parse [0x81, 0xfe, 0x00, 0xc8] + mask + mask_message(*([0x48, 0x65, 0x6c, 0x6c, 0x6f] * 40))
+    end
+    
+    it "replies to pings with a pong" do
+      @web_socket.should_receive(:send).with([0x4f, 0x48, 0x41, 0x49], :pong)
+      parse [0x89, 0x04, 0x4f, 0x48, 0x41, 0x49]
+    end
+  end
+  
+  describe :frame do
+    it "returns the given string formatted as a WebSocket frame" do
+      bytes(@parser.frame "Hello").should == [0x81, 0x05, 0x48, 0x65, 0x6c, 0x6c, 0x6f]
+    end
+    
+    it "encodes multibyte characters correctly" do
+      message = encode "Apple = "
+      bytes(@parser.frame message).should == [0x81, 0x0b, 0x41, 0x70, 0x70, 0x6c, 0x65, 0x20, 0x3d, 0x20, 0xef, 0xa3, 0xbf]
+    end
+    
+    it "encodes medium-length strings using extra length bytes" do
+      message = "Hello" * 40
+      bytes(@parser.frame message).should == [0x81, 0x7e, 0x00, 0xc8] + [0x48, 0x65, 0x6c, 0x6c, 0x6f] * 40
+    end
+    
+    it "encodes long strings using extra length bytes" do
+      message = "Hello" * 13108
+      bytes(@parser.frame message).should == [0x81, 0x7f] +
+                                             [0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x04] +
+                                             [0x48, 0x65, 0x6c, 0x6c, 0x6f] * 13108
+    end
+    
+    it "encodes close frames with an error code" do
+      frame = @parser.frame "Hello", :close, 1002
+      bytes(frame).should == [0x88, 0x07, 0x03, 0xea, 0x48, 0x65, 0x6c, 0x6c, 0x6f]
+    end
+    
+    it "encodes pong frames" do
+      bytes(@parser.frame '', :pong).should == [0x8a, 0x00]
+    end
+  end
+  
+  describe :utf8 do
+    it "detects valid UTF-8" do
+      Faye::WebSocket.valid_utf8?( [72, 101, 108, 108, 111, 45, 194, 181, 64, 195, 159, 195, 182, 195, 164, 195, 188, 195, 160, 195, 161, 45, 85, 84, 70, 45, 56, 33, 33] ).should be_true
+    end
+    
+    it "detects invalid UTF-8" do
+      Faye::WebSocket.valid_utf8?( [206, 186, 225, 189, 185, 207, 131, 206, 188, 206, 181, 237, 160, 128, 101, 100, 105, 116, 101, 100] ).should be_false
+    end
+  end
+end

data/spec/server.crt

@@ -0,0 +1,15 @@
+-----BEGIN CERTIFICATE-----
+MIICZTCCAc4CCQDxyrJZrFA0vjANBgkqhkiG9w0BAQUFADB3MQswCQYDVQQGEwJV
+SzEPMA0GA1UECBMGTG9uZG9uMQ8wDQYDVQQHEwZMb25kb24xDTALBgNVBAoTBEZh
+eWUxFTATBgNVBAMTDEphbWVzIENvZ2xhbjEgMB4GCSqGSIb3DQEJARYRamNvZ2xh
+bkBnbWFpbC5jb20wHhcNMTEwODMwMTIzOTM2WhcNMTIwODI5MTIzOTM2WjB3MQsw
+CQYDVQQGEwJVSzEPMA0GA1UECBMGTG9uZG9uMQ8wDQYDVQQHEwZMb25kb24xDTAL
+BgNVBAoTBEZheWUxFTATBgNVBAMTDEphbWVzIENvZ2xhbjEgMB4GCSqGSIb3DQEJ
+ARYRamNvZ2xhbkBnbWFpbC5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGB
+AMDjU5fAK7fvUCZIYHcGXDZD/m9bY+B/UcwGcowk0hMQGYNlLKrpiK7xXBmZpDb6
+r8n+7L/epBeSumbRIm4TDzeNHhuQGYLIeGQy7JNLoPBr6GxubjuJhKOOBnCqcupR
+CLGG7Zw5oL4UvtZVH6kL9XnjyokQQbxxeoV9DqtqOaHHAgMBAAEwDQYJKoZIhvcN
+AQEFBQADgYEAvQjSpzE1ahaeH1CmbLwckTxvWMZfxcZOrxTruK1po3cNnDOjGqFQ
+KEkNj3K5WfwTBD4QgUdYDykhDX2m6HaMz4JEbgrwQv8M8FiswIA3dyGsbOifOk8H
+r3GPNKMzm4o6vrn6RGOpt9q6bsWUBUHfNpP93uU2C9QEwDua3cFjDA0=
+-----END CERTIFICATE-----

data/spec/server.key

@@ -0,0 +1,15 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIICXAIBAAKBgQDA41OXwCu371AmSGB3Blw2Q/5vW2Pgf1HMBnKMJNITEBmDZSyq
+6Yiu8VwZmaQ2+q/J/uy/3qQXkrpm0SJuEw83jR4bkBmCyHhkMuyTS6Dwa+hsbm47
+iYSjjgZwqnLqUQixhu2cOaC+FL7WVR+pC/V548qJEEG8cXqFfQ6rajmhxwIDAQAB
+AoGABlk1DiCQD8y7mZb2PdSiwlJ4lFewsNnf6lQn/v7TPzdfb5ir4LAxBHkDLACH
+jBuyH3bZefMs+W2l3u5xMKhF7uJqYcUlJdH2UwRfNG54Hn4SGAjQOK3ONer99sUf
+USlsWSX1HjAAFMCBwUfKxMZA3VNQfYKTPdm0jSVf85kHO1ECQQD3s6ksm3QpfD0L
+eG9EoDrqmwnEfpKoWPpz1O0i5tY9VcmhmLwS5Zpd7lB1qjTqzZk4RygU73T/BseJ
+azehIHK5AkEAx1mSXt+ec8RfzVi/io6oqi2vOcACXRbOG4NQmqUWPnumdwsJjsjR
+RzEoDFC2lu6448p9sgEq+CkbmgVeiyp4fwJAQnmgySve/NMuvslPcyddKGD7OhSN
+30ghzrwx98/jZwqC1i9bKeccimDOjwVitjD/Ea9m/ldVGqwDGMoBX+iJYQJAEIOO
+CYfyw1pQKV2huGOq+zX/nwQV7go2lrbhFX55gkGR/6iNaSOfmosq6yJAje5GqLAc
+i4NnQNl+7NpnA5ZIFwJBAI1+OsZyjbRI99pYkTdOpa5IPlIb3j3JbSfjAWHLxlRY
+0HLvN3Q1mE9kbB+uKH6syF/S7nALgsLgq7eHYvIaE/A=
+-----END RSA PRIVATE KEY-----

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler/setup'
+require File.expand_path('../../lib/faye/websocket', __FILE__)
+require File.expand_path('../../vendor/em-rspec/lib/em-rspec', __FILE__)
+
+Thin::Logging.silent = true
+
+module EncodingHelper
+  def encode(message)
+    message.respond_to?(:force_encoding) ?
+        message.force_encoding("UTF-8") :
+        message
+  end
+  
+  def bytes(string)
+    string.bytes.to_a
+  end
+  
+  def parse(bytes)
+    @parser.parse(bytes.pack('C*'))
+  end
+end
+
+class EchoServer
+  def call(env)
+    socket = Faye::WebSocket.new(env)
+    socket.onmessage = lambda do |event|
+      socket.send(event.data)
+    end
+    [-1, {}, []]
+  end
+  
+  def listen(port, ssl = false)
+    Rack::Handler.get('thin').run(self, :Port => port) do |s|
+      if ssl
+        s.ssl = true
+        s.ssl_options = {
+          :private_key_file => File.expand_path('../server.key', __FILE__),
+          :cert_chain_file  => File.expand_path('../server.crt', __FILE__)
+        }
+      end
+      @server = s
+    end
+  end
+  
+  def stop
+    @server.stop
+  end
+end
+

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: faye-websocket
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- James Coglan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &2152439260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152439260
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: &2152438100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152438100
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152437380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152437380
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &2152436360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152436360
+description: 
+email: jcoglan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- examples/autobahn_client.rb
+- examples/client.rb
+- examples/index.html
+- examples/server.rb
+- lib/faye/thin_extensions.rb
+- lib/faye/websocket/api.rb
+- lib/faye/websocket/client.rb
+- lib/faye/websocket/draft75_parser.rb
+- lib/faye/websocket/draft76_parser.rb
+- lib/faye/websocket/protocol8_parser.rb
+- lib/faye/websocket.rb
+- spec/faye/websocket/client_spec.rb
+- spec/faye/websocket/draft75_parser_spec.rb
+- spec/faye/websocket/protocol8_parser_spec.rb
+- spec/server.crt
+- spec/server.key
+- spec/spec_helper.rb
+homepage: http://github.com/jcoglan/faye-websocket-ruby
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Robust general-purpose WebSocket server and client
+test_files: []