Cis Rails Chat

Refrence gem: Private pub

Cis Rails Chat is a Ruby gem for use with Rails to publish and subscribe to messages through Faye. It allows you to easily provide real-time updates through an open socket without tying up a Rails process. All channels are private so users can only listen to events you subscribe them to.

Setup

Add the gem to your Gemfile and run the bundle command to install it.

gem "cis_rails_chat"

Run the generator to create the initial files.

rails g cis_rails_chat:install

Next, start up Faye using the rackup file that was generated.

rackup cis_rails_chat.ru -s thin -E production

In Rails 3.1 add the JavaScript file to your application.js file manifest. 

//= require cis_rails_chat

The other emoticons js are rendered in the assests via generator. If you are not using the require_tree . then please add emoticons JavaScript to your application.js file manifest.

//= require emoticons
//= require emoticons_defination

In Rails 3.0 add the generated cis_rails_chat.js,emoticons.js,emoticons_defination files to your layout.

<%= javascript_include_tag "cis_rails_chat","emoticons","emoticons_defination" %>

In Rails 3.1 add the emoticons StyleSheet file to your application.css file manifest.

The emoticons css is rendered to your assests via generator. If you are not using the require_tree . then please add emoticons StyleSheet to your application.css file manifest.

*= require emoticons

In Rails 3.0 add the generated cis_rails_chat.js file to your layout.

<%= stylesheet_include_tag "emoticons" %>

It's not necessary to include faye.js since that will be handled automatically for you.

Serving Faye over HTTPS (with Thin)

To server Faye over HTTPS you could create a thin configuration file config/cis_rails_chat_thin.yml similar to the following:

---
port: 4443
ssl: true
ssl_key_file: /path/to/server.pem
ssl_cert_file: /path/to/certificate_chain.pem
environment: production
rackup: cis_rails_chat.ru

The certificate_chain.pem file should contain your signed certificate, followed by intermediate certificates (if any) and the root certificate of the CA that signed the key.

Next reconfigure the URL in config/cis_rails_chat.yml to look like https://your.hostname.com:4443/faye

Finally start up Thin from the project root.

thin -C config/cis_rails_chat_thin.yml start

Usage

Use the subscribe_to helper method on any page to subscribe to a channel.

<%= subscribe_to "/messages/new" %>

Use the publish_to helper method to send JavaScript to that channel. This is usually done in a JavaScript AJAX template (such as a create.js.erb file).

<% publish_to "/messages/new" do %>
  $("#chat").append("<%= j render(@messages) %>");
<% end %>

This JavaScript will be immediately evaluated on all clients who have subscribed to that channel. In this example they will see the new chat message appear in real-time without reloading the browser.

Alternative Usage

If you prefer to work through JSON instead of .js.erb templates, you can pass a hash to publish_to instead of a block and it will be converted to_json behind the scenes. This can be done anywhere (such as the controller).

CisRailsChat.publish_to "/messages/new", :chat_message => "Hello, world!"

And then handle this through JavaScript on the client side.

CisRailsChat.subscribe("/messages/new", function(data, channel) {
  $("#chat").append($.emoticons.replace(data.chat_message));
});

The Ruby subscribe_to helper call is still necessary with this approach to grant the user access to the channel. The JavaScript is just a callback for any custom behavior.

NOTE: To use the emoticons in your chat you have to pass your message like $.emoticons.replace(data.chat_message). This line will convert the emoticons signs into the real emoticons.

Configuration

The configuration is set separately for each environment in the generated config/cis_rails_chat.yml file. Here are the options.

  • server: The URL to use for the Faye server such as http://localhost:9292/faye.
  • secret_token: A secret hash to secure the server. Can be any string.
  • signature_expiration: The length of time in seconds before a subscription signature expires. If this is not set there is no expiration. Note: if Faye is on a separate server from the Rails app, the system clocks must be in sync for the expiration to work properly.

How It Works

The subscribe_to helper will output the following script which subscribes the user to a specific channel and server.

<script type="text/javascript">
  CisRailsChat.sign({
    channel: "/messages/new",
    timestamp: 1302306682972,
    signature: "dc1c71d3e959ebb6f49aa6af0c86304a0740088d",
    server: "http://localhost:9292/faye"
  });
</script>

The signature and timestamp checked on the Faye server to ensure users are only able to access channels you subscribe them to. The signature will automatically expire after the time specified in the configuration.

The publish_to method will send a post request to the Faye server (using Net::HTTP) instructing it to send the given data back to the browser.

Development & Feedback

Questions or comments? Please use the issue tracker. Tests can be run with bundle and rake commands.