No commit activity in last 3 years
No release in over 3 years
Slack RTM bot extension for slack-ruby-bot-server.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Slack Ruby Bot Server RealTime (RTM) Extension

Gem Version Build Status

Table of Contents

  • Introduction
  • Samples
  • Usage
    • Gemfile
    • Configure
      • Server Class
  • Copyright & License

Introduction

This library is an extension to slack-ruby-bot-server that makes it easy to implement Slack RTM bots.

Samples

You can use one of the sample applications that use MongoDB or ActiveRecord to bootstrap your project and start adding slack command handlers on top of this code.

Usage

Gemfile

Add 'slack-ruby-bot-server-rtm' to Gemfile.

gem 'slack-ruby-bot-server-rtm'

Configure

SlackRubyBotServer::RealTime.configure do |config|
  config.server_class = ...
end

The following settings are supported.

setting description
server_class Handler class for additional events.
Server Class

You can override the server class to handle additional events, and configure the service to use it.

class MyServer < SlackRubyBotServer::Server
  on :hello do |client, data|
    # connected to Slack
  end

  on :channel_joined do |client, data|
    # the bot joined a channel in data.channel['id']
  end
end

SlackRubyBotServer::RealTime.configure do |config|
  config.server_class = MyServer
end

Copyright & License

Copyright Daniel Doubrovkine and Contributors, 2020

MIT License