rmsg 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 384ab1300d4295b580a206f3607756bb2f3dc54b
-  data.tar.gz: 44032af1a2b53f8b9ec0aac81da5b255b3b01af4
+  metadata.gz: d584ea38af8db2b4492bc2f4ac94b2cb9688e489
+  data.tar.gz: 51cb5b1e0d85825525be13e078757caadb5a5009
 SHA512:
-  metadata.gz: 358b8c438fcd876e91a25dfec69a0492893be5e65f3780e3d2394c9c4c085445ff1645394a40ab0b9afc1975ec469b44aeb197f7e9653401ce440b98c7764c3c
-  data.tar.gz: 981c1c80528e67ca5f6c9ffb6ed38fa20a2b03cea470a145452bc9f805298fbec27a6e6ff48e381eede4d73d6a35e08ac328843bf1139f05b5c5c995df13fe28
+  metadata.gz: 27c5e065f5f75924352f4b1f774dcbcc0e26745a3854e07a6fab12162c313036070d5f14fe16ca1f3b0f773fcf8542c10dc55cd8b8d55dbf53cbffc0b2846cd5
+  data.tar.gz: 63703855f633d97edcc1d4a4b7db89aaf1ee5a36a4cc2ac07cae9cca6efe64e31bc881d526e0cedcd1328a5802cb8bccd9ef788f9034e2b7eb012c480c8f6c2b

data/lib/rmsg/rabbit.rb

@@ -1,13 +1,19 @@
 module Rmsg
   class Rabbit
-    attr_reader :connection, :channel
+    # @return [Bunny::Connection]
+    attr_reader :connection
+    # @return [Bunny::Channel]
+   attr_reader  :channel
 
+   # On creation holds references to RabbitMQ via
+   # a Bunny connection and a Bunny channel.
     def initialize
       @connection = Bunny.new
       @connection.start
       @channel = @connection.create_channel
     end
 
+    # Close the channel and the connection to RabbitMQ.
     def close
       @channel.close
       @connection.close

data/lib/rmsg/task.rb

@@ -1,14 +1,30 @@
 module Rmsg
+  # Task handles publishing tasks and processing them.
   class Task
+    # When initializing a task handler, the queue
+    # will be declared durable, to survive RabbitMQ restarts.
+    # @param params [Hash]
+    # * :rabbit [Rmsg::Rabbit] Example: Rmsg::Rabbit.new
+    # * :queue [String] Example: 'messages'
     def initialize(params)
       @rabbit = params[:rabbit]
       @queue = @rabbit.channel.queue(params[:queue], durable: true)
     end
 
+    # Publish a message in the tasks queue.
+    # It is marked a persistent to survive RabbitMQ restarts.
+    # @param message [Hash] The message to be consumed.
     def publish(message)
       @queue.publish(message.to_json, presistent: true)
     end
 
+    # Subscribe to the tasks queue.
+    # Subscribing happens by continuously blocking the current process.
+    # It is specifically designed for long running processes.
+    # When receiving INT it will gracefully close.
+    # Consumer processes have a prefetch value of 1 for round-robin distribution.
+    # Consumer processes will send a manual ack after processing, to avoid losing tasks.
+    # @yield message [Hash] A block to process the message received.
     def subscribe
       @rabbit.channel.prefetch(1)
       begin

data/lib/rmsg/topic.rb

@@ -1,14 +1,29 @@
 module Rmsg
+  # Topic handles publishing and subscribing
+  # to a topic with a key, over RabbitMQ.
   class Topic
+    # @param params [Hash]
+    # * :rabbit [Rmsg::Rabbit] Example: Rmsg::Rabbit.new
+    # * :topic [String] Example: 'services'
     def initialize(params)
       @rabbit = params[:rabbit]
       @exchange = @rabbit.channel.topic(params[:topic])
     end
 
+    # Publish a message with a routing key.
+    # @param message [Hash] Example: {id: 1, key: 'xxxccc'}
+    # @param key [String] Example: 'users.key_changed'
+    # @return [Exchange] The exchange used to publish.
     def publish(message, key)
       @exchange.publish(message.to_json, :routing_key => key)
     end
 
+    # Subscribe to the topic, listening for a specific key.
+    # Subscribing happens by continuously blocking the current process.
+    # It is specifically designed for long running processes.
+    # When receiving INT it will gracefully close.
+    # @param key [String] Example: 'users.key_changed'
+    # @yield message [Hash] A block to process the message received.
     def subscribe(key)
       @queue = @rabbit.channel.queue("", :exclusive => true)
       @queue.bind(@exchange, :routing_key => key)

data/lib/rmsg/version.rb

@@ -1,3 +1,3 @@
 module Rmsg
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/rmsg.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "rmsg"
   spec.version       = Rmsg::VERSION
   spec.authors       = ["badshark"]
-  spec.email         = ["info@badshark.io"]
+  spec.email         = ["marco@badshark.io"]
   spec.summary       = %q{RabbitMQ messaging.}
   spec.description   = %q{RabbitMQ messaging with topics and tasks. A thin, minimal layer on top of Bunny.}
   spec.homepage      = "https://github.com/badshark/rmsg"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rmsg
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - badshark
@@ -69,7 +69,7 @@ dependencies:
 description: RabbitMQ messaging with topics and tasks. A thin, minimal layer on top
   of Bunny.
 email:
-- info@badshark.io
+- marco@badshark.io
 executables: []
 extensions: []
 extra_rdoc_files: []