Skip to content
This repository has been archived by the owner on Feb 12, 2019. It is now read-only.
/ proclaimer Public archive

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

License

Notifications You must be signed in to change notification settings

groundctrl/proclaimer

Repository files navigation

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

Copyright (c) 2015 ground(ctrl), released under the MIT License

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages