em-breakout 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+.rvmrc
+.bundle
+*.gem
+Gemfile.lock
+pkg/*
+features/support/breakout.yml
+features/support/em-breakout.output
+features/support/stats.html

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+gemspec
+gem 'rspec', '2.5.0'
+gem 'cucumber', '>=0.10.0'
+gem 'daemons'
+gem 'breakout', :git => "git://github.com/steve9001/breakout.git"
+gem 'ruby-prof'

data/README.md

@@ -0,0 +1,19 @@
+# EM-Breakout
+
+Breakout is a light framework for routing messages among web browsers and workers using WebSockets.
+
+EM-Breakout uses [EM-WebSocket](https://github.com/igrigorik/em-websocket) to implement a standalone server process that accepts connections from both browsers and workers.
+Whenever a browser sends a message, it will be put on a queue to be read by the next available worker. 
+A simple API lets workers send messages to browsers, disconnect a browser, and be notified when a browser connects or disconnects.
+
+The [breakout](https://github.com/steve9001/breakout) gem provides a module to help create workers along with some example workers and JavaScripts.
+
+## Getting started
+
+Clone the repository and change to the directory. Use [bundler](http://gembundler.com) to install the dependencies, and run cucumber. If that is successful, you can change into the examples directory and run the server script (possibly with 'bundle exec').
+
+Your em-breakout server is now ready to accept connections. Visit the [breakout](https://github.com/steve9001/breakout) page and pick up from there!
+
+## Copyright
+
+Copyright (c) 2011 Steve Masterman. See LICENSE for details.

data/_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Steve Masterman
+
+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/em-breakout.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "em-breakout/version"
+
+Gem::Specification.new do |s|
+  s.name        = "em-breakout"
+  s.version     = EventMachine::Breakout::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Steve Masterman"]
+  s.email       = ["steve@vermonster.com"]
+  s.homepage    = "https://github.com/steve9001/em-breakout"
+  s.summary     = %q{Breakout routes messages among web browsers and workers using WebSockets.}
+  s.description = %q{Breakout routes messages among web browsers and workers using WebSockets.}
+
+  s.rubyforge_project = "em-breakout"
+
+  s.add_dependency 'json', '>=1.4.6'
+  s.add_dependency 'em-websocket', '>=0.2.1'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+end
+
+
+

data/examples/breakout.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'em-breakout'
+
+bdebug = ENV['BDEBUG']
+
+EventMachine::Breakout.start_server(:bdebug => bdebug)

data/features/api.feature

@@ -0,0 +1,101 @@
+Feature: server api
+
+  A worker can send commands to the server 
+
+  Scenario: disconnect
+    Given worker 1 opens a url for work
+    And browser 1 opens a url
+    Then browser 1 should be connected
+    When worker 1 sends disconnect for browser 1
+    Then browser 1 should not be connected
+    And worker 1 should be connected
+
+  Scenario: done work
+    Given worker 1 opens a url for work
+    And browser 1 opens a url
+    When browser 1 sends "one"
+    And browser 1 sends "two"
+    And worker 1 receives a payload
+    Then worker 1 should not have a payload
+    When worker 1 sends done_work
+    And worker 1 receives a payload
+    Then worker 1's payload message should be "two"
+
+  Scenario: done work no requeue
+    Given worker 1 opens a url for work
+    And browser 1 opens a url
+    When browser 1 sends "one"
+    And browser 1 sends "two"
+    And worker 1 receives a payload
+    Then worker 1 should not have a payload
+    When worker 1 sends done_work no requeue
+    Then worker 1 should not have a payload
+    When worker 1 sends done_work
+    And worker 1 receives a payload
+    Then worker 1's payload message should be "two"
+    
+  Scenario: done work no requeue
+    Given worker 1 opens a url for work
+    And worker 2 opens a url for work
+    When browser 1 opens a url
+    And browser 1 sends "one"
+    And worker 1 receives a payload
+    And worker 1 sends done_work
+    And browser 1 sends "two"
+    And browser 1 sends "three"
+    And worker 2 receives a payload
+    Then worker 1 should not have a payload
+    When worker 2 sends done_work no requeue
+    And worker 1 receives a payload
+    Then worker 1's payload message should be "three"
+
+  Scenario: done work disconnected browser
+    Given worker 1 opens a url for work
+    And worker 2 opens a url for work
+    And browser 1 opens a url with notify
+    And worker 1 receives a payload
+    Then worker 1's payload message should be "/open"
+    And browser 1 disconnects
+    Then worker 2 should not have a payload
+    When worker 1 sends done_work
+    And worker 2 receives a payload
+    Then worker 2's payload message should be "/close"
+
+  Scenario: done work disconnected browser
+    Given worker 1 opens a url for work
+    And browser 1 opens a url with notify
+    When browser 1 sends "one"
+    And browser 1 sends "two"
+    And worker 1 receives a payload
+    Then worker 1's payload message should be "/open"
+    And browser 1 disconnects
+    When worker 1 sends done_work
+    And worker 1 receives a payload
+    Then worker 1's payload message should be "/close"
+
+  Scenario: done work disconnected browser
+    Given worker 1 opens a url for work
+    And browser 1 opens a url with notify
+    When browser 1 sends "one"
+    And browser 1 sends "two"
+    And worker 1 receives a payload
+    Then worker 1's payload message should be "/open"
+    When worker 1 sends done_work
+    And worker 1 receives a payload
+    And browser 1 disconnects
+    When worker 1 sends done_work
+    And worker 1 receives a payload
+    Then worker 1's payload message should be "/close"
+
+  Scenario: done work disconnected browser no requeue
+    Given worker 1 opens a url for work
+    And browser 1 opens a url with notify
+    And worker 1 receives a payload
+    Then worker 1's payload message should be "/open"
+    When browser 1 disconnects
+    And worker 2 opens a url for work
+    Then worker 1 should not have a payload
+    And worker 2 should not have a payload
+    When worker 1 sends done_work no requeue
+    And worker 2 receives a payload
+    Then worker 2's payload message should be "/close"

data/features/api_format.feature

@@ -0,0 +1,38 @@
+Feature: server api disconnects on bad message
+
+  Workers must send a json hash
+    Send messages requires 
+
+  Background:
+    Given worker 1 opens a url
+    Then worker 1 should be connected
+
+  Scenario: not json
+    When worker 1 sends_eval "nil"
+    When worker 1 receives a payload
+    Then worker 1's payload should be "message must be JSON encoded"
+    Then worker 1 should not be connected
+
+  Scenario: not dictionary
+    When worker 1 sends_eval "Array.new"
+    When worker 1 receives a payload
+    Then worker 1's payload should be "message must be dictionary"
+    Then worker 1 should not be connected
+    
+  Scenario: send_messages not hash
+    When worker 1 sends_eval "{ :send_messages => Array.new }"
+    When worker 1 receives a payload
+    Then worker 1's payload should be "send_messages must be dictionary"
+    Then worker 1 should not be connected
+
+  Scenario: send_messages keys must be strings
+    When worker 1 sends_eval "{ :send_messages => { 3 => nil } }"
+    When worker 1 receives a payload
+    Then worker 1's payload should be "send_messages keys must be strings and values must be arrays"
+    Then worker 1 should not be connected
+
+  Scenario: send_messages values must be arrays
+    When worker 1 sends_eval "{ :send_messages => { '3' => nil } }"
+    When worker 1 receives a payload
+    Then worker 1's payload should be "send_messages keys must be strings and values must be arrays"
+    Then worker 1 should not be connected

data/features/connect.feature

@@ -0,0 +1,54 @@
+Feature: worker and browser connect
+
+  Workers can connect, disconnect and reconnect with worker url
+  Browsers can connect, disconnect with browser url
+
+  Scenario: worker connects
+    When worker 1 opens a url
+    Then worker 1 should be connected
+
+  Scenario: browser connects to unknown grid
+    When browser 1 opens a url
+    Then browser 1 should not be connected
+
+  Scenario: worker and browser connect
+    When worker 1 opens a url
+    And browser 1 opens a url
+    Then browser 1 should be connected
+    And worker 1 should be connected
+
+  Scenario: worker reconnects
+    When worker 1 opens a url
+    Then worker 1 should be connected
+    When worker 1 disconnects
+    And worker 1 opens a url
+    Then worker 1 should be connected
+
+  Scenario: browser disconnected when worker d/c'd
+    When worker 1 opens a url
+    And browser 1 opens a url
+    Then browser 1 should be connected
+    When worker 1 disconnects
+    Then browser 1 should not be connected
+
+  Scenario: queued browser work is removed when browser d/c's
+    When worker 1 opens a url
+    And browser 1 opens a url
+    And browser 1 sends "one"
+    And browser 1 disconnects
+    When worker 1 sends done_work
+    Then worker 1 should not have a payload
+    When browser 2 opens a url
+    And browser 2 sends "two"
+    And worker 1 receives a payload
+    Then worker 1's payload message should be "two"
+
+  Scenario: browser disconnected when workers d/c'd
+    When worker 1 opens a url
+    And browser 1 opens a url
+    And worker 2 opens a url
+    Then browser 1 should be connected
+    When worker 1 disconnects
+    Then browser 1 should be connected
+    When worker 2 disconnects
+    Then browser 1 should not be connected

data/features/notify.feature

@@ -0,0 +1,19 @@
+Feature: notify
+  In order to know when browsers connect and disconnect
+  The url can include notify=true
+  The server will queue a message "from" the browser
+  The message is either "/open" or "/close"
+
+  Scenario: notify on connect and disconnect
+    Given worker 1 opens a url for work
+    When browser 1 opens a url with notify
+    And worker 1 receives a payload
+    Then worker 1's payload route should be "test"
+    Then worker 1's payload bid should be "1"
+    And worker 1's payload message should be "/open"
+    Given worker 1 sends done_work
+    When browser 1 disconnects
+    And worker 1 receives a payload
+    Then worker 1's payload route should be "test"
+    Then worker 1's payload bid should be "1"
+    Then worker 1's payload message should be "/close"

data/features/performance.feature

@@ -0,0 +1,8 @@
+Feature: test performance
+  see how well it holds up
+
+  Scenario: performance
+    #When 500 grids connect
+    #When 500 workers connect
+    #When 500 browsers connect
+    #When a browser sends 10 messages

data/features/ping.feature

@@ -0,0 +1,21 @@
+Feature: two-way asynchronous message passing
+  
+  A worker connects to the em-breakout server and receives messages sent from the server
+  The messages always originate from a specific browser identified by bid
+  The worker interacts with browsers through a server api, which includes
+    Sending a message to one or more browsers identified by bid
+    Disconnecting one or more browsers from the server
+  The api also includes a the done_work command to inform the server that the browser message is done being processed
+
+  Scenario: browser pings worker
+    When worker 1 opens a url for work
+    And browser 1 opens a url for "ping"
+    When browser 1 sends "ping"
+    And browser 1 sends "ping 2"
+    And worker 1 receives a payload
+    Then worker 1's payload route should be "ping"
+    And worker 1's payload message should be "ping"
+    When worker 1 sends message "pong" to browser 1
+    And browser 1 receives a payload
+    Then browser 1's payload should be "pong"
+

data/features/security.feature

@@ -0,0 +1,47 @@
+Feature: security
+  In order to control access to my workers
+  As a browser url publisher
+  I want my urls to be tamper-proof
+
+  Scenario: unknown grid
+    When browser 1 opens a url
+    And browser 1 receives a payload
+    Then browser 1's payload should be "unknown grid"
+    And browser 1 should be disconnected
+
+  Scenario: bid in use
+    Given worker 1 opens a url
+    When browser 1 opens a url with bid "foo"
+    And browser 2 opens a url with bid "foo"
+    And browser 2 receives a payload
+    Then browser 2's payload should be "bid in use"
+    And browser 2 should be disconnected
+    And browser 1 should be connected
+
+  Scenario: expired link
+    Given worker 1 opens a url
+    When browser 1 opens an expired url
+    And browser 1 receives a payload
+    Then browser 1's payload should be "expired"
+
+  Scenario: Tamper with route
+    Given worker 1 opens a url
+    When browser 1 opens a tampered url
+    And browser 1 receives a payload
+    Then browser 1's payload should be "invalid url"
+
+  Scenario: invalid worker url
+    When worker 1 opens a url without grid
+    And worker 1 receives a payload
+    Then worker 1's payload should be "invalid grid"
+    And worker 1 should be disconnected
+
+  Scenario: grid is taken / wrong grid key
+    When worker 1 opens a url
+    And the grid_key config is changed
+    When worker 2 opens a url
+    And worker 2 receives a payload
+    Then worker 2's payload should be "invalid grid_key"
+    And worker 2 should be disconnected
+    And worker 1 should be connected
+

data/features/serialize.feature

@@ -0,0 +1,17 @@
+Feature: two workers will not get messages from the same browser at the same time
+  In order to keep it simple
+  Messages from a single browser will be queued up
+  And the next message will not be sent to any worker
+  Until the worker receiving the previous message sends done_work
+
+  Scenario: browser sends two messages
+    Given worker 1 opens a url for work
+    And worker 2 opens a url for work
+    When browser 1 opens a url
+    And browser 1 sends "one"
+    And browser 1 sends "two"
+    And worker 1 receives a payload
+    Then worker 2 should not have a payload
+    When worker 1 sends done_work
+    And worker 2 receives a payload
+    Then worker 2's payload message should be "two"

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,155 @@
+When /^worker (\d+) opens a url$/ do |id|
+  @worker_by_id[id] = Breakout::Socket.new(Breakout.worker_url)
+end
+
+When /^browser (\d+) opens a url for "([^"]*)"$/ do |id, route|
+  @browser_by_id[id] = Breakout::Socket.new(Breakout.browser_url(route, :bid => id))
+end
+
+When /^browser (\d+) opens a url with bid "([^"]*)"$/ do |id, bid|
+  @browser_by_id[id] = Breakout::Socket.new(Breakout.browser_url("test", :bid => bid))
+end
+
+When /^browser (\d+) opens a url with notify$/ do |id|
+  @browser_by_id[id] = Breakout::Socket.new(Breakout.browser_url("test", :bid => id, :notify => true))
+end
+
+When /^worker (\d+) opens a url for work$/ do |id|
+  @worker_by_id[id] = Breakout::Socket.new(Breakout.worker_url)
+  @worker_by_id[id].send :done_work => true
+end
+
+When /^browser (\d+) opens a url$/ do |id|
+  When %|browser #{id} opens a url for "test"|
+end
+
+When /^browser (\d+) sends "([^"]*)"$/ do |id, msg|
+  @browser_by_id[id].send(msg)
+end
+
+When /^worker (\d+) receives a payload$/ do |id|
+  Timeout::timeout(0.1) { @worker_payload_by_id[id] = @worker_by_id[id].receive }
+end
+
+Then /^worker (\d+) should not have a payload$/ do |id|
+  ->() do
+    When %|worker #{id} receives a payload|
+  end.should raise_error(Timeout::Error)
+end
+
+Then /^worker (\d+)'s payload route should be "([^"]*)"$/ do |id, route|
+  @worker_payload_by_id[id].split("\n", 3)[0].should == route
+end
+
+Then /^worker (\d+)'s payload message should be "([^"]*)"$/ do |id, msg|
+  @worker_payload_by_id[id].split("\n", 3)[2].should == msg
+end
+
+Then /^worker (\d+)'s payload bid should be "([^"]*)"$/ do |id, msg|
+  @worker_payload_by_id[id].split("\n", 3)[1].should == msg
+end
+
+Then /^worker (\d+)'s payload should be "([^"]*)"$/ do |id, msg|
+  @worker_payload_by_id[id].should == msg
+end
+
+When /^worker (\d+) sends done_work$/ do |id|
+  @worker_by_id[id].send :done_work => true
+end
+
+When /^worker (\d+) sends done_work no requeue$/ do |id|
+  @worker_by_id[id].send :done_work => false
+end
+
+When /^worker (\d+) sends disconnect for browser (\d+)$/ do |id, bid|
+  @worker_by_id[id].send :disconnect => bid
+end
+
+When /^worker (\d+) sends message "([^"]*)" to browser (\d+)$/ do |id, msg, bid|
+  @worker_by_id[id].send :send_messages => { msg => [ bid ] }
+end
+
+When /^browser (\d+) receives a payload$/ do |id|
+  Timeout::timeout(1) { @browser_payload_by_id[id] = @browser_by_id[id].receive }
+end
+
+Then /^browser (\d+)'s payload should be "([^"]*)"$/ do |id, msg|
+  @browser_payload_by_id[id].should == msg
+end
+
+Then /^worker (\d+) should be connected$/ do |id|
+  ->() do
+    Timeout::timeout(0.1) { @worker_by_id[id].receive }
+  end.should raise_error(Timeout::Error)
+end
+
+Then /^browser (\d+) should be connected$/ do |id|
+  ->() do
+    Timeout::timeout(0.1) { @browser_by_id[id].receive }
+  end.should raise_error(Timeout::Error)
+end
+
+Then /^browser (\d+) should not be connected$/ do |id|
+  ->() do
+    Timeout::timeout(0.1) { @browser_by_id[id].receive }
+  end.should_not raise_error(Timeout::Error)
+end
+
+Then /^worker (\d+) should not be connected$/ do |arg1|
+  ->() do
+    Timeout::timeout(0.1) { @worker_by_id[id].receive }
+  end.should_not raise_error(Timeout::Error)
+end
+
+When /^browser (\d+) disconnects$/ do |id|
+  @browser_by_id[id].close
+end
+
+When /^worker (\d+) disconnects$/ do |id|
+  @worker_by_id[id].close
+end
+
+Then /^browser (\d+) should be disconnected$/ do |id|
+  Then "browser #{id} should not be connected"
+end
+
+Then /^worker (\d+) should be disconnected$/ do |id|
+  Then "worker #{id} should not be connected"
+end
+
+When /^browser (\d+) opens an expired url$/ do |id|
+  url = Breakout.browser_url('test', :e => (Time.now - 1).to_i)
+  @browser_by_id[id] = Breakout::Socket.new(url)
+end
+
+When /^browser (\d+) opens a tampered url$/ do |id|
+  url = Breakout.browser_url('REALROUTE').gsub(/REALROUTE/, 'TAMPEREDROUTE')
+  @browser_by_id[id] = Breakout::Socket.new(url)
+end
+
+When /^worker (\d+) opens a url without grid$/ do |id|
+  url = "ws://#{Breakout::CONFIG[:breakout_host]}:#{Breakout::CONFIG[:worker_port]}/?grid_key=#{Breakout::CONFIG[:grid_key]}"
+  @worker_by_id[id] = Breakout::Socket.new(url)
+end
+
+When /^worker (\d+) sends_eval "([^"]*)"$/ do |id, rb|
+  @worker_by_id[id].send eval(rb)
+end
+
+When /^worker (\d+) sends not json$/ do |id|
+  @worker_by_id[id].send nil
+end
+
+When /^worker (\d+) sends not dictionary$/ do |id|
+  @worker_by_id[id].send Array.new
+end
+
+When /^the ([\w]*) config is changed$/ do |option|
+  option = option.to_sym
+  raise option unless Breakout::CONFIG.has_key? option
+  Breakout.config(option => Breakout.random_config[option])
+end
+
+Given /^the server is restarted$/ do
+  restart_server
+end

data/features/step_definitions/performance_steps.rb

@@ -0,0 +1,46 @@
+When /^(\d+) workers connect$/ do |total|
+  total = [1, total.to_i].max
+  i = 0
+  while i < total
+    i += 1
+    @worker_by_id[i] = Breakout::Socket.new(Breakout.worker_url)
+  end
+end
+
+When /^(\d+) browsers connect$/ do |total|
+  total = [1, total.to_i].max
+  i = 0
+  while i < total
+    i += 1
+    @browser_by_id[total] = Breakout::Socket.new(Breakout.browser_url('test'))
+  end
+end
+
+When /^a browser sends (\d+) messages$/ do |total|
+  total = [1, total.to_i].max
+  i = 0
+  @worker_by_id[total] = Breakout::Socket.new(Breakout.worker_url)
+  @browser_by_id[total] = Breakout::Socket.new(Breakout.browser_url('test'))
+  while i < total
+    i += 1
+    @browser_by_id[total].send(i)
+  end
+end
+
+When /^(\d+) grids connect$/ do |total|
+  total = [1, total.to_i].max
+  i = 0
+  while i < total
+    i += 1
+
+    Breakout.config(:grid => i)
+    @worker_by_id[i] = Breakout::Socket.new(Breakout.worker_url)
+    @browser_by_id[i] = Breakout::Socket.new(Breakout.browser_url("test", :bid => i))
+    @browser_by_id[i].send(i)
+    @worker_by_id[i].receive
+    @worker_by_id[i].send :send_messages => { i => [ i.to_s ] }
+    @browser_by_id[i].receive
+  end
+
+  #sleep(10)
+end

data/features/support/em_control

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'daemons'
+require File.expand_path("lib/em-breakout")
+
+options = {
+  :dir_mode => :normal,
+  :dir => File.expand_path('../', __FILE__),
+  :log_output => :true,
+  :app_name => 'em-breakout'
+}
+
+
+breakout_opts = {
+  :worker_port => 8001,
+  :browser_port => 8002,
+  :debug => ENV['EMDEBUG'],
+  :bdebug => ENV['BDEBUG']
+}
+
+Daemons.run_proc('em-breakout', options) do
+
+  if ENV['EMPROFILE']
+    require 'ruby-prof'
+    result = RubyProf.profile { EventMachine::Breakout.start_server(breakout_opts) }
+    printer = RubyProf::GraphHtmlPrinter.new(result)
+    printer.print(File.open(File.expand_path('../stats.html', __FILE__),'w'), :min_percent => 5)
+  else
+    EventMachine::Breakout.start_server(breakout_opts)
+  end
+
+
+end

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'timeout'
+require 'breakout'
+
+breakout_opts = {
+  :worker_port => 8001,
+  :browser_port => 8002
+}
+
+Before do
+  Breakout.config(Breakout.random_config.merge(breakout_opts))
+end

data/features/support/server.rb

@@ -0,0 +1,18 @@
+`rm -f #{File.expand_path('../em-breakout.output', __FILE__)}`
+CONTROL_SCRIPT = File.expand_path('../em_control', __FILE__)
+
+module ServerHelper
+  def restart_server
+    #`#{::CONTROL_SCRIPT} stop ; EMDEBUG=true #{::CONTROL_SCRIPT} start`
+    #`#{::CONTROL_SCRIPT} stop ; BDEBUG=true #{::CONTROL_SCRIPT} start`
+    `#{::CONTROL_SCRIPT} stop ; #{::CONTROL_SCRIPT} start`
+  end
+  module_function :restart_server
+end
+
+World(ServerHelper)
+
+ServerHelper.restart_server
+at_exit do
+  `#{CONTROL_SCRIPT} stop`
+end

data/features/support/socket.rb

@@ -0,0 +1,7 @@
+#WebSocket.debug = true
+Before do
+  @worker_by_id = {}
+  @worker_payload_by_id = Hash.new { |args| [] }
+  @browser_by_id = {}
+  @browser_payload_by_id = Hash.new { |args| [] }
+end

data/lib/em-breakout/browser.rb

@@ -0,0 +1,94 @@
+module EventMachine
+  module Breakout
+    class Browser < Connection
+
+      attr_accessor :wip #true from when a worker gets sent a message until the worker sends :done_work, false all other times
+      attr_reader :bid, #browser id
+        :route, #handler to which worker should route this browser's messages
+        :notify, #whether to send notification to route handler for browser open/close
+        :message_queue #for incoming browser messages waiting to be pulled by a worker
+
+      def breakout(debug=false)
+
+        onopen do
+          @grid_name = request["Path"].split('?').first.gsub('/','')
+          @grid = GRIDS[@grid_name]
+          @route = request["Query"]["route"]
+          @bid = request["Query"]["bid"]
+          @notify = request["Query"]["notify"] == "true" ? true : false
+          @e = request["Query"]["e"].to_i
+          @gat = request["Query"]["gat"]
+
+          log(%|grid_name: #{@grid_name}\nroute: #{@route}\nbid: #{@bid}\ne: #{@e}\n| +
+              %|gat: #{@gat}\nnotify: #{@notify}|) if debug
+
+          catch :break do
+            if !@grid
+              close_websocket "unknown grid"
+              throw :break
+            end
+
+            if @grid.browsers.has_key?(@bid)
+              close_websocket "bid in use"
+              throw :break
+            end
+
+            if @e < Time.now.to_i
+              close_websocket "expired"
+              throw :break
+            end
+            
+            unless @gat == ::Breakout.grid_access_token(@route, @bid, @e, @notify, @grid.grid_key)
+              close_websocket "invalid url"
+              throw :break
+            end
+
+            @message_queue = []
+            @grid.browsers[@bid] = self
+            if @notify
+              @message_queue << "/open"
+              @grid.work_queue[self] = true
+              EventMachine.next_tick { @grid.try_work }
+            end
+          end
+        end
+
+        onmessage do |msg|
+          log("msg: #{msg}") if debug
+
+          unless @is_closing
+
+            if @message_queue.empty? && !@wip
+              @grid.work_queue[self] = true
+              EventMachine.next_tick { @grid.try_work }
+            end
+
+            @message_queue << msg
+          end
+        end 
+
+        onclose do
+          log("closing") if debug
+
+          if @message_queue
+
+            if @notify
+              @grid.disconnected_browsers[@bid] = self
+              @message_queue = ["/close"]
+              unless @wip
+                @grid.work_queue[self] = true
+                EventMachine.next_tick { @grid.try_work }
+              end
+            else
+              @grid.work_queue.delete self
+            end
+          end
+        end
+
+        onerror do |reason|
+          log reason.pretty
+        end
+      end
+    end
+  end
+end

data/lib/em-breakout/connection.rb

@@ -0,0 +1,28 @@
+module EventMachine
+  module Breakout
+    class Connection < EventMachine::WebSocket::Connection
+      @@connection_counter = 0
+
+      attr_reader :grid_name, #public name of worker-browser group
+                  :grid, #Grid instance
+                  :is_closing #close_websocket has been invoked
+
+      def cid
+        @cid ||= @@connection_counter += 1
+      end
+
+      def close_websocket(msg=nil)
+        unless @is_closing
+          @is_closing = true
+          send(msg) if msg
+          super()
+        end
+      end
+
+      def log(msg)
+        puts "** #{self.class.name.split('::').last} #{cid} ********** \n#{msg}\n\n\n"
+      end
+
+    end
+  end
+end

data/lib/em-breakout/exception.rb

@@ -0,0 +1,10 @@
+class Exception
+  def pretty
+    begin
+      %Q[\n#{self.class} (#{self.message}):\n    #{backtrace.join("\n    ")}\n]
+    rescue Exception => e
+      "error in Exception#pretty: #{e}"
+    end
+  end
+end
+

data/lib/em-breakout/grid.rb

@@ -0,0 +1,44 @@
+module EventMachine
+  module Breakout
+
+    GRIDS = Hash.new # grid_name => grid
+
+    class Grid
+
+      attr_reader :grid_key, :workers, :browsers, :disconnected_browsers, :work_queue, :worker_queue
+
+      def initialize(worker)
+        @browsers = Hash.new # bid => browser
+        @disconnected_browsers = Hash.new # bid => browser
+        @workers = Hash.new  # worker => true
+        @work_queue = Hash.new   # browser => true
+        @worker_queue = Hash.new # worker => true
+        @grid_key = worker.request["Query"]["grid_key"]
+        @name = worker.grid_name
+        GRIDS[@name] = self
+      end
+
+      def release
+        GRIDS.delete @name
+        @browsers.each_value { |browser| browser.close_websocket }
+        @worker_queue = {}
+      end
+      
+      def try_work
+        return if @work_queue.empty?
+        return if @worker_queue.empty?
+
+        browser = @work_queue.shift.first
+
+        msg = browser.message_queue.shift
+        return unless msg
+
+        worker = @worker_queue.shift.first
+
+        browser.wip = true
+        worker.browser = browser
+        worker.send("#{browser.route}\n#{browser.bid}\n#{msg}")
+      end
+    end
+  end
+end

data/lib/em-breakout/server.rb

@@ -0,0 +1,29 @@
+# adapted from https://github.com/igrigorik/em-websocket/blob/866290409c35b1557017fac3c12b701af71f8d2d/lib/em-websocket/websocket.rb
+module EventMachine
+  module Breakout
+
+    def self.start_server(opts={})
+      browser_port = opts[:browser_port] || 9002
+      worker_port = opts[:worker_port] || 9001
+      debug = opts[:bdebug]
+
+      EM.epoll
+
+      EventMachine::run do
+
+        trap("TERM") { EventMachine.stop }
+        trap("INT")  { EventMachine.stop }
+
+        EventMachine::start_server('0.0.0.0', browser_port, Browser, opts) do |browser|
+          browser.breakout debug
+        end
+
+        EventMachine::start_server('0.0.0.0', worker_port, Worker, opts) do |worker|
+          worker.breakout debug
+        end
+
+      end
+    end
+
+  end
+end

data/lib/em-breakout/version.rb

@@ -0,0 +1,5 @@
+module EventMachine
+  module Breakout
+    VERSION = "0.0.1"
+  end
+end

data/lib/em-breakout/worker.rb

@@ -0,0 +1,136 @@
+module EventMachine
+  module Breakout
+    class Worker < Connection
+
+      attr_accessor :browser
+
+      def breakout(debug=false)
+
+        onopen do
+          @grid_name = request["Path"].split('?').first.gsub('/','')
+          @grid_key = request["Query"]["grid_key"]
+
+          log(%|grid: #{@grid_name}\ngrid_key: #{@grid_key}|) if debug
+
+          catch :break do
+            unless @grid_name && @grid_name.length > 0 && @grid_key && @grid_key.length > 0
+              close_websocket "invalid grid"
+              throw :break
+            end
+
+            if @grid = GRIDS[@grid_name]
+              unless @grid.grid_key == @grid_key
+                close_websocket "invalid grid_key"
+                throw :break
+              end
+            else
+              @grid = Grid.new(self)
+            end
+            
+            @grid.workers[self] = true
+          end
+        end
+
+        onmessage do |msg|
+          log("msg: #{msg}") if debug
+
+          catch :break do
+            throw :break if @is_closing
+
+            begin
+              payload = JSON.parse(msg)
+            rescue JSON::ParserError
+              close_websocket "message must be JSON encoded"
+              throw :break
+            end
+
+            unless payload.is_a? Hash
+              close_websocket "message must be dictionary"
+              throw :break
+            end
+
+            send_messages = payload['send_messages']
+            if send_messages
+              unless send_messages.is_a? Hash
+                close_websocket "send_messages must be dictionary"
+                throw :break
+              end
+
+              send_messages.each_pair do |message, bids|
+                unless message.is_a?(String) && bids.is_a?(Array)
+                  close_websocket "send_messages keys must be strings and values must be arrays"
+                  throw :break
+                end
+                message_string = "#{message}"
+                bids.each do |bid|
+                  next unless b = @grid.browsers[bid]
+                  b.send(message_string) unless b.is_closing
+                end
+              end
+            end
+
+            disconnect = payload['disconnect']
+            if disconnect && b = @grid.browsers[disconnect]
+              b.close_websocket
+            end
+
+            requeue = payload['done_work']
+            unless requeue.nil?
+              next_tick = false
+              if @browser
+                @browser.wip = false
+                if @grid.browsers.include?(@browser.bid)
+                  unless @browser.message_queue.empty? or @browser.is_closing 
+                    @grid.work_queue[@browser] = true
+                    EventMachine.next_tick { @grid.try_work }
+                    next_tick = true
+                  end
+                elsif @grid.disconnected_browsers.include?(@browser.bid)
+                  if @browser.message_queue.any?
+                    @grid.work_queue[@browser] = true
+                    unless next_tick
+                      EventMachine.next_tick { @grid.try_work }
+                      next_tick = true
+                    end
+                  else
+                    @grid.disconnected_browsers.delete @browser.bid
+                  end
+                end
+                @browser = nil
+              end
+              if requeue
+                @grid.worker_queue[self] = true
+                EventMachine.next_tick { @grid.try_work } unless next_tick
+              end
+            end
+          end
+        end 
+
+        onclose do
+          log("closing") if debug
+
+          catch :break do
+            throw :break unless @grid
+            throw :break unless @grid.workers.delete self
+
+            if @grid.workers.empty?
+              @grid.release
+              throw :break
+            end
+
+            @grid.worker_queue.delete self
+            if b = @grid.browsers[@browser]
+              b.close_websocket
+            end
+
+          end
+        end
+
+        onerror do |reason|
+          log reason.pretty
+        end
+      end
+
+    end
+  end
+end

data/lib/em-breakout.rb

@@ -0,0 +1,11 @@
+require 'digest'
+require 'json'
+require 'breakout'
+require 'em-websocket'
+require 'em-breakout/exception'
+require 'em-breakout/connection'
+require 'em-breakout/browser'
+require 'em-breakout/worker'
+require 'em-breakout/grid'
+require 'em-breakout/server'
+require 'em-breakout/version'

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: em-breakout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Steve Masterman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-05-01 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &81638730 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *81638730
+- !ruby/object:Gem::Dependency
+  name: em-websocket
+  requirement: &81638310 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *81638310
+description: Breakout routes messages among web browsers and workers using WebSockets.
+email:
+- steve@vermonster.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- _LICENSE
+- em-breakout.gemspec
+- examples/breakout.rb
+- features/api.feature
+- features/api_format.feature
+- features/connect.feature
+- features/notify.feature
+- features/performance.feature
+- features/ping.feature
+- features/security.feature
+- features/serialize.feature
+- features/step_definitions/common_steps.rb
+- features/step_definitions/performance_steps.rb
+- features/support/em_control
+- features/support/env.rb
+- features/support/server.rb
+- features/support/socket.rb
+- lib/em-breakout.rb
+- lib/em-breakout/browser.rb
+- lib/em-breakout/connection.rb
+- lib/em-breakout/exception.rb
+- lib/em-breakout/grid.rb
+- lib/em-breakout/server.rb
+- lib/em-breakout/version.rb
+- lib/em-breakout/worker.rb
+has_rdoc: true
+homepage: https://github.com/steve9001/em-breakout
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: em-breakout
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Breakout routes messages among web browsers and workers using WebSockets.
+test_files: []