eventmachine-websocket 0.1.0

data/README.markdown

@@ -0,0 +1,46 @@
+# eventmachine-websocket
+
+An [EventMachine](http://github.com/eventmachine/eventmachine/) based WebSocket server.
+
+## Example
+
+    EventMachine::WebSocket.start do |socket|
+      socket.open do
+        puts "New connection."
+      end
+      socket.message do |message|
+        socket.send "Received: #{message}"
+      end
+      socket.close do
+        puts "Closed connection."
+      end
+    end
+
+
+## Credits
+
+Based on [em-websocket](http://github.com/igrigorik/em-websocket) by [Ilya Grigorik](http://github.com/igrigorik).
+
+## License
+
+The MIT License
+
+Copyright (c) 2010 Tristan Dunn
+
+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,22 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new do |task|
+  task.spec_opts = %w(--color --format specdoc)
+end
+
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name        = 'eventmachine-websocket'
+    gemspec.summary     = 'An EventMachine based WebSocket server.'
+    gemspec.description = 'An EventMachine based WebSocket server.'
+    gemspec.email       = 'hello@tristandunn.com'
+    gemspec.homepage    = 'http://github.com/tristandunn/eventmachine-websocket'
+    gemspec.authors     = ['Tristan Dunn']
+  end
+rescue LoadError
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/eventmachine-websocket.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{eventmachine-websocket}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tristan Dunn"]
+  s.date = %q{2010-03-06}
+  s.description = %q{An EventMachine based WebSocket server.}
+  s.email = %q{hello@tristandunn.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "eventmachine-websocket.gemspec",
+     "examples/custom.rb",
+     "examples/echo.rb",
+     "lib/eventmachine-websocket.rb",
+     "lib/eventmachine-websocket/connection.rb",
+     "lib/eventmachine-websocket/websocket.rb",
+     "spec/spec_helper.rb",
+     "spec/websocket_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/tristandunn/eventmachine-websocket}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{An EventMachine based WebSocket server.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/websocket_spec.rb",
+     "examples/custom.rb",
+     "examples/echo.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/examples/custom.rb

@@ -0,0 +1,17 @@
+require 'lib/eventmachine-websocket'
+
+class Client < EventMachine::WebSocket::Connection
+  def open
+    puts "New connection."
+  end
+
+  def close
+    puts "Lost connection."
+  end
+
+  def message(data)
+    send "Received: #{data}"
+  end
+end
+
+EventMachine::WebSocket.start(:klass => Client)

data/examples/echo.rb

@@ -0,0 +1,7 @@
+require 'lib/eventmachine-websocket'
+
+EventMachine::WebSocket.start do |socket|
+  socket.message do |message|
+    socket.send message
+  end
+end

data/lib/eventmachine-websocket.rb

@@ -0,0 +1,5 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'eventmachine'
+require 'eventmachine-websocket/connection'
+require 'eventmachine-websocket/websocket'

data/lib/eventmachine-websocket/connection.rb

@@ -0,0 +1,114 @@
+module EventMachine::WebSocket
+  class Connection < EventMachine::Connection
+    def post_init
+      @data      = ''
+      @connected = false
+    end
+
+    def receive_data(data)
+      @data << data
+
+      if @connected
+        process_message
+      else
+        setup_connection
+      end
+    end
+
+    def unbind
+      close
+    end
+
+    def send(data)
+      send_data "\x00#{data}\xff"
+    end
+
+    def on_open(&block)
+      @open_callback = block
+    end
+
+    def on_close(&block)
+      @close_callback = block
+    end
+
+    def on_message(&block)
+      @message_callback = block
+    end
+
+    protected
+
+    def open
+      if @open_callback
+        @open_callback.call
+      end
+    end
+
+    def close
+      if @close_callback
+        @close_callback.call
+      end
+    end
+
+    def message(data)
+      if @message_callback
+        @message_callback.call(data)
+      end
+    end
+
+    private
+
+    def headers
+      @headers ||= headers!
+    end
+
+    def headers!
+      data = @data.split("\r\n")
+      data.inject({}) do |result, header|
+        if header.match(/^([^:]+):\s*([^$]+)/)
+          result[$1] = $2
+        elsif header.match(/^GET (\/[^\s]*) HTTP\/1\.1$/)
+          result['Path'] = $1
+        end
+
+        result
+      end
+    end
+
+    def process_message
+      while data = @data.slice!(/\000([^\377]*)\377/)
+        message(data[1..-2])
+      end
+    end
+
+    def send_handshake
+      location = "ws://#{headers['Host']}#{headers['Path']}"
+      upgrade  = "HTTP/1.1 101 Web Socket Protocol Handshake\r\n"
+      upgrade << "Upgrade: WebSocket\r\n"
+      upgrade << "Connection: Upgrade\r\n"
+      upgrade << "WebSocket-Origin: #{headers['Origin']}\r\n"
+      upgrade << "WebSocket-Location: #{location}\r\n\r\n"
+
+      send_data upgrade
+    end
+
+    def setup_connection
+      return unless @data =~ /\r\n\r\n$/
+
+      if valid_connection?
+        @data      = ''
+        @connected = true
+
+        send_handshake
+        open
+      else
+        send_data "HTTP/1.1 400 Bad Request\r\n\r\n"
+        close_connection_after_writing
+      end
+    end
+
+    def valid_connection?
+      headers['Connection'] == 'Upgrade' &&
+        headers['Upgrade']  == 'WebSocket'
+    end
+  end
+end

data/lib/eventmachine-websocket/websocket.rb

@@ -0,0 +1,23 @@
+module EventMachine::WebSocket
+  def self.start(options = {}, &block)
+    host  = options.delete(:host)  || '0.0.0.0'
+    port  = options.delete(:port)  || 8080
+    klass = options.delete(:klass) || Connection
+
+    EM.epoll
+    EM.run do
+      trap('INT')  { stop }
+      trap('TERM') { stop }
+
+      EventMachine.start_server(host, port, klass, options) do |connection|
+        if block_given?
+          block.call(connection)
+        end
+      end
+    end
+  end
+
+  def self.stop
+    EventMachine.stop
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'spec'
+require 'em-http'
+
+require 'lib/eventmachine-websocket'

data/spec/websocket_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe EventMachine::WebSocket do
+  it 'should perform WebSocket handshake' do
+    EM.run do
+      EventMachine.add_timer(0.1) do
+        http = EventMachine::HttpRequest.new('ws://127.0.0.1:8080/').get
+        http.callback do
+          http.response_header.status.should == 101
+          EventMachine.stop
+        end
+        http.errback do
+          EventMachine.stop
+          fail
+        end
+      end
+
+      EventMachine::WebSocket::start do
+      end
+    end
+  end
+
+  it 'should only accept WebSocket requests' do
+    EM.run do
+      EventMachine.add_timer(0.1) do
+        http = EventMachine::HttpRequest.new('http://127.0.0.1:8080/').get
+        http.callback do
+          http.response_header.status.should == 400
+          EventMachine.stop
+        end
+        http.errback do
+          EventMachine.stop
+          fail
+        end
+      end
+
+      EventMachine::WebSocket.start do
+      end
+    end
+  end
+
+  it 'should split multiple messages into separate callbacks' do
+    EM.run do
+      messages = %w[1 2]
+      received = []
+
+      EventMachine.add_timer(0.1) do
+        http = EventMachine::HttpRequest.new('ws://127.0.0.1:8080/').get
+        http.callback do
+          http.response_header.status.should == 101
+          http.send messages.first
+          http.send messages.last
+        end
+        http.errback do
+          EventMachine.stop
+          fail
+        end
+      end
+
+      EventMachine::WebSocket.start do |socket|
+        socket.on_message do |message|
+          message.should == messages[received.length]
+
+          received << message
+
+          if received.length == 2
+            EventMachine.stop
+          end
+        end
+      end
+    end
+  end
+
+  it 'should call close callback when client closes connection' do
+    EM.run do
+      EventMachine.add_timer(0.1) do
+        http = EventMachine::HttpRequest.new('ws://127.0.0.1:8080/').get
+        http.callback do
+          http.response_header.status.should == 101
+          http.close_connection
+        end
+        http.errback do
+          EventMachine.stop
+          fail
+        end
+      end
+
+      EventMachine::WebSocket.start do |socket|
+        socket.on_close do
+          EventMachine.stop
+        end
+      end
+    end
+  end
+
+  it 'should allow custom client classes' do
+    EM.run do
+      EventMachine.add_timer(0.1) do
+        http = EventMachine::HttpRequest.new('ws://127.0.0.1:8080/').get
+        http.callback do
+          http.send 'Hello, world.'
+        end
+      end
+
+      class Custom < EventMachine::WebSocket::Connection
+        def open
+          @open = true
+        end
+
+        def close
+          @open.should == true
+        end
+
+        def message(data)
+          EventMachine.stop
+        end
+      end
+
+      EventMachine::WebSocket.start(:klass => Custom)
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: eventmachine-websocket
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tristan Dunn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-06 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: An EventMachine based WebSocket server.
+email: hello@tristandunn.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- eventmachine-websocket.gemspec
+- examples/custom.rb
+- examples/echo.rb
+- lib/eventmachine-websocket.rb
+- lib/eventmachine-websocket/connection.rb
+- lib/eventmachine-websocket/websocket.rb
+- spec/spec_helper.rb
+- spec/websocket_spec.rb
+has_rdoc: true
+homepage: http://github.com/tristandunn/eventmachine-websocket
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: An EventMachine based WebSocket server.
+test_files: 
+- spec/spec_helper.rb
+- spec/websocket_spec.rb
+- examples/custom.rb
+- examples/echo.rb