sonixlabs-em-websocket 0.3.7

data/.gitignore

@@ -0,0 +1,4 @@
+*.gemspec
+pkg
+Gemfile.lock
+tags

data/CHANGELOG.rdoc

@@ -0,0 +1,80 @@
+= Changelog
+
+== 0.3.5 / 2011-10-24
+
+- new features:
+  - Support WebSocket draft 13
+
+== 0.3.2 / 2011-10-09
+
+- bugfixes:
+  - Handling of messages with > 2 frames
+  - Encode string passed to onmessage handler as UTF-8 on Ruby 1.9
+  - Add 10MB frame length limit to all draft versions
+
+== 0.3.1 / 2011-07-28
+
+- new features:
+  - Support WebSocket drafts 07 & 08
+
+== 0.3.0 / 2011-05-06
+
+- new features:
+  - Support WebSocket drafts 05 & 06
+- changes:
+  - Accept request headers in a case insensitive manner
+  - Change handling of errors. Previously some application errors were caught
+    internally and were invisible unless an onerror callback was supplied. See
+    readme for details
+
+== 0.2.1 / 2011-03-01
+
+- bugfixes:
+  - Performance improvements to draft 76 framing
+  - Limit frame lengths for draft 76
+  - Better error handling for draft 76 handshake
+  - Ruby 1.9 support
+
+== 0.2.0 / 2010-11-23
+
+- new features:
+  - Support for WebSocket draft 03
+- bugfixes:
+  - Handle case when handshake split into two receive_data calls
+  - Stricter regexp matching of frames
+
+== 0.1.4 / 2010-08-23
+
+- new features:
+  - Allow custom ssl certificate to be used by passing :tls_options
+  - Protect against errors caused by non limited frame lengths
+  - Use custom exceptions rather than RuntimeError
+- bugfixes:
+  - Handle invalid HTTP request with HandshakeError
+
+== 0.1.3 / 2010-07-18
+
+- new features:
+  - onerror callback
+- bugfixes:
+  - proper handling of zero spaces in key1 or key2(prevent ZeroDivisionError)
+  - convert received data to utf-8 to prevent ruby 1.9 errors
+  - fix handling of null bytes within a frame
+
+== 0.1.2 / 2010-06-16
+
+- new features:
+  - none
+- bugfixes:
+  - allow $ character inside header key
+
+== 0.1.1 / 2010-06-13
+
+- new features:
+  - wss/ssl support
+- bugfixes:
+  - can't & strings
+
+== 0.1.0 / 2010-06-12
+
+- initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,98 @@
+# EM-WebSocket
+
+EventMachine based, async, Ruby WebSocket server and client. Take a look at examples directory, or check out the blog post below:
+
+* [Ruby & Websockets: TCP for the Web](http://www.igvita.com/2009/12/22/ruby-websockets-tcp-for-the-browser/)
+
+## Simple server example
+
+```ruby
+EventMachine.run {
+
+    EventMachine::WebSocket.start_ws_server(:host => "0.0.0.0", :port => 8080) do |ws|
+        ws.onopen {
+          puts "WebSocket connection open"
+
+          # publish message to the client
+          ws.send "Hello Client"
+        }
+
+        ws.onclose { puts "Connection closed" }
+        ws.onmessage { |msg|
+          puts "Recieved message: #{msg}"
+          ws.send "Pong: #{msg}"
+        }
+    end
+}
+```
+
+## Simple client example
+
+```ruby
+EventMachine.run {
+
+    EventMachine::WebSocket.start_ws_client(:host => "echo.websocket.org", :port => 80) do |ws|
+        ws.onopen {
+          puts "WebSocket client connection open"
+
+          # publish message to the server
+          ws.send "Hello server", :text
+        }
+
+        ws.onclose { puts "Connection closed" }
+        ws.onmessage{ |msg, type|
+          puts "Received message: #{msg}"
+        }
+    end
+}
+```
+
+## Secure server
+
+It is possible to accept secure wss:// connections by passing :secure => true when opening the connection. Safari 5 does not currently support prompting on untrusted SSL certificates therefore using signed certificates is highly recommended. Pass a :tls_options hash containing keys as described in http://eventmachine.rubyforge.org/EventMachine/Connection.html#M000296
+
+For example,
+
+```ruby
+EventMachine::WebSocket.start({
+    :host => "0.0.0.0",
+    :port => 443
+    :secure => true,
+    :tls_options => {
+      :private_key_file => "/private/key",
+      :cert_chain_file => "/ssl/certificate"
+    }
+}) do |ws|
+...
+end
+```
+
+## Handling errors
+
+There are two kinds of errors that need to be handled - errors caused by incompatible WebSocket clients sending invalid data and errors in application code. They are handled as follows:
+
+Errors caused by invalid WebSocket data (for example invalid errors in the WebSocket handshake or invalid message frames) raise errors which descend from `EventMachine::WebSocket::WebSocketError`. Such errors are rescued internally and the WebSocket connection will be closed immediately or an error code sent to the browser in accordance to the WebSocket specification. However it is possible to be notified in application code on such errors by including an `onerror` callback.
+
+```ruby
+ws.onerror { |error|
+  if e.kind_of?(EM::WebSocket::WebSocketError)
+    ...
+  end
+}
+```
+
+Application errors are treated differently. If no `onerror` callback has been defined these errors will propagate to the EventMachine reactor, typically causing your program to terminate. If you wish to handle exceptions, simply supply an `onerror callback` and check for exceptions which are not decendant from `EventMachine::WebSocket::WebSocketError`.
+
+It is also possible to log all errors when developing by including the `:debug => true` option when initialising the WebSocket connection.
+
+## Examples & Projects using em-websocket
+
+* [Pusher](http://pusherapp.com) - Realtime client push
+* [Livereload](https://github.com/mockko/livereload) - LiveReload applies CSS/JS changes to Safari or Chrome w/o reloading
+* [Twitter AMQP WebSocket Example](http://github.com/rubenfonseca/twitter-amqp-websocket-example)
+* examples/multicast.rb - broadcast all ruby tweets to all subscribers
+* examples/echo.rb - server <> client exchange via a websocket
+
+# License
+
+The MIT License - Copyright (c) 2009 Ilya Grigorik

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress", "-r ./spec/helper.rb"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/em-websocket.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "em-websocket/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sonixlabs-em-websocket"
+  s.version     = EventMachine::Websocket::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kazuhiro Yamada"]
+  s.email       = ["sonixlabs@sonix.asia", "kyamada@sonix.asia"]
+  s.homepage    = "https://github.com/sonixlabs/em-websocket"
+  s.summary     = %q{EventMachine based WebSocket server}
+  s.description = %q{EventMachine based WebSocket server}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("eventmachine", ">= 0.12.9")
+  s.add_dependency("addressable", '>= 2.1.1')
+  s.add_development_dependency('em-spec', '~> 0.2.5')
+  s.add_development_dependency("eventmachine", "~> 0.12.10")
+  s.add_development_dependency('em-http-request', '~> 0.2.6')
+  s.add_development_dependency('rspec', "~> 2.6.0")
+  s.add_development_dependency('rake')
+end

data/examples/echo.rb

@@ -0,0 +1,8 @@
+require 'lib/em-websocket'
+
+EventMachine::WebSocket.start(:host => "0.0.0.0", :port => 8080, :debug => true) 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.message}" }
+end

data/examples/flash_policy_file_server.rb

@@ -0,0 +1,21 @@
+# Super simple flash policy file server
+# See https://github.com/igrigorik/em-websocket/issues/61
+
+require 'eventmachine'
+
+module FlashPolicy
+  def post_init
+    cross_domain_xml =<<-EOF
+    <cross-domain-policy>
+       <allow-access-from domain="*" to-ports="*" />
+    </cross-domain-policy>  
+    EOF
+
+    send_data cross_domain_xml
+    close_connection_after_writing
+  end
+end
+
+EM.run {
+  EventMachine::start_server '0.0.0.0', 843, FlashPolicy
+}