queueing_rabbit 0.3.10 → 0.4.0

data/README.md

@@ -1,16 +1,66 @@
 # QueueingRabbit [![Build Status](https://travis-ci.org/temochka/queueing_rabbit.png?branch=master)](https://travis-ci.org/temochka/queueing_rabbit) [![Code Climate](https://codeclimate.com/github/temochka/queueing_rabbit.png)](https://codeclimate.com/github/temochka/queueing_rabbit)
 
-QueueingRabbit is a Ruby library that provides a convenient object-oriented
-syntax for managing background jobs with AMQP. All jobs' argumets are
-serialized to JSON and transfered as AMQP message payloads. The library
-implements amqp and bunny gems as adapters, making it possible to use
-synchronous publishing and asynchronous consuming, which might be useful for
-Rails apps running on non-EventMachine based application servers (i. e.
-Passenger).
+QueueingRabbit provides a Ruby DSL to interact with RabbitMQ. It is fairly flexible and allows you to integrate with existing infrastructure and naming conventions. It currently offers gems [bunny](https://github.com/ruby-amqp/bunny) and [amqp](https://github.com/ruby-amqp/amqp) as supported back-ends.
+
+## Example
+
+The following Ruby program publishes an excerpt of Joseph Brodsky’s poem line by line to a RabbitMQ exchange and prints received messages on the screen.
+
+``` ruby
+require 'queueing_rabbit'
+
+class Reciter < QueueingRabbit::AbstractJob
+
+  def perform
+    puts payload
+  end
+
+end
+
+worker = QueueingRabbit::Worker.new(Reciter)
+
+poem = <<-
+  I said fate plays a game without a score,
+  and who needs fish if you've got caviar?
+  The triumph of the Gothic style would come to pass
+  and turn you on - no need for coke, or grass.
+  I sit by the window. Outside, an aspen.
+  When I loved, I loved deeply. It wasn't often.
+
+
+Thread.new {
+  poem.each_line { |l| Reciter.enqueue(l) }
+  sleep 5
+  worker.stop
+}
+
+worker.work!
+```
+
+This code has following important side effects:
+
+* A Rabbit queue named `Reciter` is created with default options (if not exists).
+* 6 messages are published to the default exchange with routing key `Reciter`.
+* 6 messages are consumed from the `Reciter` queue.
+* 6 lines of the poem are printed to STDOUT.
+
+## Choosing the back-end: bunny or amqp?
+
+`Bunny` is a pseudo-synchronous RabbitMQ client. `Amqp` is EventMachine-based and heavily asynchronous (lots of callbacks involved). Both clients are in active development, thoroughly documented and fairly stable.
+
+Choose `bunny` if you don’t want to worry about blocking I/O and EventMachine-compilant drivers. Choose `amqp` if you’re familiar with EventMachine, designing a lightweight app from scratch and performance is a serious concern. Obviously there are exceptions, and no one knows your requirements better than you.
+
+Also, you can use both of them. For example, you may decide to publish via `bunny` from your Rails app and use `amqp` in your background worker.
+
+## Documentation & Support
+
+Check out the [project wiki](https://github.com/temochka/queueing_rabbit/wiki) for additional guidance. If you have questions or something doesn’t work for you, feel free to file issues.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+QueueingRabbit supports MRI Ruby version 1.9.3 and above. It is still compilant with Ruby 1.8.7, but some features may not work as expected and the compatibility will be removed in the near future.
+
+Add this line to your application's `Gemfile`:
 
     gem 'queueing_rabbit'
 
@@ -18,16 +68,15 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it globally as:
 
     $ gem install queueing_rabbit
 
-## Usage
 
-QueueingRabbit is currently in RC1 and is not recommended for production use.
+## Special Thanks
 
-The docs are coming soon, currently you can check out the examples in
-`spec/integration` dir.
+* [Wildbit](http://wildbit.com) — for letting me open source this library initially developed for the internal use.
+* [RabbitMQ client libraries for Ruby](https://github.com/ruby-amqp) — for providing outstanding well-documented gems that made this project possible.
 
 ## Contributing
 

data/lib/queueing_rabbit/version.rb

@@ -1,3 +1,3 @@
 module QueueingRabbit
-  VERSION = "0.3.10"
+  VERSION = "0.4.0"
 end

data/queueing_rabbit.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/queueing_rabbit/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Artem Chistyakov"]
   gem.email         = ["chistyakov.artem@gmail.com"]
-  gem.summary       = %q{QueueingRabbit is an AMQP-based queueing system}
+  gem.summary       = %q{QueueingRabbit provides a flexible DSL to interact with RabbitMQ}
   gem.homepage      = "https://github.com/temochka/queueing_rabbit"
 
   gem.files         = `git ls-files`.split($\)
@@ -13,6 +13,7 @@ Gem::Specification.new do |gem|
   gem.name          = "queueing_rabbit"
   gem.require_paths = ["lib"]
   gem.version       = QueueingRabbit::VERSION
+  gem.license       = 'MIT'
 
   gem.extra_rdoc_files  = [ "LICENSE", "README.md" ]
   gem.rdoc_options      = ["--charset=UTF-8"]
@@ -23,17 +24,14 @@ Gem::Specification.new do |gem|
   gem.add_dependency "json",  ">= 0"
 
   gem.description   = <<description
-    QueueingRabbit is a Ruby library providing convenient object-oriented syntax
-    for managing background jobs using AMQP. The library implements amqp and
-    bunny gems as adapters making it possible to use synchronous publishing and
-    asynchronous consuming, which might be useful for Rails app running on
-    non-EventMachine based application servers (i. e. Passenger).
+    QueueingRabbit is a Ruby library providing a flexible DSL to interact with a
+    RabbitMQ server.
 
     Any Ruby class or Module can be transformed into QueueingRabbit's background
     job by including QueueingRabbit::Job module. It is also possible to inherit
     your class from QueueingRabbit::AbstractJob abstract class.
 
-    The library is bundled with a Rake task which is capable of starting a
-    worker processing a specified list of jobs.
+    The library is bundled with a Rake task to start a worker processing a list
+    of specified jobs.
 description
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: queueing_rabbit
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-27 00:00:00.000000000 Z
+date: 2014-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amqp
@@ -75,16 +75,12 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "    QueueingRabbit is a Ruby library providing convenient object-oriented
-  syntax\n    for managing background jobs using AMQP. The library implements amqp
-  and\n    bunny gems as adapters making it possible to use synchronous publishing
-  and\n    asynchronous consuming, which might be useful for Rails app running on\n
-  \   non-EventMachine based application servers (i. e. Passenger).\n\n    Any Ruby
-  class or Module can be transformed into QueueingRabbit's background\n    job by
-  including QueueingRabbit::Job module. It is also possible to inherit\n    your class
-  from QueueingRabbit::AbstractJob abstract class.\n\n    The library is bundled with
-  a Rake task which is capable of starting a\n    worker processing a specified list
-  of jobs.\n"
+description: ! "    QueueingRabbit is a Ruby library providing a flexible DSL to interact
+  with a\n    RabbitMQ server.\n\n    Any Ruby class or Module can be transformed
+  into QueueingRabbit's background\n    job by including QueueingRabbit::Job module.
+  It is also possible to inherit\n    your class from QueueingRabbit::AbstractJob
+  abstract class.\n\n    The library is bundled with a Rake task to start a worker
+  processing a list\n    of specified jobs.\n"
 email:
 - chistyakov.artem@gmail.com
 executables: []
@@ -160,7 +156,8 @@ files:
 - spec/unit/queueing_rabbit/worker_spec.rb
 - spec/unit/queueing_rabbit_spec.rb
 homepage: https://github.com/temochka/queueing_rabbit
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
@@ -174,7 +171,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1201733101669835717
+      hash: 3856307769293124515
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -183,13 +180,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1201733101669835717
+      hash: 3856307769293124515
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: QueueingRabbit is an AMQP-based queueing system
+summary: QueueingRabbit provides a flexible DSL to interact with RabbitMQ
 test_files:
 - spec/integration/asynchronous_batch_publishing_spec.rb
 - spec/integration/asynchronous_publishing_and_consuming_spec.rb