Emque Producing

Define and send messages with Ruby to a variety of message brokers. Currently supported message brokers are RabbitMQ and Kafka.

This is a library that pairs nicely with Emque Consuming, a framework for consuming and routing messages to your code.

Installation

Add these lines to your application's Gemfile, depending on your message broker:

# for RabbitMQ, bunny is used
gem "emque-producing"
gem "bunny", "~> 1.4.1"

# for Kafka, poseidon is used
gem "emque-producing"
gem "poseidon", "0.0.4"

And then execute:

$ bundle

Or install it yourself as:

$ gem install emque-producing

Usage

# configure (likely in a Rails initializer)
require 'emque-producing'
Emque::Producing.configure do |c|
  c.app_name = "app"
  c.publishing_adapter = :rabbitmq
  c.rabbitmq_options = { :url => "amqp://guest:guest@localhost:5672" }
  #c.kafka_options = { :seed_brokers => [localhost:9092],
  #                    :producer_options => {} }
  c.error_handlers << Proc.new {|ex,context|
   # notify/log
  }
end

# create a message class
class MyMessage
  include Emque::Producing::Message
  topic "topic1"
  message_type "mymessage.new"

  attribute :first_property, Integer, :required => true
  attribute :another_property, String, :required => true
end

# produce message
message = MyMessage.new({:first_property => 1, :another_property => "another"})
message.publish

Requirements

Ruby 1.9.3 or higher
RabbitMQ 3.x
Bunny 1.4.x
Kafka 0.8.1
Poseidon 0.0.4

Tests

To run tests...

rspec

If you would like to test the gem as part of your client, you can update the configuration option publish_messages to false like so:

    Emque::Producing.configure do |c|
      c.publish_messages = false
    ...other options
    end

This will prevent Emque from actually attempting to make the connection to your adapter which may be convenient in the case of CI environments.

Contributing

Fork it ( http://github.com/teamsnap/emquemessages/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request