Slacks

A library for communicating via Slack

Slacks uses Slack's Web API to allow your bot to communicate on Slack:

require "slacks"
slack = Slacks::Connection.new("xoxb-0123456789-abcdefghijklmnopqrstuvwx")
slack.send_message "Hi everyone!", channel: "#general"

You can post attachment:

slack.send_message "", channel: "#general", attachments: [{
  color: "#36a64f",
  fallback: "Tests passed!",
  text: "Tests passed!",
  fields: [{
    title: "Tests",
    value: "143",
    short: true
  }, {
    title: "Assertions",
    value: "298",
    short: true
  }]
}]

(For more information about sending messages, see chat.postMessage.)

You can indicate that your bot is typing:

slack.typing_on "#general"

You can react to messages:

slack.add_reaction "+1", message.ts

Slacks uses Slack's RTM API to allow your bot to listen on Slack. Slacks connects to a websocket provided by Slack and allows you to set up listeners for events by type:

require "slacks"
slack = Slacks::Connection.new("xoxb-0123456789-abcdefghijklmnopqrstuvwx")
slack.on "message" do |event|
  puts "I heard #{event["user"]} say #{event["text"].inspect}"
end
slack.on "reaction_added" do |event|
  next unless event["item"]["type"] == "message"
  message = slack.get_message data["item"]["channel"], data["item"]["ts"]
  puts "#{event["user"]} added #{event["reaction"]} to #{message["text"].inspect}"
end
slack.listen!

Add this line to your application's Gemfile:

gem "slacks"

And then execute:

$ bundle

Or install it yourself as:

$ gem install slacks

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/slacks.

The gem is available as open source under the terms of the MIT License.