Sha256: 5a9ef5ac5034ddd784079d9744fef8f7331b5038b4699963c4dc92c925ec751b

Contents?: true

Size: 1.18 KB

Versions: 1

Compression:

Stored size: 1.18 KB

Contents

# SlackNotifier

Simple Ruby gem for sending messages to Slack

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'slack_notifier'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install slack_notifier

## Configuration

```ruby
SlackNotifier.configure({
  default_channel: 'deployment-alerts',
  default_nickname: 'Deployment Bot',
  default_icon_emoji: ':ship:',
  default_report_title: 'Details',
  default_report_color: '#D3D3D3',
  webhook_url: 'https://hooks.slack.com/services/X01XXYY11/A1XXY1X00/YYYYYYYYYYYYYYYYYY',
  raise_delivery_errors: false
})
```

## Usage
```ruby
SlackNotifier::Message.send(
  text: "This uses all default configuration",
  report: 'Some report/attachment text'
)

# Customizing default configuration
SlackNotifier::Message.send(
  channel: 'errors',
  nickname: 'Bugs',
  text: ex.message,
  report: ex.backtrace
)
```

## Development

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

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/FindHotel/ruby_slack_notifier.

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
slack_notifier-1.0.1 README.md