https://github.com/h3poteto/exception_notification-shoryuken

Exception Notifier Plugin for Rails with Shoryuken http://smartinez87.github.com/exception_notification
https://github.com/h3poteto/exception_notification-shoryuken

exception-notification gem shoryuken

Last synced: about 1 year ago
JSON representation

Exception Notifier Plugin for Rails with Shoryuken http://smartinez87.github.com/exception_notification

• Host: GitHub
• URL: https://github.com/h3poteto/exception_notification-shoryuken
• Owner: h3poteto
• License: mit
• Created: 2016-02-24T03:27:35.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-11-02T00:33:24.000Z (over 2 years ago)
• Last Synced: 2025-05-01T10:22:23.844Z (about 1 year ago)
• Topics: exception-notification, gem, shoryuken
• Language: Ruby
• Homepage:
• Size: 30.3 KB
• Stars: 5
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# ExceptionNotification::Shoryuken

[![Test](https://github.com/h3poteto/exception_notification-shoryuken/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/h3poteto/exception_notification-shoryuken/actions/workflows/test.yml)

[![GitHub release](https://img.shields.io/github/release/h3poteto/exception_notification-shoryuken.svg)](https://github.com/h3poteto/exception_notification-shoryuken/releases)

[![Gem](https://img.shields.io/gem/v/exception_notification-shoryuken.svg)](https://rubygems.org/gems/exception_notification-shoryuken)

![Gem](https://img.shields.io/gem/dt/exception_notification-shoryuken.svg)

This Ruby gem is an extension of the [exception_notification](https://github.com/smartinez87/exception_notification) gem, and provides a set of notifiers for sending notifications when errors occur in [Shoryuken](https://github.com/phstc/shoryuken) worker. This is useful if you use Shoryuken worker as asynchronous

process.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'exception_notification-shoryuken'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install exception_notification-shoryuken

## Usage

Add `require` in your initializer which setup exception_notification like `config/initializers/exception_notification.rb`:

```ruby

require 'exception_notification/shoryuken'

ExceptionNotification.configure do |config|

  # setup some notification

end

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, 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/h3poteto/exception_notification-shoryuken. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

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