socket.io 0.0.1 → 0.0.2

data/README.markdown

@@ -1,8 +1,64 @@
-= socket.io-ruby
+# socket.io-ruby
 
-Description goes here.
+[Socket.io] for the Ruby Kids. A plugin for [Cramp](http://cramp.in/). Socket.io is a library that makes writing cross-borwser websockets super easy and resilient.
 
-== Note on Patches/Pull Requests
+## Usage
+
+This implementation Socket.io works within an existing [cramp](http://cramp.in/) app. 
+Cramp is similar in spirit to Rails but specializes in evented web apps. Simply 
+`gem install cramp` and run `cramp new myapp`.
+
+Define a new Cramp::Action and include SocketIo::Websocket. Then define which 
+method should handle certain events and messages.
+
+    # app/actions/akbar_action.rb
+    
+    class AkbarAction < Cramp::Websocket
+      include SocketIo::Websocket
+
+      on :message, :read_message
+      on :trap, :report_trap
+      
+      # This is fired when the client sends a standard 
+      # Socket.io message
+      def read_message(data)
+        puts "Our Bothan spies report #{data}"
+      end
+      
+      def report_trap(imperial_fleet)
+        puts "It's a trap!"
+        puts "Concentrate all firepower on #{imperial_fleet['super_stardestroyer']}"
+        return { 'move' => 'sector 227' }
+      end
+    end
+
+By default, Cramp uses HttpRouter in config/routes.rb to manage connections. SocketIo has a handy helper for that:
+
+    # config/routes.rb
+    
+    require 'socket.io'
+    require 'http_router'
+    
+    HttpRouter.new do
+      SocketIo.routes self, AkbarAction
+    end
+
+Optionally, SocketIo.routes can take a path. The default is `/socket.io`.
+
+Throw that in with some [Thin](http://code.macournoyer.com/thin/) or [Rainbows](http://rainbows.rubyforge.org), and you've got yourself a websocket server! Here's the client-side code to make it all happen:
+
+    <script type="text/javascript" src="socket.io-client.js"></script>
+    <script type="text/javascript">
+      var socket = io.connect('http://localhost/socket.io');
+      socket.on('connect', function () {
+        socket.send('the Emperor is building a new Death Star');
+        socket.emit('trap', { 'super_stardestroyer': 'Executor' }, function(instructions) {
+          alert('moving to ' + instructions['move']);
+        });
+      });
+    </script>
+
+## Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -12,6 +68,6 @@ Description goes here.
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Copyright
+## Copyright
 
 Copyright (c) 2011 Derek Kastner. See LICENSE for details.

data/lib/socket.io.rb

@@ -1,6 +1,17 @@
 require 'socket.io/packet'
 require 'socket.io/websocket'
+require 'socket.io/actions'
 
 module SocketIo
+  extend self
+
+  def routes(router, handler, path = '/socket.io')
+    router.add("#{path}/:protocol_version").to(HandshakeAction)
+    router.add("#{path}/:protocol_version/websocket/:session_id").to(handler)
+    #router.add("#{path}/:protocol_version/flashsocket/:session_id").to(ImpactAction)
+    #router.add("#{path}/:protocol_version/xhr-polling/:session_id").to(ImpactXhrPollingAction)
+    #router.add("#{path}/:protocol_version/xhr-polling/:session_id/:verified").to(ImpactXhrPollingAction)
+    #router.add("#{path}/:protocol_version/xhr-polling/:session_id/send").to(ImpactXhrPollingAction)
+  end
 end
 

data/lib/socket.io/actions.rb

@@ -0,0 +1 @@
+require 'socket.io/actions/handshake_action'

data/lib/socket.io/actions/handshake_action.rb

@@ -0,0 +1,23 @@
+require 'cramp'
+require 'uuid'
+
+class HandshakeAction < Cramp::Action
+  HEARTBEAT_TIMEOUT = 27
+  CLOSING_CONNECTION_TIMEOUT = 10
+  #TRANSPORTS = 'websocket,xhr-polling,flashsocket'
+  TRANSPORTS = 'websocket'
+
+  def uuid
+    @uuid ||= UUID.new
+  end
+
+  def session_id
+    uuid.generate
+  end
+
+  def start
+    body = [session_id, HEARTBEAT_TIMEOUT, CLOSING_CONNECTION_TIMEOUT, TRANSPORTS].join(':')
+    render body
+    finish
+  end
+end

data/lib/socket.io/version.rb

@@ -1,3 +1,3 @@
 module SocketIo
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/socket.io.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.name = 'socket.io'
   s.version = SocketIo::VERSION
   s.platform = Gem::Platform::RUBY
-  s.date = '2011-11-21'
+  s.date = "2011-11-22"
   s.authors = ['Derek Kastner']
   s.email = 'dkastner@gmail.com'
   s.homepage = 'http://github.com/dkastner/socket.io-ruby'
@@ -27,9 +27,11 @@ Gem::Specification.new do |s|
 
 
   s.add_dependency 'cramp', '~> 0.15.1'
+  s.add_dependency 'uuid'
 
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'bueller'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rcov'
+  s.add_development_dependency 'rspec'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: socket.io
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-21 00:00:00.000000000Z
+date: 2011-11-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cramp
-  requirement: &2165211900 !ruby/object:Gem::Requirement
+  requirement: &2166458340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: 0.15.1
   type: :runtime
   prerelease: false
-  version_requirements: *2165211900
+  version_requirements: *2166458340
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2165211100 !ruby/object:Gem::Requirement
+  name: uuid
+  requirement: &2166457160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2166457160
+- !ruby/object:Gem::Dependency
+  name: bueller
+  requirement: &2166455480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165211100
+  version_requirements: *2166455480
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2165210000 !ruby/object:Gem::Requirement
+  requirement: &2166453420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165210000
+  version_requirements: *2166453420
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2165203780 !ruby/object:Gem::Requirement
+  requirement: &2166452800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165203780
+  version_requirements: *2166452800
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2165202980 !ruby/object:Gem::Requirement
+  requirement: &2166451400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2166451400
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2166450040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165202980
+  version_requirements: *2166450040
 description: A plugin for Cramp that enables websockets using the Socket.io protocol
 email: dkastner@gmail.com
 executables: []
@@ -81,6 +103,8 @@ files:
 - README.markdown
 - Rakefile
 - lib/socket.io.rb
+- lib/socket.io/actions.rb
+- lib/socket.io/actions/handshake_action.rb
 - lib/socket.io/packet.rb
 - lib/socket.io/packet/ack_packet.rb
 - lib/socket.io/packet/connect_packet.rb
@@ -112,6 +136,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4017494604457113772
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: