libwebsocket 0.0.4

data/README.md

@@ -0,0 +1,88 @@
+# Protocol::WebSocket
+
+A WebSocket message parser/constructor. It is not a server and is not meant to
+be one. It can be used in any server, event loop etc.
+
+## Server handshake
+
+    h = LibWebSocket::Handshake::Server.new
+
+    # Parse client request
+    h.parse \<<EOF
+    GET /demo HTTP/1.1
+    Upgrade: WebSocket
+    Connection: Upgrade
+    Host: example.com
+    Origin: http://example.com
+    Sec-WebSocket-Key1: 18x 6]8vM;54 *(5:  {   U1]8  z [  8
+    Sec-WebSocket-Key2: 1_ tx7X d  <  nw  334J702) 7]o}` 0
+
+    Tm[K T2u
+    EOF
+
+    h.error # Check if there were any errors
+    h.done? # Returns true
+
+    # Create response
+    h.to_s # HTTP/1.1 101 WebSocket Protocol Handshake
+           # Upgrade: WebSocket
+           # Connection: Upgrade
+           # Sec-WebSocket-Origin: http://example.com
+           # Sec-WebSocket-Location: ws://example.com/demo
+           #
+           # fQJ,fN/4F4!~K~MH
+
+## Client handshake
+
+    h = LibWebSocket::Handshake::Client.new(url => 'ws://example.com')
+
+    # Create request
+    h.to_s # GET /demo HTTP/1.1
+           # Upgrade: WebSocket
+           # Connection: Upgrade
+           # Host: example.com
+           # Origin: http://example.com
+           # Sec-WebSocket-Key1: 18x 6]8vM;54 *(5:  {   U1]8  z [  8
+           # Sec-WebSocket-Key2: 1_ tx7X d  <  nw  334J702) 7]o}` 0
+           #
+           # Tm[K T2u
+
+    # Parse server response
+    h.parse \<<EOF
+    HTTP/1.1 101 WebSocket Protocol Handshake
+    Upgrade: WebSocket
+    Connection: Upgrade
+    Sec-WebSocket-Origin: http://example.com
+    Sec-WebSocket-Location: ws://example.com/demo
+
+    fQJ,fN/4F4!~K~MH
+    EOF
+
+    h.error # Check if there were any errors
+    h.done? # Returns true
+
+## Parsing and constructing frames
+
+    # Create frame
+    frame = LibWebSocket::Frame.new('123')
+    frame.to_s # \x00123\xff
+
+    # Parse frames
+    frame = LibWebSocket::Frame.new
+    frame.append("123\x00foo\xff56\x00bar\xff789")
+    frame.next # foo
+    frame.next # bar
+
+## Examples
+
+For examples on how to use LibWebSocket with various event loops see
+examples directory in the repository.
+
+## Copyright
+
+Copyright (C) 2010, Bernard Potocki.
+
+Based on protocol-websocket perl distribution by Viacheslav Tykhanovskyi.
+
+This program is free software, you can redistribute it and/or modify it under
+the MIT License.

data/Rakefile

@@ -0,0 +1,26 @@
+$:.unshift(File.dirname(__FILE__))
+require 'rake/testtask'
+require 'lib/libwebsocket'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "libwebsocket"
+    gemspec.version = LibWebSocket::VERSION
+    gemspec.summary = "Universal Ruby library to handle WebSocket protocol"
+    gemspec.description = "Universal Ruby library to handle WebSocket protocol"
+    gemspec.email = "bernard.potocki@imanel.org"
+    gemspec.homepage = "http://github.com/imanel/libwebsocket"
+    gemspec.authors = ["Bernard Potocki"]
+    gemspec.files.exclude ".gitignore"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/examples/eventmachine_server.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'eventmachine'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/libwebsocket')
+
+module EchoServer
+  def receive_data(data)
+    @hs ||= LibWebSocket::Handshake::Server.new
+    @frame ||= LibWebSocket::Frame.new
+
+    if !@hs.done?
+      @hs.parse(data)
+
+      if @hs.done?
+        send_data(@hs.to_s)
+      end
+
+      return
+    end
+
+    @frame.append(data)
+
+    while message = @frame.next
+      send_data @frame.new(message).to_s
+    end
+  end
+
+end
+
+EventMachine::run do
+  host = '0.0.0.0'
+  port = 8080
+  EventMachine::start_server host, port, EchoServer
+  puts "Started EchoServer on #{host}:#{port}..."
+end

data/examples/plain_client.rb

@@ -0,0 +1,59 @@
+require "socket"
+require File.expand_path(File.dirname(__FILE__) + '/../lib/libwebsocket')
+
+class WebSocket
+
+  def initialize(url, params = {})
+    @hs ||= LibWebSocket::Handshake::Client.new(:url => url, :version => params[:version])
+    @frame ||= LibWebSocket::Frame.new
+
+    @socket = TCPSocket.new(@hs.url.host, @hs.url.port || 80)
+
+    @socket.write(@hs.to_s)
+    @socket.flush
+
+    loop do
+      data = @socket.getc
+      next if data.nil?
+
+      result = @hs.parse(data.chr)
+
+      raise @hs.error unless result
+
+      if @hs.done?
+        @handshaked = true
+        break
+      end
+    end
+  end
+
+  def send(data)
+    raise "no handshake!" unless @handshaked
+
+    data = @frame.new(data).to_s
+    @socket.write data
+    @socket.flush
+  end
+
+  def receive
+    raise "no handshake!" unless @handshaked
+
+    data = @socket.gets("\xff")
+    @frame.append(data)
+
+    messages = []
+    while message = @frame.next
+      messages << message
+    end
+    messages
+  end
+
+  def socket
+    @socket
+  end
+
+  def close
+    @socket.close
+  end
+
+end

data/examples/thin_server.rb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'thin'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/libwebsocket')
+
+# This is required due to thin incompatibility with streamming of data
+module ThinExtension
+  def self.included(thin_conn)
+     thin_conn.class_eval do
+       alias :pre_process_without_websocket :pre_process
+       alias :pre_process :pre_process_with_websocket
+
+       alias :receive_data_without_websocket :receive_data
+       alias :receive_data :receive_data_with_websocket
+     end
+   end
+
+   attr_accessor :websocket_client
+
+   def pre_process_with_websocket
+     @request.env['async.connection'] = self
+     pre_process_without_websocket
+   end
+   def receive_data_with_websocket(data)
+     if self.websocket_client
+       self.websocket_client.receive_data(data)
+     else
+       receive_data_without_websocket(data)
+     end
+   end
+end
+
+::Thin::Connection.send(:include, ThinExtension)
+
+class EchoServer
+  def call(env)
+    @hs ||= LibWebSocket::Handshake::Server.new
+    @connection = env['async.connection']
+
+    if !@hs.done?
+      @hs.parse(env)
+
+      if @hs.done?
+        @connection.websocket_client = self
+        resp = @hs.to_rack
+        return resp
+      end
+
+      return
+    end
+  end
+
+  def receive_data(data)
+    @frame ||= LibWebSocket::Frame.new
+
+    @frame.append(data)
+
+    while message = @frame.next
+      @connection.send_data @frame.new(message).to_s
+    end
+  end
+end
+
+Thin::Server.start('127.0.0.1', 8080) do
+  map '/' do
+    run proc{ |env| EchoServer.new.call(env) }
+  end
+end

data/lib/libwebsocket.rb

@@ -0,0 +1,17 @@
+# Client/server WebSocket message and frame parser/constructor. This module does
+# not provide a WebSocket server or client, but is made for using in http servers
+# or clients to provide WebSocket support.
+module LibWebSocket
+
+  VERSION = '0.0.4' # Version of LibWebSocket
+
+  autoload :Cookie,    "#{File.dirname(__FILE__)}/libwebsocket/cookie"
+  autoload :Frame,     "#{File.dirname(__FILE__)}/libwebsocket/frame"
+  autoload :Handshake, "#{File.dirname(__FILE__)}/libwebsocket/handshake"
+  autoload :Message,   "#{File.dirname(__FILE__)}/libwebsocket/message"
+  autoload :Request,   "#{File.dirname(__FILE__)}/libwebsocket/request"
+  autoload :Response,  "#{File.dirname(__FILE__)}/libwebsocket/response"
+  autoload :Stateful,  "#{File.dirname(__FILE__)}/libwebsocket/stateful"
+  autoload :URL,       "#{File.dirname(__FILE__)}/libwebsocket/url"
+
+end

data/lib/libwebsocket/cookie.rb

@@ -0,0 +1,60 @@
+module LibWebSocket
+  #A base class for LibWebSocket::Cookie::Request and LibWebSocket::Cookie::Response.
+  class Cookie
+
+    autoload :Request,  "#{File.dirname(__FILE__)}/cookie/request"
+    autoload :Response, "#{File.dirname(__FILE__)}/cookie/response"
+
+    attr_accessor :pairs
+
+    TOKEN         = /[^;,\s"]+/ # Cookie token
+    NAME          = /[^;,\s"=]+/ # Cookie name
+    QUOTED_STRING = /"(?:\\"|[^"])+"/ # Cookie quoted value
+    VALUE         = /(?:#{TOKEN}|#{QUOTED_STRING})/ # Cookie unquoted value
+
+    def initialize(hash = {})
+      hash.each do |k,v|
+        instance_variable_set("@#{k}",v)
+      end
+    end
+
+    # Parse cookie string to array
+    def parse(string)
+      self.pairs = []
+
+      return if string.nil? || string == ''
+
+      while string.slice!(/\s*(#{NAME})\s*(?:=\s*(#{VALUE}))?;?/)
+        attr, value = $1, $2
+        if !value.nil?
+          value.gsub!(/^"/, '')
+          value.gsub!(/"$/, '')
+          value.gsub!(/\\"/, '"')
+        end
+        self.pairs.push([attr, value])
+      end
+
+      return self
+    end
+
+    # Convert cookie array to string
+    def to_s
+      pairs = []
+
+      self.pairs.each do |pair|
+        string = ''
+        string += pair[0]
+
+        unless pair[1].nil?
+          string += '='
+          string += (!pair[1].match(/^#{VALUE}$/) ? "\"#{pair[1]}\"" : pair[1])
+        end
+
+        pairs.push(string)
+      end
+
+      return pairs.join("; ")
+    end
+
+  end
+end

data/lib/libwebsocket/cookie/request.rb

@@ -0,0 +1,48 @@
+module LibWebSocket
+  class Cookie
+    # Construct or parse a WebSocket request cookie.
+    class Request < Cookie
+
+      attr_accessor :name, :value, :version, :path, :domain
+
+      # Parse a WebSocket request cookie.
+      # @example
+      #   cookie = LibWebSocket::Cookie::Request.new
+      #   cookies = cookie.parse('$Version=1; foo="bar"; $Path=/; bar=baz; $Domain=.example.com')
+      def parse(string)
+        result = super
+        return unless result
+
+        cookies = []
+
+        pair = self.pairs.shift
+        version = pair[1]
+
+        cookie = nil
+        self.pairs.each do |pair|
+          next if pair[0].nil?
+
+          if pair[0].match(/^[^\$]/)
+            cookies.push(cookie) unless cookie.nil?
+
+            cookie = self.build_cookie( :name => pair[0], :value => pair[1], :version => version)
+          elsif pair[0] == '$Path'
+            cookie.path = pair[1]
+          elsif pair[0] == '$Domain'
+            cookie.domain = pair[1]
+          end
+        end
+
+        cookies.push(cookie) unless cookie.nil?
+
+        return cookies
+      end
+
+      protected
+
+      def build_cookie(hash)
+        self.class.new(hash)
+      end
+    end
+  end
+end

data/lib/libwebsocket/cookie/response.rb

@@ -0,0 +1,44 @@
+module LibWebSocket
+  class Cookie
+    # Construct or parse a WebSocket response cookie.
+    class Response < Cookie
+
+      attr_accessor :name, :value, :comment, :comment_url, :discard, :max_age, :path, :portlist, :secure
+
+      # Construct a WebSocket response cookie.
+      # @example
+      #   cookie = LibWebSocket::Cookie::Response.new(
+      #     :name    => 'foo',
+      #     :value   => 'bar',
+      #     :discard => 1,
+      #     :max_age => 0
+      #   )
+      #   cookie.to_s # foo=bar; Discard; Max-Age=0; Version=1
+      def to_s
+        pairs = []
+
+        pairs.push([self.name, self.value])
+
+        pairs.push ['Comment', self.comment] if self.comment
+        pairs.push ['CommentURL', self.comment_url] if self.comment_url
+        pairs.push ['Discard'] if self.discard
+        pairs.push ['Max-Age', self.max_age] if self.max_age
+        pairs.push ['Path', self.path] if self.path
+
+        if self.portlist
+          self.portlist = Array(self.portlist)
+          list          = self.portlist.join(' ')
+          pairs.push ['Port', "\"#{list}\""]
+        end
+
+        pairs.push ['Secure'] if self.secure
+        pairs.push ['Version', '1']
+
+        self.pairs = pairs
+
+        super
+      end
+
+    end
+  end
+end