Spree Legacy Webhooks

Legacy HTTP webhooks extension for Spree Commerce, an open source e-commerce platform built with Ruby on Rails.

This extension provides the legacy callback-based webhook system for Spree. We recommend migrating to the new event-based webhooks available in spree_api as they offer much better performance, scalability and Admin UI.

Installation

1. Add this extension to your Gemfile:

   gem 'spree_legacy_webhooks'

2. Install the gem:

   bundle install

3. Run the install generator:

   bundle exec rails g spree_legacy_webhooks:install

4. Restart your server

Usage

Disabling webhooks temporarily

You can disable webhook dispatching temporarily using:

Spree::LegacyWebhooks.disable_webhooks do
  # Your code here - no webhooks will be fired
end

Or set it globally:

Spree::LegacyWebhooks.disabled = true

Developing

1. Create a dummy app:

   bundle update
   bundle exec rake test_app

2. Add your new code

3. Run tests:

   bundle exec rspec

When testing your application's integration with this extension you may use its factories. Simply add this require statement to your spec_helper:

require 'spree_legacy_webhooks/factories'

Releasing a new version

bundle exec gem bump -p -t
bundle exec gem release

For more options please see gem-release README

Contributing

If you'd like to contribute, please take a look at the instructions for installing dependencies and crafting a good pull request.

License

Spree Legacy Webhooks is released under the AGPL-3.0 License.