faye 0.3.4 → 0.5.0

data/History.txt

@@ -1,3 +1,16 @@
+=== 0.5.0 / 2010-07-17 
+
+* Handle multiple event listeners bound to a channel
+* Add extension system for adding domain-specific logic to the protocol
+* Improve handling of client reconnections if the server goes down
+* Change default polling interval to 0 (immediate reconnect)
+* Add support for WebSockets (draft75 only) as a network transport
+* Remove support for Ruby servers other than Thin
+* Make client and server compatible with CometD (1.x and 2.0) components
+* Improve clean-up of unused server-side connections
+* Change Node API for adding Faye service to an HTTP server
+
+
 === 0.3.4 / 2010-06-20
 
 * Stop local clients going into an infinite loop if a subscription block causes a reconnect

data/Manifest.txt

@@ -2,43 +2,26 @@ History.txt
 Manifest.txt
 README.txt
 Rakefile
-jake.yml
-Jakefile
-build/faye.js
-build/faye-client-min.js
-examples/README.rdoc
-examples/shared/public/index.html
-examples/shared/public/favicon.ico
-examples/shared/public/jquery.js
-examples/shared/public/mootools.js
-examples/shared/public/prototype.js
-examples/shared/public/robots.txt
-examples/shared/public/soapbox.js
-examples/shared/public/style.css
-examples/node/app.js
-examples/node/client.js
-examples/node/faye.js
-examples/node/faye-client-min.js
-examples/rack/app.rb
-examples/rack/client.rb
-examples/rack/config.ru
-lib/faye-client-min.js
+lib/faye-browser-min.js
 lib/faye.rb
-lib/faye/channel.rb
-lib/faye/client.rb
-lib/faye/connection.rb
+lib/thin_extensions.rb
+lib/faye/adapters/rack_adapter.rb
+lib/faye/mixins/logging.rb
+lib/faye/mixins/publisher.rb
+lib/faye/mixins/timeouts.rb
+lib/faye/network/transport.rb
+lib/faye/protocol/channel.rb
+lib/faye/protocol/client.rb
+lib/faye/protocol/connection.rb
+lib/faye/protocol/extensible.rb
+lib/faye/protocol/grammar.rb
+lib/faye/protocol/server.rb
+lib/faye/protocol/subscription.rb
+lib/faye/util/namespace.rb
+lib/faye/util/web_socket.rb
 lib/faye/error.rb
-lib/faye/grammar.rb
-lib/faye/logging.rb
-lib/faye/namespace.rb
-lib/faye/rack_adapter.rb
-lib/faye/server.rb
-lib/faye/timeouts.rb
-lib/faye/transport.rb
-test/scenario.js
 test/scenario.rb
 test/test_channel.rb
-test/test_clients.js
 test/test_clients.rb
 test/test_grammar.rb
 test/test_server.rb

data/README.txt

@@ -1,5 +1,6 @@
 = Faye
 
+* http://faye.jcoglan.com
 * http://github.com/jcoglan/faye
 
 Faye is a set of tools for dirt-simple publish-subscribe messaging
@@ -7,292 +8,26 @@ between web clients. It ships with easy-to-use message routing servers
 for Node.js and Rack applications, and clients that can be used on
 the server and in the browser.
 
-
-== Introduction
-
-Faye is an implementation of the Bayeux prototcol (http://svn.cometd.com/trunk/bayeux/bayeux.html),
-a publish-subscribe messaging protocol designed primarily to allow
-client-side JavaScript programs to send messages to each other with
-low latency over HTTP. It also allows for server-side clients that let
-your backend applications push data to the client side.
-
-Bayeux works by letting clients publish and subscribe to named data
-channels. For example, one client may publish a message:
-
-  clientA.publish('/foo', {hello: 'world'});
-
-And another client can subscribe to that channel to receive messages
-that are published to it:
-
-  // alerts "world"
-  clientB.subscribe('/foo', function(message) {
-    alert(message.hello);
-  });
-
-Faye's messaging backend was originally developed in Ruby for a toy
-project of mine, but was not written to scale across multiple processes
-as required for deployment under Passenger. It has since been ported to
-Node.js which is better designed for handling highly concurrent traffic.
-If you use the Ruby version, I recommend deploying it behind Thin, an
-event-driven Ruby web server.
-
-The two backends are architecturally identical, using evented messaging
-throughout and maintaining subscription data in memory. Neither is geared
-up yet for running multi-process servers, but their event-driven setup
-should let them handle more concurrent connections than a typical
-threaded server.
-
-
-== Installation
-
-The JavaScript client and Node.js server are in the +build+ directory. Just
-copy them onto your machine and <tt>require('path/to/faye')</tt>.
-
-The Rack server is distributed as a Ruby gem:
-
-  sudo gem install faye
-
-
-== Using the client
-
-Both backends allow you to specify a 'mount point' that the message server
-accepts requests on. Say you set this to <tt>/faye</tt>, the client script
-will be available from <tt>/faye.js</tt> and should connect to <tt>/faye</tt>.
-
-You should set up the client as follows:
-
-  <script type="text/javascript" src="/faye.js"></script>
-  
-  <script type="text/javascript">
-    fayeClient = new Faye.Client('/faye', {timeout: 120});
-  </script>
-
-The client (and the Node.js and Rack server-side clients) accepts the following
-options in its constructor:
-
-* +timeout+ - the maximum time (seconds) to wait for a connection response
-  from the server before attempting to reconnect. This should be greater than
-  the timeout set up on the server side, the idea being that if the server
-  doesn't send a connection response within this time then there has probably
-  been a network failure and we should reconnect. When the client reconnects,
-  any existing channel subscriptions are re-established automatically.
-
-Take care only to have one instance of the client per page; since each one
-opens a long-running request you will hit the two-requests-per-host limit
-and block all other Ajax calls if you use more than one client.
-
-This client object can be used to publish and subscribe to named channels:
-
-  fayeClient.subscribe('/path/to/channel', function(message) {
-    // process received message object
-  });
-  
-  fayeClient.publish('/some/other/channel', {foo: 'bar'});
-
-You can publish arbitrary JavaScript objects to a channel, and the object will
-be transmitted as the +message+ parameter to any subscribers to that channel.
-Channel names must be formatted as absolute path names as shown. Channels
-beginning with <tt>/meta/</tt> are reserved for use by the messaging protocol
-and may not be subscribed to.
-
-The client can also be used cross-domain if connecting to a backend that
-supports callback polling (see below under 'Transports'). Just pass in the
-full path to the endpoint including the domain. Faye figures out whether the
-server is on the same domain and uses an appropriate transport.
-
-  fayeClient = new Faye.Client('http://example.com/faye');
-
-
-=== Transports
-
-The Bayeux spec defines several transport mechanisms for clients to establish
-low-latency connections with the server, the two required types being
-<tt>long-polling</tt> and <tt>callback-polling</tt>.
-
-<tt>long-polling</tt> is where the client makes an <tt>XMLHttpRequest</tt>
-to the server, and the server waits until it has new messages for that client
-before it returns a response. Faye's client and server backends all support
-this transport. Since it uses XHR, the server endpoint must be on the same
-domain as the client page.
-
-<tt>callback-polling</tt> involves the client using JSON-P to make the request.
-The server wraps its JSON responses in a JavaScript function call that the
-client then executes. This transport does not require the client and server
-to be on the same domain. Faye's client supports this transport, as does the
-Node.js backend. The Rack backend supports it if running under Thin.
-
-Faye also supports an <tt>in-process</tt> transport, which is used when a
-server-side client has direct in-memory access to the server without going
-over HTTP.
-
-
-== Using the backend
-
-Both the Node.js and Rack backends have identical architectures and are
-designed to be easily plugged into other web services. For Rack the adapter
-is explicitly designed as middleware, while for Node.js the adapter is
-a simple object you can manually offload requests to.
-
-The backends provide a service for routing messages between clients; no
-server-side programming is needed to control them, just start them up
-and they'll sit there merrily chewing through requests. They are both
-currently single-process since they hold all channel subscriptions in
-memory. This means, for example, that the Rack backend will not work
-under Passenger since that spawns multiple Ruby processes to serve your
-site.
-
-Faye uses async messaging internally so nothing blocks while waiting for
-new messages. If running under a Ruby web server (except Thin) the server
-will block while waiting for a response from Faye. Thin supports async
-responses and is a better choice for long-running concurrent connections.
-
-Both backends support the following initialization options:
-
-* +mount+ - the path at which the Faye service is accessible. e.g. if
-  set to <tt>/faye</tt>, the Faye endpoint will be at <tt>http://yoursite.com/faye</tt>
-  and the client script at <tt>http://yoursite.com/faye.js</tt>.
-* +timeout+ - the maximum time (seconds) to hold a long-running request
-  open before returning a response. This must be smaller than the timeout
-  on your frontend webserver to make sure Faye sends a response before
-  the server kills the connection.
-
-Regarding the +mount+ parameter: Faye will respond to any path under the
-mount point, so <tt>/faye</tt>, <tt>/faye.js</tt> and <tt>/faye/some/subpath</tt>
-will all be handled by Faye rather than your application. This is so that
-Faye can interoperate with clients that use different URLs for different
-message types.
-
-Usage examples and a demo app are in the +examples+ directory.
-
-
-=== Node.js backend
-
-Here's a very simple Node web server that offloads requests to the messaging
-service to Faye and deals with all other requests itself. The Faye object
-returns +true+ or +false+ to indicate whether it handled the request.
-You'll need <tt>faye.js</tt> and <tt>faye-client-min.js</tt> in the same
-directory.
-
-  var http  = require('http')
-      faye  = require('./faye');
-  
-  var server = new faye.NodeAdapter({mount: '/faye', timeout: 45});
-  
-  http.createServer(function(request, response) {
-    if (server.call(request, response)) return;
-    
-    response.sendHeader(200, {'Content-Type': 'text/plain'});
-    response.write('Hello, non-Faye request!');
-    response.close();
-    
-  }).listen(9292);
-
-
-=== Node.js client
-
-Faye's JavaScript client can be used server-side under Node. There are
-two ways you can set a client up: either connect to as remote server
-over HTTP or connect directly to the <tt>NodeAdapter</tt>. Either way,
-the API for the client is exactly as it is in the browser.
-
-  // Remote client
-  client = new faye.Client('http://example.com/faye', {timeout: 120});
-  
-  // Local client
-  server = new faye.NodeAdapter(options);
-  client = server.getClient();
-
-Note <tt>getClient()</tt> returns the same client object every time you
-call it, so any subscriptions you make with it are retained.
-
-
-=== Rack backend
-
-Faye can be installed as middleware in front of any Rack application. The
-Rack backend uses EventMachine for asynchronous message distribution and
-timeouts. It can run under any web server, though Thin is best placed for
-handling long-running concurrent connections and supports async server
-responses. Under other servers the request thread will block while waiting
-for a response from Faye.
-
-Here's a <tt>config.ru</tt> for running it with Sinatra:
-
-  require 'rubygems'
-  require 'faye'
-  require 'sinatra'
-  require 'path/to/sinatra/app'
-  
-  use Faye::RackAdapter, :mount   => '/faye',
-                         :timeout => 25
-  
-  run Sinatra::Application
-
-This functions much the same as the Node.js example; Faye catches messaging
-requests and deals with them, letting all other requests fall down the
-stack of Rack middlewares.
-
-
-=== Rack client
-
-Again mirroring the Node tools, Faye has a server-side Ruby client that
-can be used under EventMachine. Setup is identical:
-
-  # Remote client
-  client = Faye::Client.new('http://example.com/faye', :timeout => 120)
-  
-  # Local client
-  server = Faye::RackAdapter.new(options)
-  client = server.get_client
-
-Both types of client must be run inside EventMachine, and can publish and
-subscribe just like the JavaScript client:
-
-  EM.run {
-    client.subscribe('/from/*') do |message|
-      # do something with message hash
-    end
-    
-    client.publish('/from/jcoglan', 'hello' => 'world')
-  }
-
-If you're using the <tt>RackAdapter</tt> as middleware and running your app
-using Thin, applications further down the chain can get a client for it from
-the Rack environment, for example in a Sinatra application:
-
-  get '/post' do
-    env['faye.client'].publish('/mentioning/*', {
-      'user' => 'sinatra',
-      'message' => params[:message]
-    })
-    params[:message]
-  end
+See http://faye.jcoglan.com for documentation.
 
 
 == Development
 
-If you want to hack on Faye, you'll need Node.js, Ruby and the following
-gems installed:
-
-  sudo gem install eventmachine em-http-request rack thin json jake hoe
+To hack on Faye, you'll need Ruby and Jake, which we use to build
+the JavaScript packages. Once you have Ruby installed:
 
-DO NOT edit any JavaScript files outside the +javascript+ and +test+
-directories. They are generated using Jake, which you should run after
-editing the JavaScript source.
+  sudo gem install jake
 
-  jake -f
+Just run `jake` from the root of the project to build the JavaScripts.
 
-Ordinarily I would keep generated files out of the repo but I'm keeping
-some in here as it's currently the only place to download them.
+The Ruby version depends on the following gems, which you'll need
+to install:
 
-If you want to submit patches, they're far more likely to make it in
-if you update both the Ruby and JavaScript versions with equivalent
-changes where appropriate.
+  sudo gem install hoe eventmachine em-http-request rack thin json
 
 
 == To-do
 
-* Investigate WebSockets as a possible message transport
-* Support Bayeux extensions for authentication
 * Let local server-side clients listen to <tt>/meta/*</tt> channels
 * Provide support for user-defined <tt>/service/*</tt> channels
 * Allow server to scale to multiple nodes

data/Rakefile

@@ -4,10 +4,10 @@ require 'rubygems'
 require 'hoe'
 require './lib/faye.rb'
 
-Hoe.spec('faye') do |p|
-  # p.rubyforge_name = 'fayex' # if different than lowercase project name
-  p.developer('James Coglan', 'jcoglan@googlemail.com')
-  p.extra_deps = [
+Hoe.spec('faye') do
+  self.developer('James Coglan', 'jcoglan@googlemail.com')
+  self.description = 'Simple pub/sub messaging for the web'
+  self.extra_deps = [
     ['eventmachine', '>= 0.12'],
     ['em-http-request', '>= 0.2'],
     ['rack', '>= 1.0'],

data/lib/faye-browser-min.js

@@ -0,0 +1 @@
+if(!this.Faye)Faye={};Faye.extend=function(a,b,c){if(!b)return a;for(var d in b){if(!b.hasOwnProperty(d))continue;if(a.hasOwnProperty(d)&&c===false)continue;if(a[d]!==b[d])a[d]=b[d]}return a};Faye.extend(Faye,{VERSION:'0.5.0',BAYEUX_VERSION:'1.0',ID_LENGTH:128,JSONP_CALLBACK:'jsonpcallback',CONNECTION_TYPES:['long-polling','callback-polling','websocket'],MANDATORY_CONNECTION_TYPES:['long-polling','callback-polling','in-process'],ENV:(function(){return this})(),random:function(a){a=a||this.ID_LENGTH;if(a>32){var b=Math.ceil(a/32),c='';while(b--)c+=this.random(32);return c}var d=Math.pow(2,a);return Math.floor(Math.random()*d).toString(36)},commonElement:function(a,b){for(var c=0,d=a.length;c<d;c++){if(this.indexOf(b,a[c])!==-1)return a[c]}return null},indexOf:function(a,b){for(var c=0,d=a.length;c<d;c++){if(a[c]===b)return c}return-1},each:function(a,b,c){if(a instanceof Array){for(var d=0,f=a.length;d<f;d++){if(a[d]!==undefined)b.call(c||null,a[d],d)}}else{for(var g in a){if(a.hasOwnProperty(g))b.call(c||null,g,a[g])}}},map:function(a,b,c){var d=[];this.each(a,function(){d.push(b.apply(c||null,arguments))});return d},filter:function(a,b,c){var d=[];this.each(a,function(){if(b.apply(c,arguments))d.push(arguments[0])});return d},size:function(a){var b=0;this.each(a,function(){b+=1});return b},enumEqual:function(c,d){if(d instanceof Array){if(!(c instanceof Array))return false;var f=c.length;if(f!==d.length)return false;while(f--){if(c[f]!==d[f])return false}return true}else{if(!(c instanceof Object))return false;if(this.size(d)!==this.size(c))return false;var g=true;this.each(c,function(a,b){g=g&&(d[a]===b)});return g}},toJSON:function(a){if(this.stringify)return this.stringify(a,function(key,value){return(this[key]instanceof Array)?this[key]:value});return JSON.stringify(a)},timestamp:function(){var b=new Date(),c=b.getFullYear(),d=b.getMonth()+1,f=b.getDate(),g=b.getHours(),h=b.getMinutes(),j=b.getSeconds();var i=function(a){return a<10?'0'+a:String(a)};return i(c)+'-'+i(d)+'-'+i(f)+' '+i(g)+':'+i(h)+':'+i(j)}});Faye.Class=function(a,b){if(typeof a!=='function'){b=a;a=Object}var c=function(){if(!this.initialize)return this;return this.initialize.apply(this,arguments)||this};var d=function(){};d.prototype=a.prototype;c.prototype=new d();Faye.extend(c.prototype,b);return c};Faye.Namespace=Faye.Class({initialize:function(){this._u={}},generate:function(){var a=Faye.random();while(this._u.hasOwnProperty(a))a=Faye.random();return this._u[a]=a}});Faye.Deferrable={callback:function(a,b){if(!a)return;if(this._B==='succeeded')return a.apply(b,this._v);this._9=this._9||[];this._9.push([a,b])},setDeferredStatus:function(){var b=Array.prototype.slice.call(arguments),c=b.shift();this._B=c;this._v=b;if(c!=='succeeded')return;if(!this._9)return;Faye.each(this._9,function(a){a[0].apply(a[1],this._v)},this);this._9=[]}};Faye.Publisher={countSubscribers:function(a){if(!this._2||!this._2[a])return 0;return this._2[a].length},addSubscriber:function(a,b,c){this._2=this._2||{};var d=this._2[a]=this._2[a]||[];d.push([b,c])},removeSubscriber:function(a,b,c){if(!this._2||!this._2[a])return;var d=this._2[a],f=d.length;while(f--){if(b&&d[f][0]!==b)continue;if(c&&d[f][1]!==c)continue;d.splice(f,1)}},publishEvent:function(){var b=Array.prototype.slice.call(arguments),c=b.shift();if(!this._2||!this._2[c])return;Faye.each(this._2[c],function(a){a[0].apply(a[1],b)})}};Faye.Timeouts={addTimeout:function(a,b,c,d){this._6=this._6||{};if(this._6.hasOwnProperty(a))return;var f=this;this._6[a]=setTimeout(function(){delete f._6[a];c.call(d)},1000*b)},removeTimeout:function(a){this._6=this._6||{};var b=this._6[a];if(!b)return;clearTimeout(b);delete this._6[a]}};Faye.Logging={LOG_LEVELS:{error:3,warn:2,info:1,debug:0},logLevel:'error',log:function(a,b){if(!Faye.logger)return;var c=Faye.Logging.LOG_LEVELS;if(c[Faye.Logging.logLevel]>c[b])return;var a=Array.prototype.slice.apply(a),d=' ['+b.toUpperCase()+'] [Faye',f=null,g=a.shift().replace(/\?/g,function(){try{return Faye.toJSON(a.shift())}catch(e){return'[Object]'}});for(var h in Faye){if(f)continue;if(typeof Faye[h]!=='function')continue;if(this instanceof Faye[h])f=h}if(f)d+='.'+f;d+='] ';Faye.logger(Faye.timestamp()+d+g)}};Faye.each(Faye.Logging.LOG_LEVELS,function(a,b){Faye.Logging[a]=function(){this.log(arguments,a)}});Faye.Grammar={LOWALPHA:/^[a-z]$/,UPALPHA:/^[A-Z]$/,ALPHA:/^([a-z]|[A-Z])$/,DIGIT:/^[0-9]$/,ALPHANUM:/^(([a-z]|[A-Z])|[0-9])$/,MARK:/^(\-|\_|\!|\~|\(|\)|\$|\@)$/,STRING:/^(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*$/,TOKEN:/^(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)))+$/,INTEGER:/^([0-9])+$/,CHANNEL_SEGMENT:/^(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)))+$/,CHANNEL_SEGMENTS:/^(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)))+(\/(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)))+)*$/,CHANNEL_NAME:/^\/(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)))+(\/(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)))+)*$/,WILD_CARD:/^\*{1,2}$/,CHANNEL_PATTERN:/^(\/(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)))+)*\/\*{1,2}$/,VERSION_ELEMENT:/^(([a-z]|[A-Z])|[0-9])(((([a-z]|[A-Z])|[0-9])|\-|\_))*$/,VERSION:/^([0-9])+(\.(([a-z]|[A-Z])|[0-9])(((([a-z]|[A-Z])|[0-9])|\-|\_))*)*$/,CLIENT_ID:/^((([a-z]|[A-Z])|[0-9]))+$/,ID:/^((([a-z]|[A-Z])|[0-9]))+$/,ERROR_MESSAGE:/^(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*$/,ERROR_ARGS:/^(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*(,(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*)*$/,ERROR_CODE:/^[0-9][0-9][0-9]$/,ERROR:/^([0-9][0-9][0-9]:(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*(,(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*)*:(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*|[0-9][0-9][0-9]::(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*)$/};Faye.Extensible={addExtension:function(a){this._7=this._7||[];this._7.push(a);if(a.added)a.added()},removeExtension:function(a){if(!this._7)return;var b=this._7.length;while(b--){if(this._7[b]!==a)continue;this._7.splice(b,1);if(a.removed)a.removed()}},pipeThroughExtensions:function(c,d,f,g){if(!this._7)return f.call(g,d);var h=this._7.slice();var j=function(a){if(!a)return f.call(g,a);var b=h.shift();if(!b)return f.call(g,a);if(b[c])b[c](a,j);else j(a)};j(d)}};Faye.Channel=Faye.Class({initialize:function(a){this.id=this.name=a},push:function(a){this.publishEvent('message',a)}});Faye.extend(Faye.Channel.prototype,Faye.Publisher);Faye.extend(Faye.Channel,{HANDSHAKE:'/meta/handshake',CONNECT:'/meta/connect',SUBSCRIBE:'/meta/subscribe',UNSUBSCRIBE:'/meta/unsubscribe',DISCONNECT:'/meta/disconnect',META:'meta',SERVICE:'service',isValid:function(a){return Faye.Grammar.CHANNEL_NAME.test(a)||Faye.Grammar.CHANNEL_PATTERN.test(a)},parse:function(a){if(!this.isValid(a))return null;return a.split('/').slice(1)},isMeta:function(a){var b=this.parse(a);return b?(b[0]===this.META):null},isService:function(a){var b=this.parse(a);return b?(b[0]===this.SERVICE):null},isSubscribable:function(a){if(!this.isValid(a))return null;return!this.isMeta(a)&&!this.isService(a)},Tree:Faye.Class({initialize:function(a){this._4=a;this._a={}},eachChild:function(c,d){Faye.each(this._a,function(a,b){c.call(d,a,b)})},each:function(c,d,f){this.eachChild(function(a,b){a=c.concat(a);b.each(a,d,f)});if(this._4!==undefined)d.call(f,c,this._4)},getKeys:function(){return this.map(function(a,b){return'/'+a.join('/')})},map:function(c,d){var f=[];this.each([],function(a,b){f.push(c.call(d,a,b))});return f},get:function(a){var b=this.traverse(a);return b?b._4:null},set:function(a,b){var c=this.traverse(a,true);if(c)c._4=b},traverse:function(a,b){if(typeof a==='string')a=Faye.Channel.parse(a);if(a===null)return null;if(a.length===0)return this;var c=this._a[a[0]];if(!c&&!b)return null;if(!c)c=this._a[a[0]]=new Faye.Channel.Tree();return c.traverse(a.slice(1),b)},findOrCreate:function(a){var b=this.get(a);if(b)return b;b=new Faye.Channel(a);this.set(a,b);return b},glob:function(f){if(typeof f==='string')f=Faye.Channel.parse(f);if(f===null)return[];if(f.length===0)return(this._4===undefined)?[]:[this._4];var g=[];if(Faye.enumEqual(f,['*'])){Faye.each(this._a,function(a,b){if(b._4!==undefined)g.push(b._4)});return g}if(Faye.enumEqual(f,['**'])){g=this.map(function(a,b){return b});if(this._4!==undefined)g.pop();return g}Faye.each(this._a,function(b,c){if(b!==f[0]&&b!=='*')return;var d=c.glob(f.slice(1));Faye.each(d,function(a){g.push(a)})});if(this._a['**'])g.push(this._a['**']._4);return g},subscribe:function(c,d,f){if(!d)return;Faye.each(c,function(a){var b=this.findOrCreate(a);b.addSubscriber('message',d,f)},this)},unsubscribe:function(a,b,c){var d=this.get(a);if(!d)return false;d.removeSubscriber('message',b,c);return d.countSubscribers('message')===0},distributeMessage:function(b){var c=this.glob(b.channel);Faye.each(c,function(a){a.publishEvent('message',b.data)})}})});Faye.Subscription=Faye.Class({initialize:function(a,b,c,d){this._c=a;this._b=b;this._m=c;this._d=d;this._w=false},cancel:function(){if(this._w)return;this._c.unsubscribe(this._b,this._m,this._d);this._w=true},unsubscribe:function(){this.cancel()}});Faye.Client=Faye.Class({UNCONNECTED:1,CONNECTING:2,CONNECTED:3,DISCONNECTED:4,HANDSHAKE:'handshake',RETRY:'retry',NONE:'none',CONNECTION_TIMEOUT:60.0,DEFAULT_ENDPOINT:'/bayeux',MAX_DELAY:0.1,INTERVAL:0.0,initialize:function(a,b){this.info('New client created for ?',a);this._3=a||this.DEFAULT_ENDPOINT;this._x=b||{};this._f=Faye.Transport.get(this,Faye.MANDATORY_CONNECTION_TYPES);this._1=this.UNCONNECTED;this._h=[];this._b=new Faye.Channel.Tree();this._C=new Faye.Namespace();this._n={};this._8={reconnect:this.RETRY,interval:1000*(this._x.interval||this.INTERVAL),timeout:1000*(this._x.timeout||this.CONNECTION_TIMEOUT)};if(Faye.Event)Faye.Event.on(Faye.ENV,'beforeunload',this.disconnect,this)},handshake:function(b,c){if(this._8.reconnect===this.NONE)return;if(this._1!==this.UNCONNECTED)return;this._1=this.CONNECTING;var d=this;this.info('Initiating handshake with ?',this._3);this._e({channel:Faye.Channel.HANDSHAKE,version:Faye.BAYEUX_VERSION,supportedConnectionTypes:[this._f.connectionType]},function(a){if(a.successful){this._1=this.CONNECTED;this._0=a.clientId;this._f=Faye.Transport.get(this,a.supportedConnectionTypes);this.info('Handshake successful: ?',this._0);this.subscribe(this._b.getKeys());if(b)b.call(c)}else{this.info('Handshake unsuccessful');setTimeout(function(){d.handshake(b,c)},this._8.interval);this._1=this.UNCONNECTED}},this)},connect:function(a,b){if(this._8.reconnect===this.NONE)return;if(this._1===this.DISCONNECTED)return;if(this._1===this.UNCONNECTED)return this.handshake(function(){this.connect(a,b)},this);this.callback(a,b);if(this._1!==this.CONNECTED)return;this.info('Calling deferred actions for ?',this._0);this.setDeferredStatus('succeeded');this.setDeferredStatus('deferred');if(this._o)return;this._o=true;this.info('Initiating connection for ?',this._0);this._e({channel:Faye.Channel.CONNECT,clientId:this._0,connectionType:this._f.connectionType},this._y,this)},disconnect:function(){if(this._1!==this.CONNECTED)return;this._1=this.DISCONNECTED;this.info('Disconnecting ?',this._0);this._e({channel:Faye.Channel.DISCONNECT,clientId:this._0});this.info('Clearing channel listeners for ?',this._0);this._b=new Faye.Channel.Tree()},subscribe:function(c,d,f){if(c instanceof Array)return Faye.each(c,function(channel){this.subscribe(channel,d,f)},this);this._p(c);this.connect(function(){this.info('Client ? attempting to subscribe to ?',this._0,c);this._e({channel:Faye.Channel.SUBSCRIBE,clientId:this._0,subscription:c},function(a){if(!a.successful)return;var b=[].concat(a.subscription);this.info('Subscription acknowledged for ? to ?',this._0,b);this._b.subscribe(b,d,f)},this)},this);return new Faye.Subscription(this,c,d,f)},unsubscribe:function(c,d,f){if(c instanceof Array)return Faye.each(c,function(channel){this.unsubscribe(channel,d,f)},this);this._p(c);var g=this._b.unsubscribe(c,d,f);if(!g)return;this.connect(function(){this.info('Client ? attempting to unsubscribe from ?',this._0,c);this._e({channel:Faye.Channel.UNSUBSCRIBE,clientId:this._0,subscription:c},function(a){if(!a.successful)return;var b=[].concat(a.subscription);this.info('Unsubscription acknowledged for ? from ?',this._0,b)},this)},this)},publish:function(a,b){this._p(a);this.connect(function(){this.info('Client ? queueing published message to ?: ?',this._0,a,b);this._e({channel:a,data:b,clientId:this._0})},this)},receiveMessage:function(c){this.pipeThroughExtensions('incoming',c,function(a){if(!a)return;if(a.advice)this._D(a.advice);var b=this._n[a.id];if(b){delete this._n[a.id];b[0].call(b[1],a)}this._E(a)},this)},_D:function(a){Faye.extend(this._8,a);if(this._8.reconnect===this.HANDSHAKE&&this._1!==this.DISCONNECTED){this._1=this.UNCONNECTED;this._0=null;this._y()}},_E:function(a){if(!a.channel||!a.data)return;this.info('Client ? calling listeners for ? with ?',this._0,a.channel,a.data);this._b.distributeMessage(a)},_F:function(){if(!this._o)return;this._o=null;this.info('Closed connection for ?',this._0)},_y:function(){this._F();var a=this;setTimeout(function(){a.connect()},this._8.interval)},_e:function(b,c,d){b.id=this._C.generate();if(c)this._n[b.id]=[c,d];this.pipeThroughExtensions('outgoing',b,function(a){if(!a)return;if(a.channel===Faye.Channel.HANDSHAKE)return this._f.send(a,this._8.timeout/1000);this._h.push(a);if(a.channel===Faye.Channel.CONNECT)this._q=a;this.addTimeout('publish',this.MAX_DELAY,this._G,this)},this)},_G:function(){this.removeTimeout('publish');if(this._h.length>1&&this._q)this._q.advice={timeout:0};this._q=null;this._f.send(this._h,this._8.timeout/1000);this._h=[]},_p:function(a){if(!Faye.Channel.isValid(a))throw'"'+a+'" is not a valid channel name';if(!Faye.Channel.isSubscribable(a))throw'Clients may not subscribe to channel "'+a+'"';}});Faye.extend(Faye.Client.prototype,Faye.Deferrable);Faye.extend(Faye.Client.prototype,Faye.Timeouts);Faye.extend(Faye.Client.prototype,Faye.Logging);Faye.extend(Faye.Client.prototype,Faye.Extensible);Faye.Transport=Faye.extend(Faye.Class({initialize:function(a,b){this.debug('Created new ? transport for ?',this.connectionType,b);this._c=a;this._3=b},send:function(a,b){a=[].concat(a);this.debug('Client ? sending message to ?: ?',this._c._0,this._3,a);return this.request(a,b)},receive:function(a){this.debug('Client ? received from ?: ?',this._c._0,this._3,a);Faye.each(a,this._c.receiveMessage,this._c)},retry:function(a,b){var c=this;return function(){setTimeout(function(){c.request(a,2*b)},1000*b)}}}),{get:function(d,f){var g=d._3;if(f===undefined)f=this.supportedConnectionTypes();var h=null;Faye.each(this._r,function(a){var b=a[0],c=a[1];if(Faye.indexOf(f,b)<0)return;if(h)return;if(c.isUsable(g))h=c});if(!h)throw'Could not find a usable connection type for '+g;return new h(d,g)},register:function(a,b){this._r.push([a,b]);b.prototype.connectionType=a},_r:[],supportedConnectionTypes:function(){return Faye.map(this._r,function(a){return a[0]})}});Faye.extend(Faye.Transport.prototype,Faye.Logging);Faye.Event={_i:[],on:function(a,b,c,d){var f=function(){c.call(d)};if(a.addEventListener)a.addEventListener(b,f,false);else a.attachEvent('on'+b,f);this._i.push({_j:a,_s:b,_m:c,_d:d,_z:f})},detach:function(a,b,c,d){var f=this._i.length,g;while(f--){g=this._i[f];if((a&&a!==g._j)||(b&&b!==g._s)||(c&&c!==g._m)||(d&&d!==g._d))continue;if(g._j.removeEventListener)g._j.removeEventListener(g._s,g._z,false);else g._j.detachEvent('on'+g._s,g._z);this._i.splice(f,1);g=null}}};Faye.Event.on(Faye.ENV,'unload',Faye.Event.detach,Faye.Event);Faye.URI=Faye.extend(Faye.Class({queryString:function(){var c=[],d;Faye.each(this.params,function(a,b){c.push(encodeURIComponent(a)+'='+encodeURIComponent(b))});return c.join('&')},isLocal:function(){var a=Faye.URI.parse(Faye.ENV.location.href);var b=(a.hostname!==this.hostname)||(a.port!==this.port)||(a.protocol!==this.protocol);return!b},toURL:function(){var a=this.queryString();return this.protocol+this.hostname+':'+this.port+this.pathname+(a?'?'+a:'')}}),{parse:function(d,f){if(typeof d!=='string')return d;var g=new this();var h=function(b,c){d=d.replace(c,function(a){if(a)g[b]=a;return''})};h('protocol',/^https?\:\/+/);h('hostname',/^[^\/\:]+/);h('port',/^:[0-9]+/);Faye.extend(g,{protocol:'http://',hostname:Faye.ENV.location.hostname,port:Faye.ENV.location.port},false);if(!g.port)g.port=(g.protocol==='https://')?'443':'80';g.port=g.port.replace(/\D/g,'');var j=d.split('?'),i=j.shift(),l=j.join('?'),n=l?l.split('&'):[],o=n.length,k={};while(o--){j=n[o].split('=');k[decodeURIComponent(j[0]||'')]=decodeURIComponent(j[1]||'')}if(typeof f==='object')Faye.extend(k,f);g.pathname=i;g.params=k;return g}});Faye.XHR={request:function(a,b,c,d,f){var g=new this.Request(a,b,c,d,f);g.send();return g},getXhrObject:function(){return Faye.ENV.ActiveXObject?new ActiveXObject("Microsoft.XMLHTTP"):new XMLHttpRequest()},Request:Faye.Class({initialize:function(a,b,c,d,f){this._k=a.toUpperCase();this._3=Faye.URI.parse(b,c);this._H=(typeof c==='string')?c:null;this._9=(typeof d==='function')?{success:d}:d;this._d=f||null;this._5=null},send:function(){if(this._t)return;var a=this._3.pathname,b=this._3.queryString();if(this._k==='GET')a+='?'+b;var c=(this._k==='POST')?(this._H||b):'';this._t=true;this._5=Faye.XHR.getXhrObject();this._5.open(this._k,a,true);if(this._k==='POST')this._5.setRequestHeader('Content-Type','application/json');var d=this,f=function(){if(d._5.readyState!==4)return;if(g){clearInterval(g);g=null}Faye.Event.detach(Faye.ENV,'beforeunload',d.abort,d);d._t=false;d._I();d=null};var g=setInterval(f,10);Faye.Event.on(Faye.ENV,'beforeunload',this.abort,this);this._5.send(c)},abort:function(){this._5.abort()},_I:function(){var a=this._9;if(!a)return;return this.success()?a.success&&a.success.call(this._d,this):a.failure&&a.failure.call(this._d,this)},waiting:function(){return!!this._t},complete:function(){return this._5&&!this.waiting()},success:function(){if(!this.complete())return false;var a=this._5.status;return(a>=200&&a<300)||a===304||a===1223},failure:function(){if(!this.complete())return false;return!this.success()},text:function(){if(!this.complete())return null;return this._5.responseText},status:function(){if(!this.complete())return null;return this._5.status}})};if(!this.JSON){JSON={}}(function(){function l(a){return a<10?'0'+a:a}if(typeof Date.prototype.toJSON!=='function'){Date.prototype.toJSON=function(a){return this.getUTCFullYear()+'-'+l(this.getUTCMonth()+1)+'-'+l(this.getUTCDate())+'T'+l(this.getUTCHours())+':'+l(this.getUTCMinutes())+':'+l(this.getUTCSeconds())+'Z'};String.prototype.toJSON=Number.prototype.toJSON=Boolean.prototype.toJSON=function(a){return this.valueOf()}}var n=/[\u0000\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,o=/[\\\"\x00-\x1f\x7f-\x9f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,k,p,s={'\b':'\\b','\t':'\\t','\n':'\\n','\f':'\\f','\r':'\\r','"':'\\"','\\':'\\\\'},m;function r(c){o.lastIndex=0;return o.test(c)?'"'+c.replace(o,function(a){var b=s[a];return typeof b==='string'?b:'\\u'+('0000'+a.charCodeAt(0).toString(16)).slice(-4)})+'"':'"'+c+'"'}function q(a,b){var c,d,f,g,h=k,j,i=b[a];if(i&&typeof i==='object'&&typeof i.toJSON==='function'){i=i.toJSON(a)}if(typeof m==='function'){i=m.call(b,a,i)}switch(typeof i){case'string':return r(i);case'number':return isFinite(i)?String(i):'null';case'boolean':case'null':return String(i);case'object':if(!i){return'null'}k+=p;j=[];if(Object.prototype.toString.apply(i)==='[object Array]'){g=i.length;for(c=0;c<g;c+=1){j[c]=q(c,i)||'null'}f=j.length===0?'[]':k?'[\n'+k+j.join(',\n'+k)+'\n'+h+']':'['+j.join(',')+']';k=h;return f}if(m&&typeof m==='object'){g=m.length;for(c=0;c<g;c+=1){d=m[c];if(typeof d==='string'){f=q(d,i);if(f){j.push(r(d)+(k?': ':':')+f)}}}}else{for(d in i){if(Object.hasOwnProperty.call(i,d)){f=q(d,i);if(f){j.push(r(d)+(k?': ':':')+f)}}}}f=j.length===0?'{}':k?'{\n'+k+j.join(',\n'+k)+'\n'+h+'}':'{'+j.join(',')+'}';k=h;return f}}Faye.stringify=function(a,b,c){var d;k='';p='';if(typeof c==='number'){for(d=0;d<c;d+=1){p+=' '}}else if(typeof c==='string'){p=c}m=b;if(b&&typeof b!=='function'&&(typeof b!=='object'||typeof b.length!=='number')){throw new Error('JSON.stringify');}return q('',{'':a})};if(typeof JSON.stringify!=='function'){JSON.stringify=Faye.stringify}if(typeof JSON.parse!=='function'){JSON.parse=function(g,h){var j;function i(a,b){var c,d,f=a[b];if(f&&typeof f==='object'){for(c in f){if(Object.hasOwnProperty.call(f,c)){d=i(f,c);if(d!==undefined){f[c]=d}else{delete f[c]}}}}return h.call(a,b,f)}n.lastIndex=0;if(n.test(g)){g=g.replace(n,function(a){return'\\u'+('0000'+a.charCodeAt(0).toString(16)).slice(-4)})}if(/^[\],:{}\s]*$/.test(g.replace(/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,'@').replace(/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,']').replace(/(?:^|:|,)(?:\s*\[)+/g,''))){j=eval('('+g+')');return typeof h==='function'?i({'':j},''):j}throw new SyntaxError('JSON.parse');}}}());Faye.WebSocketTransport=Faye.Class(Faye.Transport,{UNCONNECTED:1,CONNECTING:2,CONNECTED:3,request:function(b,c){this._l=this._l||{};Faye.each(b,function(a){this._l[a.id]=a},this);this.withSocket(function(a){a.send(Faye.toJSON(b))})},withSocket:function(d,f){this.callback(d,f);this._1=this._1||this.UNCONNECTED;if(this._1!==this.UNCONNECTED)return;this._1=this.CONNECTING;var g=Faye.URI.parse(this._3).toURL().replace(/^https?/ig,'ws');this._g=new WebSocket(g);var h=this;this._g.onopen=function(){h._1=h.CONNECTED;h.setDeferredStatus('succeeded',h._g)};this._g.onmessage=function(b){var c=[].concat(JSON.parse(b.data));Faye.each(c,function(a){delete h._l[a.id]});h.receive(c)};this._g.onclose=function(){h.setDeferredStatus('deferred');h._1=h.UNCONNECTED;h._g=null;h.resend()}},resend:function(){var c=Faye.map(this._l,function(a,b){return b});this.request(c)}});Faye.extend(Faye.WebSocketTransport.prototype,Faye.Deferrable);Faye.WebSocketTransport.isUsable=function(a){return!!Faye.ENV.WebSocket};Faye.Transport.register('websocket',Faye.WebSocketTransport);Faye.XHRTransport=Faye.Class(Faye.Transport,{request:function(b,c){var d=this.retry(b,c);Faye.XHR.request('post',this._3,Faye.toJSON(b),{success:function(a){try{this.receive(JSON.parse(a.text()))}catch(e){d()}},failure:d},this)}});Faye.XHRTransport.isUsable=function(a){return Faye.URI.parse(a).isLocal()};Faye.Transport.register('long-polling',Faye.XHRTransport);Faye.JSONPTransport=Faye.extend(Faye.Class(Faye.Transport,{request:function(b,c){var d={message:Faye.toJSON(b)},f=document.getElementsByTagName('head')[0],g=document.createElement('script'),h=Faye.JSONPTransport.getCallbackName(),j=Faye.URI.parse(this._3,d),i=this;var l=function(){if(!g.parentNode)return false;g.parentNode.removeChild(g);return true};Faye.ENV[h]=function(a){Faye.ENV[h]=undefined;try{delete Faye.ENV[h]}catch(e){}if(!l())return;i.receive(a)};setTimeout(function(){if(!Faye.ENV[h])return;l();i.request(b,2*c)},1000*c);j.params.jsonp=h;g.type='text/javascript';g.src=j.toURL();f.appendChild(g)}}),{_A:0,getCallbackName:function(){this._A+=1;return'__jsonp'+this._A+'__'}});Faye.JSONPTransport.isUsable=function(a){return true};Faye.Transport.register('callback-polling',Faye.JSONPTransport);

data/lib/faye.rb

@@ -1,32 +1,44 @@
 require 'forwardable'
-require 'observer'
 require 'set'
 require 'rubygems'
 require 'eventmachine'
 require 'json'
 
 module Faye
-  VERSION = '0.3.4'
+  VERSION = '0.5.0'
   
   ROOT = File.expand_path(File.dirname(__FILE__))
   
   BAYEUX_VERSION   = '1.0'
   ID_LENGTH        = 128
   JSONP_CALLBACK   = 'jsonpcallback'
-  CONNECTION_TYPES = %w[long-polling callback-polling]
+  CONNECTION_TYPES = %w[long-polling callback-polling websocket]
   
-  %w[ logging timeouts grammar namespace server
-      channel connection error client transport
+  MANDATORY_CONNECTION_TYPES = %w[long-polling callback-polling in-process]
+  
+  %w[ mixins/publisher
+      mixins/timeouts
+      mixins/logging
+      util/namespace
+      protocol/grammar
+      protocol/extensible
+      protocol/channel
+      protocol/subscription
+      protocol/client
+      protocol/server
+      protocol/connection
+      network/transport
+      error
+      
   ].each do |lib|
     require File.join(ROOT, 'faye', lib)
   end
   
-  autoload :RackAdapter, File.join(ROOT, 'faye', 'rack_adapter')
+  autoload :RackAdapter, File.join(ROOT, 'faye', 'adapters', 'rack_adapter')
+  autoload :WebSocket, File.join(ROOT, 'faye', 'util', 'web_socket')
   
   def self.random(bitlength = ID_LENGTH)
-    field  = 2 ** bitlength
-    strlen = bitlength / 4
-    ("%0#{strlen}s" % rand(field).to_s(16)).gsub(' ', '0')
+    rand(2 ** bitlength).to_s(36)
   end
   
   def self.to_json(value)
@@ -36,5 +48,10 @@ module Faye
       else value.to_s
     end
   end
+  
+  def self.ensure_reactor_running!
+    Thread.new { EM.run } unless EM.reactor_running?
+    while not EM.reactor_running?; end
+  end
 end