rails_chat 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Ryan Bates
+
+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/README.md

@@ -0,0 +1,155 @@
+# RailsChat
+Refrence gem: [Private pub](https://github.com/ryanb/private_pub)
+
+RailsChat is a Ruby gem for use with Rails to publish and subscribe to messages through [Faye](http://faye.jcoglan.com/). 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.
+
+```ruby
+gem "rails_chat"
+```
+
+Run the generator to create the initial files.
+
+```
+rails g rails_chat:install
+```
+
+Next, start up Faye using the rackup file that was generated.
+
+```
+rackup rails_chat.ru -s thin -E production
+```
+
+**In Rails 3.1** add the JavaScript file to your application.js file manifest. 
+
+```javascript
+//= require 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.
+
+```javascript
+//= require emoticons
+//= require emoticons_defination
+```
+
+**In Rails 3.0** add the generated rails_chat.js,emoticons.js,emoticons_defination files to your layout.
+
+```rhtml
+<%= javascript_include_tag "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.
+
+```stylesheet
+*= require emoticons
+```
+
+**In Rails 3.0** add the generated rails_chat.js file to your layout.
+
+```rhtml
+<%= 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/rails_chat_thin.yml` similar to the following:
+
+```yaml
+---
+port: 4443
+ssl: true
+ssl_key_file: /path/to/server.pem
+ssl_cert_file: /path/to/certificate_chain.pem
+environment: production
+rackup: 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/rails_chat.yml` to look like `https://your.hostname.com:4443/faye`
+
+Finally start up Thin from the project root.
+
+```
+thin -C config/rails_chat_thin.yml start
+```
+
+## Usage
+
+Use the `subscribe_to` helper method on any page to subscribe to a channel.
+
+```rhtml
+<%= 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).
+
+```rhtml
+<% 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).
+
+```ruby
+RailsChat.publish_to "/messages/new", :chat_message => "Hello, world!"
+```
+
+And then handle this through JavaScript on the client side.
+
+```javascript
+RailsChat.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/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.
+
+```html
+<script type="text/javascript">
+  RailsChat.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](https://github.com/ciserfan/rails_chat/issues). Tests can be run with `bundle` and `rake` commands.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+require 'jasmine'
+load 'jasmine/tasks/jasmine.rake'
+
+desc "Run RSpec"
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+end
+
+task :default => [:spec, "jasmine:ci"]

data/app/assets/javascripts/emoticons.js

@@ -0,0 +1,127 @@
+(function($, exports, window, name) {
+
+if (!exports) {
+    exports = {};
+
+    if ($) {
+        $[name] = exports;
+    } else {
+        window[name] = exports;
+    }
+}
+
+var emoticons,
+    codesMap = {},
+    primaryCodesMap = {},
+    regexp,
+    metachars = /[[\]{}()*+?.\\|^$\-,&#\s]/g,
+    entityMap;
+
+entityMap = {
+    '&': '&',
+    '<': '&lt;',
+    '>': '&gt;',
+    '"': '&quot;',
+    "'": '&#39;',
+    '/': '&#x2F;'
+};
+
+function escape(string) {
+    return String(string).replace(/[&<>"'\/]/g, function(s) {
+        return entityMap[s];
+    });
+}
+
+/**
+ * Define emoticons set.
+ *
+ * @param {Object} data
+ */
+exports.define = function(data) {
+    var name, i, codes, code,
+        patterns = [];
+
+    for (name in data) {
+        codes = data[name].codes;
+        for (i in codes) {
+            code = codes[i];
+            codesMap[code] = name;
+
+            // Create escaped variants, because mostly you want to parse escaped
+            // user text.
+            codesMap[escape(code)] = name;
+            if (i == 0) {
+                primaryCodesMap[code] = name;
+            }
+        }
+    }
+
+    for (code in codesMap) {
+        patterns.push('(' + code.replace(metachars, "\\$&") + ')');
+    }
+
+    regexp = new RegExp(patterns.join('|'), 'g');
+    emoticons = data;
+};
+
+/**
+ * Replace emoticons in text.
+ *
+ * @param {String} text
+ * @param {Function} [fn] optional template builder function.
+ */
+exports.replace = function(text, fn) {
+    return text.replace(regexp, function(code) {
+        var name = codesMap[code];
+        return (fn || exports.tpl)(name, code, emoticons[name].title);
+    });
+};
+
+/**
+ * Get primary emoticons as html string in order to display them later as overview.
+ *
+ * @param {Function} [fn] optional template builder function.
+ * @return {String}
+ */
+exports.toString = function(fn) {
+    var code,
+        str = '',
+        name;
+
+    for (code in primaryCodesMap) {
+        name = primaryCodesMap[code];
+        str += (fn || exports.tpl)(name, code, emoticons[name].title);
+    }
+
+    return str;
+};
+
+/**
+ * Build html string for emoticons.
+ *
+ * @param {String} name
+ * @param {String} code
+ * @param {String} title
+ * @return {String}
+ */
+exports.tpl = function(name, code, title) {
+    return '<span class="emoticon emoticon-' + name + '" title="' + title + '">' +
+        code + '</span>';
+};
+
+/**
+ * Build html string for emoticons.
+ *
+ * @param {String} name
+ * @param {String} code
+ * @param {String} title
+ * @return {String}
+ */
+exports.img = function(name, code, title) {
+    return '<img src="assets/' + name + '.gif" title="' + title + '" alt="'+ code +'"/>';
+};
+
+}(typeof jQuery != 'undefined' ? jQuery : null,
+  typeof exports != 'undefined' ? exports : null,
+  window,
+  'emoticons'));

data/app/assets/javascripts/emoticons_defination.js

@@ -0,0 +1,365 @@
+(function () {
+    var definition = {
+        smile: {
+            title: "Smile",
+            codes: [":)", ":=)", ":-)"]
+        },
+        "sad-smile": {
+            title: "Sad Smile",
+            codes: [":(", ":=(", ":-("]
+        },
+        "big-smile": {
+            title: "Big Smile",
+            codes: [":D", ":=D", ":-D", ":d", ":=d", ":-d"]
+        },
+        cool: {
+            title: "Cool",
+            codes: ["8)", "8=)", "8-)", "B)", "B=)", "B-)", "(cool)"]
+        },
+        surprised:{
+            title: "Surprised",
+            codes: [":o", ":=o", ":-o", ":O", ":=O", ":-O"]
+        },
+        wink: {
+            title: "Wink",
+            codes: [";)", ";=)", ";-)"]
+        },
+        crying: {
+            title: "Crying",
+            codes: [";(", ";-(", ";=("]
+        },
+        sweating: {
+            title: "Sweating",
+            codes: ["(sweat)", "(:|"]
+        },
+        speechless: {
+            title: "Speechless",
+            codes: [":|", ":=|", ":-|"]
+        },
+        kiss: {
+            title: "Kiss",
+            codes: [":*", ":=*", ":-*"]
+        },
+        "tongue-out": {
+            title: "Tongue Out",
+            codes: [":P", ":=P", ":-P", ":p", ":=p", ":-p"]
+        },
+        blush: {
+            title: "Blush",
+            codes: ["(blush)", ":$", ":-$", ":=$", ':">']
+        },
+        wondering: {
+            title: "Wondering",
+            codes: [":^)"]
+        },
+        sleepy: {
+            title: "Sleepy",
+            codes: ["|-)", "I-)", "I=)", "(snooze)"]
+        },
+        dull: {
+            title: "Dull",
+            codes: ["|(", "|-(", "|=("]
+        },
+        "in-love": {
+            title: "In love",
+            codes: ["(inlove)"]
+        },
+        "evil-grin": {
+            title: "Evil grin",
+            codes: ["]:)", ">:)", "(grin)"]
+        },
+        talking: {
+            title: "Talking",
+            codes: ["(talk)"]
+        },
+        yawn: {
+            title: "Yawn",
+            codes: ["(yawn)", "|-()"]
+        },
+        puke: {
+            title: "Puke",
+            codes: ["(puke)", ":&", ":-&", ":=&"]
+        },
+        "doh!": {
+            title: "Doh!",
+            codes: ["(doh)"]
+        },
+        angry: {
+            title: "Angry",
+            codes: [":@", ":-@", ":=@", "x(", "x-(", "x=(", "X(", "X-(", "X=("]
+        },
+        "it-wasnt-me": {
+            title: "It wasn't me",
+            codes: ["(wasntme)"]
+        },
+        party: {
+            title: "Party!!!",
+            codes: ["(party)"]
+        },
+        worried: {
+            title: "Worried",
+            codes: [":S", ":-S", ":=S", ":s", ":-s", ":=s"]
+        },
+        mmm: {
+            title: "Mmm...",
+            codes: ["(mm)"]
+        },
+        nerd: {
+            title: "Nerd",
+            codes: ["8-|", "B-|", "8|", "B|", "8=|", "B=|", "(nerd)"]
+        },
+        "lips-sealed": {
+            title: "Lips Sealed",
+            codes: [":x", ":-x", ":X", ":-X", ":#", ":-#", ":=x", ":=X", ":=#"]
+        },
+        hi: {
+            title: "Hi",
+            codes: ["(hi)"]
+        },
+        call: {
+            title: "Call",
+            codes: ["(call)"]
+        },
+        devil: {
+            title: "Devil",
+            codes: ["(devil)"]
+        },
+        angel: {
+            title: "Angel",
+            codes: ["(angel)"]
+        },
+        envy: {
+            title: "Envy",
+            codes: ["(envy)"]
+        },
+        wait: {
+            title: "Wait",
+            codes: ["(wait)"]
+        },
+        bear: {
+            title: "Bear",
+            codes: ["(bear)", "(hug)"]
+        },
+        "make-up": {
+            title: "Make-up",
+            codes: ["(makeup)", "(kate)"]
+        },
+        "covered-laugh": {
+            title: "Covered Laugh",
+            codes: ["(giggle)", "(chuckle)"]
+        },
+        "clapping-hands": {
+            title: "Clapping Hands",
+            codes: ["(clap)"]
+        },
+        thinking: {
+            title: "Thinking",
+            codes: ["(think)", ":?", ":-?", ":=?"]
+        },
+        bow: {
+            title: "Bow",
+            codes: ["(bow)"]
+        },
+        rofl: {
+            title: "Rolling on the floor laughing",
+            codes: ["(rofl)"]
+        },
+        whew: {
+            title: "Whew",
+            codes: ["(whew)"]
+        },
+        happy: {
+            title: "Happy",
+            codes: ["(happy)"]
+        },
+        smirking: {
+            title: "Smirking",
+            codes: ["(smirk)"]
+        },
+        nodding: {
+            title: "Nodding",
+            codes: ["(nod)"]
+        },
+        shaking: {
+            title: "Shaking",
+            codes: ["(shake)"]
+        },
+        punch: {
+            title: "Punch",
+            codes: ["(punch)"]
+        },
+        emo: {
+            title: "Emo",
+            codes: ["(emo)"]
+        },
+        yes: {
+            title: "Yes",
+            codes: ["(y)", "(Y)", "(ok)"]
+        },
+        no: {
+            title: "No",
+            codes: ["(n)", "(N)"]
+        },
+        handshake: {
+            title: "Shaking Hands",
+            codes: ["(handshake)"]
+        },
+        skype: {
+            title: "Skype",
+            codes: ["(skype)", "(ss)"]
+        },
+        heart: {
+            title: "Heart",
+            codes: ["(h)", "<3", "(H)", "(l)", "(L)"]
+        },
+        "broken-heart": {
+            title: "Broken heart",
+            codes: ["(u)", "(U)"]
+        },
+        mail: {
+            title: "Mail",
+            codes: ["(e)", "(m)"]
+        },
+        flower: {
+            title: "Flower",
+            codes: ["(f)", "(F)"]
+        },
+        rain: {
+            title: "Rain",
+            codes: ["(rain)", "(london)", "(st)"]
+        },
+        sun: {
+            title: "Sun",
+            codes: ["(sun)"]
+        },
+        time: {
+            title: "Time",
+            codes: ["(o)", "(O)", "(time)"]
+        },
+        music: {
+            title: "Music",
+            codes: ["(music)"]
+        },
+        movie: {
+            title: "Movie",
+            codes: ["(~)", "(film)", "(movie)"]
+        },
+        phone: {
+            title: "Phone",
+            codes: ["(mp)", "(ph)"]
+        },
+        coffee: {
+            title: "Coffee",
+            codes: ["(coffee)"]
+        },
+        pizza: {
+            title: "Pizza",
+            codes: ["(pizza)", "(pi)"]
+        },
+        cash: {
+            title: "Cash",
+            codes: ["(cash)", "(mo)", "($)"]
+        },
+        muscle: {
+            title: "Muscle",
+            codes: ["(muscle)", "(flex)"]
+        },
+        cake: {
+            title: "Cake",
+            codes: ["(^)", "(cake)"]
+        },
+        beer: {
+            title: "Beer",
+            codes: ["(beer)"]
+        },
+        drink: {
+            title: "Drink",
+            codes: ["(d)", "(D)"]
+        },
+        dance: {
+            title: "Dance",
+            codes: ["(dance)", "\\o/", "\\:D/", "\\:d/"]
+        },
+        ninja: {
+            title: "Ninja",
+            codes: ["(ninja)"]
+        },
+        star: {
+            title: "Star",
+            codes: ["(*)"]
+        },
+        mooning: {
+            title: "Mooning",
+            codes: ["(mooning)"]
+        },
+        finger: {
+            title: "Finger",
+            codes: ["(finger)"]
+        },
+        bandit: {
+            title: "Bandit",
+            codes: ["(bandit)"]
+        },
+        drunk: {
+            title: "Drunk",
+            codes: ["(drunk)"]
+        },
+        smoking: {
+            title: "Smoking",
+            codes: ["(smoking)", "(smoke)", "(ci)"]
+        },
+        toivo: {
+            title: "Toivo",
+            codes: ["(toivo)"]
+        },
+        rock: {
+            title: "Rock",
+            codes: ["(rock)"]
+        },
+        headbang: {
+            title: "Headbang",
+            codes: ["(headbang)", "(banghead)"]
+        },
+        bug: {
+            title: "Bug",
+            codes: ["(bug)"]
+        },
+        fubar: {
+            title: "Fubar",
+            codes: ["(fubar)"]
+        },
+        poolparty: {
+            title: "Poolparty",
+            codes: ["(poolparty)"]
+        },
+        swearing: {
+            title: "Swearing",
+            codes: ["(swear)"]
+        },
+        tmi: {
+            title: "TMI",
+            codes: ["(tmi)"]
+        },
+        heidy: {
+            title: "Heidy",
+            codes: ["(heidy)"]
+        },
+        myspace: {
+            title: "MySpace",
+            codes: ["(MySpace)"]
+        },
+        malthe: {
+            title: "Malthe",
+            codes: ["(malthe)"]
+        },
+        tauri: {
+            title: "Tauri",
+            codes: ["(tauri)"]
+        },
+        priidu: {
+            title: "Priidu",
+            codes: ["(priidu)"]
+        }
+    };
+    $.emoticons.define(definition);
+}());