Proclaimer

An easy, and extensible transactional event notification add on for Spree

Installation

Add proclaimer to your Gemfile:

gem "proclaimer"

Bundle your dependencies and run the installation generator:

bundle
bundle exec rails g proclaimer:install

Usage

Use Proclaimer.configure block to setup subscription:

Proclaimer.configure do |config|
  # Subscribe to a particular event
  config.subscribe("order.complete") do |event, payload|
    # ...
  end

  # Subscribe to any events related to order
  config.subscribe("order") do |event, payload|
    # ...
  end

  # Subscribe to any Spree events
  config.subscribe_all do |event, payload|
    # ...
  end
end

Testing

First bundle your dependencies, then run rake. rake will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using rake test_app.

bundle
bundle exec rake