December 18, 2017

BotMan for ChatWork

作り始めた所。

BotMan

The only PHP chatbot framework you will ever need.
https://botman.io/

BotMan を Laravel に導入済にして用意してあるのが BotMan Studio
https://github.com/botman/studio

今回は BotMan Studio を元に作っていった。

ChatWork Webhook

BotMan のデフォルトでは当然 ChatWork はない。ChatWork はこういう所が弱すぎる。少し前に Webhook 対応してやっと Chat bot 的なものを作れるようになった。

http://developer.chatwork.com/ja/webhook.html

調べた結論としては Webhook は アカウントイベント と ルームイベント があり

  • アカウントイベント に ご自身へのメンション(mention_to_me)
  • ルームイベント に メッセージ作成(message_created) と メッセージ更新(message_updated)

一つの Webhook 設定で両方のイベントが飛んでくることはないので両方使うなら Webhook を2つ作る。
bot へのメンション時にのみ発動させるなら アカウントイベント だけでもいい。
両方使うと bot へのメンションで mention_to_me と message_created 両方発動するので一つのほうがいいかもしれない。

作ったものとデモ

基本的な使い方

導入は GitHub 見てなんとかしてもらうとして…
Chat bot としての動作をどこに書くか。

書く場所としては2つ。

routes/botman.php

<?php
$botman = resolve('botman');

$botman->hears('Hi', function ($bot) {
    $bot->reply('Hello!');
});

Laravel のルーティングと大体同じなので分かりやすい。

クロージャではなくクラスで指定もできる。クラスの置き場所はどこでもいい。

$botman->hears('laravel version', 'App\Botman\LaravelCommand@version');

bot へのメンションで laravel version と書けば GitHub API を使って取得した Laravel の最新バージョンを返すコマンド。
Laravel ベースだとなんでもできるのがメリット。Lambda とかでも作れるけど不慣れだと後からメンテできなくなる可能性が高い。

webルーティングからコントローラー

routes/web.php の

Route::match(['get', 'post'], '/botman', 'BotManController@handle');

コントローラー内に書いている。

    /**
     * Place your BotMan logic here.
     */
    public function handle()
    {
        $botman = app('botman');

        //$botman->hears();

        $botman->listen();
    }

webhook で指定するのは /botman のURL。

どっちかを使うかは別にどっちでもいいはずだけどたぶん botman.php。/botman へのリクエストで BotMan が発動(listen)、実際の動作の細かいことは botman.php。

もう少し調べるとちょっと違ったかも。 botman.php に書いた方は常に有効。コントローラーの方はルーティングから発動した場合のみ有効。つまり /botman とは別に /slack を作り SlackController に書いた動作は /slack から呼び出された場合にのみ有効。

開発

困るのは開発時。ローカルサーバーでは当然 webhook は飛んで来ないのでやりにくい。
コマンド作るのを試してみたいという人がもしいれば ChatWork に参加して botman-chatwork-project のほうにプルリク送れば試せるようにする。

ドライバー

独自ドライバーを作りたい場合、Slack は複雑なので HipChat 辺りを参考にするといい。
https://github.com/botman/driver-hipchat

class HipChatDriver extends HttpDriver なので HttpDriver を見る。

https://github.com/botman/botman/blob/master/src/Drivers/HttpDriver.php

abstract class HttpDriver implements DriverInterface

DriverInterface はこれなので必要なメソッドを用意すればいい。
https://github.com/botman/botman/blob/master/src/Interfaces/DriverInterface.php

重要そうなのは

  • buildPayload() : HTTPリクエストから必要なデータを取得。
  • matchesRequest() : say() はドライバー指定してるけど hears() はしてない。どのドライバーを使うか判定するのは matchesRequest。これで true を返したドライバーが使われる。
  • buildServicePayload() : bot から投稿するデータを用意するメソッド。この後 sendPayload() で実際に送信。

Slack から ChatWork

実現したかったのは Chat bot ではなく Slack にしか対応してない通知を ChatWork にも流すことなんだ…。

自分で使う用だけど一応誰でも使えるようにはなっている。
https://botman.kawax.biz/

  1. ChatWork アカウントでログイン。ChatWork用のSocialiteは先にさっと作っていた。ログインに使うだけなので最低限の情報しか取得しないし token さえ保存してない。OAuth の token は期限短いので使いにくそう。
  2. 連携設定で投稿先の ChatWork ルームID、APIトークンを設定。Webhook URLが作られる。
  3. Slack 側の Outgoing Webhook でこのWebhook URLを設定する。

当然ずっと使える保証はないので必要なら自分で動かしたほうがいい。そもそもこれだけなら他にも方法はあるはず。

Outgoing Webhook で届くのは text のみで attachments は含まれないので全部そのまま流すのは無理そう。

© kawax