smart-que 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cf953f15f60241f8a52e4025d4be07ddaced6cd
-  data.tar.gz: 0d054f939176d647268548a8c4e210435dec7876
+  metadata.gz: 1836ac2d48717aee44d47c1c5025cc69c34ac58d
+  data.tar.gz: 3ba9f72b6b3185eeb72d75bc84250f98ad4983f4
 SHA512:
-  metadata.gz: 63441db9cf0d5ca6b05786c80e3d34876c2f14b855fd45b9b72b3cea98df7bd290e1f02a573d878df716dab8007debec6456e0566a5bf1be23b0355ee89a6535
-  data.tar.gz: 33fb2dbcc03e158ab3b121a12d6f9875f4a8887bd96c458103adaf0fc9f4a19a7eed218c6ffd898c78cec5ceefb9c8ec42a4e6b5b165e2a288328d3d568d6b71
+  metadata.gz: 138dfac1cba953b04d0f252e78fc3dee607aea276b960af1d5809f65b31fa19bcb34d54e154859fd5be828682b311a6cec5a9afe7173240069c4f283d990dc2f
+  data.tar.gz: 39554d1078fe45df50dc11c97e2204fa308aa5392dfa9e937074f46b8e10580f479a82a5849d696d0cc3bc24151f393736d938cd0b86c44abe11891ab9fb3e52

data/Gemfile

@@ -6,7 +6,11 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 # Add required gems
-gem "bunny"
+gem "bunny", '~> 2.11.0'
+
+# Channel Connections
+gem "connection_pool", '~> 2.2.1'
+
 gem "pry"
 gem 'guard'
 gem 'guard-minitest'

data/Gemfile.lock

@@ -1,21 +1,24 @@
 PATH
   remote: .
   specs:
-    smart-que (0.1.0)
+    smart-que (0.2.2)
+      bunny (~> 2.11)
+      connection_pool (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    amq-protocol (2.2.0)
-    bunny (2.7.0)
-      amq-protocol (>= 2.2.0)
-    coderay (1.1.1)
-    ffi (1.9.18)
+    amq-protocol (2.3.0)
+    bunny (2.11.0)
+      amq-protocol (~> 2.3.0)
+    coderay (1.1.2)
+    connection_pool (2.2.2)
+    ffi (1.9.25)
     formatador (0.2.5)
-    guard (2.14.1)
+    guard (2.14.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
-      lumberjack (~> 1.0)
+      lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
       pry (>= 0.9.12)
@@ -29,42 +32,41 @@ GEM
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
-    lumberjack (1.0.12)
+    lumberjack (1.0.13)
     metaclass (0.0.4)
-    method_source (0.8.2)
-    minitest (5.10.3)
-    mocha (1.2.1)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    mocha (1.5.0)
       metaclass (~> 0.0.1)
     nenv (0.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    pry (0.10.4)
+    pry (0.11.3)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (10.5.0)
-    rb-fsevent (0.10.2)
+      method_source (~> 0.9.0)
+    rake (12.3.1)
+    rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
     ruby_dep (1.5.0)
     shellany (0.0.1)
-    slop (3.6.0)
-    thor (0.19.4)
+    thor (0.20.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.15)
-  bunny
+  bundler (~> 1.16)
+  bunny (~> 2.11.0)
+  connection_pool (~> 2.2.1)
   guard
   guard-minitest
-  minitest (~> 5.0)
+  minitest (~> 5.11)
   mocha
   pry
-  rake (~> 10.0)
+  rake (~> 12.3)
   smart-que!
 
 BUNDLED WITH
-   1.15.3
+   1.16.2

data/README.md

@@ -8,7 +8,7 @@ to publish and consume messages with defined queues.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'smart-que'
+gem 'smart-que', '~> 0.2.0'
 ```
 
 And then execute:
@@ -17,7 +17,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install smart-que
+    $ gem install smart-que -v 0.2.0
 
 ## Usage
 
@@ -38,6 +38,7 @@ RabbitMq server details and queue lists can be configured as follows
 SmartQue.configure do |f|
   f.host = ENV[:rabbit_mq][:host']
   f.port = ENV[:rabbit_mq][:port']
+  f.vhost = ENV[:rabbit_mq][:vhost']
   f.username = ENV[:rabbit_mq][:username']
   f.password = ENV[:rabbit_mq][:password']
   f.logger = Rails.logger
@@ -63,6 +64,39 @@ to publish messages to the RabbitMq server.
 $publisher.publish('sms_otp', { number: '+919898123123', message: 'Test Message' })
 ```
 
+
+## SmartQue unicast
+
+```
+$publisher.unicast(queue_name, payload)
+```
+
+The `unicast` method will provide an option to publish message to any queue which are
+not predefined with initialization configuration. The `queue_name` parameter can be any queue
+name, which will be created and bind to direct exchange instantly if doesn't exist.
+
+```
+$publisher.unicast('sms_alert', { number: '+919898123123', message: 'Test Message' })
+```
+
+
+
+## SmartQue multicast
+
+```
+$publisher.multicast(topic_name, payload)
+```
+
+The `multicast` method will provide an option to multicast message to queues which are
+not predefined with initialization configuration. The `topic_name` parameter can be any
+topic name and message will be consumable by any queues which subscribe to this topic
+name.
+
+```
+$publisher.multicast('weather', { message: 'Test Message' })
+```
+
+
 ## SmartQue Consumer
 
 The consumer class should be inherited from SmartQue::Consumer, and each consumer will be

data/lib/smart_que.rb

@@ -22,17 +22,31 @@ module SmartQue
   end
 
   # Establish bunny connection
-  def self.establish_connection
-    return @conn if @conn
+  def self.establish_connection(options = {})
+    unless @conn_pool
+      @conn_pool = ConnectionPool.new do
+        create_connection(options)
+      end
+    end
+
+    @conn_pool.with do |conn|
+      conn
+    end
+  end
 
-    @conn ||= Bunny.new(
+  def self.create_connection(options = {})
+    conn = Bunny.new(
       host: config.host,
       port: config.port,
+      vhost: fetch_parameters('vhost'),
       username: config.username,
-      password: config.password)
+      password: config.password
+    )
+    conn.start
+  end
 
-    @conn.start
-    @conn
+  def self.fetch_parameters(parameter, options = {})
+    (options[parameter] || config.send(parameter))
   end
 
   # Logger

data/lib/smart_que/config.rb

@@ -2,7 +2,7 @@ module SmartQue
   class Config
     # Configurations
     # allowed configurations
-    CONFIGURATION = %w(host port queues env username password logfile logger)
+    CONFIGURATION = %w(host vhost port queues env username password logfile logger)
 
     # Initialize
     def initialize

data/lib/smart_que/publisher.rb

@@ -6,30 +6,56 @@ module SmartQue
     # Initialize
     def initialize
       queue_list.each do |q_name|
-        q = get_queue(q_name)
-        q.bind(x_direct, routing_key: q.name)
+        find_or_initialize_queue(q_name)
       end
     end
 
     # Instance methods
 
     # Publish message to the respective queue
-    def publish(queue, options = {})
+    def publish(queue, payload = {})
       # Check queue name includes in the configured list
       # Return if queue doesn't exist
       if queue_list.include? queue
         # Publish sms to queue
         x_direct.publish(
-                          options.to_json,
-                          mandatory: true,
-                          routing_key: get_queue(queue).name
-                        )
-        log_message("Publish status: success, Queue : #{queue}, Content : #{options}")
+          payload.to_json,
+          mandatory: true,
+          routing_key: get_queue(queue).name
+        )
+        log_message("Publish status: success, Queue : #{queue}, Content : #{payload}")
       else
         log_message("Publish status: failed, Queue(#{queue}) doesn't exist.")
-        log_message("Content : #{options}")
+        log_message("Content : #{payload}")
         raise QueueNotFoundError
       end
     end
+
+    # unicast message to queues
+    def unicast(q_name, payload = {})
+      x_default.publish(
+        payload.to_json,
+        routing_key: dot_formatted(q_name)
+      )
+      log_message("unicast status: success, Queue : #{q_name}, Content : #{payload}")
+    end
+
+
+    # multicast message to queues based on topic subscription
+    def multicast(topic, payload = {})
+      x_topic.publish(
+        payload.to_json,
+        routing_key: dot_formatted(topic)
+      )
+      log_message("multicast status: success, Topic : #{topic}, Content : #{payload}")
+    end
+
+    # broadcast message to queues based on topic subscription
+    def broadcast(payload = {})
+      x_fanout.publish(
+        payload.to_json
+      )
+      log_message("broadcast status: success, Content : #{payload}")
+    end
   end
 end

data/lib/smart_que/publishers/base.rb

@@ -1,19 +1,43 @@
+require 'connection_pool'
+
 module SmartQue
   module Publishers
     class Base
       # List Queues from configuration
       def queue_list
-        @queue_list ||= ::SmartQue.config.queues
+        ::SmartQue.config.queues
       end
 
       # Methods related to bunny exchange, channels, queues
+      def channel_pool
+        @channel_pool ||= ConnectionPool.new do
+          connection.create_channel
+        end
+      end
+
       def channel
-        @channel ||= connection.create_channel
+        channel_pool.with do |channel|
+          channel
+        end
       end
 
       # Direct exchange
       def x_direct
-        @x_direct ||= channel.direct("smartque.direct")
+        channel.direct("amq.direct")
+      end
+
+      def x_default
+        channel.default_exchange
+      end
+
+      # Topic exchange
+      def x_topic
+        channel.topic("amq.topic")
+      end
+
+      # Fanout exchange
+      def x_fanout
+        channel.fanout("amq.fanout")
       end
 
       # Connection Object
@@ -21,10 +45,18 @@ module SmartQue
         ::SmartQue.establish_connection
       end
 
+      def find_or_initialize_queue(q_name)
+        q = get_queue(q_name)
+        q.bind(x_direct, routing_key: q.name)
+      end
+
       # Get/Set queue with name
       # name : sms_otp
-      def get_queue(q_name)
-        channel.queue(modified_q_name(q_name))
+      def get_queue(q_name, options = {})
+        unless options[:dot_format] == false
+          q_name = modified_q_name(q_name)
+        end
+        channel.queue(q_name)
       end
 
       # Logging
@@ -39,7 +71,11 @@ module SmartQue
       private
 
       def modified_q_name(q_name)
-        q_name.downcase.sub('_','.')
+        dot_formatted(q_name)
+      end
+
+      def dot_formatted(name_string)
+        name_string.downcase.gsub(/[\/|\_]/,".")
       end
     end
   end

data/lib/smart_que/version.rb

@@ -1,3 +1,3 @@
 module SmartQue
-  VERSION = "0.2.0"
+  VERSION = "0.2.3"
 end

data/smart_que.gemspec

@@ -31,10 +31,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Run time dependencies
-  spec.add_runtime_dependency "bunny", "~> 2.7.0"
+  spec.add_runtime_dependency "bunny", "~> 2.11"
+  spec.add_runtime_dependency "connection_pool", "~> 2.2"
 
   # Development Dependencies
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "minitest", "~> 5.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart-que
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Ashik Salman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2018-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -16,56 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '2.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.11'
 description: Publish messages to RabbitMq broker and Consume with independent workers.
 email:
 - ashiksp@gmail.com