websocket 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+autobahn
+pkg/*.gem

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+script: "bundle exec rake spec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ree

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 / 2012-11-18
+
+- initial release

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'rake'

data/README.md

@@ -0,0 +1,117 @@
+# WebSocket Ruby
+
+- Travis CI build: [![](http://travis-ci.org/imanel/websocket-ruby.png)](http://travis-ci.org/imanel/websocket-ruby)
+- Autobahn tests: [server](http://imanel.github.com/websocket-ruby/autobahn/server/), client
+
+Universal Ruby library to handle WebSocket protocol. It foucses on providing abstraction layer over [WebSocket API](http://dev.w3.org/html5/websockets/) instead of providing server or client functionality.
+
+Currently WebSocket Ruby supports all existing drafts of WebSocket, which include:
+
+- [hixie-75](http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75)
+- [hixie-76](http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76)
+- [all hybi drafts (00-17)](http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-17)
+- [RFC 6455](http://datatracker.ietf.org/doc/rfc6455/)
+
+## Installation
+
+WebSocket Ruby has no external dependencies, so it can be installed from source or directly from rubygems:
+
+```
+gem install "websocket"
+```
+
+or via Gemfile:
+
+```
+gem "websocket"
+```
+
+## Server handshake
+
+``` ruby
+@handshake = WebSocket::Handshake::Server.new
+
+# Parse client request
+@handshake << <<EOF
+GET /demo HTTP/1.1
+Upgrade: websocket
+Connection: Upgrade
+Host: example.com
+Sec-WebSocket-Origin: http://example.com
+Sec-WebSocket-Version: 17
+Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
+
+EOF
+
+# All data received?
+@handshake.finished?
+
+# No parsing errors?
+@handshake.valid?
+
+# Create response
+@handshake.to_s # HTTP/1.1 101 Switching Protocols
+                # Upgrade: websocket
+                # Connection: Upgrade
+                # Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=
+```
+
+## Client handshake
+
+``` ruby
+@handshake = WebSocket::Handshake::Client.new(:url => 'ws://example.com')
+
+# Create request
+@handshake.to_s # GET /demo HTTP/1.1
+                # Upgrade: websocket
+                # Connection: Upgrade
+                # Host: example.com
+                # Sec-WebSocket-Origin: http://example.com
+                # Sec-WebSocket-Version: 17
+                # Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
+
+# Parse server response
+@handshake << <<EOF
+HTTP/1.1 101 Switching Protocols
+Upgrade: websocket
+Connection: Upgrade
+Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=
+
+EOF
+
+# All data received?
+@handshake.finished?
+
+# No parsing errors?
+@handshake.valid?
+```
+
+## Parsing and constructing frames
+
+``` ruby
+# Prepare frame for sending
+frame = WebSocket::Frame::Outgoing::Server.new(:version => @handshake.version, :data => "Hello", :type => :text)
+frame.to_s # "\x81\x05\x48\x65\x6c\x6c\x6f"
+
+# Parse incoming frames
+frame = WebSocket::Frame::Incoming::Server.new(:version => @handshake.version)
+frame << "\x81\x05\x48\x65\x6c\x6c\x6f\x81\x06\x77\x6f\x72\x6c\x64\x21"
+frame.next # "Hello"
+frame.next # "world!""
+```
+
+## Examples
+
+For examples on how to use WebSocket Ruby see examples directory in the repository. Provided examples are fully working servers - they are passing full autobahn compatibility suit.
+
+## License
+
+(The MIT License)
+
+Copyright © 2012 Bernard Potocki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec
+
+namespace :autobahn do
+  desc "Run autobahn tests for client"
+  task :client do
+    system('wstest --mode=fuzzingserver --spec=autobahn-client.json')
+  end
+
+  desc "Run autobahn tests for server"
+  task :server do
+    system('wstest --mode=fuzzingclient --spec=autobahn-server.json')
+  end
+end

data/autobahn-client.json

@@ -0,0 +1,11 @@
+{
+   "url": "ws://127.0.0.1:9001",
+
+   "options": {"failByDrop": false},
+   "outdir": "./autobahn/client",
+   "webport": 8080,
+
+   "cases": ["1.1.1"],
+   "exclude-cases": [],
+   "exclude-agent-cases": {}
+}

data/autobahn-server.json

@@ -0,0 +1,10 @@
+{
+   "options": {"failByDrop": false},
+   "outdir": "./autobahn/server",
+
+   "servers": [{"agent": "WebSocket-Ruby v1.0.0", "url": "ws://localhost:9001", "options": {"version": 18}}],
+
+   "cases": ["*"],
+   "exclude-cases": [],
+   "exclude-agent-cases": {}
+}

data/examples/base.rb

@@ -0,0 +1,162 @@
+require 'rubygems'
+require 'eventmachine'
+require "#{File.expand_path(File.dirname(__FILE__))}/../lib/websocket"
+
+module WebSocket
+  module EventMachine
+    class Base < ::EventMachine::Connection
+
+      ###########
+      ### API ###
+      ###########
+
+      def onopen(&blk);     @onopen = blk;    end # Called when connection is opened
+      def onclose(&blk);    @onclose = blk;   end # Called when connection is closed
+      def onerror(&blk);    @onerror = blk;   end # Called when error occurs
+      def onmessage(&blk);  @onmessage = blk; end # Called when message is received from server
+      def onping(&blk);     @onping = blk;    end # Called when ping message is received from server
+      def onpong(&blk);     @onpong = blk;    end # Called when pond message is received from server
+
+      # Send data to client
+      # @param data [String] Data to send
+      # @param args [Hash] Arguments for send
+      # @option args [String] :type Type of frame to send - available types are "text", "binary", "ping", "pong" and "close"
+      # @return [Boolean] true if data was send, otherwise call on_error if needed
+      def send(data, args = {})
+        type = args[:type] || :text
+        unless type == :plain
+          frame = outgoing_frame.new(:version => @handshake.version, :data => data, :type => type)
+          if !frame.supported?
+            trigger_onerror("Frame type '#{type}' is not supported in protocol version #{@handshake.version}")
+            return false
+          elsif !frame.require_sending?
+            return false
+          end
+          data = frame.to_s
+        end
+        # debug "Sending raw: ", data
+        send_data(data)
+        true
+      end
+
+      # Close connection
+      # @return [Boolean] true if connection is closed immediately, false if waiting for server to close connection
+      def close
+        if @state == :open
+          @state = :closing
+          return false if send('', :type => :close)
+        else
+          send('', :type => :close) if @state == :closing
+          @state = :closed
+        end
+        close_connection_after_writing
+        true
+      end
+
+      # Send ping message to client
+      # @return [Boolean] false if protocol version is not supporting ping requests
+      def ping(data = '')
+        send(data, :type => :ping)
+      end
+
+      # Send pong message to client
+      # @return [Boolean] false if protocol version is not supporting pong requests
+      def pong(data = '')
+        send(data, :type => :pong)
+      end
+
+      ############################
+      ### EventMachine methods ###
+      ############################
+
+      def receive_data(data)
+        # debug "Received raw: ", data
+        case @state
+        when :connecting then handle_connecting(data)
+        when :open then handle_open(data)
+        when :closing then handle_closing(data)
+        end
+      end
+
+      def unbind
+        unless @state == :closed
+          @state = :closed
+          close
+          trigger_onclose('')
+        end
+      end
+
+      #######################
+      ### Private methods ###
+      #######################
+
+      private
+
+      ['onopen'].each do |m|
+        define_method "trigger_#{m}" do
+          callback = instance_variable_get("@#{m}")
+          callback.call if callback
+        end
+      end
+
+      ['onerror', 'onping', 'onpong', 'onclose'].each do |m|
+        define_method "trigger_#{m}" do |data|
+          callback = instance_variable_get("@#{m}")
+          callback.call(data) if callback
+        end
+      end
+
+      def trigger_onmessage(data, type)
+        @onmessage.call(data, type) if @onmessage
+      end
+
+      def handle_connecting(data)
+        @handshake << data
+        return unless @handshake.finished?
+        if @handshake.valid?
+          send(@handshake.to_s, :type => :plain) if @handshake.should_respond?
+          @frame = incoming_frame.new(:version => @handshake.version)
+          @state = :open
+          trigger_onopen
+          handle_open(@handshake.leftovers) if @handshake.leftovers
+        else
+          trigger_onerror(@handshake.error)
+          close
+        end
+      end
+
+      def handle_open(data)
+        @frame << data
+        while frame = @frame.next
+          case frame.type
+          when :close
+            @state = :closing
+            close
+            trigger_onclose(frame.to_s)
+          when :ping
+            pong(frame.to_s)
+            trigger_onping(frame.to_s)
+          when :pong
+            trigger_onpong(frame.to_s)
+          when :text
+            trigger_onmessage(frame.to_s, :text)
+          when :binary
+            trigger_onmessage(frame.to_s, :binary)
+          end
+        end
+        unbind if @frame.error?
+      end
+
+      def handle_closing(data)
+        @state = :closed
+        close
+        trigger_onclose
+      end
+
+      def debug(description, data)
+        puts(description + data.bytes.to_a.collect{|b| '\x' + b.to_s(16).rjust(2, '0')}.join) unless @state == :connecting
+      end
+
+    end
+  end
+end

data/examples/client.rb

@@ -0,0 +1,70 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/base"
+require 'uri'
+
+# Example WebSocket Client (using EventMachine)
+# @example Usage
+#   ws = WebSocket::EventMachine::Client.connect(:host => "0.0.0.0", :port => 8080)
+#   ws.onmessage { |msg| ws.send "Pong: #{msg}" }
+#   ws.send "data"
+module WebSocket
+  module EventMachine
+    class Client < Base
+
+      # Connect to websocket server
+      # @param args [Hash] The request arguments
+      # @option args [String] :host The host IP/DNS name
+      # @option args [Integer] :port The port to connect too(default = 80)
+      # @option args [Integer] :version Version of protocol to use(default = 13)
+      def self.connect(args = {})
+        host = nil
+        port = nil
+        if args[:uri]
+          uri = URI.parse(args[:uri])
+          host = uri.host
+          port = uri.port
+        end
+        host = args[:host] if args[:host]
+        port = args[:port] if args[:port]
+        port ||= 80
+
+        ::EventMachine.connect host, port, self, args
+      end
+
+      # Initialize connection
+      # @param args [Hash] Arguments for connection
+      # @option args [String] :host The host IP/DNS name
+      # @option args [Integer] :port The port to connect too(default = 80)
+      # @option args [Integer] :version Version of protocol to use(default = 13)
+      def initialize(args)
+        @args = args
+      end
+
+      ############################
+      ### EventMachine methods ###
+      ############################
+
+      # Called after initialize of connection, but before connecting to server
+      def post_init
+        @state = :connecting
+        @handshake = WebSocket::Handshake::Client.new(@args)
+      end
+
+      # Called by EventMachine after connecting.
+      # Sends handshake to server
+      def connection_completed
+        send(@handshake.to_s, :type => :plain)
+      end
+
+      private
+
+      def incoming_frame
+        WebSocket::Frame::Incoming::Client
+      end
+
+      def outgoing_frame
+        WebSocket::Frame::Outgoing::Client
+      end
+
+    end
+  end
+end

data/examples/server.rb

@@ -0,0 +1,56 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/base"
+
+# Example WebSocket Server (using EventMachine)
+# @example Usage
+#   WebSocket::EventMachine::Server.start(:host => "0.0.0.0", :port => 8080) do |ws|
+#     ws.onopen    { ws.send "Hello Client!"}
+#     ws.onmessage { |msg| ws.send "Pong: #{msg}" }
+#     ws.onclose   { puts "WebSocket closed" }
+#     ws.onerror   { |e| puts "Error: #{e}" }
+#   end
+module WebSocket
+  module EventMachine
+    class Server < Base
+
+      # Start server
+      # @param options [Hash] The request arguments
+      # @option args [String] :host The host IP/DNS name
+      # @option args [Integer] :port The port to connect too(default = 80)
+      def self.start(options, &block)
+        ::EventMachine::start_server(options[:host], options[:port], self, options) do |c|
+          block.call(c)
+        end
+      end
+
+      # Initialize connection
+      # @param args [Hash] Arguments for server
+      # @option args [Boolean] :secure If true then server will run over SSL
+      # @option args [Hash] :tls_options Options for SSL if secure = true
+      def initialize(args)
+        @secure = args[:secure] || false
+        @tls_options = args[:tls_options] || {}
+      end
+
+      ############################
+      ### Eventmachine methods ###
+      ############################
+
+      def post_init
+        @state = :connecting
+        @handshake = WebSocket::Handshake::Server.new(:secure => @secure)
+        start_tls(@tls_options) if @secure
+      end
+
+      private
+
+      def incoming_frame
+        WebSocket::Frame::Incoming::Server
+      end
+
+      def outgoing_frame
+        WebSocket::Frame::Outgoing::Server
+      end
+
+    end
+  end
+end