banter 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f98c954f1577641de0413fcdb61bd4de641159ee
+  data.tar.gz: cca0062d0018c28a2b6d3f1ff9951735cda37361
+SHA512:
+  metadata.gz: c9df28a97f6ed9ba8764dd77002a5726092c8f60b5a20b3b3c89ed653f45699a4dc2def024b3f5471157dca3f39e65605850c3a73cafebf2db00c93ca675fbaf
+  data.tar.gz: 4d1abbfb632f94924f6e7cd69353032804cc2a3b2a6f72ee79099f6ce4528106773504b7987dd8bc49b84c57ba0fcae483e2982831321f0f9f9db25295529029

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.project
+.ruby-gemset
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rspec
+.idea
+test_pubsub.log

data/.ruby-version

@@ -0,0 +1 @@
+2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 The Honest Company
+
+MIT License
+
+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,113 @@
+# Banter
+
+Simple Publishers and subscribers for Ruby using RabbitMQ
+
+[![Gem Version](https://badge.fury.io/rb/banter.svg)](http://badge.fury.io/rb/banter)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'banter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install banter
+
+You also need to install RabbitMQ
+
+    $ brew install rabbitmq
+
+## Usage
+
+There are two sides to this gem, publishers and subscribers
+
+### Publishers
+
+Publishing to a message is super simple
+
+    Banter.publish('user.created', { id: 3, name: 'Foo Bar', email: 'foobar@email.com')
+
+Additionally you can setup a context that is passed down to the subscribers. This context can be set up in a `before_filter`
+
+```ruby
+class ApplicationController < ActionController::Base
+    before_filter :setup_pubsub_context
+
+    private
+
+    def setup_pubsub_context
+        Banter::Context.setup_context
+          unique_id:       request.uuid,
+          orig_ip_address: request.remote_ip,
+          application:     "my_app/web:#{self.class.name.underscore}/#{action_name}",
+          user_id:         current_user.try(:id)
+    end
+end
+```
+
+Context is automatically cleared up by the gem for a Rails Application. Otherwise, you can call
+`Banter::Context.clear!`
+
+### Subscribers
+
+You can declare a subscriber class as follows
+
+```ruby
+class UserWelcomeSubscriber < Banter::Subscriber
+  subscribe_to "user_created" # The message prefix that you're subscribing to
+  # subscribe_to "user_created", on: 'welcome_emails_queue' # If you want to specify the queue name
+
+  def perform(payload)
+    # My awesome logic goes here...
+  end
+end
+```
+
+You also run subscribers in a separate process to consume the message using the provided executable
+
+`bundle exec start_subscribers`
+
+You can execute `bundle exec start_subscribers --help` to see all the various options that it providers
+```
+Usage: bundle exec start_subscribers [options]
+    -P, --pidfile PATH               path to pidfile
+    -o, --only [SUBSCRIBERS]         comma separated name of subsriber classes that should be run
+    -r, --require [PATH|DIR]         Location of Rails application with workers or file to require
+    -v, --version                    Print version and exit
+
+```
+
+#### Validations
+
+```ruby
+class UserWelcomeSubscriber < Banter::Subscriber
+  subscribe_to "user_created" # The message prefix that you're subscribing to
+  validates_payload_with :id_present
+  validates_payload_with do |payload|
+    payload[:email].present?
+  end
+
+  def perform(payload)
+    # My awesome logic goes here...
+  end
+
+  private
+
+  def id_present(payload)
+    payload[:id].present?
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/banter.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# require all files in the folder?
+require 'banter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "banter"
+  spec.version       = Banter::VERSION
+  spec.authors       = ["The Honest Company", "Thanh Lim", "Tushar Ranka", "Joel Jackson"]
+  spec.email         = ["webadmin@honest.com", "tusharranka@gmail.com", "jackson.joel@gmail.com"]
+  spec.description   = "Publish & subscribe to messages"
+  spec.summary       = "Library for pub-sub (Message Bus)"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+  spec.add_development_dependency "debugger"
+  spec.add_runtime_dependency "activesupport", ">= 3.2"
+  spec.add_runtime_dependency "awesome_print", "~> 1.2.0"
+  spec.add_runtime_dependency "bunny", ">= 1.2"
+  spec.add_runtime_dependency "airbrake", ">= 3.1"
+  spec.add_runtime_dependency "hashie", ">= 1.2"
+  spec.add_runtime_dependency "json", ">= 1.8"
+  spec.add_runtime_dependency "celluloid", ">= 0.15"
+  spec.add_runtime_dependency "celluloid-io", ">= 0.15"
+
+
+end

data/bin/start_subscribers

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/banter/cli'
+
+begin
+  cli = Banter::CLI.instance
+  cli.parse
+  cli.run
+rescue => e
+  raise e if $DEBUG
+  STDERR.puts e.message
+  STDERR.puts e.backtrace.join("\n")
+  exit 1
+end

data/config/pubsub.yml

@@ -0,0 +1,17 @@
+development:
+  # Documentation for parameters for rabbit and bunny is located here: http://rubybunny.info/articles/connecting.html
+  connection:
+    host: localhost
+    port: 5672
+    # username: rabbit
+    # password: rabbit
+    heartbeat: 60 # in seconds
+    log_level: 0
+    log_file: rabbit.log
+    network_recovery_interval: 10 # in seconds
+    continuation_timeout: 4000 # in milliseconds
+
+  logger:
+    enabled: true
+    level: warn
+    file: pubsub.log

data/lib/banter.rb

@@ -0,0 +1,47 @@
+require "active_support/all"
+require "bunny"
+require "yaml"
+require "airbrake"
+
+require "banter/configuration"
+require "banter/context"
+require "banter/db_logger"
+require "banter/logger"
+require "banter/logging"
+require "banter/message"
+require "banter/publisher"
+require "banter/server/rabbit_mq_subscriber"
+require "banter/version"
+require "banter/exceptions/payload_validation_error"
+require 'banter/server'
+require 'banter/subscriber'
+
+if defined?(Rails::Railtie)
+  require "banter/middleware"
+  require "banter/railtie"
+end
+
+module Banter
+
+  def self.root
+    File.expand_path '../..', __FILE__
+  end
+
+# This method publishes payload to rabbitmq.  All listeners with appropriate
+# routing keys will receive the payload.
+# @param [String] routing_key Identifier of the message type
+# @param [Hash] payload The data that will be passed to the subscriber
+
+  def self.publish(routing_key, payload)
+    Publisher.instance.publish(Banter::Context.instance, routing_key, payload)
+  end
+
+  def self.logger
+    Banter::Logging.logger
+  end
+
+  # @param [Logger] logger Logger used by Banter
+  def self.logger=(logger)
+    Banter::Logging.logger = logger
+  end
+end

data/lib/banter/cli.rb

@@ -0,0 +1,94 @@
+# This class handles parsing and running the command line interface for executing subscribers
+
+$stdout.sync = true
+
+require 'singleton'
+require 'optparse'
+require 'banter/server'
+
+module Banter
+  class CLI
+    include Singleton
+
+    attr_accessor :pidfile, :subscribers
+
+    # Method to support parsing of arguments passed through the command line
+    def parse(args = ARGV)
+      optparse = OptionParser.new do |opts|
+        opts.banner = "Usage: bundle exec start_subscribers [options]"
+        opts.on '-P', '--pidfile PATH', "path to pidfile" do |arg|
+          @pidfile = arg
+        end
+
+        opts.on("-o", "--only [SUBSCRIBERS]", "comma separated name of subsriber classes that should be run") do |subscribers|
+          @subscribers = subscribers.split(/\,/)
+        end
+
+        opts.on '-r', '--require [PATH|DIR]', "Location of Rails application with workers or file to require" do |arg|
+          @require_path = arg
+        end
+
+        opts.on '-v', '--version', "Print version and exit" do |arg|
+          puts "Banter #{Banter::VERSION}"
+          abort
+        end
+      end
+
+      optparse.parse!(args)
+    end
+
+    def run
+      load_environment
+      write_pidfile
+      load_subscribers
+    end
+
+    def require_path
+      @require_path || "."
+    end
+
+
+    # @return [Array] returns array of subscriber classes that will be executed by the CLI
+    def subscriber_classes
+      if subscribers.present?
+        subscribers.map(&:constantize)
+      else
+        Banter::Subscriber.class_variable_get(:@@registered_subscribers)
+      end
+    end
+
+    def remove_pid
+      return unless pidfile
+      File.delete(pidfile) if File.exist?(pidfile)
+    end
+
+    private
+
+    def load_environment
+      if require_path
+        raise ArgumentError, "#{require_path} does not exist" unless File.exist?(require_path)
+      end
+
+      if File.directory?(require_path)
+        require 'rails'
+        require File.expand_path("#{require_path}/config/environment.rb")
+        ::Rails.application.eager_load!
+      else
+        require require_path
+      end
+    end
+
+    def write_pidfile
+      return unless pidfile
+      File.open(pidfile, 'w') do |f|
+        f.puts Process.pid
+      end
+    end
+
+    def load_subscribers
+      Banter::Server::SubscriberServer.new(subscriber_classes).start
+    end
+  end
+end
+
+

data/lib/banter/configuration.rb

@@ -0,0 +1,42 @@
+module Banter
+  class Configuration
+    @@conf = nil
+
+    def self.configure_with(environment_name, yaml_file = nil)
+      @@yaml_file = yaml_file.nil? ? "config/pubsub.yml" : yaml_file
+      @@all_conf = Hashie::Mash.new(YAML.load_file(@@yaml_file) )
+      @@conf = @@all_conf[environment_name.to_sym]
+      self
+    end
+
+    def self.configuration
+      self.configure_with(self.environment) if @@conf.nil?
+      @@conf
+    end
+
+    def self.environment
+      val = ENV["RAILS_ENV"] || ENV["RACK_ENV"]
+      val = if val.present?
+        val.to_sym
+      else
+        if defined?(Rails)
+          Rails.env
+        else
+          raise "No environment can be found for configuration!"
+        end
+      end
+    end
+
+    def self.default_queue_ttl
+      24.hours * 1000
+    end
+
+    def self.application_name
+      @application_name ||= if defined?(Rails)
+        Rails.application.class.name.to_s.gsub("::Application", '')
+      else
+        'banter'
+      end.downcase
+    end
+  end
+end

data/lib/banter/context.rb

@@ -0,0 +1,70 @@
+module Banter
+  class Context
+    # acceptable values
+    # employee - employee id that the context could have
+    # user_id - ender user id of call
+    # unique_id - unique identifier (could be request.uuid most of the time)
+    # orig_ip_address - ip address of originating requester
+    def initialize(params_hash = {})
+      @data = Hashie::Mash.new(params_hash)
+    end
+
+    def user_id
+      @data.user_id
+    end
+
+    def employee_id
+      @data.employee_id
+    end
+
+    def as_json
+      @data.as_json
+    end
+
+    def unique_id
+      @data.unique_id
+    end
+
+    def originating_ip_address
+      @data.orig_ip_address
+    end
+
+    def serialize
+      @data.as_json
+    end
+
+    def application
+      @data.application
+    end
+
+    def self.instance
+      Thread.current['pubsub_context'] || {}
+    end
+
+    def self.setup_context(attrs = {})
+      Thread.current['pubsub_context'] = self.new(attrs)
+    end
+
+    def self.clear!
+      Thread.current['pubsub_context'] = nil
+    end
+
+    # USE AS INFREQUENTLY AS POSSIBLE.  Only use it if you absolutely must
+    # as really, we want context in the object, and not the kitchen sink,
+    # which is what this will turn out to be if we use regularly use this
+    # mechanism.
+    def method_missing(method_name, *arguments, &block)
+      if @data.key?(method_name)
+        @data[method_name]
+      else
+        super
+      end
+
+    end
+
+    def self.from_json(data_hash)
+      ::Banter::Context.new(data_hash)
+    end
+
+  end
+end