Skip to content

Latest commit

 

History

History
97 lines (66 loc) · 3 KB

README.rdoc

File metadata and controls

97 lines (66 loc) · 3 KB
Raw

Faye ↑

Faye is a set of tools for dirt-simple publish-subscribe messaging 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.

See faye.jcoglan.com for documentation.

Questions, issues, ideas ↑

Please raise questions on the mailing list: groups.google.com/group/faye-users, and feel free to announce and share ideas on Faye-related projects here too. I’d appreciate it if we only use the GitHub issue tracker for bona fide bugs; You’ll probably get better and quicker answers to questions from the mailing list.

Development ↑

To hack on Faye, you’ll need Ruby in order to build both the Gem and the NPM package. There are also a few submodules we use for testing. The following should get you up and running:

# Download the code from Git
git clone git://github.com/jcoglan/faye.git
cd faye
git submodule update --init --recursive

# Install dependencies
gem install bundler
bundle install
npm install redis

# Build test tools and Faye itself
cd vendor/js.class
jake
cd ../../
jake

# Run tests
redis-server spec/redis.conf
bundle exec rspec -c spec/
node spec/node.js

# Install Ruby gem
gem build faye.gemspec
gem install faye-x.x.x.gem

# Install NPM package
npm install build

To-do ↑

Notification API:

  • Notify listeners of network drop-out (may be transport dependent)

  • Provide reflection API for internal stats on channels, subscriptions, message queues

  • (Maybe) build a monitoring GUI into the server

Sugar:

  • Add sugar for authentication extensions for protected subscribe + publish

Missing protocol features:

  • Provide support for user-defined /service/* channels

  • Let local server-side clients listen to /meta/* channels

License ↑

(The MIT License)

Copyright © 2009-2011 James Coglan and contributors

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.