sevak 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 843314fe964ef77b46ef99e377238d8e2dde944d
-  data.tar.gz: 1a78b5c0c64586baa439bdbf56bbd9e3cb6247c4
+  metadata.gz: 4ba1b1f19dfedbf1f09684c3f20bf0961b43ab8e
+  data.tar.gz: 6e009c195d675174db7bea30d5d9545e431c3a66
 SHA512:
-  metadata.gz: 5e8659484405844cd142746fb840d7854d78b087e7321a8c751be03a58c81c8e83c46ed593f071a8cedd7a622562a53df8c98621a5fcc826abce41dee0f9be64
-  data.tar.gz: 076114e4da8d8fa2039b185754b9779ef8cc020631e2022bd4da081f24fb776a90a59fb242ad030fb580100faa82cfebf284eab23a70f0ecda34cc5b326649ca
+  metadata.gz: 8110cea597ffa6e22441f222a6e793599047a5707dc4b2c71993d8e3cad37a369eb7269ec31ccbdec2432fe58b64d8c3f0ed537c3ea3ab16ab5402443583dd0b
+  data.tar.gz: 901110f1a5d8700e8cbf3a32d9a04985dcca4b0339f6b51ad8abb11cde0f668bebd7f3f6a538ab62b0783ca5ef954f9b3d72a18119ce8b33cc5dead1fc9c369c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sevak (0.2.0)
+    sevak (0.4.0)
       bunny
 
 GEM

data/README.md

@@ -1,47 +1,71 @@
-Sevak gem provides makes it easy to send and receive messages from rabbitmq queues. It is buit on top of the bunny gem.
-
+Sevak gem makes it easy to send and receive messages from rabbitmq queues. It is built on top of the bunny gem.
+It also supports delayed queuing using [rabbitmq delayed exchange plugin](https://github.com/rabbitmq/rabbitmq-delayed-message-exchange)
 
 Usage:
 
+Dependencies
+
+* [rabbitmq delayed exchange plugin](https://github.com/rabbitmq/rabbitmq-delayed-message-exchange)
+To install this plugin:
+    1. Download the latest build for the plugin from [here](http://www.rabbitmq.com/community-plugins.html)
+    2. Enable the plugin using command:
+
+        rabbitmq-plugins enable rabbitmq_delayed_message_exchange
+
 Install
     
     gem install sevak
 
-Congigure
+Configuration
+    Create a file under `config/initializers` and add following lines to that file:
 
-    Sevak.configure do |f|
-        f.host = 'localhost'
-        f.port = '5672'
-        f.user = 'username'
-        f.password = 'password'
-        f.prefetch_count = 10
-    end
+        Sevak.configure do |f|
+            f.host = 'localhost'
+            f.port = '5672'
+            f.user = 'username'
+            f.password = 'password'
+            f.prefetch_count = 10
+        end
+
+
+Usage
 
-In your code to publish some message to a queue 'sms'.
+### Publishing to a queue
 
+To publish any message to a queue use the following syntax:
     
-    Sevak::Publisher.publish('sms', message = { name: 'Deepak', msisdn: '9078657543' })
+    Sevak::Publisher.publish(*queue_name*, *message*)
 
 If the queue is not present already it will be created automatically.
 
+Example usage: 
 
-To receive message from this queue and process the message a create a consumer.
+    Sevak::Publisher.delayed_publish('sms', message = { name: 'Deepak', msisdn: '9078657543' })
 
+### Publishing to a queue with a delay
+
+To publish any message to a queue with some delay use the following syntax:
+    
+    Sevak::Publisher.publish(*queue_name*, *message*, *delay in milliseconds*)
+
+Exaple usage:
+
+    Sevak::Publisher.delayed_publish('sms', message = { name: 'Deepak', msisdn: '9078657543' }, 10000)
+
+This will publish the message to an exchange which will route the message to the specified queue with a delay of 10 seconds.
+
+### Receiving messages from ths queues
+To receive message from this queue and process the message create a consumer file inside your project under `app/controllers`.
 
     class SmsConsumer < Sevak::Consumer
         
         queue_name 'sms'
         
         def run(message)
-            status = process(message)
-            status
+            *process the message*
         end
         
         ..
     end
 
 The return status can have three values :ok, :error, :retry.
-
-Publishing to the queue
-
-    Publisher.publish('in.chillr.email', { name: 'Deepak Kumar', message: 'welcome', email: 'deepak@chillr.in' }) 

data/lib/sevak/publisher.rb

@@ -6,11 +6,28 @@ module Sevak
     include Singleton
 
     def self.publish(queue_name, message)
-      instance.channel.queue(queue_name).publish(message.to_json)
+      instance.queue(queue_name).publish(message.to_json)
+    end
+
+    def self.delayed_publish(queue_name, message, delay = 0)
+      instance.publish_exchange(queue_name, message, delay)
     end
 
     def channel
       @channel ||= connection.create_channel
     end
+
+    def queue(queue_name)
+      @queue ||= channel.queue(queue_name)
+    end
+
+    def exchange(queue_name)
+      @exchange ||= channel.exchange("#{queue_name}_exchange", type: "x-delayed-message", arguments: { "x-delayed-type" => "direct" })
+    end
+
+    def publish_exchange(queue_name, message, delay)
+      queue(queue_name).bind(exchange(queue_name))
+      exchange(queue_name).publish(message.to_json, headers: { "x-delay" => delay })
+    end
   end
-end
+end

data/lib/sevak/version.rb

@@ -1,3 +1,3 @@
 module Sevak
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sevak
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Deepak Kumar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-21 00:00:00.000000000 Z
+date: 2018-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -42,12 +42,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- chillr_sevak.gemspec
 - lib/sevak.rb
 - lib/sevak/consumer.rb
 - lib/sevak/core.rb
 - lib/sevak/publisher.rb
 - lib/sevak/version.rb
+- sevak.gemspec
 - tasks/.keep
 homepage: ''
 licenses:
@@ -69,9 +69,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Consumers for chillr api
 test_files: []
-has_rdoc: