Slackit
Slackit is a very simply Ruby Gem for posting to a slack incoming webhook.
Installation
Add this line to your application's Gemfile:
gem 'slackit'
And then execute:
$ bundle
Or install it yourself as:
$ gem install slackit
Usage
require "slackit"
Initialize client:
client = Slackit.new(webhook_url: "slack webhook url")
Initialize with options:
client = SlackNotify::Client.new(
webhook_url: "slack webhook url",
channel: "#development",
username: "mybot",
icon_emoji: ":shipit:",
)
Initialize via shorthand method:
client = Slackit.new(options)
Command Line Usage
Usage: slackit
-h, --help Display this screen
-c, --channel string The channel to send the message to
-i, --icon-emoji string The emoji to use as the channel icon [default: :wolf:]
-m, --message string The message to send
-w, --webhook-url string The slack incoming webhook url to use
-u, --username string The username to send as [default: slackit]
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.
Testing
For local testing make sure that you run bundle exec rspec spec
and then rake install
to install the gem locally.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/AntiPhotonltd/slackit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Slackit project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.