rabid_mq 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f29fae6619404a7e32b70f54503daa684cb4a99
+  data.tar.gz: f899f98e7a15370216b9819969d688840c900f23
+SHA512:
+  metadata.gz: 95035fde4312aee4356b96e9e002002bc073f6c021a240ddfff03aacae216f59131a995aa4db2edf5d8fd0deac81e9f162b862bfdad1f93e37ee0e8537c80f9f
+  data.tar.gz: ab9ab838228b06881d7558ae83d6f3a5a9ca3094946ec4e87b7c16d3ca0268d9f2826df9b90faa8b4054f1887abc8dd374d108557a8a223602bb558624a2867a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rbenv-gemsets

@@ -0,0 +1 @@
+rabid_mq

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rabid_mq.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Black Swan Data
+
+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,126 @@
+# RabidMQ
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rabid_mq`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rabid_mq'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install rabid_mq
+```
+
+## Configuration
+
+To configure simply add a yaml file `config/rabid_mq.yml` to your project and adjust the settings to match your requirements. These options are used verbatim to initialize `bunny` so any option supported by bunny is also supported in the rabid_mq config.
+
+```yaml
+# config/rabid_mq.yml
+
+default: &default
+  host: localhost
+  port: 5672
+  ssl: false
+  vhost: "/"
+  user: guest
+  pass: guest
+  heartbeat: server
+  frame_max: 131072
+  auth_mechanism: PLAIN
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+
+production:
+  <<: *default
+```
+
+## Usage
+
+### AMQP Producer
+
+To create a RabbitMQ "Producer" you can include the RabidMQ::Publisher concern in your producer class
+
+`app/models/my_class.rb`
+
+```ruby
+class MyClass
+  include RabidMQ::Publisher
+
+  # code ...
+end
+```
+
+`app/controllers/some_controller.rb`
+
+```ruby
+class SomeController < ApplicationController
+  def create
+    # code ...
+    MyClass.broadcast('some.amqp.topic', "Hello RabbitMQ")
+
+    #  OR
+
+    # if you already have a `broadcast` method you can use the method `amqp_broadcast`
+    MyClass.amqp_broadcast('some.amqp.topic', "Hello RabbitMQ")
+
+    # OR
+
+    # IF you have an instance of MyClass
+    my_class_instance.broadcast('some.amqp.topic', "Hellow RabbitMQ from an instance")
+
+    # code ...
+  end
+end
+```
+
+### Consumer
+
+`app/models/my_class`
+
+```ruby
+class MyClass
+  include RabidMQ::Listener
+
+  amqp 'some_queue_name', 'some.exchange.name', exclusive: false, routing_key: 'some.*.key.*.definition'
+
+  # OR (for finer grained control with more options)
+  # queue_name 'name', **options
+  # exchange 'name', **options
+
+  subscribe do |info, meta, data|
+    # Do your logic with the data here
+  end
+
+  # Or (for finer control on the exchange binding) you can pass in an explicitly created
+  # Bunny::Exchange object with options
+  # bind(exchange, **options).subscribe do |info, meta, data|
+  #  # code ...
+  # end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/[USERNAME]/rabid_mq>. 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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rabid_mq"
+
+# 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/rabid_mq/config.rb

@@ -0,0 +1,35 @@
+module RabidMQ
+  module Config
+    class << self
+      def load_config
+        @config ||= YAML.load(File.read(file_name))
+      rescue Errno::ENOENT, NameError => e
+        puts "[WARN] #{e.message} in #{__FILE__}. Falling back to default config"
+        default_config
+      end
+
+      def default_config
+        {
+          :host           => "localhost",
+          :port           => 5672,
+          :ssl            => false,
+          :vhost          => "/",
+          :user           => "guest",
+          :pass           => "guest",
+          :heartbeat      => :server, # will use RabbitMQ setting
+          :frame_max      => 131072,
+          :auth_mechanism => "PLAIN"
+        }
+      end
+
+      private
+      def file_name
+        if defined? ::Rails
+          ::Rails.root.join('config/rabid_mq.yml')
+        else
+          'config/rabid_mq.yml'
+        end
+      end
+    end
+  end
+end

data/lib/rabid_mq/listener.rb

@@ -0,0 +1,61 @@
+# Provides including class with ability to subscribe and react to events that
+# arrive via RabidMQ
+# Example:
+# class MyClass
+#   include RabidMQ::Listener
+#
+#   amqp 'queue_name', 'exchange.name', exclusive: false, routing_key: 'some.routing.*.key'
+#
+#   subscribe do |info, meta, data|
+#     # code to do on message receipt
+#   end
+# end
+#
+
+module RabidMQ
+  module Listener
+    extend ::ActiveSupport::Concern
+
+    included do
+      class << self
+        attr_reader :amqp_queue, :amqp_exchange
+
+        def amqp(queue, exchange, exclusive: false, routing_key: '#')
+          self.queue_name queue, exclusive: exclusive
+          self.exchange(exchange, routing_key: routing_key)
+        end
+
+        # Use this as a macro in including classes like
+        # class MyClass
+        #   include RabidMQ::Listener
+        #   queue_name 'some.queue_name', exclusive: true
+        # end
+        #
+        def queue_name(name, **options)
+          @amqp_queue = RabidMQ.channel.queue(name, **options)
+        end
+
+        # Use this as a macro in including classes like
+        # class MyClass
+        #   include RabidMQ::Listener
+        #   exchange 'exchange.name'
+        # end
+        #
+        def exchange(topic, **options)
+          @amqp_exchange = RabidMQ.topic_exchange topic, options
+        end
+
+        def bind(exchange=@amqp_exchange, routing_key: '#', **options)
+          amqp_queue.bind(exchange, routing_key: routing_key, **options)
+        end
+
+        delegate :subscribe, to: :bind
+
+        def amqp_connection
+          amqp_exchange.channel.connection
+        end
+
+      end
+    end
+  end
+end

data/lib/rabid_mq/publisher.rb

@@ -0,0 +1,42 @@
+# Provides any including class with the ability to publish via RabidMQ
+# Example:
+# class MyClass
+#   include RabidMQ::Publisher
+# end
+#
+# MyClass.amqp_broadcast('some_topic', "Class Hello")
+# instance = MyClass.new
+# instance.amqp_broadcast('some_topic', "Instance Hello")
+#
+
+module RabidMQ
+  module Publisher
+    extend ActiveSupport::Concern
+
+    included do
+      def amqp_broadcast(*args, **options)
+        self.class.amqp_broadcast *args, **options
+      end
+
+      alias_method :broadcast, :amqp_broadcast
+
+      class << self
+        def amqp_broadcast(topic, payload, routing_key: self.default_amqp_routing_key)
+          exchange = topic_exchange(topic)
+          exchange.publish(payload, routing_key: routing_key)
+        rescue  => e
+          Rails.logger.error e.message
+        end
+
+        alias_method :broadcast, :amqp_broadcast
+
+        delegate :topic_exchange, to: RabidMQ
+
+        def default_amqp_routing_key
+          self.name.underscore.gsub(/\//, '.')
+        end
+
+      end
+    end
+  end
+end

data/lib/rabid_mq/railtie.rb

@@ -0,0 +1,7 @@
+require 'rails'
+
+module RabidMQ
+  class Railtie < Rails::Railtie
+
+  end
+end

data/lib/rabid_mq/version.rb

@@ -0,0 +1,3 @@
+module RabidMQ
+  VERSION = "0.1.1"
+end

data/lib/rabid_mq.rb

@@ -0,0 +1,48 @@
+require 'bunny'
+require 'yaml'
+require 'active_support/concern'
+require 'active_support/core_ext/module/delegation'
+require 'rabid_mq/version'
+require 'rabid_mq/railtie' if defined?(::Rails::Railtie)
+require 'rabid_mq/config'
+require 'rabid_mq/listener'
+require 'rabid_mq/publisher'
+# Module to abstract the boilerplate of connecting to rabbitMQ
+# This will also abstract how the credentials are supplied etc
+module RabidMQ
+  class << self
+
+    # Provide a topic exchange on demand connected to the existing channel
+    def topic_exchange(topic, **options)
+      channel.topic(topic, **options)
+    end
+
+    # Provide fanout exchange
+    def fanout_exchange(topic, **options)
+      channel.fanout(topic, **options)
+    end
+
+    # Get a channel with the Bunny::Session
+    def channel
+      @channel ||= connect.create_channel
+    rescue Bunny::ChannelAlreadyClosed => e
+      @channel = nil
+      channel
+    end
+
+    # Start a new connection
+    def connect
+      connection.tap do |c|
+        c.start
+        at_exit do
+          c.close
+        end
+      end
+    end
+
+    # Provide a new or existing Bunny::Session
+    def connection
+      @connection ||= Bunny.new RabidMQ::Config.load_config
+    end
+  end
+end

data/rabid_mq.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rabid_mq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rabid_mq"
+  spec.version       = RabidMQ::VERSION
+  spec.authors       = ["Tyrone Wilson"]
+  spec.email         = ["tyrone.wilson@blackswan.com"]
+
+  spec.summary       = %q{Provides easy way to configure and use RabbitMQ in Ruby on Rails}
+  spec.description   = %q{If you want to just get up and going in making your rails app into a producer or consumer of RabbitMQ events then use this gem}
+  spec.homepage      = "https://github.com/container-streams/rabid_mq"
+  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_dependency 'bunny', '~> 2.7.1'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 11.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: rabid_mq
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tyrone Wilson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: If you want to just get up and going in making your rails app into a
+  producer or consumer of RabbitMQ events then use this gem
+email:
+- tyrone.wilson@blackswan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rbenv-gemsets"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rabid_mq.rb
+- lib/rabid_mq/config.rb
+- lib/rabid_mq/listener.rb
+- lib/rabid_mq/publisher.rb
+- lib/rabid_mq/railtie.rb
+- lib/rabid_mq/version.rb
+- rabid_mq.gemspec
+homepage: https://github.com/container-streams/rabid_mq
+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.11
+signing_key: 
+specification_version: 4
+summary: Provides easy way to configure and use RabbitMQ in Ruby on Rails
+test_files: []