smart-que 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 605e197f083180d5577170fbf93ec5ef906a649b
-  data.tar.gz: fcd9aa512213de49962f8d98059d742ed2e69e2f
+  metadata.gz: 529f52a47cda3ae2921d73514be3ab68dc162480
+  data.tar.gz: 6bf9acfd151c73aec7e1fb52036f096fe2b3036e
 SHA512:
-  metadata.gz: 84c4af92dcdbd96a637c91212bf045fd082964c14c478f4d7119ee2cd4d85c9676bc04db488b3fe02313bffd7f7d4aecd1a5bcf76341d9a870dd04b6d86a47bb
-  data.tar.gz: ce4a28136ea19d31e2d0b2522f0ce944c3ea97a4d3feb2f079a15042e6581d02cc551e191c317de1a7d87bedf37bd83ce25466ff87aeb73ce03ced235b83c9db
+  metadata.gz: 773828ad29daa876e46611d6be154f6c21f561a7a4849bac9f58305e5b6535032d6854c2a1e540927486734b6a56687dc7914f4cd3c86762da9b9b763f43a4ed
+  data.tar.gz: 8be6f714be2d6344d7ea79861c62ab224dd95b2cd1fe7cf4a34c4501c0d39663baadc0aa59f479a3aad8ddf919a84c8408375743e30fc5b62173785912c3f2cb

data/README.md

@@ -24,13 +24,91 @@ Or install it yourself as:
 TODO: Write usage instructions here
 
 1. Setup [RabbitMq](https://www.rabbitmq.com/#getstarted)
+2. Add `smart-que` gem to your Gemfile and perform bundle install
+3. Create Publisher/Consumer classes & start publish/consume messages
+
+## SmartQue Publisher
+
+SmartQue publisher is used to publish messages to the previously setup RabbitMq
+server. All messages are converted to JSON format before publishing to the queue.
+RabbitMq server details and queue lists can be configured as follows
+
+```
+file: config/initializers/smart_que.rb
+
+SmartQue.configure do |f|
+  f.host = ENV[:rabbit_mq][:host']
+  f.port = ENV[:rabbit_mq][:port']
+  f.username = ENV[:rabbit_mq][:username']
+  f.password = ENV[:rabbit_mq][:password']
+  f.logger = Rails.logger
+  f.queues = [
+      'default',
+      'sms_otp',
+      'fcm_push'
+  ]
+end
+
+$publisher = SmartQue::Publisher.new
+
+```
+
+After initializing SmartQue publisher, it can be accessed anywhere in the rails application
+to publish messages to the RabbitMq server.
+
+```
+$publisher.publish('sms_otp', { number: '+919898123123', message: 'Test Message' })
+```
+
+## SmartQue Consumer
+
+The consumer class should be inherited from SmartQue::Consumer, and each consumer will be
+listening to a defined Queue. The queue name and `run` method should be defined properly
+in each consumer class.
+
+```
+Class OtpSmsConsumer < SmartQue::Consumer
+  QUEUE_NAME = 'sms.otp'
+
+  def run(payload)
+    # Payload: { number: '+919898123123', message: 'Test Message' }
+    # Method implementation goes here
+  end
+end
+```
+
+Note that, queue name words are separated by `.` while defining it with consumer class.
+Consumer can be started by calling `start` method available for consumer instance as follows
+
+```
+c = OtpSmsConsumer.new
+c.start
+```
+
+All consumer processes can be placed in a rake file, so that it can be started individually
+with rake tasks.
+
+```
+File : lib/tasks/consumer.rake
+
+# Tasks which related to rabbitmq broker.
+namespace :rabbitmq do
+
+  desc "Run OTP sms worker"
+  task :send_otp_sms => [:environment] do
+    c = OtpSmsConsumer.new
+    c.start
+  end
+end
+
+# Task can be initiated by rake
+RAILS_ENV=staging bundle exec rake rabbitmq:send_otp_sms
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-Under Development !!!
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/smart_que. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/smart_que.rb

@@ -2,6 +2,7 @@ require "smart_que/version"
 require "smart_que/config"
 require "smart_que/errors"
 require "smart_que/publisher"
+require "smart_que/consumer"
 
 require "bunny"
 require "yaml"

data/lib/smart_que/consumer.rb

@@ -0,0 +1,20 @@
+require_relative "consumers/base"
+
+module SmartQue
+  class Consumer < Consumers::Base
+    
+    # Initialize
+    def initialize(queue_name = nil)
+      @queue_name = ( queue_name || self.class::QUEUE_NAME )
+    end
+
+    # Instance methods
+
+    # Consume message and perform tasks
+    def run(payload)
+      # Implement logic in the corresponding consumer
+      Rails.logger.info "Not Implemented, Please define run method for the consumer class."
+      :ok
+    end
+  end
+end

data/lib/smart_que/consumers/base.rb

@@ -0,0 +1,62 @@
+module Consumers
+  class Base
+    # Methods which are related to implement a base consumer.
+
+    # The queue name should be defined here.
+    QUEUE_NAME = 'smart_que.default'
+
+    attr_accessor :queue_name
+
+    def queue_name
+      @queue_name
+    end
+
+    # This method will return the default queue which present
+    # in the message queues. Consumer specific queue should be
+    # defined and implemented in the consumer sub classes.
+    def queue
+      @queue ||= channel.queue(queue_name)
+    end
+
+    # Establish connection to Message Queues.
+    def connection
+      ::SmartQue.establish_connection
+    end
+
+    # Create channel with the established connection.
+    def channel
+      @channel ||= connection.create_channel
+    end
+
+    def config
+      ::SmartQue.config
+    end
+
+    # Method which kick start the consumer process thread
+    def start
+      channel.prefetch(10)
+      queue.subscribe(manual_ack: true, exclusive: false) do |delivery_info, metadata, payload|
+        begin
+          body = JSON.parse(payload).with_indifferent_access
+          status = run(body)
+        rescue => e
+          status = :error
+        end
+
+        if status == :ok
+          channel.ack(delivery_info.delivery_tag)
+        elsif status == :retry
+          channel.reject(delivery_info.delivery_tag, true)
+        else # :error, nil etc
+          channel.reject(delivery_info.delivery_tag, false)
+        end
+      end
+
+      wait_for_threads
+    end
+
+    def wait_for_threads
+      sleep
+    end
+  end
+end

data/lib/smart_que/publishers/base.rb

@@ -32,6 +32,10 @@ module SmartQue
         ::SmartQue.log(data)
       end
 
+      def config
+        ::SmartQue.config
+      end
+
       private
 
       def modified_q_name(q_name)

data/lib/smart_que/version.rb

@@ -1,3 +1,3 @@
 module SmartQue
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart-que
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ashik Salman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,8 @@ files:
 - bin/setup
 - lib/smart_que.rb
 - lib/smart_que/config.rb
+- lib/smart_que/consumer.rb
+- lib/smart_que/consumers/base.rb
 - lib/smart_que/errors.rb
 - lib/smart_que/publisher.rb
 - lib/smart_que/publishers/base.rb