Sha256: 7e3d5e7cbed4a0b4817e258c94da153a3ec73a8a0149579ced228437fa544113

Contents?: true

Size: 1.57 KB

Versions: 1

Compression:

Stored size: 1.57 KB

Contents

# 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.

Source code is extracted from https://cheddar.me/ main service to be used in internal microservices. Code here could be a subject to change while we flesh out details.

Due to that, support for this gem is limited.

## 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.

`munster:install`

Mount munster engine in your routes.

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

## 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).

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
munster-0.1.0 README.md