hubot-traq

traQ用Hubotアダプター

使い方

新しいbotをつくる

インストール

前提としてNode.jsが必要です

# 利用ツールのインストール
npm install -g hubot coffee-script yo generator-hubot
# botを管理するディレクトリの作成
mkdir -p /path/to/hubot
cd /path/to/hubot
# テンプレートの作成
yo hubot

ここまでしたら、画面にしたがって入力していき、Bot adapterと表示されたらtraqと入力します
(もしくはyo hubotのあとにすべてコマンド引数で指定することもできます)

既定で入っているscriptsが存在するので一度除きます(このままだとredisがないだの怒られるため)
./external-scripts.jsonを開いて[]にします
package.jsonのdependenciesのhubotとhubot-traq以外を取り除いてnpm installをするといいかもしれません
さらに./hubot-scripts.jsonを消すと非推奨というエラーが出なくなります

# gitレポジトリの作成
git init
git add .
git commit -m "Init"

初期設定

下記の環境変数をそれぞれ設定します

• HUBOT_TRAQ_NAME - traQで動かすHubotのtraQ ID (例: @BOT_TESTならBOT_TEST)
• HUBOT_TRAQ_MODE - BOTのモード (HTTPまたはWebSocket、省略時はHTTP)
• HUBOT_TRAQ_ACCESS_TOKEN - traQで動かすHubotのAccess Token
• HUBOT_TRAQ_EMBED - メンション・チャンネルリンクの自動埋め込みの有無(TRUEにすると有効、省略時は無効)
• PORTまたはEXPRESS_PORT - HTTPモードでのポート (省略時は8080)
• 以下はHTTPモードのときのみ必要
  • HUBOT_TRAQ_VERIFY_TOKEN - traQで動かすHubotのVerification Code
  • HUBOT_TRAQ_PATH - Botサーバーエンドポイントのパス(直下で受け取るなら""、/webhook/で受け取るなら"/webhook/")

Verification CodeなどはそれぞれtraQのBot Consoleから確認できます

実行

./bin/hubot -a traq -n "$HUBOT_TRAQ_NAME"

showcase.yaml

type: runtime
startup: |
  npm install -g coffee-script
  npm ci
entrypoint: exec node_modules/.bin/hubot -a traq -n "$HUBOT_TRAQ_NAME" "$@"
http_proxy: 8080

このようにするとshowcaseで実行できます

javascript coffeescript typescript

./scripts/example.coffeeが存在していますが、拡張子が.coffeeではなく.jsのファイルを./scriptsに置くことでcoffeescriptではなくJavaScriptで書くことも可能です
ただし、この場合でもnpm install -g coffee-scriptは必要です

また、Typescriptで書くことも可能です。
ただし、あまり型の恩恵を受けれないと思います…。

さらに詳しい説明はhubotのドキュメントを参照してください

Changelog

• Change log

リファレンス

• Wiki
• Example
• Example with Typescript