https://github.com/galliani/flock-notifier

https://github.com/galliani/flock-notifier

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/galliani/flock-notifier
• Owner: galliani
• License: mit
• Created: 2020-12-01T01:16:01.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-01T01:49:11.000Z (about 4 years ago)
• Last Synced: 2024-10-02T16:37:40.666Z (3 months ago)
• Language: Ruby
• Size: 8.79 KB
• Stars: 5
• Watchers: 3
• 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

        
# Flock::Notifier

A simple wrapper to send notifications to [Flock](https://flock.com/) channel using Incoming webhook.

## Example

```ruby

require 'flock-notifier'

notifier = Flock::Notifier.new "CHANNEL_WEBHOOK_UID"

notifier.ping 'Hello World'

# => if your webhook is setup, will message "Hello World"

# => to the selected channel you set in Flock when generating the incoming webhook

```

For more info as how you can generate the webhook, you can follow [this official tutorial by Flock](https://docs.flock.com/display/flockos/Create+An+Incoming+Webhook).

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'flock-notifier'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install flock-notifier

## Usage

TODO: Write usage instructions here

## 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/[USERNAME]/flock-notifier. 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](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Flock::Notifier project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/flock-notifier/blob/master/CODE_OF_CONDUCT.md).