action_subscriber 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14ee094f6885fec532698cf8eac89dca3f79978e
+  data.tar.gz: 54740c601d44855e1260483ebfd73e7e042eee93
+SHA512:
+  metadata.gz: bdd0d984f012f90c8100fa5c079dd7dee1c02362f7a5e93c4c2686758057ca4be52e53d17c820c7ddb1f39b68782048955d071811068183f7ff71a516bcf1211
+  data.tar.gz: 1c5543030e5b226fb9f97655454f3f644778c375a9b44a8c08742ec7795c1514d4b99adeb9498275e98c5b7891e3427cab4062a600bef1d9cd52e5f7f4de58c3

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.ruby-*
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+Gemfile.lock
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--order rand

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+source 'http://gems.moneydesktop.com'
+
+# Specify your gem's dependencies in action_subscriber.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Brian
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Stien
+
+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,122 @@
+ActionSubscriber
+=================
+ActionSubscriber is a DSL for for easily intergrating your Rails app with a RabbitMQ messaging server.
+
+Requirements
+-----------------
+I test on Ruby 2.1.1 and Jruby 1.7.x.  Ruby 1.8 is not supported.
+
+Supported Message Types
+-----------------
+ActionSubscriber support JSON and plain text out of the box, but you can easily
+add support for any custom message type.
+
+Example
+-----------------
+A subscriber is set up by creating a class that inherits from ActionSubscriber::Base.
+
+```ruby
+class UserSubscriber < ::ActionSubscriber::Base
+  publisher :user_hq
+
+  def created
+    # do something when a user is created
+  end
+end
+```
+
+checkout the examples dir for more detailed examples.
+
+Usage
+-----------------
+ActionSubscriber is inspired by rails observers, and if you are familiar with rails
+observers the ActionSubscriber DSL should make you feel right at home!
+
+First, create a subscriber the inherits from ActionSubscriber::Base
+
+Then, when your app starts up, you will need to load your subscriber code and then do
+
+```ruby
+ActionSubscriber.start_subscribers
+while true
+  sleep 1.0
+end
+```
+
+or
+
+```ruby
+::ActionSubscriber.start_queues
+while true
+  ::ActionSubscriber.auto_pop!
+  sleep 1.0
+end
+```
+
+Any public methods on your subscriber will be registered as queues with rabbit with
+routing keys named intelligently.
+
+Once ActionSubscriber receives a message, it will call the associated method and the
+parameter you recieve will be a decoded message.
+
+Configuration
+-----------------
+ActionSubscriber needs to know how to connect to your rabbit server to start getting messages.
+
+In an initializer, you can set the host and the port like this :
+
+    ActionSubscriber::Configuration.configure do |config|
+      config.host = "my rabbit host"
+      config.port = 5672
+    end
+
+Other configuration options include :
+
+* config.allow_low_priority_methods - subscribe to queues for methods suffixed with "_low"
+* config.default_exchange - set the default exchange that your queues will use, using the default RabbitMQ exchange is not recommended
+* config.hosts - an array of hostnames in your cluster
+* config.times_to_pop - when using RabbitMQ's pull API, the number of messages we will grab each time we pool the broker
+* config.threadpool_size - set the number of threads availiable to action_subscriber
+* config.error_handler - handle error like you want to handle them!
+* config.add_decoder - add a custom decoder for a custom content type
+
+Message Acknowledgment
+----------------------
+### no_acknolwedgement!
+
+This mode is the default. Rabbit is told to not expect any message acknowledgements so messages will be lost if an error occurs.
+
+### manual_acknowledgement!
+
+This mode leaves it up to the subscriber to handle acknowledging or rejecting messages. In your subscriber you can just call <code>acknowledge</code> or <code>reject</code>.
+
+### at_most_once!
+
+Rabbit is told to expect message acknowledgements, but sending the acknowledgement is left up to ActionSubscriber. We send the acknowledgement right before calling your subscriber.
+
+### at_least_once!
+
+Rabbit is told to expect message acknowledgements, but sending the acknowledgement is left up to ActionSubscriber. We send the acknowledgement right after calling your subscriber. If an error is raised by your subscriber we reject the message instead of acknowledging it. Rejected messages go back to rabbit and will be re-delivered.
+
+Testing
+-----------------
+ActionSubscriber includes support for easy unit testing with RSpec.
+
+In your spec_helper.rb:
+
+```
+require 'action_subscriber/rspec'
+
+RSpec.configure do |config|
+  config.include ::ActionSubscriber::Rspec
+end
+```
+
+In your_subscriber_spec.rb :
+``` subject { mock_subscriber }```
+
+Your test subject will be an instance of your subscriber class, and you can
+easily test your public methods without dependence on data from Rabbit.  You can
+optionally pass data for your mock subscriber to consume if you wish.
+
+``` subject { mock_subscriber(:header => "test_header", :payload => "payload") } ```

data/Rakefile

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

data/action_subscriber.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_subscriber/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_subscriber"
+  spec.version       = ActionSubscriber::VERSION
+  spec.authors       = ["Brian Stien","Adam Hutchison","Brandon Dewitt","Devin Christensen","Michael Ries"]
+  spec.email         = ["brianastien@gmail.com","liveh2o@gmail.com","brandonsdewitt@gmail.com","quixoten@gmail.com","michael@riesd.com"]
+  spec.description   = %q{ActionSubscriber is a DSL that allows a rails app to consume messages from a RabbitMQ broker.}
+  spec.summary       = %q{ActionSubscriber is a DSL that allows a rails app to consume messages from a RabbitMQ broker.}
+  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_dependency 'activesupport', '>= 3.2'
+
+  if ENV['PLATFORM'] == "java" || ::RUBY_PLATFORM == 'java'
+    spec.platform = "java"
+    spec.add_dependency 'march_hare', '>= 2.7.0'
+  else
+    spec.add_dependency 'bunny', '>= 1.5.0'
+  end
+  spec.add_dependency 'lifeguard'
+  spec.add_dependency 'middleware'
+
+  spec.add_development_dependency "activerecord", ">= 3.2"
+  spec.add_development_dependency "bundler", ">= 1.6"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+end

data/examples/at_least_once.rb

@@ -0,0 +1,17 @@
+class UserSubscriber < ActionSubscriber::Base
+  publisher :bob
+  exchange :events
+
+  # By turning on the at_least_once! mode we will tell rabbit
+  # to expect message acknowledgements, but ActionSubscriber
+  # will handle sending those acknowledgements right after
+  # it calls your subscriber. If your subscriber raises an error
+  # we will reject the message which causes rabbit to try it again.
+  # This way if you have an intermittent error (like a failed databse connection)
+  # you can get the message again later.
+  at_least_once!
+
+  def created
+    UserProfile.create_for_user(payload)
+  end
+end

data/examples/at_most_once.rb

@@ -0,0 +1,15 @@
+class UserSubscriber < ActionSubscriber::Base
+  publisher :bob
+  exchange :events
+
+  # By turning on the at_most_once! mode we will tell rabbit
+  # to expect message acknowledgements, but ActionSubscriber
+  # will handle sending those acknowledgements right before
+  # it calls your subscriber. This way you don't have to worry
+  # about the same message being sent to you twice.
+  at_most_once!
+
+  def created
+    UserProfile.create_for_user(payload)
+  end
+end

data/examples/basic_subscriber.rb

@@ -0,0 +1,30 @@
+class UserSubscriber < ActionSubscriber::Base
+
+  # In this example, we are in an application called "alice"
+  # We want to listen to events in bob when bob creates a user.
+  # When bob creates a user, bob publishes to "bob.user.created",
+  # on an exchange called events.
+  #
+  # This subscriber listens to bob's events and executes the created
+  # method every time bob publishes to the created queue.
+
+  publisher :bob
+  exchange :events
+
+  # Will create the queue:
+  #   alice.bob.user.created
+  # With the routing key:
+  #   bob.user.created
+  #
+  def created
+    send_email(payload)
+  end
+
+  private
+
+  # This is a private method and will be invisible to ActionSubscriber
+  #
+  def send_email(user)
+    # MyMailer.send_welcome_email(user.email, user.name)
+  end
+end

data/examples/message_acknowledgement.rb

@@ -0,0 +1,19 @@
+class UserSubscriber < ActionSubscriber::Base
+  publisher :users_hq
+  exchange :events
+
+
+  # When we turn on manual acknowledgements RabbitMQ will be expecting us
+  # to send back either and acknowledgement or a rejection for each message
+  # if we don't send anything back rabbit might stop sending us messages
+  manual_acknowledgement!
+
+  def created
+    user_profile = UserProfile.create_for_user(payload)
+    if user_profile.save
+      acknowledge
+    else
+      reject
+    end
+  end
+end

data/lib/action_subscriber.rb

@@ -0,0 +1,93 @@
+require "active_support"
+require "active_support/core_ext"
+if ::RUBY_PLATFORM == "java"
+  require 'march_hare'
+else
+  require "bunny"
+end
+require "lifeguard"
+require "middleware"
+require "thread"
+
+require "action_subscriber/version"
+
+require "action_subscriber/default_routing"
+require "action_subscriber/dsl"
+require "action_subscriber/configuration"
+require "action_subscriber/middleware"
+require "action_subscriber/rabbit_connection"
+require "action_subscriber/subscribable"
+require "action_subscriber/bunny/subscriber"
+require "action_subscriber/march_hare/subscriber"
+require "action_subscriber/threadpool"
+require "action_subscriber/base"
+
+module ActionSubscriber
+  ##
+  # Public Class Methods
+  #
+
+  # Loop over all subscribers and pull messages if there are
+  # any waiting in the queue for us.
+  #
+  def self.auto_pop!
+    return if ::ActionSubscriber::Threadpool.busy?
+    ::ActionSubscriber::Base.inherited_classes.each do |klass|
+      klass.auto_pop!
+    end
+  end
+
+  # Loop over all subscribers and register each as
+  # a subscriber.
+  #
+  def self.auto_subscribe!
+    ::ActionSubscriber::Base.inherited_classes.each do |klass|
+      klass.auto_subscribe!
+    end
+  end
+
+  def self.configuration
+    @configuration ||= ::ActionSubscriber::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  def self.print_subscriptions
+    ::ActionSubscriber::Base.print_subscriptions
+  end
+
+  def self.setup_queues!
+    ::ActionSubscriber::Base.inherited_classes.each do |klass|
+      klass.setup_queues!
+    end
+  end
+
+  def self.start_queues
+    ::ActionSubscriber::RabbitConnection.connect!
+    setup_queues!
+    print_subscriptions
+  end
+
+  def self.start_subscribers
+    ::ActionSubscriber::RabbitConnection.connect!
+    setup_queues!
+    auto_subscribe!
+    print_subscriptions
+  end
+
+  ##
+  # Class aliases
+  #
+  class << self
+    alias_method :config, :configuration
+  end
+
+  # Initialize config object
+  config
+
+  ::ActiveSupport.run_load_hooks(:action_subscriber, Base)
+end
+
+require "action_subscriber/railtie" if defined?(Rails)

data/lib/action_subscriber/base.rb

@@ -0,0 +1,83 @@
+module ActionSubscriber
+  class Base
+    extend ::ActionSubscriber::DefaultRouting
+    extend ::ActionSubscriber::DSL
+    extend ::ActionSubscriber::Subscribable
+    if ::RUBY_PLATFORM == "java"
+      extend ::ActionSubscriber::MarchHare::Subscriber
+    else
+      extend ::ActionSubscriber::Bunny::Subscriber
+    end
+
+    ##
+    # Private Attributes
+    #
+    private
+
+    attr_reader :env, :payload, :raw_payload
+
+    public
+
+    ##
+    # Constructor
+    #
+    def initialize(env)
+      @env = env
+      @payload = env.payload
+      @raw_payload = env.encoded_payload
+    end
+
+    ##
+    # Class Methods
+    #
+
+    def self.connection
+      ::ActionSubscriber::RabbitConnection.connection
+    end
+
+    # Inherited callback, save a reference to our descendents
+    #
+    def self.inherited(klass)
+      super
+
+      inherited_classes << klass
+    end
+
+    # Storage for any classes that inherited from us
+    #
+    def self.inherited_classes
+      @_inherited_classes ||= []
+    end
+
+    def self.print_subscriptions
+      puts ::ActionSubscriber.configuration.inspect
+      puts ""
+
+      inherited_classes.each do |klass|
+        puts klass.inspect
+      end
+
+      nil
+    end
+
+    ##
+    # Class Aliases
+    #
+    class << self
+      alias_method :subscribers, :inherited_classes
+    end
+
+    ##
+    # Private Instance Methods
+    #
+    private
+
+    def acknowledge
+      env.acknowledge
+    end
+
+    def reject
+      env.reject
+    end
+  end
+end