websocket-rack 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 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/README.md

@@ -95,6 +95,23 @@ Rack env - contain all data sent by client when connectind.
 
 Thin wrapper between client and EventMachine::Connection
 
+## FAQ
+
+### Which Rack servers are supported?
+
+Currently only Thin. I plan to support also Rainbows! in future, but not yet.
+
+### Why (using Thin) user is disconnected after 30 seconds?
+
+This is bug in EventMachine < 1.0.0. Please consider updating to newer version or use thin-websocket wrapper around thin binary.
+
+### How to enable wss/SSL support?
+
+Thin v1.2.8 have --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
 

data/bin/thin-websocket

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# Modified Thin command line interface script.
+# This is fallback for WebSocket-Rack.
+# Use it when you have EventMachine version < 1.0.0
+# Rationale:
+#   Older versions of EM have bug that prevent to
+#   clearing connection inactivity once it's set.
+#   This one will set connection timeout to 0 at
+#   default, so there will be no need to overwrite it.
+#   Be aware that this will also change inactivity
+#   timeout for "normal" connection, so it will be
+#   easy to make DoS attack.
+
+require 'rubygems'
+require 'thin'
+
+if EM::VERSION < "1.0.0"
+  begin
+    old_verbose, $VERBOSE = $VERBOSE, nil
+    ::Thin::Server.const_set 'DEFAULT_TIMEOUT', 0
+  ensure
+    $VERBOSE = old_verbose
+  end
+end
+
+Thin::Runner.new(ARGV).run!

data/lib/rack/websocket/connection.rb

@@ -12,6 +12,13 @@ module Rack
         @debug = options[:debug] || false
 
         socket.websocket = self
+        socket.comm_inactivity_timeout = 0
+
+        if socket.comm_inactivity_timeout != 0
+          puts "WARNING: You are using old EventMachine version. " +
+               "Please consider updating to EM version >= 1.0.0 " +
+               "or running Thin using thin-websocket."
+        end
 
         debug [:initialize]
       end

data/lib/rack/websocket.rb

@@ -2,7 +2,7 @@ require 'rack'
 
 module Rack
   module WebSocket
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
     ROOT_PATH = ::File.expand_path(::File.dirname(__FILE__))
 
     class WebSocketError < RuntimeError; end

data/websocket-rack.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |s|
   s.description = %q{Rack-based WebSocket server}
 
   s.add_dependency 'rack'
+  s.add_dependency 'addressable', '>= 2.1.1'
+  s.add_dependency 'eventmachine', '>= 0.12.9'
   s.add_dependency 'thin'
   s.add_development_dependency 'rspec', '~> 2.4.0'
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: websocket-rack
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Bernard Potocki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-05 00:00:00 +01:00
+date: 2011-03-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,9 +33,41 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: thin
+  name: addressable
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 0
+        - 12
+        - 9
+        version: 0.12.9
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: thin
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -45,11 +77,11 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -61,21 +93,23 @@ dependencies:
         - 0
         version: 2.4.0
   type: :development
-  version_requirements: *id003
+  version_requirements: *id005
 description: Rack-based WebSocket server
 email: 
 - bernard.potocki@imanel.org
-executables: []
-
+executables: 
+- thin-websocket
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
+- bin/thin-websocket
 - example/example.ru
 - example/html/FABridge.js
 - example/html/WebSocketMain.swf
@@ -134,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: Rack-based WebSocket server