websocket-rack-noodles 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 831b70dad0a08ddb271e39ddd90aef36cceca285
+  data.tar.gz: 91e6d4ca6818b570e15a8766540dd2bf967e57bc
+SHA512:
+  metadata.gz: 7e887852026879e1d14a17983522acad6fc8c462e72e8afd729163fcde1b1e239dcbbbcabb409d74430fa80edb688c4afd440dc3cc1ff029252304f0ed46ac64
+  data.tar.gz: 1665ccd616fc44176d7253b115fb75710c5752a8b2e6b80a63f8d040ac6d2af14802a49b4c887d71b31c927749be3f51d2ebd170b12effce472477a010fb56ae

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,8 @@
+script: "bundle exec rake spec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree
+  - rbx-18mode
+  # - rbx-19mode

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+# Changelog
+
+## 0.4.0 / 2012-04-16
+
+- require EventMachine ~> 1.0.0.beta.4 (support for old version was to confusing for a lot of users)
+- remove thin-websocket wrapper
+
+## 0.3.3 / 2012-02-16
+
+- postponse sending messages and closing connection to next tick(prevent locking rest of current request)
+- support for WebSocket drafts 09-13 (currently proposed as standard)
+- prevent blocking tests when invalid responsed is received
+
+## 0.3.2 / 2011-12-13
+
+- fix bug that resulted in 'location mismatch' error on Safari and iOS
+
+## 0.3.1 / 2011-07-29
+
+- support for WebSocket drafts 07 and 08
+
+## 0.3.0 / 2011-05-10
+
+- support for WebSocket drafts 05 and 06
+- fix tests in Ruby 1.9.2
+- better documentation
+
+## 0.2.1 / 2011-04-01
+
+- bugfix: env passed to callbacks should be valid now
+
+## 0.2.0 / 2011-04-01
+
+- prepare for supporting server other that thin
+- small changes of API
+- change handling backend options
+- depend on em-websocket instead of copying source
+
+## 0.1.4 / 2011-03-13
+
+- performance improvements thanks to rbtrace
+
+## 0.1.3 / 2011-03-12
+
+- fixed critical bug that duplicated instance variables
+
+## 0.1.2 / 2011-03-08
+
+- change Rack::WebSocket::Application @connection variable name to @conn - first one is to often used to block it
+- allow debugging of WebSocket connection
+
+## 0.1.1 / 2011-03-07
+
+- add missing gem dependencies
+- clear connection inactivity timeout for WebSocket connections
+- inform about bug in EM < 1.0.0
+- add thin-websocket wrapper around thin binary
+
+## 0.1.0 / 2011-03-05
+
+- initial release

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'rake'
+gem 'rspec', '~> 2.4'
+gem 'mocha'

data/README.md

@@ -0,0 +1,196 @@
+# WebSocket Rack
+
+- [![Build Status](https://travis-ci.org/imanel/websocket-rack.png)](http://travis-ci.org/imanel/websocket-rack)
+- [![Dependency Status](https://gemnasium.com/imanel/websocket-rack.png)](http://gemnasium.com/imanel/websocket-rack)
+- [![Code Climate](https://codeclimate.com/github/imanel/websocket-rack.png)](https://codeclimate.com/github/imanel/websocket-rack)
+
+Rack-based WebSocket server
+
+## Usage
+
+Create sample rack config file, and inside build app basing on Rack::WebSocket::Application.
+
+``` ruby
+require 'rack/websocket'
+
+class MyApp < Rack::WebSocket::Application
+end
+
+map '/' do
+  run MyApp.new
+end
+```
+
+After that just run Rack config from Rack server:
+
+``` bash
+thin -R config.ru start
+```
+
+Done.
+
+## Configuration
+
+Rack::WebSocket::Application make following methods available:
+
+### initialize
+
+Called once after server is started. This is place for application configuration so each instance variables from here will be available in whole application.
+
+Example:
+
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def initialize(options = {})
+    super
+    @myvar = 4
+  end
+end
+```
+
+It is important to include 'super' in initialize function, so application will be properly configured.
+
+Please notice that in some servers, when 'initialize' is called, EventMachine reactor is not running yet. If you would like to configure EventMachine-based software, then you need to put it inside 'EM.next_tick' block, so this function will be called in first cycle of reactor.
+
+Example:
+
+``` ruby
+class MyWebSocket < Rack::WebSocket::Application
+  def initialize
+    EM.next_tick { @redis = EM::Hiredis.connect }
+  end
+end
+```
+
+### on_open(env)
+
+Called after client is connected. Rack env of client is passed as attribute.
+
+Example:
+
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def on_open(env)
+    puts "Client connected"
+  end
+end
+```
+
+### on_close(env)
+
+Called after client is disconnected. Rack env of client is passed as attribute.
+
+Example:
+
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def on_close(env)
+    puts "Client disconnected"
+  end
+end
+```
+
+### on_message(env, msg)
+
+Called after server receive message. Rack env of client is passed as attribute.
+
+Example:
+
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def on_message(env, msg)
+    puts "Received message: " + msg
+  end
+end
+```
+
+### on_error(env, error)
+
+Called after server catch error. Variable passed is instance of Ruby Exception class.
+
+Example:
+
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def on_error(env, error)
+    puts "Error occured: " + error.message
+  end
+end
+```
+
+### send_data(data)
+
+Sends data do client.
+
+Example:
+
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def on_open(env)
+    send_data "Hello to you!"
+  end
+end
+```
+
+### close_websocket
+
+Closes connection.
+
+Example:
+
+``` ruby
+class MyApp < Rack::WebSocket::Application
+  def on_open(env)
+    close_websocket if env['REQUEST_PATH'] != '/websocket'
+  end
+end
+```
+
+## Available variables:
+
+### @options
+
+Options passed to app on initialize.
+
+Example:
+
+``` ruby
+# In config.ru
+map '/' do
+  run MyApp.new :some => :variable
+end
+
+# In application instance
+@options # => { :some => :variable }
+```
+
+## FAQ
+
+### Which WebSocket drafts are supported:
+
+Currently we support drafts -75 and -76 form old(hixie) numeration and all drafts from -00 to -13 from current(ietf-hybi) numeration.
+Please note that ietf-hybi-13 is currently proposed as final standard.
+
+### Which Rack servers are supported?
+
+Currently we are supporting following servers:
+
+- Thin
+
+### How to enable debugging?
+
+Just use :backend => { :debug => true } option when initializing your app.
+
+### How to enable wss/SSL support?
+
+Thin v1.2.8 has an --ssl option - just use that! :)
+
+### How to use function xxx?
+
+Check [Thin](http://code.macournoyer.com/thin/) config - any option supported by Thin(like demonizing, SSL etc.) is supported by WebSocket-Rack.
+
+## About
+
+Author: Bernard Potocki <bernard.potocki@imanel.org>
+
+Released under MIT license.

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"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/example/example.ru

@@ -0,0 +1,33 @@
+require './lib/rack/websocket'
+
+class MyApp < Rack::WebSocket::Application
+  def on_open(env)
+    puts "client connected"
+    EM.add_timer(5) do
+      send_data "This message should show-up 5 secs later"
+    end
+
+    EM.add_timer(15) do
+      send_data "This message should show-up 15 secs later"
+    end
+  end
+
+  def on_message(env, msg)
+    puts "message received: " + msg
+    send_data "Message: #{msg}"
+  end
+
+  def on_close(env)
+    puts "client disconnected"
+  end
+end
+
+# use Rack::CommonLogger
+
+map '/' do
+  run Rack::File.new(File.expand_path(File.dirname(__FILE__)) + '/html')
+end
+
+map '/websocket' do
+  run MyApp.new # :backend => { :debug => true }
+end