Skip to content

Commit

Permalink
let's wrap up v0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
skatkov committed Jun 6, 2024
1 parent 4e41595 commit f875919
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 2 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## Unreleased
## 0.2.0

- Handler methods are now defined as instance methods for simplicity.
- Define service_id in initializer with active_handlers, instead of handler class.
- Use ruby 3.0 as a base for standard/rubocop, format all code according to it.
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# 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.
Expand All @@ -16,6 +17,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
$ gem install munster

## Usage

Generate migrations and initializer file.

`munster:install`
Expand All @@ -25,12 +27,14 @@ Mount munster engine in your routes.
`mount Munster::Engine, at: "/webhooks"`

## 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.
Expand Down
2 changes: 1 addition & 1 deletion lib/munster/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module Munster
VERSION = "0.1.0"
VERSION = "0.2.0"
end

0 comments on commit f875919

Please sign in to comment.