faye-redis 0.1.0

data/README.rdoc

@@ -0,0 +1,58 @@
+= Faye::Redis {<img src="https://secure.travis-ci.org/faye/faye-redis-ruby.png?branch=master" alt="Build Status" />}[http://travis-ci.org/faye/faye-redis-ruby]
+
+This plugin provides a Redis-based backend for the {Faye}[http://faye.jcoglan.com]
+messaging server. It allows a single Faye service to be distributed across many
+front-end web servers by storing state and routing messages through a
+{Redis}[http://redis.io] database server.
+
+
+== Usage
+
+Pass in the engine and any settings you need when setting up your Faye server.
+
+    require 'faye'
+    require 'faye/redis'
+    
+    bayeux = Faye::RackAdapter.new(
+      :mount   => '/',
+      :timeout => 25,
+      :engine  => {
+        :type  => Faye::Redis,
+        :host  => 'redis.example.com',
+        # more options
+      }
+    )
+
+The full list of settings is as follows.
+
+* <b><tt>:host</tt></b> - hostname of your Redis instance
+* <b><tt>:port</tt></b> - port number, default is +6379+
+* <b><tt>:password</tt></b> - password, if +requirepass+ is set
+* <b><tt>:database</tt></b> - number of database to use, default is +0+
+* <b><tt>:namespace</tt></b> - prefix applied to all keys, default is <tt>''</tt>
+* <b><tt>:socket</tt></b> - path to Unix socket if +unixsocket+ is set
+
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2011-2012 James Coglan
+
+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/lib/faye/redis.rb

@@ -0,0 +1,222 @@
+require 'em-hiredis'
+require 'yajl'
+
+module Faye
+  class Redis
+    
+    DEFAULT_HOST     = 'localhost'
+    DEFAULT_PORT     = 6379
+    DEFAULT_DATABASE = 0
+    DEFAULT_GC       = 60
+    LOCK_TIMEOUT     = 120
+    
+    def self.create(server, options)
+      new(server, options)
+    end
+    
+    def initialize(server, options)
+      @server  = server
+      @options = options
+    end
+    
+    def init
+      return if @redis
+      
+      host   = @options[:host]      || DEFAULT_HOST
+      port   = @options[:port]      || DEFAULT_PORT
+      db     = @options[:database]  || DEFAULT_DATABASE
+      auth   = @options[:password]
+      gc     = @options[:gc]        || DEFAULT_GC
+      @ns    = @options[:namespace] || ''
+      socket = @options[:socket]
+      
+      if socket
+        @redis      = EventMachine::Hiredis::Client.connect(socket, nil)
+        @subscriber = EventMachine::Hiredis::Client.connect(socket, nil)
+      else
+        @redis      = EventMachine::Hiredis::Client.connect(host, port)
+        @subscriber = EventMachine::Hiredis::Client.connect(host, port)
+      end
+      if auth
+        @redis.auth(auth)
+        @subscriber.auth(auth)
+      end
+      @redis.select(db)
+      @subscriber.select(db)
+      
+      @subscriber.subscribe(@ns + '/notifications')
+      @subscriber.on(:message) do |topic, message|
+        empty_queue(message) if topic == @ns + '/notifications'
+      end
+      
+      @gc = EventMachine.add_periodic_timer(gc, &method(:gc))
+    end
+    
+    def disconnect
+      @subscriber.unsubscribe(@ns + '/notifications')
+      EventMachine.cancel_timer(@gc)
+    end
+    
+    def create_client(&callback)
+      init
+      client_id = @server.generate_id
+      @redis.zadd(@ns + '/clients', 0, client_id) do |added|
+        next create_client(&callback) if added == 0
+        @server.debug 'Created new client ?', client_id
+        ping(client_id)
+        @server.trigger(:handshake, client_id)
+        callback.call(client_id)
+      end
+    end
+    
+    def destroy_client(client_id, &callback)
+      init
+      @redis.zrem(@ns + '/clients', client_id)
+      @redis.del(@ns + "/clients/#{client_id}/messages")
+      
+      @redis.smembers(@ns + "/clients/#{client_id}/channels") do |channels|
+        i, n = 0, channels.size
+        next after_destroy(client_id, &callback) if i == n
+        
+        channels.each do |channel|
+          unsubscribe(client_id, channel) do
+            i += 1
+            after_destroy(client_id, &callback) if i == n
+          end
+        end
+      end
+    end
+    
+    def after_destroy(client_id, &callback)
+      @server.debug 'Destroyed client ?', client_id
+      @server.trigger(:disconnect, client_id)
+      callback.call if callback
+    end
+    
+    def client_exists(client_id, &callback)
+      init
+      @redis.zscore(@ns + '/clients', client_id) do |score|
+        callback.call(score != nil)
+      end
+    end
+    
+    def ping(client_id)
+      init
+      timeout = @server.timeout
+      return unless Numeric === timeout
+      
+      time = get_current_time
+      @server.debug 'Ping ?, ?', client_id, time
+      @redis.zadd(@ns + '/clients', time, client_id)
+    end
+    
+    def subscribe(client_id, channel, &callback)
+      init
+      @redis.sadd(@ns + "/clients/#{client_id}/channels", channel) do |added|
+        @server.trigger(:subscribe, client_id, channel) if added == 1
+      end
+      @redis.sadd(@ns + "/channels#{channel}", client_id) do
+        @server.debug 'Subscribed client ? to channel ?', client_id, channel
+        callback.call if callback
+      end
+    end
+    
+    def unsubscribe(client_id, channel, &callback)
+      init
+      @redis.srem(@ns + "/clients/#{client_id}/channels", channel) do |removed|
+        @server.trigger(:unsubscribe, client_id, channel) if removed == 1
+      end
+      @redis.srem(@ns + "/channels#{channel}", client_id) do
+        @server.debug 'Unsubscribed client ? from channel ?', client_id, channel
+        callback.call if callback
+      end
+    end
+    
+    def publish(message, channels)
+      init
+      @server.debug 'Publishing message ?', message
+      
+      json_message = Yajl::Encoder.encode(message)
+      channels     = Channel.expand(message['channel'])
+      keys         = channels.map { |c| @ns + "/channels#{c}" }
+      
+      @redis.sunion(*keys) do |clients|
+        clients.each do |client_id|
+          @server.debug 'Queueing for client ?: ?', client_id, message
+          @redis.rpush(@ns + "/clients/#{client_id}/messages", json_message)
+          @redis.publish(@ns + '/notifications', client_id)
+        end
+      end
+      
+      @server.trigger(:publish, message['clientId'], message['channel'], message['data'])
+    end
+    
+    def empty_queue(client_id)
+      return unless @server.has_connection?(client_id)
+      init
+      
+      key = @ns + "/clients/#{client_id}/messages"
+      
+      @redis.multi
+      @redis.lrange(key, 0, -1)
+      @redis.del(key)
+      @redis.exec.callback  do |json_messages, deleted|
+        messages = json_messages.map { |json| Yajl::Parser.parse(json) }
+        @server.deliver(client_id, messages)
+      end
+    end
+    
+  private
+    
+    def get_current_time
+      (Time.now.to_f * 1000).to_i
+    end
+    
+    def gc
+      timeout = @server.timeout
+      return unless Numeric === timeout
+      
+      with_lock 'gc' do |release_lock|
+        cutoff = get_current_time - 1000 * 2 * timeout
+        @redis.zrangebyscore(@ns + '/clients', 0, cutoff) do |clients|
+          i, n = 0, clients.size
+          next release_lock.call if i == n
+          
+          clients.each do |client_id|
+            destroy_client(client_id) do
+              i += 1
+              release_lock.call if i == n
+            end
+          end
+        end
+      end
+    end
+    
+    def with_lock(lock_name, &block)
+      lock_key     = @ns + '/locks/' + lock_name
+      current_time = get_current_time
+      expiry       = current_time + LOCK_TIMEOUT * 1000 + 1
+      
+      release_lock = lambda do
+        @redis.del(lock_key) if get_current_time < expiry
+      end
+      
+      @redis.setnx(lock_key, expiry) do |set|
+        next block.call(release_lock) if set == 1
+        
+        @redis.get(lock_key) do |timeout|
+          next unless timeout
+          
+          lock_timeout = timeout.to_i(10)
+          next if current_time < lock_timeout
+          
+          @redis.getset(lock_key, expiry) do |old_value|
+            block.call(release_lock) if old_value == timeout
+          end
+        end
+      end
+    end
+    
+  end
+end
+

data/spec/faye_redis_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe Faye::Redis do
+  let(:engine_opts)  do
+    pw = ENV["TRAVIS"] ? nil : "foobared"
+    {:type => Faye::Redis, :password => pw, :namespace => Time.now.to_i.to_s}
+  end
+  
+  after do
+    engine.disconnect
+    redis = EM::Hiredis::Client.connect('localhost', 6379)
+    redis.auth(engine_opts[:password])
+    redis.flushall
+  end
+  
+  it_should_behave_like "faye engine"
+  it_should_behave_like "distributed engine"
+  
+  next if ENV["TRAVIS"]
+  
+  describe "using a Unix socket" do
+    before { engine_opts[:socket] = "/tmp/redis.sock" }
+    it_should_behave_like "faye engine"
+  end
+end
+

data/spec/redis.conf

@@ -0,0 +1,42 @@
+daemonize no
+pidfile /tmp/redis.pid
+port 6379
+unixsocket /tmp/redis.sock
+timeout 300
+loglevel verbose
+logfile stdout
+databases 16
+
+save 900 1
+save 300 10
+save 60 10000
+
+rdbcompression yes
+dbfilename dump.rdb
+dir ./
+
+slave-serve-stale-data yes
+
+requirepass foobared
+
+appendonly no
+appendfsync everysec
+no-appendfsync-on-rewrite no
+
+vm-enabled no
+vm-swap-file /tmp/redis.swap
+vm-max-memory 0
+vm-page-size 32
+vm-pages 134217728
+vm-max-threads 4
+
+hash-max-zipmap-entries 512
+hash-max-zipmap-value 64
+
+list-max-ziplist-entries 512
+list-max-ziplist-value 64
+
+set-max-intset-entries 512
+
+activerehashing yes
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require File.expand_path('../../lib/faye/redis', __FILE__)
+require File.expand_path('../../vendor/faye/spec/ruby/engine_examples', __FILE__)
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: faye-redis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- James Coglan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &10557300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *10557300
+- !ruby/object:Gem::Dependency
+  name: em-hiredis
+  requirement: &10556820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *10556820
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &10556360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *10556360
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &10555900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *10555900
+description: 
+email: jcoglan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- spec/redis.conf
+- spec/faye_redis_spec.rb
+- spec/spec_helper.rb
+- lib/faye/redis.rb
+homepage: http://github.com/faye/faye-redis-ruby
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Redis backend engine for Faye
+test_files: []