2016-12-17

Slack にボットを設置する

Slack を CircleCI に連携したように、Slack はさまざまなサービスと連携できます. またボットを設置して会話への応答やアクションを実行することも可能です. 最近は Slack のようなチャット・ツールからインフラのオペレーションを実行する ChatOps というキーワードも登場しています.
今回は Slack に簡単なボットを設置したいと思います.

作業環境

Windows 7
Node.js 6.9.1 LTS
Botkit 0.4.2

Slack の Bots を作成

まずは Slack に Bots のカスタム連携を追加します.
Slack へログインし、ボットの追加画面 https://my.slack.com/services/new/bot へアクセスします.
ボットの名前を入力し、[Add bot integration] ボタンをクリックします. 今回は bot としました. (ちゃんと名前を付けてあげよう… orz)

ボットが作成されました. 各種設定が行える画面が表示されるので、通知名やアイコンなどを必要に応じて変更します. せっかくのボットなので、ちゃんと名前とアイコンを付けてかわいがりましょう. 変更した際には画面下の [Save Integration] をクリックします.
最後に、API Token をコピーしておきます.

Slack のチャット画面に戻り、ボットが参加するチャンネルを表示し、/invite @[BOT_NAME] とコマンドを実行します. 今回は sandbox チャンネルで　/invite @bot としました.

無事、ボットがチャンネルに参加しました.

Botkit でボットのプログラムを作成

ボットのプログラムを作成します. Slack のボットというと、GitHub の Hubot が有名ですが、開発が止まってしまったようです. 残念…
今回は Slack から発表された Howdy の Botkit を使いたいと思います.

作業ディレクトリを c:\Develop\repos、プロジェクト名を slack-bot とします. まずは npm init でプロジェクト作成を行います. 基本的にはエンターを押していくだけで問題ありません. license は公開するならライセンス設定をしますし、今回は特に公開しないので UNLICENSED にしました.

c:\Develop\repos> mkdir slack-bot
c:\Develop\repos> cd slack-bot

c:\Develop\repos\slack-bot> npm init
name: (slack-bot)
version: (1.0.0)
description:
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC) UNLICENSED
About to write to c:\Develop\repos\slack-bot\package.json:

{
  "name": "test",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "UNLICENSED"
}


Is this ok? (yes)

プロジェクト作成後、Botkit をインストールします.

1	c:\Develop\repos\slack-bot> npm install botkit --save

ボットのプログラムを作成します. プロジェクト直下に index.js ファイルを作成します.
まずは基本動作の確認からなので、Botkit の readme.md #Basic Usage になります.

const Botkit = require('botkit');
const controller = Botkit.slackbot();

controller.spawn({
    token : process.env.token
}).startRTM();

controller.hears('hello', [ 'direct_message', 'direct_mention', 'mention' ], (bot, message) => {
    bot.reply(message, 'Hello yourself.');
});

ボットのプログラムができたら起動します.
[API_TOKEN] は Slack からコピーした、ボットの API Token になります.

c:\Develop\repos\slack-bot> set token=[API_TOKEN]
c:\Develop\repos\slack-bot> node index.js
info: ** No persistent storage method specified! Data may be lost when process shuts down.
info: ** Setting up custom handlers for processing Slack messages
info: ** API CALL: https://slack.com/api/rtm.start
notice: ** BOT ID: bot ...attempting to connect to RTM!
notice: RTM websocket opened

Hello ボット！

ボットのプログラムが起動すると、DIRECT MESSAGES のボットのユーザ名(ここでは bot) の左のアイコンに色がつき ● になります. 色がない ○ の場合は接続できていないのでプログラムのログなどを確認し接続できるようにします.
接続できたら @bot hello と、メンションで hello をボットに送ります.

ボットが Helllo yourself. と返してくれました！

先ほどのプログラムの以下の部分が会話の処理になります.

1
2
3

controller.hears('hello', [ 'direct_message', 'direct_mention', 'mention' ], (bot, message) => {
    bot.reply(message, 'Hello yourself.');
});

controller.hears() の第１引数で反応するメッセージ、第２引数で聞く(反応する)イベントを指定しています.
今回は hello という文字列を以下のイベントで待っているという処理になります.

direct_message: ダイレクト・メッセージ
direct_mention: 名前で始まるメンションのメッセージ (e.g. @bot hello)
mention: メンションのメッセージ (e.g. hello @bot)

第３引数にイベントに対する反応の処理を渡します. bot.reply() なので、今回はメッセージに対して Hello yourself. と返事をする処理になります.

はじめてみようSlack 使いこなすための31のヒント

posted with ヨメレバ

Slack研究会パーソナルメディア 2016-08-03

Slack入門 [ChatOpsによるチーム開発の効率化]

posted with ヨメレバ

松下雅和,小島泰洋,長瀬敦史,坂本卓巳技術評論社 2016-06-28

Botkit を使うことで、簡単にボットを実装することができました. メッセージ対して返事をするだけでなく、さまざまな処理ができますので、このボットを育てていきたいともいます.

験なきものを思はずは

Azriton's blog

Slack にボットを設置する

Slack の Bots を作成

Botkit でボットのプログラムを作成

Hello ボット！

Slack の Bots を 作成

Botkit で ボットのプログラムを作成

Hello ボット！

Slack の Bots を作成

Botkit でボットのプログラムを作成