Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Ruby amqp gem is a widely used, feature-rich, well-maintained, fast asynchronous AMQP 0.9.1 Ruby client with batteries included. Get started in an instant: http://bit.ly/jcuACj, all documentation guides are at http://bit.ly/amqp-gem-docs, API reference is at http://bit.ly/mDm1JE — we do care about the docs!
Ruby Other

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
docs
examples
gemfiles
lib
spec
.gitignore
.rspec
.travis.yml
.yardopts
CHANGELOG
CONTRIBUTORS
Gemfile
README.textile
Rakefile
amqp.gemspec
tasks.rb

README.textile

About amqp gem

amqp gem is a widely used, feature-rich, well-maintained asynchronous AMQP 0.9.1 client with batteries included.
This library works with Ruby 1.8.7 (p174 and p334), Ruby 1.9.2, JRuby, REE and Rubinius, and is
licensed under the Ruby License.
Versions 0.8.0 and later of amqp gem implement AMQP 0.9.1.

I know what AMQP is, how do I get started?

See “Getting started with amqp gem” and “Documentation: tutorials, guides & API reference” sections below.

What is AMQP?

AMQP is an open standard for messaging middleware that
emphasizes interoperability between different technologies (for example, Java, .NET,
Ruby, Python, C and so on).

Key features of AMQP are very flexible yet simple routing and binary protocol
efficiency.

What is amqp gem good for?

One can use amqp gem to make Ruby applications interoperate with other
applications (both Ruby and not). Complexity and size may vary from
simple work queues to complex multi-stage data processing workflows that involve
dozens or hundreds of applications built with all kinds of technologies.

Specific examples:

  • A Web application may route messages to a Java app that works
    with SMS delivery gateways.
  • Periodically run (Cron-driven) application may notify other systems that
    there are some new results.
  • Content aggregators may update full-text search and geospatial search indexes
    by delegating actual indexing work to other applications over AMQP.
  • Companies may provide “Firehose-like” push APIs to their customers, partners
    or just general public.
  • A new shiny Ruby-based system may be integrated with an existing C++-based component
    using AMQP.
  • An application that watches updates from a real-time stream (be it markets data
    or Twitter stream) can propagate updates to interested parties, including
    Web applications that display that information in the real time.

Getting started with amqp gem

Install RabbitMQ

Please refer to RabbitMQ installation guide
Note that for Ubuntu and Debian we strongly advice that you use RabbitMQ apt repository
that has recent versions of RabbitMQ. Learn more in {file:docs/RabbitMQVersions.textile RabbitMQ versions} section.

Install the gem

gem install amqp

“Hello, World” example


#!/usr/bin/env ruby
# encoding: utf-8

require "rubygems"
# or
#
# require "bundler"
# Bundler.setup
#
# if you use Bundler

require 'amqp'

EventMachine.run do
  connection = AMQP.connect(:host => '127.0.0.1')
  puts "Connected to AMQP broker. Running #{AMQP::VERSION} version of the gem..."

  channel  = AMQP::Channel.new(connection)
  queue    = channel.queue("amqpgem.examples.hello_world", :auto_delete => true)
  exchange = channel.direct("")

  queue.subscribe do |payload|
    puts "Received a message: #{payload}. Disconnecting..."

    connection.close {
      EM.stop { exit }
    }
  end

  exchange.publish "Hello, world!", :routing_key => queue.name
end

(see as a Gist)

Getting started guide explains this and two more examples in detail,
and is written in a form of a tutorial.

Documentation: tutorials, guides & API reference

We believe that in order to be the best Ruby AMQP client out there, we need to care about documentation as much as
code readability, API beauty and autotomated testing across 5 Ruby implementations on 3 operating systems.

Tutorials

We have written and maintain Getting started guide that is written in form of a tutorial.
Check it out! If something isn’t clear, every guide explains how to contact documentation authors.

Examples

You can find many examples (both real-world cases and simple demonstrations)
under examples directory in the repository.
Note that those examples are written against version 0.8.0.rc1 and later. 0.6.x and 0.7.x
may not support certain AMQP protocol or “DSL syntax” features.

Guides

Documentation guides describe
the library itself as well as AMQP usage scenarios, routing, error handing & recovery, broker-specific extensions, TLS support and so on.

API reference

Reference documentation is up on rdoc.info and is updated daily.

If you don’t find your answer in documentation, we consider it a high severity bug that you should file to us.

How to use AMQP gem with Ruby on Rails, Merb, Sinatra and other web frameworks

We cover this subject for multiple Ruby application servers in Connecting to the broker guide, take a look and let us know
what wasn’t clear.

How does amqp gem relate to amq-client gem, amq-protocol and libraries like bunny?

See this page about AMQP gems family

How can I learn more?

AMQP resources

Messaging and distributed systems resources

Community

License

AMQP gem is licensed under the Ruby License.

Credits and copyright information

  • The Original Code is tmm1/amqp.
  • The Initial Developer of the Original Code is Aman Gupta.
  • Copyright © 2008 – 2010 Aman Gupta.
  • Contributions from Jakub Stastny are Copyright © 2011 VMware, Inc.
  • Copyright © 2010 — 2011 ruby-amqp group members.

Currently maintained by ruby-amqp group members
Special thanks to Dmitriy Samovskiy, Ben Hood and Tony Garnock-Jones.

FAQ

So, does amqp gem only work with RabbitMQ?

This library was tested primarily with RabbitMQ, although it should be compatible with any
server implementing the AMQP 0.9.1 spec. For AMQP 0.8.0 brokers,
use version 0.7.

Why isn’t Ruby 1.8.7.-p249 supported?

Because there is absolutely no way we can both make code like the following (pseudo-synchronous) work


conn = AMQP.connect
ch   = AMQP::Channel.new(conn)

ex   = ch.default_exchange
ex.publish(some_data)

and not be affected by this Ruby 1.8.7-p249-specific bug

Links

Something went wrong with that request. Please try again.