https://github.com/bitsapien/slackbot-rails

An activerecord hook to send notifications to slack on updations and creation of resources.
https://github.com/bitsapien/slackbot-rails

activerecord notifications slack slackbot

Last synced: 1 day ago
JSON representation

An activerecord hook to send notifications to slack on updations and creation of resources.

• Host: GitHub
• URL: https://github.com/bitsapien/slackbot-rails
• Owner: bitsapien
• License: mit
• Created: 2017-03-07T07:40:27.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-10T14:52:48.000Z (almost 8 years ago)
• Last Synced: 2024-12-13T19:08:29.657Z (about 1 month ago)
• Topics: activerecord, notifications, slack, slackbot
• Language: Ruby
• Size: 42 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Slackbot::Rails

An activerecord hook to send notifications to slack on updations and creation of resources.

## Installation

Add this line to your application's Gemfile:

    gem 'slackbot-rails', :git => 'git://github.com/bitsapien/slackbot-rails.git'

And then execute:

    $ bundle

## Usage

Just put the `notify_bot` method in your model

```ruby

class Model < ActiveRecord::Base

  notify_bot bot:     {

               webhook: '',

               name: '',

               channel: '#channel-name'

             }, 

             message: {

              create: 'A new resource in *{class.model_name.human}* was created. '}

end

```

This would send a notification on Slack:

![Slack Preview](https://raw.githubusercontent.com/bitsapien/slackbot-rails/master/images/slack-preview.png)

Attributes inside '{}' will be evaluated on the present object of the model, for example : 

`It is {valid?} that the present object passed validations` would output ->

`It is true that the present object passed validations`

#### Setting Defaults

You may enable/disable notifications using a flag, for example in `application.rb`

```ruby

config.slackbot_rails_enable = Rails.env.production?

```

## TODO

1. Specs!

2. Background job option.

3. Add I18n support.

4. Add fallbacks for configurations.

5. Add more support for emojis.

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request