https://github.com/cheddar-me/munster

webhooks processing engine for rails applications
https://github.com/cheddar-me/munster

Last synced: 4 months ago
JSON representation

webhooks processing engine for rails applications

• Host: GitHub
• URL: https://github.com/cheddar-me/munster
• Owner: cheddar-me
• License: mit
• Created: 2024-05-08T15:41:10.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-07-29T12:20:02.000Z (4 months ago)
• Last Synced: 2024-07-30T12:46:30.270Z (4 months ago)
• Language: Ruby
• Homepage:
• Size: 163 KB
• Stars: 30
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Munster

Munster is a Rails engine that provides a webhook endpoint for receiving and processing webhooks from various services. Engine stores received webhook first and later processes webhook in a separete async process.

> [!CAUTION]

> At the moment Munster is only used internally at Cheddar. Any support to external parties is on best-effort

> basis. While we are happy to see issues and pull requests, we can't guarantee that those will be addressed

> quickly. The engine does receive rapid updates which may break your application if you come to depend on

> the library. That is to be expected.

## Installation

Install the gem and add to the application's Gemfile by executing:

    $ bundle add munster

If bundler is not being used to manage dependencies, install the gem by executing:

    $ gem install munster

## Usage

Generate migrations and initializer file.

`bin/rails g munster:install`

Mount munster engine in your routes.

```ruby

mount Munster::Engine, at: "/webhooks"

```

Define a class for your first handler (let's call it `ExampleHandler`) and inherit it from `Munster::BaseHandler`. Place it somewhere where Rails autoloading can find it, and add it to your `munster.rb` config file:

```ruby

config.active_handlers = {

  "example" => "ExampleHandler"

}

```

## Example handlers

We provide a number of webhook handlers which demonstrate certain features of Munster. You will find them in `handler-examples`.

## Requirements

This project depends on two dependencies:

- Ruby >= 3.0

- Rails >= 7.0

## Error reporter

This gem uses [Rails common error reporter](https://guides.rubyonrails.org/error_reporting.html) to report any possible error to services like Honeybadger, Appsignal, Sentry and etc. Most of those services already support this common interface, if not - it's not that hard to add this support on your own.

It's possible to provide additional context for every error. e.g.

```ruby

Munster.configure do |config|

  config.error_context = { appsignal: { namespace: "webhooks" } }

end

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/cheddar-me/munster.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).