libwebsocket 0.0.4

data/lib/libwebsocket/stateful.rb

@@ -0,0 +1,24 @@
+module LibWebSocket
+  # Base class for all classes with states
+  module Stateful
+
+    attr_accessor :state
+
+    # Return true if current state match given state
+    def state?(val)
+      @state == val
+    end
+
+    # Change state to 'done'
+    def done
+      @state = 'done'
+      true
+    end
+
+    # Check if current state is done
+    def done?
+      @state == 'done'
+    end
+
+  end
+end

data/lib/libwebsocket/url.rb

@@ -0,0 +1,67 @@
+require 'addressable/uri'
+
+module LibWebSocket
+  # Construct or parse a WebSocket URL.
+  class URL
+
+    attr_accessor :secure, :host, :port, :resource_name
+
+    def initialize(hash = {})
+      hash.each do |k,v|
+        instance_variable_set("@#{k}",v)
+      end
+
+      @secure ||= false
+    end
+
+    # Parse a WebSocket URL.
+    # @example Parse
+    #   url = LibWebSocket::URL.new
+    #   url.parse('wss://example.com:3000')
+    #   url.host   # => example.com
+    #   url.port   # => 3000
+    #   url.secure # => true
+    def parse(string)
+      return nil unless string.is_a?(String)
+
+      uri = Addressable::URI.parse(string)
+
+      scheme = uri.scheme
+      return nil unless scheme
+
+      self.secure = true if scheme.match(/ss\Z/m)
+
+      host = uri.host
+      host = '/' unless host && host != ''
+      self.host = host
+      self.port = uri.port.to_s if uri.port
+
+      path = uri.path
+      path = '/' unless path && path != ''
+      self.resource_name = path
+
+      return self
+    end
+
+    # Construct a WebSocket URL.
+    # @example Construct
+    #   url = LibWebSocket::URL.new
+    #   url.host = 'example.com'
+    #   url.port = '3000'
+    #   url.secure = true
+    #   url.to_s # => 'wss://example.com:3000'
+    def to_s
+      string = ''
+
+      string += 'ws'
+      string += 's' if self.secure
+      string += '://'
+      string += self.host
+      string += ':' + self.port.to_s if self.port
+      string += self.resource_name || '/'
+
+      return string
+    end
+
+  end
+end

data/test/libwebsocket/cookie/request.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class TestCookieRequest < Test::Unit::TestCase
+
+  def test_parse
+    cookie  = LibWebSocket::Cookie::Request.new
+    cookies = cookie.parse('$Version=1; foo=bar; $Path=/; $Domain=.example.com')
+    assert_equal 'foo', cookies[0].name
+    assert_equal 'bar', cookies[0].value
+    assert_equal 1, cookies[0].version
+    assert_equal '/', cookies[0].path
+    assert_equal '.example.com', cookies[0].domain
+
+    cookie  = LibWebSocket::Cookie::Request.new
+    cookies = cookie.parse('$Version=1; foo=bar')
+    assert_equal 'foo', cookies[0].name
+    assert_equal 'bar', cookies[0].value
+    assert_equal 1, cookies[0].version
+    assert_equal nil, cookies[0].path
+    assert_equal nil, cookies[0].domain
+
+    cookie  = LibWebSocket::Cookie::Request.new
+    cookies = cookie.parse('$Version=1; foo="hello\"there"')
+    assert_equal 'foo', cookies[0].name
+    assert_equal 'hello"there', cookies[0].value
+
+    cookie  = LibWebSocket::Cookie::Request.new
+    cookies = cookie.parse('$Version=1; foo="bar"; $Path=/; bar=baz; $Domain=.example.com')
+    assert_equal 'foo', cookies[0].name
+    assert_equal 'bar', cookies[0].value
+    assert_equal '/', cookies[0].path
+    assert_equal 'bar', cookies[1].name
+    assert_equal 'baz', cookies[1].value
+    assert_equal '.example.com', cookies[1].domain
+  end
+
+end

data/test/libwebsocket/cookie/response.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class TestCookieResponse < Test::Unit::TestCase
+
+  def test_to_s
+    cookie = LibWebSocket::Cookie::Response.new(:name => 'foo', :value => 'bar')
+    assert_equal 'foo=bar; Version=1', cookie.to_s
+
+    cookie = LibWebSocket::Cookie::Response.new(
+        :name    => 'foo',
+        :value   => 'bar',
+        :discard => 1,
+        :max_age => 0
+    )
+    assert_equal 'foo=bar; Discard; Max-Age=0; Version=1', cookie.to_s
+
+    cookie = LibWebSocket::Cookie::Response.new(
+        :name     => 'foo',
+        :value    => 'bar',
+        :portlist => 80
+    )
+    assert_equal 'foo=bar; Port="80"; Version=1', cookie.to_s
+
+    cookie = LibWebSocket::Cookie::Response.new(
+        :name     => 'foo',
+        :value    => 'bar',
+        :portlist => [80, 443]
+    )
+    assert_equal 'foo=bar; Port="80 443"; Version=1', cookie.to_s
+  end
+
+end

data/test/libwebsocket/handshake/test_client.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+
+class TestServerHandshake < Test::Unit::TestCase
+
+  def test_to_s
+    h = LibWebSocket::Handshake::Client.new
+    h.url = 'ws://example.com/demo'
+
+    # Mocking
+    h.req.key1 = "18x 6]8vM;54 *(5:  {   U1]8  z [  8"
+    h.req.key2 = "1_ tx7X d  <  nw  334J702) 7]o}` 0"
+    h.req.challenge = "Tm[K T2u"
+
+    assert_equal h.to_s, "GET /demo HTTP/1.1\x0d\x0a" +
+      "Upgrade: WebSocket\x0d\x0a" +
+      "Connection: Upgrade\x0d\x0a" +
+      "Host: example.com\x0d\x0a" +
+      "Origin: http://example.com\x0d\x0a" +
+      "Sec-WebSocket-Key1: 18x 6]8vM;54 *(5:  {   U1]8  z [  8\x0d\x0a" +
+      "Sec-WebSocket-Key2: 1_ tx7X d  <  nw  334J702) 7]o}` 0\x0d\x0a" +
+      "Content-Length: 8\x0d\x0a" +
+      "\x0d\x0aTm[K T2u"
+
+    h = LibWebSocket::Handshake::Client.new(:url => 'ws://example.com')
+
+    # Mocking
+    h.req.key1 = "18x 6]8vM;54 *(5:  {   U1]8  z [  8"
+    h.req.key2 = "1_ tx7X d  <  nw  334J702) 7]o}` 0"
+    h.req.challenge = "Tm[K T2u"
+
+    assert_equal h.to_s, "GET / HTTP/1.1\x0d\x0a" +
+      "Upgrade: WebSocket\x0d\x0a" +
+      "Connection: Upgrade\x0d\x0a" +
+      "Host: example.com\x0d\x0a" +
+      "Origin: http://example.com\x0d\x0a" +
+      "Sec-WebSocket-Key1: 18x 6]8vM;54 *(5:  {   U1]8  z [  8\x0d\x0a" +
+      "Sec-WebSocket-Key2: 1_ tx7X d  <  nw  334J702) 7]o}` 0\x0d\x0a" +
+      "Content-Length: 8\x0d\x0a" +
+      "\x0d\x0aTm[K T2u"
+
+    assert !h.done?
+    assert h.parse('')
+
+    assert h.parse("HTTP/1.1 101 WebSocket Protocol Handshake\x0d\x0a" +
+          "Upgrade: WebSocket\x0d\x0a" +
+          "Connection: Upgrade\x0d\x0a" +
+          "Sec-WebSocket-Origin: http://example.com\x0d\x0a" +
+          "Sec-WebSocket-Location: ws://example.com/demo\x0d\x0a" +
+          "\x0d\x0a" +
+          "fQJ,fN/4F4!~K~MH")
+    assert !h.error
+    assert h.done?
+
+    message = "HTTP/1.1 101 WebSocket Protocol Handshake\x0d\x0a"
+    h = LibWebSocket::Handshake::Client.new(:url => 'ws://example.com')
+    assert h.parse(message)
+    assert !h.error
+
+    h = LibWebSocket::Handshake::Client.new
+    assert !h.parse("HTTP/1.0 foo bar\x0d\x0a")
+    assert_equal 'Wrong response line', h.error
+  end
+
+end

data/test/libwebsocket/handshake/test_server.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class TestServerHandshake < Test::Unit::TestCase
+
+  def test_parse
+    h = LibWebSocket::Handshake::Server.new
+    assert !h.done?
+    assert h.parse('')
+
+    assert h.parse("GET /demo HTTP/1.1\x0d\x0a")
+    assert h.parse("Upgrade: WebSocket\x0d\x0a")
+    assert h.parse("Connection: Upgrade\x0d\x0a")
+    assert h.parse("Host: example.com\x0d\x0a")
+    assert h.parse("Origin: http://example.com\x0d\x0a")
+    assert h.parse("Sec-WebSocket-Key1: 18x 6]8vM;54 *(5:  {   U1]8  z [  8\x0d\x0a")
+    assert h.parse("Sec-WebSocket-Key2: 1_ tx7X d  <  nw  334J702) 7]o}` 0\x0d\x0a")
+    assert h.parse("\x0d\x0aTm[K T2u")
+    assert !h.error
+    assert h.done?
+
+    assert_equal h.to_s, "HTTP/1.1 101 WebSocket Protocol Handshake\x0d\x0a" +
+      "Upgrade: WebSocket\x0d\x0a" +
+      "Connection: Upgrade\x0d\x0a" +
+      "Sec-WebSocket-Origin: http://example.com\x0d\x0a" +
+      "Sec-WebSocket-Location: ws://example.com/demo\x0d\x0a" +
+      "\x0d\x0a" +
+      "fQJ,fN/4F4!~K~MH";
+
+    message = "GET /demo HTTP/1.1\x0d\x0a"
+    h = LibWebSocket::Handshake::Server.new
+    assert h.parse(message)
+    assert_nil h.error
+
+    h = LibWebSocket::Handshake::Server.new
+    assert_nil h.parse("GET /demo\x0d\x0a")
+    assert_equal 'Wrong request line', h.error
+  end
+
+end

data/test/libwebsocket/test_cookie.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class TestCookie < Test::Unit::TestCase
+
+  def test_parse
+    cookie = LibWebSocket::Cookie.new
+    assert_nil cookie.parse('')
+    assert cookie.parse('foo=bar; baz = zab; hello= "the;re"; here')
+    assert_equal [['foo', 'bar'], ['baz', 'zab'], ['hello', 'the;re'], ['here', nil]], cookie.pairs
+    assert_equal 'foo=bar; baz=zab; hello="the;re"; here', cookie.to_s
+
+    cookie = LibWebSocket::Cookie.new
+    cookie.parse('$Foo="bar"')
+    assert_equal [['$Foo', 'bar']], cookie.pairs
+
+    cookie = LibWebSocket::Cookie.new
+    cookie.parse('foo=bar=123=xyz')
+    assert_equal [['foo', 'bar=123=xyz']], cookie.pairs
+  end
+
+end

data/test/libwebsocket/test_frame.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+class TestFrame < Test::Unit::TestCase
+
+  def test_append
+    f = LibWebSocket::Frame.new
+
+    f.append
+    assert_nil f.next
+    f.append('')
+    assert_nil f.next
+
+    f.append('qwe')
+    assert_nil f.next
+    f.append("\x00foo\xff")
+    assert_equal 'foo', f.next
+    assert_nil f.next
+
+    f.append("\x00")
+    assert_nil f.next
+    f.append("\xff")
+    assert_equal '', f.next
+
+    f.append("\x00")
+    assert_nil f.next
+    f.append("foo")
+    f.append("\xff")
+    assert_equal 'foo', f.next
+
+    f.append("\x00foo\xff\x00bar\n\xff")
+    assert_equal 'foo', f.next
+    assert_equal "bar\n", f.next
+    assert_nil f.next
+
+    f.append("123\x00foo\xff56\x00bar\xff789")
+    assert_equal 'foo', f.next
+    assert_equal 'bar', f.next
+    assert_nil f.next
+
+    # We append bytes, but read characters
+    msg = "\342\230\272"
+    f.append("\x00" + msg + "\xff")
+    msg.force_encoding('UTF-8') if msg.respond_to?(:force_encoding)
+    assert_equal msg, f.next
+  end
+
+  def test_new
+    f = LibWebSocket::Frame.new
+    msg = "\x00\xff"
+    msg.force_encoding('UTF-8') if msg.respond_to?(:force_encoding)
+    assert_equal msg, f.to_s
+
+    f = LibWebSocket::Frame.new('123')
+    msg = "\x00123\xff"
+    msg.force_encoding('UTF-8') if msg.respond_to?(:force_encoding)
+    assert_equal msg, f.to_s
+
+    # We pass characters, but send bytes
+    f = LibWebSocket::Frame.new("\342\230\272")
+    msg = "\x00\342\230\272\xff"
+    msg.force_encoding('UTF-8') if msg.respond_to?(:force_encoding)
+    assert_equal msg, f.to_s
+  end
+
+end

data/test/libwebsocket/test_message.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class TestMessage < Test::Unit::TestCase
+
+  def test_parse
+    m = LibWebSocket::Message.new
+    assert m.parse("HTTP/1.1 101 WebSocket Protocol Handshake\x0d\x0a")
+    assert m.parse("Upgrade: WebSocket\x0d\x0a")
+    assert m.parse("Connection: Upgrade\x0d\x0a")
+    assert m.parse("Sec-WebSocket-Origin: file://\x0d\x0a")
+    assert m.parse("Sec-WebSocket-Location: ws://example.com/demo\x0d\x0a")
+    assert m.parse("\x0d\x0a0st\x0d\x0al&q-2ZU^weu")
+    assert m.done?
+  end
+
+end

data/test/libwebsocket/test_request_75.rb

@@ -0,0 +1,145 @@
+require 'test_helper'
+
+class TestRequest75 < Test::Unit::TestCase
+
+  def test_parse
+    req = LibWebSocket::Request.new
+    assert !req.done?
+    assert req.parse('')
+    assert req.parse("GET /demo HTTP/1.1\x0d\x0a")
+    assert_equal 'fields', req.state
+
+    assert req.parse("Upgrade: WebSocket\x0d\x0a")
+    assert_equal 'fields', req.state
+    assert req.parse("Connection: Upgrade\x0d\x0a")
+    assert_equal 'fields', req.state
+    assert req.parse("Host: example.com\x0d\x0a")
+    assert_equal 'fields', req.state
+    assert req.parse("Origin: http://example.com\x0d\x0a")
+    assert_equal 'fields', req.state
+    assert req.parse("\x0d\x0a")
+    assert_equal 'done', req.state
+
+    assert_equal 75, req.version
+    assert_equal '/demo', req.resource_name
+    assert_equal 'example.com', req.host
+    assert_equal 'http://example.com', req.origin
+
+    req = LibWebSocket::Request.new
+    assert req.parse("GET /demo HTTP/1.1\x0d\x0a")
+    assert req.parse("Upgrade: WebSocket\x0d\x0a")
+    assert req.parse("Connection: Upgrade\x0d\x0a")
+    assert req.parse("Host: example.com:3000\x0d\x0a")
+    assert req.parse("Origin: null\x0d\x0a")
+    assert req.parse("\x0d\x0a")
+    assert_equal 75, req.version
+    assert_equal 'done', req.state
+
+    req = LibWebSocket::Request.new
+    assert req.parse("GET /demo HTTP/1.1\x0d\x0a")
+    assert req.parse("UPGRADE: WebSocket\x0d\x0a")
+    assert req.parse("CONNECTION: Upgrade\x0d\x0a")
+    assert req.parse("HOST: example.com:3000\x0d\x0a")
+    assert req.parse("ORIGIN: null\x0d\x0a")
+    assert req.parse("\x0d\x0a")
+    assert_equal 75, req.version
+    assert_equal 'done', req.state
+
+    req = LibWebSocket::Request.new
+    assert req.parse("GET /demo HTTP/1.1\x0d\x0a")
+    assert req.parse("Upgrade: WebSocket\x0d\x0a")
+    assert req.parse("Connection: Upgrade\x0d\x0a")
+    assert req.parse("Host: example.com:3000\x0d\x0a")
+    assert req.parse("Origin: null\x0d\x0a")
+    assert req.parse("WebSocket-Protocol: sample\x0d\x0a")
+    assert req.parse("\x0d\x0a")
+    assert_equal 75, req.version
+    assert_equal 'done', req.state
+    assert_equal 'sample', req.subprotocol
+
+    req     = LibWebSocket::Request.new
+    message = "GET /demo HTTP/1.1\x0d\x0a" +
+        "Upgrade: WebSocket\x0d\x0a" +
+        "Connection: Upgrade\x0d\x0a"
+    assert req.parse(message)
+    message = "Host: example.com:3000\x0d\x0a" + "Origin: null\x0d\x0a" + "\x0d\x0a"
+    assert req.parse(message)
+    assert_equal 75, req.version
+    assert req.done?
+
+    req = LibWebSocket::Request.new
+    assert req.parse("GET /demo HTTP/1.1\x0d\x0a")
+    assert req.parse("Upgrade: WebSocket\x0d\x0a")
+    assert req.parse("Connection: Upgrade\x0d\x0a")
+    assert req.parse("Host: example.com\x0d\x0a")
+    assert req.parse("Origin: null\x0d\x0a")
+    assert req.parse("cookie: \$Version=1; foo=bar; \$Path=/\x0d\x0a")
+    assert req.parse("\x0d\x0a")
+    assert req.done?
+
+    assert_equal req.cookies[0].version, '1'
+    assert_equal req.cookies[0].name, 'foo'
+    assert_equal req.cookies[0].value, 'bar'
+
+    req = LibWebSocket::Request.new
+    assert req.parse("GET /demo HTTP/1.1\x0d\x0a")
+    assert req.parse("Upgrade: WebSocket\x0d\x0a")
+    assert req.parse("Connection: Bar\x0d\x0a")
+    assert req.parse("Host: example.com\x0d\x0a")
+    assert req.parse("Origin: http://example.com\x0d\x0a")
+    assert_nil req.parse("\x0d\x0a")
+    assert_equal 'error', req.state
+    assert_equal 'Not a valid request', req.error
+
+    req = LibWebSocket::Request.new
+    assert req.parse("GET /demo HTTP/1.1\x0d\x0a")
+    assert req.parse("Upgrade: WebSocket\x0d\x0a")
+    assert req.parse("Connection: Upgrade\x0d\x0a")
+    assert req.parse("Host: example.com\x0d\x0a")
+    assert req.parse("Origin: http://example.com\x0d\x0a")
+    assert_nil req.parse("\x0d\x0afoo")
+    assert_equal 'error', req.state
+    assert_equal 'Leftovers', req.error
+  end
+
+  def test_to_s
+    req = LibWebSocket::Request.new(
+        :version       => 75,
+        :host          => 'example.com',
+        :resource_name => '/demo'
+    )
+    assert_equal req.to_s, "GET /demo HTTP/1.1\x0d\x0a" +
+        "Upgrade: WebSocket\x0d\x0a" +
+        "Connection: Upgrade\x0d\x0a" +
+        "Host: example.com\x0d\x0a" +
+        "Origin: http://example.com\x0d\x0a" +
+        "\x0d\x0a"
+
+    req = LibWebSocket::Request.new(
+        :version       => 75,
+        :host          => 'example.com',
+        :subprotocol   => 'sample',
+        :resource_name => '/demo'
+    )
+    assert_equal req.to_s, "GET /demo HTTP/1.1\x0d\x0a" +
+        "Upgrade: WebSocket\x0d\x0a" +
+        "Connection: Upgrade\x0d\x0a" +
+        "Host: example.com\x0d\x0a" +
+        "Origin: http://example.com\x0d\x0a" +
+        "WebSocket-Protocol: sample\x0d\x0a" +
+        "\x0d\x0a"
+
+    req = LibWebSocket::Request.new(
+        :version       => 75,
+        :host          => 'example.com',
+        :resource_name => '/demo'
+    );
+    assert_equal req.to_s, "GET /demo HTTP/1.1\x0d\x0a" +
+        "Upgrade: WebSocket\x0d\x0a" +
+        "Connection: Upgrade\x0d\x0a" +
+        "Host: example.com\x0d\x0a" +
+        "Origin: http://example.com\x0d\x0a" +
+        "\x0d\x0a"
+  end
+
+end