alondra 0.0.3

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.rvmrc
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+
+# Pusher server
+gemspec
+
+# rails dependecies
+gem "mysql2"
+
+# Rails 3.1 - Asset Pipeline
+gem 'json'
+gem 'sass-rails'
+gem 'coffee-script'
+gem 'uglifier'
+
+# Rails 3.1 - JavaScript
+gem 'jquery-rails'
+
+gem 'capybara'
+gem 'capybara-webkit'
+gem 'launchy'
+gem 'factory_girl'
+

data/Gemfile.lock

@@ -0,0 +1,166 @@
+PATH
+  remote: .
+  specs:
+    alondra (0.0.2)
+      daemons
+      em-websocket
+      em-zeromq (= 0.2.1)
+      eventmachine (>= 1.0.0.beta.3)
+      ffi-rzmq (= 0.8.0)
+      rails (>= 3.1.0)
+      uuidtools
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.1)
+      actionpack (= 3.1.1)
+      mail (~> 2.3.0)
+    actionpack (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.2)
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    addressable (2.2.6)
+    arel (2.2.1)
+    builder (3.0.0)
+    capybara (1.1.1)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    capybara-webkit (0.7.2)
+      capybara (>= 1.0.0, < 1.2)
+    childprocess (0.2.2)
+      ffi (~> 1.0.6)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.1.2)
+    daemons (1.1.4)
+    em-websocket (0.3.5)
+      addressable (>= 2.1.1)
+      eventmachine (>= 0.12.9)
+    em-zeromq (0.2.1)
+      eventmachine (>= 1.0.0.beta.3)
+      ffi-rzmq (>= 0.7.2)
+    erubis (2.7.0)
+    eventmachine (1.0.0.beta.4)
+    execjs (1.2.9)
+      multi_json (~> 1.0)
+    factory_girl (2.2.0)
+      activesupport
+    ffi (1.0.9)
+    ffi-rzmq (0.8.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jquery-rails (1.0.16)
+      railties (~> 3.0)
+      thor (~> 0.14)
+    json (1.6.1)
+    json_pure (1.6.1)
+    launchy (2.0.5)
+      addressable (~> 2.2.6)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    multi_json (1.0.3)
+    mysql2 (0.3.7)
+    nokogiri (1.5.0)
+    polyglot (0.3.3)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.1)
+      actionmailer (= 3.1.1)
+      actionpack (= 3.1.1)
+      activerecord (= 3.1.1)
+      activeresource (= 3.1.1)
+      activesupport (= 3.1.1)
+      bundler (~> 1.0)
+      railties (= 3.1.1)
+    railties (3.1.1)
+      actionpack (= 3.1.1)
+      activesupport (= 3.1.1)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.11)
+      json (~> 1.4)
+    rubyzip (0.9.4)
+    sass (3.1.10)
+    sass-rails (3.1.4)
+      actionpack (~> 3.1.0)
+      railties (~> 3.1.0)
+      sass (>= 3.1.4)
+      sprockets (~> 2.0.0)
+      tilt (~> 1.3.2)
+    selenium-webdriver (2.10.0)
+      childprocess (>= 0.2.1)
+      ffi (= 1.0.9)
+      json_pure
+      rubyzip
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+    uglifier (1.0.4)
+      execjs (>= 0.3.0)
+      multi_json (>= 1.0.2)
+    uuidtools (2.1.2)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  alondra!
+  capybara
+  capybara-webkit
+  coffee-script
+  factory_girl
+  jquery-rails
+  json
+  launchy
+  mysql2
+  sass-rails
+  uglifier

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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,177 @@
+# Alondra
+
+Alondra is a push server and framework that adds real time capabilities to
+your rails applications.
+
+## What can I do with Alondra?
+
+### Subscribe clients to channels
+
+Alondra allows browsers to subscribe to channels. Any Ruby process that loads
+your Rails environment will be able to push messages to those channels.
+
+To subscribe to a channel you can use the built in helper:
+
+```
+  <%= alondra_client @chat %>
+```
+
+Alondra uses [conventions to map records and classes to channel names](https://github.com/afcapel/alondra/wiki/Event-conventions).
+The last example will subscribe the browser to a channel named '/chats/:chat_id'.
+Then, the Alondra client will render any message pushed to that channel.
+
+If you don't want to use Alondra conventions, you can always provide your own
+channel names:
+
+```
+  <%= alondra_client ['my custom channel', 'another channel'] %>
+```
+
+### Sending push notifications
+
+Since Alondra is all Ruby and integrates with your Rails environment, you can
+use your Rails models and views to render push messages. For example, sending
+a push notification from your controller action is as simple as this:
+
+```ruby
+  def create
+    @chat = Chat.find(params[:chat_id])
+    @message = @chat.messages.build(params[:message])
+
+    if @message.save
+      push '/messages/create', :to => @chat
+    end
+
+    respond_with @message
+  end
+```
+
+This will render the '/messages/create' view and send the results to all
+clients subscribed to the chat channel.
+
+You can send push notifications from any process that loads your Rails
+environment and from any class that includes the Alondra::Pushing module.
+When rendering a push message the local context (that is, the instance
+variables of the caller object) will be available in the view.
+
+### Listening to events
+
+Alondra comes bundled with an EventListener class that allows you to react to
+events such as when a client subscribes to a channel.
+
+```ruby
+  # A ChatListener will by default listen to events
+  # sent to any channel whose name begins with '/chat'
+  class ChatListener < Alondra::EventListener
+
+    # If you want to listen to other channels than the default ones
+    # you can specify other patterns with the listen_to method, like
+    #
+    # listen_to  /tion$/
+    #
+    # That would make your listener receive events from any channel whose
+    # name ends in 'ion'
+
+
+    # This will be fired any time a client subscribes to
+    # any of the observed channels
+    on :subscribed, :to => :member do
+
+      # If you use Cookie Based Session Store,
+      # you can access the Rails session from the listener
+      @user = User.find(session[:user_id])
+
+      # Push notifications from listener
+      push '/users/user', :to => channel_name
+    end
+  end
+```
+
+You can also listen to :unsubscribe, :created, :updated, :destroyed or any
+custom event in the observed channels.
+
+### Push record changes to the client
+
+Sometimes you are just interested in pushing record updates to subscribed
+clients. You can do that annotating your model:
+
+```ruby
+  class Presence < ActiveRecord::Base
+    belongs_to :user
+    belongs_to :chat
+
+    push :changes, :to => :chat
+  end
+```
+
+This will push an event (:created, :upated or :destroyed)  to the chat channel
+each time a Message instance changes.
+
+In the client you can listen to these events using the JavaScript API:
+
+```javascript
+
+  var alondraClient = new AlondraClient('localhost', 12345, ['/chat_rooms/1']);
+
+  // render user name when presence is created
+
+  $(alondraClient).bind("created.Presence", function(event, resource){
+    if( $('#user_'+resource.user_id).length == 0 ){
+      $('#users').append("<li id='user_" + resource.user_id + "'>" + resource.username + "</li>");
+    }
+  });
+
+  // remove user name when presence is destroyed
+
+  $(alondraClient).bind("destroyed.Presence", function(event, resource){
+    $('#user_'+resource.user_id).remove();
+  });
+
+```
+
+This technique is especially useful if you use something like Backbone.js
+to render your app frontend.
+
+
+## Example application
+
+You can check the [example application](http://github.com/afcapel/alondra-example)
+to see how some of the features are used.
+
+## Installation
+
+Currently Alondra depends on Rails 3.1 and Ruby 1.9. It also uses ZeroMQ for
+interprocess communication, so you need to install the library first. If
+you are using Homebrew on Mac OS X, just type
+
+<pre>
+  brew install zeromq
+</pre>
+
+When ZeroMQ is installed, add the Alondra gem to your Gemfile.
+
+<pre>
+  gem "alondra"
+</pre>
+
+You also will need to install the server initialization script into your app.
+In the shell execute the generator.
+
+<pre>
+  $ rails g alondra install
+</pre>
+
+To run the Alondra server, just call the generated script
+
+<pre>
+  $ script/alondra start
+</pre>
+
+In development mode you can also run the Alondra server in its own thread.
+See the [initializer in the example application](https://github.com/afcapel/alondra-example/blob/master/config/initializers/alondra_server.rb)
+for how to do it.
+
+## Contributors
+
+- [Ryan LeCompte](http://github.com/ryanlecompte)
+- [Jaime Iniesta](http://github.com/jaimeiniesta)

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Alondra'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/alondra.gemspec

@@ -0,0 +1,23 @@
+# Provide a simple gemspec so you can easily use your
+# project in your rails apps through git.
+Gem::Specification.new do |s|
+  s.name = "alondra"
+  s.summary = "Add real time capabilities to your rails app"
+  s.description = "Add real time capabilities to your rails app"
+  s.version = "0.0.3"
+  s.authors = ['Alberto F. Capel', 'Ryan LeCompte']
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Dependencies
+  s.add_dependency('daemons')
+  s.add_dependency('uuidtools')
+  s.add_dependency('rails', '>= 3.1.0')
+  s.add_dependency('eventmachine', '>= 1.0.0.beta.3')
+  s.add_dependency('em-websocket')
+  s.add_dependency('ffi-rzmq', '0.8.0')
+  s.add_dependency('em-zeromq', '0.2.1')
+end

data/app/assets/javascripts/alondra-client.js.coffee.erb

@@ -0,0 +1,71 @@
+#= require "moz_websocket"
+#= require "vendor/jquery.json-2.2"
+#= require "vendor/swfobject"
+#= require "vendor/web_socket"
+//= provide "../swf"
+
+window.WEB_SOCKET_SWF_LOCATION = "<%= asset_path 'WebSocketMain.swf' %>"
+
+class @AlondraClient
+  constructor: (host, port, channels, token = null, retry = 5000) ->
+    @channels = channels
+    @token    = token
+    @retry    = retry
+    @url = "ws://#{host}:#{port}"
+
+    @url += "?token=#{@token}" if @token
+
+    this.connect()
+
+  subscribe: (channel) ->
+    subscription =
+      command: 'subscribe'
+      channel: channel
+
+    @socket.send $.toJSON(subscription)
+
+  connect: ->
+    @socket   = new WebSocket(@url)
+
+    @socket.onopen = () =>
+      if @reconnectInterval
+        clearInterval(@reconnectInterval)
+        @reconnectInterval = null
+
+      if @channels instanceof Array
+        this.subscribe(channel) for channel in @channels
+      else
+        this.subscribe(@channels)
+
+    @socket.onclose = () =>
+      this.reconnect()
+
+
+    @socket.onmessage = (message) =>
+      msg = $.parseJSON(message.data)
+      if msg.event
+        this.process(msg)
+      else
+        this.execute(msg)
+
+
+    @socket.onerror = (error) =>
+      this.reconnect()
+
+  process: (serverEvent) ->
+    eventName    = serverEvent.event
+    resourceType = serverEvent.resource_type
+    resource     = serverEvent.resource
+
+    $(this).trigger("#{eventName}.#{resourceType}", resource)
+
+  execute: (message) ->
+    eval(message.message)
+
+  reconnect: ->
+    return if !@retry || @reconnectInterval
+
+    @reconnectInterval = setInterval =>
+      this.connect()
+    ,@retry
+

data/app/assets/javascripts/moz_websocket.js

@@ -0,0 +1,5 @@
+/* In Firefox 6 WebSocket has been renamed to MozWebSocket */
+
+if( window.WebSocket == null && window.MozWebSocket ){
+  window.WebSocket = window.MozWebSocket;
+}