BunnySubscriber

Simple RabbitMQ subscriber for ruby and rails applications using Bunny. Heavily inspired by Sneakers, it provides a simple way to connect to RabbitMQ as a subscriber. But its goal is not to be a background job processing framework; just a subscriber to connect to other services that use RabbitMQ. For this reason BunnySubscriber does not provide a way to enqueue jobs, nor does it have scheduling jobs or retries with configurable times. If you want this features, BunnySubscriber works great with other background job processing tools, like Sidekiq or Resque. Or you can just use Sneakers directly.

Installation

Add this line to your application's Gemfile:

gem 'bunny_subscriber'

Basic usage

To add a consumer, just include the module BunnySubscriber::Consumer, and define the method process_event:

class SomeConsumer
  include BunnySubscriber::Consumer

  subscriber_options queue_name: 'some.rabbit.queue'

  def process_event(message)
    # Do some work
  end
end

To start the server, just run:

bundle exec bunny_subscriber

Configuration

By default, BunnySubscriber loads the file ./config/bunny_subscriber.yml for configurations. But that path can be specified on the command line as follows:

bundle exec bunny_subscriber -c some/path.yml

The options available in the yaml, by environment, are:

default: &default
  host: 127.0.0.1
  port: 5672
  user: guest
  pass: guest
  vhost: /
  heartbeat: 30
  consumer_classes: 
    - SomeConsumer
development:
  <<: *default
  workers: 2

production:
  <<: *default
  host: some.host
  vhost: /other
  user: <%= ENV['user_in_env'] %>
  pass: <%= ENV['password_in_env'] %>
  workers: 5
  daemonize: true

Parameter name	Type	Description	Default
host	String	RabbitMQ host	127.0.0.1
port	Integer	RabbitMQ port	5672
user	String	RabbitMQ user	guest
pass	String	RabbitMQ password	guest
vhost	String	RabbitMQ virtual host	/
heartbeat	Integer	Standard RabbitMQ server heartbeat
workers	Integer	Number of process (not threads) that runs the server	1
daemonize	Boolean	Run server in background or not	false
logger_path	String	Logger output file when running as daemon	./log/bunny_subscriber.log
pid_path	String	File that saves the current process master id	./pids/bunny_subscriber.pid
boot_path	String	Path to a ruby script that initialize the environment. The default works for a Rails app	./config/environment
consumer_classes	Array	Specified which consumers you want to consider	All defined consummers

Command line options

For all the command line options, run:

bundle exec bunny_subscriber --help

Using without Rails

By default, BunnySubscriber works with Rails. If you want to use it without Rails, or do not want to load the entire Rails environment (usefull if you want to create consumers that only enqueue jobs using other frameworks), just change the boot_path and load what you want in that script.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Beetrack/bunny_subscriber.

License

The gem is available as open source under the terms of the MIT License.

TedYin / bunny_subscriber