rt-tackle 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c97d2ff7d67880695b2d97d2ecad9b07abafaca6
-  data.tar.gz: 33cb64ad00cc670d12d675103e2f0a81f1c4ca9b
+  metadata.gz: beb7fcc50f104dade384ab9e3090d1edc68c8c6e
+  data.tar.gz: 87865b2ef1bea50c964d75cc79302a7aa29b9157
 SHA512:
-  metadata.gz: 536a9691867f1a5d25f1cc35785f99c777e4172f826bd65e03d42432647301de49ecdb6d02c7000560e3284859141b5e11c5249337ac164f24bb9b640a878f7f
-  data.tar.gz: 3b6f70028efc46b0ce4fda79a0305354ebc749a6a580f7bcf117e2d0e09487629841dad15281b41b18c16233ea3026943a86b9d0489d2ecf0dff907d84b55583
+  metadata.gz: c6daaaaaab58645d5a22450790a7f44e30304ac68329bec4369d2024f790e5d39a0f6812e26a981ffb3d1bb4c356f14606523d0ecf4ccbd347965beb1ce4fead
+  data.tar.gz: 8760c4719ebb9c953fbb8e6aa30a65de5e4332a7a956fb32c1c51906f822952883096769e1982e5154f534d8e80092b4153e415afb00c1561e3e30ed2568bda4

data/README.md

@@ -1,6 +1,6 @@
 # Tackle
 
-[![Build Status](https://semaphoreci.com/api/v1/projects/b39e2ae2-2516-4fd7-9e2c-f5be1a043ff5/732979/badge.svg)](https://semaphoreci.com/renderedtext/tackle)
+[![Build Status](https://semaphoreci.com/api/v1/renderedtext/tackle/branches/master/badge.svg)](https://semaphoreci.com/renderedtext/tackle)
 
 Tackles the problem of processing asynchronous jobs in reliable manner
 by relying on RabbitMQ.
@@ -15,42 +15,97 @@ gem "rt-tackle", :require => "tackle"
 
 ## Usage
 
-### Subscribe consumer:
+### Publishing a message
+
+With tackle, you can publish a message to an AMQP exchange. For example, to
+publish `"Hello World!"` do the following:
+
+```ruby
+options = {
+  :url => "amqp://localhost",
+  :exchange => "test-exchange",
+  :routing_key => "test-messages",
+}
+
+Tackle.publish("Hello World!", options)
+```
+
+Optionally, you can pass a dedicated logger to the publish method. This comes
+handy if you want to log the status of your publish action to a file.
+
+```ruby
+options = {
+  :url => "amqp://localhost",
+  :exchange => "test-exchange",
+  :routing_key => "test-messages",
+  :logger => Logger.new("publish.log")
+}
+
+Tackle.publish("Hello World!", options)
+```
+
+### Subscribe to an exchange
+
+To consume messages from an exchange, do the following:
 
 ```ruby
 require "tackle"
 
 options = {
-  :url         => "amqp://localhost", # optional
-  :exchange    => "test-exchange",    # required
-  :routing_key => "test-messages",    # required
-  :queue       => "test-queue",       # required
-  :retry_limit => 8,                  # optional
-  :retry_delay => 30,                 # optional
-  :logger      => Logger.new(STDOUT)  # optional
+  :url => "amqp://localhost",
+  :exchange => "test-exchange",
+  :routing_key => "test-messages",
+  :queue => "test-queue"
 }
 
 Tackle.subscribe(options) do |message|
-  # Do something with message
+  puts message
 end
 ```
 
-### Publish message:
+By default, tackle will retry any message that fails to be consumed. To
+configure the retry limit and the delay in which the messages will be retried,
+do the following:
 
 ```ruby
+require "tackle"
 
 options = {
-  :url         => "amqp://localhost", # optional
-  :exchange    => "test-exchange",    # required
-  :routing_key => "test-messages",    # required
-  :logger      => Logger.new(STDOUT)  # optional
+  :url => "amqp://localhost",
+  :exchange => "test-exchange",
+  :routing_key => "test-messages",
+  :queue => "test-queue",
+  :retry_limit => 8,
+  :retry_delay => 30
 }
 
-Tackle.publish("Hello, world!", options)
+Tackle.subscribe(options) do |message|
+  puts message
+end
 ```
 
-## Development
+Tackle uses the `STDOUT` by default to trace the state of incoming messages. You
+can pass a dedicated logger to the `subscribe` method to redirect the output:
 
+```ruby
+require "tackle"
+
+options = {
+  :url => "amqp://localhost",
+  :exchange => "test-exchange",
+  :routing_key => "test-messages",
+  :queue => "test-queue",
+  :retry_limit => 8,
+  :retry_delay => 30,
+  :logger => Logger.new("subscribe.log")
+}
+
+Tackle.subscribe(options) do |message|
+  puts message
+end
+```
+
+## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then,
 run `rake rspec` to run the tests. You can also run `bin/console` for an

data/lib/tackle/version.rb

@@ -1,3 +1,3 @@
 module Tackle
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rt-tackle
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Rendered Text
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-02 00:00:00.000000000 Z
+date: 2016-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny