rabbitmq-async 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e322d503327fa3e56401e658d83ad3e0ba9b350f
+  data.tar.gz: ae375b9e8a523800832847d7f390d49a401c1f40
+SHA512:
+  metadata.gz: 3a71166e896d69d998ec6ca0de366f80d4759520b50f81eb3984658bfca6a1c0c14222b120674b5c404930fb64b0589cbe6498d0093468412b5cad77060b2e0c
+  data.tar.gz: 92afb6a87bec9d15705d292cb058be90324eb399871e28bf1b85fb2c059df5d8a0a12f8912a10e38184acc1d32c2c9458fc66bcb4abeba255276ea1fc8d63e34

data/.gitignore

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

data/.travis.yml

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

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 gakmarn@amazon.com // UPDATE THIS. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rabbitmq-async.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    rabbitmq-async (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amq-protocol (2.2.0)
+    bunny (2.7.2)
+      amq-protocol (>= 2.2.0)
+    minitest (5.10.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  bunny (~> 2.7)
+  minitest (~> 5.0)
+  rabbitmq-async!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Gaurav Kumar // UPDATE THIS
+
+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,127 @@
+# RabbitmqAsync
+
+rabbitmq-async is a rabbitmq-backed library for calling object(Class) methods asynchronously, placing those requests on multiple queues, and processing them in consumers.
+
+Any Ruby class can call perform_async method to execute a method asynchronously
+
+RabbitmqAsync is simillar to rescure
+
+[Demo app using RabbitmqAsync](https://github.com/gauravkumar28/rabbitmq-async-demo)
+
+Say you have a ruby class
+```ruby
+class Order < ActiveRecord::Base
+
+  def display id
+    self.name
+  end
+
+  def self.list count
+    Order.first(count).each do |x|
+      x.name
+    end
+  end
+
+  def update_name new_name
+    self.name = new_name
+    self.save
+  end
+
+  def self.create_order name
+    order = Order.new
+    order.name = name
+    order.save!
+  end
+
+end
+```
+
+and you want to call create_order method asynchronously
+```ruby
+Order.perform_async("create_order", "xyz")
+```
+will do the job 
+
+###Similarly to call update_name method asynchronously
+```ruby
+order.perform_async("update_name", "abc")
+```
+###Generic Call
+```ruby
+object.perform_async("<method_name">, <comma seperated arguments>)
+```
+
+###For example
+```ruby
+order.perform_async("notify_user", 1, "msg")
+```
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rabbitmq-async'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rabbitmq-async
+
+## Usage
+### create rabbitmq-async.rb in config/initializers/ and paste below code
+```ruby
+require 'yaml'
+$consumer_config = YAML.load_file("#{Rails.root}/config/consumer.yml")
+```
+### Also add consumer.yml in config/ to specify queue name, exchange and routing key
+To deal with scalablity each class can have differnt queue
+```ruby
+consumer:
+  user:
+    routing_key: "myroute1"
+    self_exchange: "selfexchange2"
+    queue: "myqueue1"
+  comment:
+    routing_key: "myroute2"
+    self_exchange: "selfexchange2"
+    queue: "myqueue2"
+  generic:
+    routing_key: "myroute3"
+    self_exchange: "selfexchange3"
+    queue: "myqueue3"
+  order:
+    routing_key: "myroute4"
+    self_exchange: "selfexchange4"
+    queue: "myqueue4"
+```
+
+Need to start consumers which will perform the method execution
+```ruby
+rake rabbitmq:consumer name=order
+```
+here name is the class name, for which this consumer will perform the task
+
+#### Demo use case
+
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rabbitmq-async. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rabbitmq::Async project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rabbitmq-async/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+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"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rabbitmq/async"
+
+# 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/consumer.yml

@@ -0,0 +1,13 @@
+consumer:
+  user:
+    routing_key: a
+    self_exchange: b
+    queue: c
+  comment:
+    routing_key: a
+    self_exchange: b
+    queue: c
+  generic:
+    routing_key: a
+    self_exchange: b
+    queue: c

data/lib/rabbitmq/async.rb

@@ -0,0 +1,9 @@
+require "rabbitmq/async/version"
+require "rabbitmq/async/service"
+require 'rabbitmq/async/initialize'
+require 'rabbitmq/async/helpers/rabbitmq_helper'
+require "rabbitmq/async/railtie" if defined?(Rails)
+module Rabbitmq
+  module Async
+  end
+end

data/lib/rabbitmq/async/helpers/rabbitmq_helper.rb

@@ -0,0 +1,12 @@
+require "bunny"
+
+module RabbitmqHelper
+  def self.publish_event(msg, exchange_name, routing_key)
+    connection = Bunny.new
+    connection.start
+    channel  = connection.create_channel
+    exchange = channel.topic(exchange_name)
+    exchange.publish(msg.to_json, :routing_key => routing_key)
+    connection.close
+  end
+end

data/lib/rabbitmq/async/initialize.rb

@@ -0,0 +1,12 @@
+$consumer_config = YAML.load_file("config/consumer.yml")
+ActiveRecord::Base.class_eval do
+  def perform_async(method, *args)
+    RabbitmqHelper.publish_event({"object" => self, "method" => method, "arg_list" => args, "object_method" => true, "class" => self.class.name}, $consumer_config["consumer"]["#{self.class.table_name.singularize }"]["self_exchange"], $consumer_config["consumer"]["#{self.class.table_name.singularize }"]["routing_key"])
+    self
+  end
+
+  def self.perform_async(method, *args)
+    RabbitmqHelper.publish_event({"object" => self.name, "method" => method, "arg_list" => args}, $consumer_config["consumer"]["#{self.table_name.singularize }"]["self_exchange"], $consumer_config["consumer"]["#{self.table_name.singularize}"]["routing_key"])
+    self
+  end
+end

data/lib/rabbitmq/async/railtie.rb

@@ -0,0 +1,38 @@
+ require 'rails'
+ require 'json'
+ class Railtie < Rails::Railtie
+    railtie_name :rabbitmq
+
+    rake_tasks do
+      namespace :rabbitmq do
+        desc "consumers to perform async task"
+        task :consumer => :environment do
+          consumer_name = ENV["name"] || "generic"
+          $consumer_config = YAML.load_file("#{Rails.root}/config/consumer.yml")
+          conn = Bunny.new
+          conn.start
+          channel  = conn.create_channel
+          exchange   = channel.topic($consumer_config["consumer"][consumer_name]["self_exchange"])
+          queue   = channel.queue($consumer_config["consumer"][consumer_name]["queue"], :exclusive => true)
+
+          queue.bind(exchange, :routing_key => $consumer_config["consumer"][consumer_name]["routing_key"])
+
+          begin
+            queue.subscribe(:block => true) do |delivery_info, properties, body|
+             #parse msg and invoke method
+             #puts "msg.......: #{body}"
+             params = JSON.parse(body)
+             #puts "params.......: #{params}"
+             async_service = Rabbitmq::Async::Service.new(params)
+             async_service.perform()
+            end
+          rescue Interrupt => _
+            channel.close
+            conn.close
+          end
+        end
+      end
+
+      task :rabbitmq => ['rabbitmq:consumer']
+    end
+  end

data/lib/rabbitmq/async/service.rb

@@ -0,0 +1,54 @@
+module Rabbitmq
+  module Async
+    class Service
+      attr_reader :object, :method, :arg_list, :object_method, :klass
+
+      def initialize(params)
+        @object = params["object"] || (raise "Object Name Missing")
+        @method = params["method"] || (raise "Method Name Missing")
+        @arg_list = params["arg_list"] || (raise "Argument List Misisng")
+        @object_method = params["object_method"] || false
+        @klass = params["class"] || nil
+        @arg_list = parse_arg(@arg_list)
+      end
+
+      def perform
+        object_method ? perform_object_method : perform_class_method
+      end
+
+      def perform_class_method
+        object.constantize.send(method.to_sym, *arg_list)
+      end
+
+      def perform_object_method
+        obj = klass.constantize.send(:find, object["id"])
+        obj.send(method.to_sym, *arg_list)
+      end
+
+      private 
+
+      def parse_arg(arg_list)
+        models = ActiveRecord::Base.subclasses.collect { |type| type.name }.sort
+        new_arg_list = []
+        arg_list.each do |arg|
+          if arg.class == ActiveSupport::HashWithIndifferentAccess
+            klass_key = arg.keys.first
+            if models.include? klass_key
+              #TODO  add validation for Hash of object
+              if arg[klass_key].class == Array 
+                new_arg_list << arg[klass_key].map{ |x| klass_key.constantize.find(x["id"])}
+              else
+                new_arg_list << klass_key.constantize.find(arg[klass_key]["id"])
+              end
+            else
+              new_arg_list << arg
+            end
+          else
+            new_arg_list << arg
+          end
+        end
+        new_arg_list
+      end
+    end
+  end
+end

data/lib/rabbitmq/async/version.rb

@@ -0,0 +1,5 @@
+module Rabbitmq
+  module Async
+    VERSION = "0.1.3"
+  end
+end

data/lib/tasks/rabbitmq_consumer.rake

@@ -0,0 +1,28 @@
+require "bunny"
+require "json"
+namespace :rabbitmq  do
+  desc "create some fake data"
+  task :consumer => :environment do
+    consumer = ENV["name"] || "generic"
+    $consumer_config = YAML.load("#{Rails.app}/config/consumer_config.yml")
+    conn = Bunny.new
+    conn.start
+    channel  = conn.create_channel
+    exchange   = channel.topic($consumer_config[consumer]["self_exchange"])
+    queue   = channel.queue($consumer_config[consumer]["queue"], :exclusive => true)
+
+    queue.bind(exchange, :routing_key => $consumer_config[consumer]["routing_key"])
+
+    begin
+      queue.subscribe(:block => true) do |delivery_info, properties, body|
+       #parse msg and invoke method
+       params = JSON.parse(body)
+       async_service = Rabbitmq::Async::Service.new(params)
+       async_service.perform()
+      end
+    rescue Interrupt => _
+      channel.close
+      conn.close
+    end
+  end
+end

data/rabbitmq-async.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rabbitmq/async/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rabbitmq-async"
+  spec.version       = Rabbitmq::Async::VERSION
+  spec.authors       = ["Gaurav Kumar"]
+  spec.email         = ["gaurav.sachin.007@gmail.com"]
+
+  spec.summary       = %q{Ruby Gem to call Class methos Asynchronously using Rabbitmq}
+  spec.description   = %q{It is similar to resque, but uses rabbitmq}
+  spec.homepage      = "https://github.com/gauravkumar28/rabbitmq-async"
+  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.
+  
+
+  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.16"
+  spec.add_dependency "bunny", '~> 2.7' 
+  spec.add_dependency "json", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: rabbitmq-async
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Gaurav Kumar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: It is similar to resque, but uses rabbitmq
+email:
+- gaurav.sachin.007@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
+- consumer.yml
+- lib/rabbitmq/async.rb
+- lib/rabbitmq/async/helpers/rabbitmq_helper.rb
+- lib/rabbitmq/async/initialize.rb
+- lib/rabbitmq/async/railtie.rb
+- lib/rabbitmq/async/service.rb
+- lib/rabbitmq/async/version.rb
+- lib/tasks/rabbitmq_consumer.rake
+- rabbitmq-async.gemspec
+homepage: https://github.com/gauravkumar28/rabbitmq-async
+licenses:
+- MIT
+metadata: {}
+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.13
+signing_key: 
+specification_version: 4
+summary: Ruby Gem to call Class methos Asynchronously using Rabbitmq
+test_files: []