RestRedisPubSub

RestRedisPubSub is a small library for publishing, subscribing and handling messages via Redis pub/sub. It use conventions to simplify configuration.

Installation

gem 'rest_redis_pub_sub'

Configuration

For configuring defaults you have to define/load:

RestRedisPubSub.configure do |config|

  config.subscribe_to = ['my-app-channel']

  # It defaults to #{generator}.#{resource}
  config.publish_to = 'interested-channel'

  # Set you preferable redis client to handle subscribe and publish.
  config.redis_instance = $redis_instance

  # Set this if your listeners will be inside a namespace.
  config.listeners_namespace = MyListeners::Namespace

  # Set publish generator
  config.generator = 'my-app'
end

Running the worker

Include rest_redis_pub_sub/tasks in your application:

require 'rest_redis_pub_sub/tasks'

Run the worker:

bundle exec run rake rest_redis_pub_sub:subscribe

Publish

Using default channel:

client = RestRedisPubSub::Client.new
client.publish_create(resource, identifier, data)

Or a custom one:

client = RestRedisPubSub::Client.new('channel')
client.publish_create(resource, identifier, data)

It publish to the specified channel the following data in json format:

=> {
  generator: {
    display_name: 'crushpath'
  },
  provider: {
    display_name: 'rest_redis_pub_sub 0.3.1'
  }
  verb: 'create',
  id: 'spot_id',
  actor: {
    object_type: 'user',
    ...
  },
  object: {
    object_type: 'spot',
    ...
  },
  target: {
    object_type: 'etc'
  }
}

Available publish events:

[
 :add, :call, :change, :comment, :complete, :confirm, :create,
 :dismiss, :email_reply, :evolve, :label, :like, :locate,
 :make_friend, :message, :open, :post, :promote, :publish, :read,
 :receive, :reject, :remove, :request, :request_contact, :send,
 :sign_in, :sign_out, :system, :thank, :unpublish, :update, :view
]

RestRedisPubSub provides a publisher class that can be inherit to create child classes:

class MyPublishers::SpotCreate < RestRedisPubSub::Publisher

  def initialize(attrs={})
  end

  def verb
    #required
  end

  def object
    #required
  end

  def actor
    #required
  end

  def target
  end

  def id
  end

end

Subscribe

RestRedisPubSub will forward all messages received to a class base on the generator, event and resource received:

Verb	Object	Class
create	spot	PublisherSpotCreate
update	spot	PublisherSpotUpdate

The class must implement a class method .perform. If Resque is defined it will enqueue it.

An example class that should be defined in the project to handle the publish message:

class Listeners::CrushpathSpotCreate

  def self.perform(id, data)
    ...
  end

end