smart-que 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 605e197f083180d5577170fbf93ec5ef906a649b
+  data.tar.gz: fcd9aa512213de49962f8d98059d742ed2e69e2f
+SHA512:
+  metadata.gz: 84c4af92dcdbd96a637c91212bf045fd082964c14c478f4d7119ee2cd4d85c9676bc04db488b3fe02313bffd7f7d4aecd1a5bcf76341d9a870dd04b6d86a47bb
+  data.tar.gz: ce4a28136ea19d31e2d0b2522f0ce944c3ea97a4d3feb2f079a15042e6581d02cc551e191c317de1a7d87bedf37bd83ce25466ff87aeb73ce03ced235b83c9db

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/*

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ashiksp@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in smart_que.gemspec
+gemspec
+
+# Add required gems
+gem "bunny"
+gem "pry"
+gem 'guard'
+gem 'guard-minitest'
+gem 'mocha'

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    smart-que (0.1.0)
+
+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)
+    formatador (0.2.5)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.6)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    minitest (5.10.3)
+    mocha (1.2.1)
+      metaclass (~> 0.0.1)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rb-fsevent (0.10.2)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  bunny
+  guard
+  guard-minitest
+  minitest (~> 5.0)
+  mocha
+  pry
+  rake (~> 10.0)
+  smart-que!
+
+BUNDLED WITH
+   1.15.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ashik Salman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# SmartQue
+
+Welcome to SmartQue gem! This gem uses bunny library to connect with RabbitMq message broker
+to publish and consume messages with defined queues.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smart-que'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smart-que
+
+## Usage
+
+TODO: Write usage instructions here
+
+1. Setup [RabbitMq](https://www.rabbitmq.com/#getstarted)
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SmartQue project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/smart_que/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = false
+  t.warning = false
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "smart_que"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/smart_que.rb

@@ -0,0 +1,66 @@
+require "smart_que/version"
+require "smart_que/config"
+require "smart_que/errors"
+require "smart_que/publisher"
+
+require "bunny"
+require "yaml"
+require "json"
+require "logger"
+require 'fileutils'
+
+module SmartQue
+  # Methods related to configurations
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield(config) if block_given?
+    config
+  end
+
+  # Establish bunny connection
+  def self.establish_connection
+    return @conn if @conn
+
+    @conn ||= Bunny.new(
+      host: config.host,
+      port: config.port,
+      username: config.username,
+      password: config.password)
+
+    @conn.start
+    @conn
+  end
+
+  # Logger
+  def self.log(data)
+    env = ENV['RAILS_ENV'] || config.env
+
+    proc = Proc.new do
+      if config.logger
+        @logger = config.logger
+      else
+        logfile = config.logfile || default_log_file
+        @logger = Logger.new(logfile, 'weekly')
+      end
+    end
+
+
+    return if (env == 'testing' or env == 'test')
+
+    @logger ||= proc.call
+
+    @logger.info(data.inspect)
+  end
+
+  def self.default_log_file
+    log_file = "log/smart_que.log"
+    dir = File.dirname(log_file)
+    unless File.directory?(dir)
+      FileUtils.mkdir_p(dir)
+    end
+    log_file
+  end
+end

data/lib/smart_que/config.rb

@@ -0,0 +1,48 @@
+module SmartQue
+  class Config
+    # Configurations
+    # allowed configurations
+    CONFIGURATION = %w(host port queues env username password logfile logger)
+
+    # Initialize
+    def initialize
+      @config = {}
+      load_configuration_from_yml
+    end
+
+    def method_missing(name, *args)
+      setter = false
+
+      name = name.to_s
+
+      if name =~ /=$/
+        name = name.to_s.chop
+        setter = true
+      end
+
+      super(name, args) unless CONFIGURATION.include?(name)
+
+      if setter
+        set(name, args.first)
+      else
+        get(name)
+      end
+    end
+
+    private
+
+    def load_configuration_from_yml
+      if File.exist? 'config/smart_que.yml'
+        @config = YAML.load(File.read('config/smart_que.yml')) || @config
+      end
+    end
+
+    def set(key, val)
+      @config[key] = val
+    end
+
+    def get(key)
+      @config[key]
+    end
+  end
+end

data/lib/smart_que/errors.rb

@@ -0,0 +1,7 @@
+module SmartQue
+  class QueueNotFoundError < StandardError
+    def message
+      "Queue doesn't exist"
+    end
+  end
+end

data/lib/smart_que/publisher.rb

@@ -0,0 +1,35 @@
+require_relative "publishers/base"
+
+module SmartQue
+  class Publisher < Publishers::Base
+    
+    # Initialize
+    def initialize
+      queue_list.each do |q_name|
+        q = get_queue(q_name)
+        q.bind(x_direct, routing_key: q.name)
+      end
+    end
+
+    # Instance methods
+
+    # Publish message to the respective queue
+    def publish(queue, options = {})
+      # 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}")
+      else
+        log_message("Publish status: failed, Queue(#{queue}) doesn't exist.")
+        log_message("Content : #{options}")
+        raise QueueNotFoundError
+      end
+    end
+  end
+end

data/lib/smart_que/publishers/base.rb

@@ -0,0 +1,42 @@
+module SmartQue
+  module Publishers
+    class Base
+      # List Queues from configuration
+      def queue_list
+        @queue_list ||= ::SmartQue.config.queues
+      end
+
+      # Methods related to bunny exchange, channels, queues
+      def channel
+        @channel ||= connection.create_channel
+      end
+
+      # Direct exchange
+      def x_direct
+        @x_direct ||= channel.direct("smartque.direct")
+      end
+
+      # Connection Object
+      def connection
+        ::SmartQue.establish_connection
+      end
+
+      # Get/Set queue with name
+      # name : sms_otp
+      def get_queue(q_name)
+        channel.queue(modified_q_name(q_name))
+      end
+
+      # Logging
+      def log_message(data)
+        ::SmartQue.log(data)
+      end
+
+      private
+
+      def modified_q_name(q_name)
+        q_name.downcase.sub('_','.')
+      end
+    end
+  end
+end

data/lib/smart_que/version.rb

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

data/smart_que.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "smart_que/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "smart-que"
+  spec.version       = SmartQue::VERSION
+  spec.authors       = ["Ashik Salman"]
+  spec.email         = ["ashiksp@gmail.com"]
+
+  spec.summary       = %q{Queue Publisher & Consumer}
+  spec.description   = %q{Publish messages to RabbitMq broker and Consume with independent workers.}
+  spec.homepage      = "https://github.com/ashiksp/smart_que"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: smart-que
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ashik Salman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Publish messages to RabbitMq broker and Consume with independent workers.
+email:
+- ashiksp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smart_que.rb
+- lib/smart_que/config.rb
+- lib/smart_que/errors.rb
+- lib/smart_que/publisher.rb
+- lib/smart_que/publishers/base.rb
+- lib/smart_que/version.rb
+- smart_que.gemspec
+homepage: https://github.com/ashiksp/smart_que
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Queue Publisher & Consumer
+test_files: []