Ruboty::SlackSocketMode

Slack(Socket Mode) adapter for ruboty. This gem is experimental.

This is fork of rosylilly/ruboty-slack_rtm, adapted new slack API(Socket Mode) instead of old API(RTM).

ENV

• SLACK_APP_TOKEN: Slack App-Level token for Socket Mode. get one on https://api.slack.com/apis/connections/socket#token
• SLACK_BOT_TOKEN: Slack OAuth token for using Web API. get one on https://api.slack.com/web#basics
• SLACK_EXPOSE_CHANNEL_NAME: if this set to 1, message.to will be channel name instead of id (optional)
• SLACK_IGNORE_BOT_MESSAGE: if this set to 1, bot ignores bot_messages and messages posted by bot users, including itself (optional)
• SLACK_IGNORE_SELF_MESSAGE: if this set to 1, bot ignores messages posted by itself (optional)
• SLACK_IGNORE_WEBHOOK_MESSAGE: if this set to 1, bot ignores messages that have bot_id but no user, such as messages posted via incoming webhooks or Workflow Builder (optional)
• SLACK_IGNORE_GENERAL: if this set to 1, bot ignores all messages on #general channel (optional)
• SLACK_GENERAL_NAME: Set general channel name if your Slack changes general name (optional)
• SLACK_AUTO_RECONNECT: Enable auto reconnect if websocket disconnected by Slack (optional)

Messages ignored by SLACK_IGNORE_SELF_MESSAGE or SLACK_IGNORE_WEBHOOK_MESSAGE are logged at info level without their text.

Development

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.

For instant confirmation, sample directory may be useful with below steps. You will need a slack workspace and slack app tokens. you can use sample/slack_app_manifest.yml to create a slack app.

cd sample
cp sample.env .env # and fill your slack_app tokens

docker compose run --rm ruboty

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/reproio/ruboty-slack_socket_mode.