【第一回】超簡単！RubyでSlack Botを作る方法

この記事はCAMPHOR- Advent Calendar 2016の13日目の記事です

ごあいさつ

今年もAdvent Calendarの季節がやってきましたね。 せっかくなのでこれを機にTech関連の記事を残すため、はてなブログはじめました。 相変わらず見習いエンジニアの域を出ない@andoshin11 です。 今回の記事は2本立ての構成になっています。(2本目の記事は12/17に公開予定)

またまた長文になりますがお付き合いよろしくお願いします。

昨年度の記事はこちら↓↓

tech.camph.net

概要

  • プログラミング初心者でも記事を読めばBotが作れるよう意識して書きました*1
  • 昨年は Googla Apps Scriptを使用しましたが、今年は RubyでSlack Botを実装します
  • Slack公式が提供する Real Time Messaging APIを利用します
  • Botを作成し、外部サーバー(Heroku)で動かすところまでを目標にします
  • rubotyやlitaのようなライブラリは利用せず、勉強も兼ねて自前での実装を目指します
  • 質問あればコメントください！

目次

  1. Slack API入門
  2. Real Time Messaging API
  3. Herokuにデプロイするぞ

環境

参考

やっていくぞ！！

1. Slack API 入門

幸いなことにSlack自身がすでに豊富なAPIを整えてくれているので、その使い方さえ理解すれば比較的容易に手元のマシンからでもメッセージの送受信ができます。

Slack API

1.1. APIのテスト

何はともあれ Rubyで Slack APIを叩いて遊んでみましょう！ まずは作業ディレクトリ内に Gemfileを作成します。

# Gemfile
source 'https://rubygems.org'

gem 'http'
gem 'json'

次に本体である test.rbの作成です

# test.rb
require 'http'
require 'json'

response = HTTP.post("https://slack.com/api/api.test")
puts JSON.pretty_generate(JSON.parse(response.body))

2つのファイルの用意ができたら $ bundle exec ruby test.rbでスクリプトを実行します。

f:id:andoshin11:20161209230148p:plain

POSTしたリクエストへのレスポンスとして "ok":trueが返ってきましたね。Slack本体のサーバーと対話ができた証拠です。

1.2. Authentication

次はもう一歩踏み込んでチーム固有の情報を取得できるよう、 Authenticationを行なっていきたいと思います。

先ほどはhttps://slack.com/api/api.testというURLにリクエストを送りましたが今度はhttps://slack.com/api/auth.testというアドレスにリクエストを送ってみます。

test.rbを編集

# test.rb
require 'http'
require 'json'

response = HTTP.post("https://slack.com/api/auth.test")
puts JSON.pretty_generate(JSON.parse(response.body))

実行

f:id:andoshin11:20161209230259p:plain

"ok":false, "error": "not_authed"と怒られてしまいました。これはリクエスト時に Tokenが設定されていないことが原因です。 Tokenは、管理画面から Bots Integrationを追加することで取得できます。 f:id:andoshin11:20161209190042p:plain f:id:andoshin11:20161209190056p:plain

発行された Tokenをコピーして環境変数として保存しましょう。

f:id:andoshin11:20161209230425p:plain

POSTリクエストに params[:token]を追加。

require 'http'
require 'json'

response = HTTP.post("https://slack.com/api/auth.test", params: {
    token: ENV['SLACK_API_TOKEN']
  })
puts JSON.pretty_generate(JSON.parse(response.body))

実行

f:id:andoshin11:20161211222749p:plain

成功しました！今度は認証が認められ、加えて Tokenに紐づいたチームの情報やユーザーの情報も返ってきています。 余談ですがSlack内で割り振られている team_idは先頭が Tから始まり、 user_idは Uから始まるという仕様のようです。

1.3. Post Message

認証が通るようになったので、実際にSlackへメッセージを投稿してみましょう。

メッセージ投稿用APIのURLはhttps://slack.com/api/chat.postMessageです。パラメータに投稿先のチャンネルや、投稿したいテキストを指定してリクエストを送ることでメッセージの投稿が可能になります。

test.rbを編集

require 'http'
require 'json'

response = HTTP.post("https://slack.com/api/chat.postMessage", params: {
    token: ENV['SLACK_API_TOKEN'],
    channel: "#general",
    text: "こんにちは！",
    as_user: true,
  })
puts JSON.pretty_generate(JSON.parse(response.body))

as_user: trueとしているのはデフォルトの Bots Integrationとしてではなく、自分で ConfigureしたBotユーザーに投稿させたいからです。

スクリプトを実行

f:id:andoshin11:20161211223037p:plain

f:id:andoshin11:20161211223050p:plain

メッセージの投稿に成功しました！このときレスポンス内に投稿されたメッセージの関する情報が含まれているのもわかりますね(タイムスタンプ等)

ここまでで基本的な Slack APIの使い方を把握できました！ Cron等で定期的にこのメッセージ投稿APIを叩くだけでも簡易Botが作れそうですね。

2. Real Time Messaging API

前節ではあくまで一方通行のメッセージの投稿方法を確認しました。 ですが実際の運用を想定すると常時双方向通信を監視し、ユーザーからの投稿に合わせて適切な出力を返してあげる必要があるでしょう。 ここからはSlackの備える Real Time Messaging APIと低コストで双方向通信を可能にする Web Socketの仕組みを利用して、より実用的なBotを作っていきます。

2.1. Real Time Messaging APIとは

Slackには既に Outgoing Webhookというユーザーの投稿内容を外部のサイトやアプリに出力してくれる仕組みがありますが、 Outgoing Webhookの扱える情報は特定のキーワードから始まるメッセージのみです。

対して Real Time Messaging APIはその名の通り24時間チームを監視しユーザーの全ての投稿内容だけでなく、「チャンネルの新規作成」「チャンネルへのユーザーの参加/脱退」などといった1つ1つのイベントの情報すら出力してくれる仕組みです。

この仕組みを用いることでより複雑なBotの実装が可能になります。

2.2. Real Time Messaging APIでデータを取得する

まずは Gemfileを編集して2つの新たなGemを追加します

# Gemfile
source 'https://rubygems.org'

gem 'http'
gem 'json'
gem 'faye-websocket'
gem 'eventmachine'

faye-websocketによってRubyでWeb Socketサーバーを立てることが容易になり、 eventmachineは並列処理等を可能にしてくれるものです

早速、https://slack.com/api/rtm.startにリクエストを送り Web SocketのURLを確認しましょう。

# test.rb
require 'http'
require 'json'
require 'eventmachine'
require 'faye/websocket'

response = HTTP.post("https://slack.com/api/rtm.start", params: {
    token: ENV['SLACK_API_TOKEN']
  })

rc = JSON.parse(response.body)

puts rc['url']

実行

f:id:andoshin11:20161209232226p:plain

レスポンスの JSONの中の['url']にアドレスが含まれているのが分かりますね。このアドレスに対して双方向通信を確立するよう、 Web Socketを動かしていきます。 Real Time Messaging APIからは常に情報が降ってくるので、並列処理のための Event Machineもお忘れなく。

# test.rb
require 'http'
require 'json'
require 'eventmachine'
require 'faye/websocket'

response = HTTP.post("https://slack.com/api/rtm.start", params: {
    token: ENV['SLACK_API_TOKEN']
  })

rc = JSON.parse(response.body)

url = rc['url']

EM.run do
  # Web Socketインスタンスの立ち上げ
  ws = Faye::WebSocket::Client.new(url)

  #  接続が確立した時の処理
  ws.on :open do
    p [:open]
  end

  # RTM APIから情報を受け取った時の処理
  ws.on :message do |event|
    p [:message, JSON.parse(event.data)] 
  end

  # 接続が切断した時の処理
  ws.on :close do
    p [:close, event.code]
    ws = nil
    EM.stop
  end

end

実行！

f:id:andoshin11:20161209232530p:plain

一番上に接続が確立したことを示す [:open]が表示されていますね。

二行目の [:message]に含まれる {"type"=>"hello"}というのはSlack側が接続確立時に送信してくるものです。三行目は無視して構いません。

四行目の内容ですが {"type"=>"presence_change"...}というメッセージからも分かる通り、ユーザーのステータスが変わったことを示すイベントをキャッチしてReal Timeでこちらの Web Socket Serverに送信してくれています。

このプログラムを走らせたまま、もう少しSlack側でいろいろいじってみましょう。

https://gyazo.com/7c40944aa3c8d36adccac896dd444e5b.gif

https://gyazo.com/059890bb5da0f256b26665cbae0901de.gif

みなさんお気付きのように Real Time Messaging APiではユーザーが投稿する時だけでなく、「入力中」であることや「リアクション」を取った事すらも細かく取得することがわかりました。これで様々な種類のBotが実装できますね！

2.3 ユーザーの投稿に合わせてメッセージを返す

ここまでで常時ユーザーの投稿内容が取得できるようになりました。 次は投稿に合わせたレスポンスを返せるよう test.rbを修正していきます。

# test.rb
...

  ws.on :open do
    p [:open]
  end

  ws.on :message do |event|
    data = JSON.parse(event.data)
    p [:message, data]

    if data['text'] == 'こんにちは'
      ws.send({
        type: 'message',
        text: "こんにちは <@#{data['user']}> さん",
        channel: data['channel']
        }.to_json)
    end
  end

  ws.on :close do
    p [:close, event.code]
    ws = nil
    EM.stop
  end

...

ユーザーが「こんにちは」と投稿したら、「こんにちは (ユーザー名)さん」と同じチャンネルで返すようなシンプルなスクリプトです。

実行！

https://gyazo.com/4eedd5ba19eacd9def0f7ee0ccd8e4dc.gif

意図した通りに動きましたね。

1つ注意しなくてはいけないのが、Botが投稿した内容もまた RTM APIによって返ってくるということです。Bot同士の会話が一生終わらないという事態が無いように気をつけてください。 f:id:andoshin11:20161209202001j:plain

RTM APIで受信したJSON内に含まれる情報を上手く利用することで双方向対話ができるようになりました。おめでとうございます！

3. 作ったBotを公開する

ここまででLoaclのマシン上でBotが動くようになりましたが、せっかくなので外部サーバーでホスティングして常時稼働させてあげたいものです。

今回は Herokuにデプロイすることでこの課題を解決していきます。 事前準備として heroku toolbeltを導入するところまでは進めておいてください。

参考リンク：Heroku登録〜Macで環境整備〜お試しWebアプリを作るまで

3.1. Gitの設定

Heroku上で動かすにあたって Gemfileに Rubyのバージョンに関する情報を追記します。

# Gemfile
source 'https://rubygems.org'
ruby "2.3.1"

gem 'http'
gem 'json'
gem 'faye-websocket'
gem 'eventmachine'

また test.rbの名前をカッコ悪いので bot.rbに変更し、「こんばんは」というコマンドに反応するよう修正しました。

# bot.rb
...

  ws.on :message do |event|
    data = JSON.parse(event.data)
    p [:message, data]

    if data['text'] == 'こんばんは'
      ws.send({
        type: 'message',
        text: "こんばんは <@#{data['user']}> さん",
        channel: data['channel']
        }.to_json)
    end
  end

...

お決まりの $ git init $ git add . $ git commit -m "Initial commit"までの流れで Gitの初期化を行います

f:id:andoshin11:20161210011218p:plain

3.2. Heroku側の設定

Heroku のアカウントを取得し Heroku Toolbeltの設定も済んでいる方はコマンドラインからログインができます。

$ heroku login実行後ログイン情報を入力

f:id:andoshin11:20161210004318p:plain

初期状態では Heroku上に Rubyの実行環境が存在しないため、公式の提供する Heroku Buildpack for Rubyを利用してアプリケーションの初期化を行います。

$ heroku create --buildpack https://github.com/heroku/heroku-buildpack-ruby.gitを実行

f:id:andoshin11:20161210004746p:plain

$ git push heroku masterでファイルをデプロイ！

f:id:andoshin11:20161210011545p:plain

Tokenを Herokuの環境変数として登録します

f:id:andoshin11:20161210011706p:plain

さぁ、ここまでで準備完了です。実際に Heroku上で Rubyのスクリプトを動かしてみましょう！

$ heroku run bundle exec ruby bot.rbを実行

f:id:andoshin11:20161210012017p:plain

https://gyazo.com/5abef68450c61f6c09c56f31323952c7.gif

動いたー！！

おわりに(...そして予告)

お疲れ様でした。Slackの強力なAPIと Web Socketの力でシンプルなスクリプトでもBotを作れるようになりましたね。やっている事は本当に単純なのでどんな言語でも応用が効くことでしょう。

冒頭でもお伝えしましたが今回は2本立てです。 次回の内容は、今回作成したプログラムにアップデートを加えてより実用的(????)なBotを作る手段を記事にします。 お楽しみに！

明日はsiriusjackの記事です

*1:僕自身が雑魚エンジニアなので...

*2:MBA、ディスコンになってしまったのでかなしい...