7 Commits

Author SHA1 Message Date
James Coglan 69ef5f8be2 Update the changelog for 0.2.0. 2013-10-01 15:46:54 +01:00
James Coglan a2a76ce200 Migrate readme and changelog to markdown. 2013-10-01 15:43:50 +01:00
James Coglan 9e0c198013 Trigger the :close event as required by Faye 1.0. 2013-10-01 15:37:00 +01:00
James Coglan 19cd96eed9 Bump faye submodule to fix JRuby tests. 2013-10-01 15:24:36 +01:00
James Coglan f894a1deb5 Don't test on 1.8.7. 2013-10-01 15:14:36 +01:00
James Coglan f893c15efd Bring things up to date: update the faye submodule, replace Yajl with MultiJson. 2013-10-01 15:08:43 +01:00
James Coglan 2de09943e0 Bump copyright date. 2013-04-28 12:27:00 +01:00
9 changed files with 112 additions and 91 deletions
+1 -2
View File
@@ -1,10 +1,9 @@
language: ruby
rvm:
- 1.8.7
- 1.9.3
- 2.0.0
- rbx-18mode
- jruby-19mode
- rbx-19mode
before_script:
+15
View File
@@ -0,0 +1,15 @@
### 0.2.0 / 2013-10-01
* Migrate from Yajl to MultiJson to support JRuby
* Trigger `close` event as required by Faye 1.0
### 0.1.1 / 2013-04-28
* Improve garbage collection to avoid leaking Redis memory
### 0.1.0 / 2012-02-26
* Initial release: Redis backend for Faye 0.8
-9
View File
@@ -1,9 +0,0 @@
=== 0.1.1 / 2013-04-28
* Improve garbage collection to avoid leaking Redis memory
=== 0.1.0 / 2012-02-26
* Initial release: Redis backend for Faye 0.8
+61
View File
@@ -0,0 +1,61 @@
# Faye::Redis [![Build Status](https://travis-ci.org/faye/faye-redis-ruby.png)](https://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.
```rb
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>`:uri`</b> - redis URL (example: `redis://:secretpassword@example.com:9000/4`)
* <b>`:host`</b> - hostname of your Redis instance
* <b>`:port`</b> - port number, default is `6379`
* <b>`:password`</b> - password, if `requirepass` is set
* <b>`:database`</b> - number of database to use, default is `0`
* <b>`:namespace`</b> - prefix applied to all keys, default is `''`
* <b>`:socket`</b> - path to Unix socket if `unixsocket` is set
## License
(The MIT License)
Copyright (c) 2011-2013 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.
-59
View File
@@ -1,59 +0,0 @@
= Faye::Redis {<img src="https://secure.travis-ci.org/faye/faye-redis-ruby.png" 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>:uri</tt></b> - redis URL (example: redis://:secretpassword@example.com:9000/4)
* <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.
+15 -13
View File
@@ -1,20 +1,22 @@
Gem::Specification.new do |s|
s.name = "faye-redis"
s.version = "0.1.1"
s.summary = "Redis backend engine for Faye"
s.author = "James Coglan"
s.email = "jcoglan@gmail.com"
s.homepage = "http://github.com/faye/faye-redis-ruby"
s.name = 'faye-redis'
s.version = '0.2.0'
s.summary = 'Redis backend engine for Faye'
s.author = 'James Coglan'
s.email = 'jcoglan@gmail.com'
s.homepage = 'http://github.com/faye/faye-redis-ruby'
s.extra_rdoc_files = %w[README.rdoc]
s.rdoc_options = %w[--main README.rdoc]
s.extra_rdoc_files = %w[README.md]
s.rdoc_options = %w[--main README.md --markup markdown]
s.require_paths = %w[lib]
s.files = %w[README.rdoc CHANGELOG.txt] + Dir.glob("lib/**/*.rb")
s.files = %w[CHANGELOG.md README.md] +
Dir.glob('lib/**/*.rb')
s.add_dependency "eventmachine", ">= 0.12.0"
s.add_dependency "em-hiredis", ">= 0.2.0"
s.add_dependency "yajl-ruby", ">= 1.0.0"
s.add_dependency 'eventmachine', '>= 0.12.0'
s.add_dependency 'em-hiredis', '>= 0.2.0'
s.add_dependency 'multi_json', '>= 1.0.0'
s.add_development_dependency "rspec"
s.add_development_dependency 'rspec'
s.add_development_dependency 'websocket-driver'
end
+14 -7
View File
@@ -1,5 +1,5 @@
require 'em-hiredis'
require 'yajl'
require 'multi_json'
module Faye
class Redis
@@ -40,9 +40,14 @@ module Faye
end
@subscriber = @redis.pubsub
@subscriber.subscribe(@ns + '/notifications')
@message_channel = @ns + '/notifications/messages'
@close_channel = @ns + '/notifications/close'
@subscriber.subscribe(@message_channel)
@subscriber.subscribe(@close_channel)
@subscriber.on(:message) do |topic, message|
empty_queue(message) if topic == @ns + '/notifications'
empty_queue(message) if topic == @message_channel
@server.trigger(:close, message) if topic == @close_channel
end
@gc = EventMachine.add_periodic_timer(gc, &method(:gc))
@@ -50,7 +55,8 @@ module Faye
def disconnect
return unless @redis
@subscriber.unsubscribe(@ns + '/notifications')
@subscriber.unsubscribe(@message_channel)
@subscriber.unsubscribe(@close_channel)
EventMachine.cancel_timer(@gc)
end
@@ -97,6 +103,7 @@ module Faye
@redis.zrem(@ns + '/clients', client_id) do
@server.debug 'Destroyed client ?', client_id
@server.trigger(:disconnect, client_id)
@redis.publish(@close_channel, client_id)
callback.call if callback
end
end
@@ -138,7 +145,7 @@ module Faye
init
@server.debug 'Publishing message ?', message
json_message = Yajl::Encoder.encode(message)
json_message = MultiJson.dump(message)
channels = Channel.expand(message['channel'])
keys = channels.map { |c| @ns + "/channels#{c}" }
@@ -148,7 +155,7 @@ module Faye
@server.debug 'Queueing for client ?: ?', client_id, message
@redis.rpush(queue, json_message)
@redis.publish(@ns + '/notifications', client_id)
@redis.publish(@message_channel, client_id)
client_exists(client_id) do |exists|
@redis.del(queue) unless exists
@@ -170,7 +177,7 @@ module Faye
@redis.del(key)
@redis.exec.callback do |json_messages, deleted|
next unless json_messages
messages = json_messages.map { |json| Yajl::Parser.parse(json) }
messages = json_messages.map { |json| MultiJson.load(json) }
@server.deliver(client_id, messages)
end
end
+5
View File
@@ -1,3 +1,8 @@
require File.expand_path('../../lib/faye/redis', __FILE__)
require 'websocket/driver'
require File.expand_path('../../vendor/faye/spec/ruby/engine_examples', __FILE__)
class << Faye
attr_accessor :logger
end
Vendored
+1 -1