2017-02-01

Slack のボットで今日の天気を通知する - Slack ボット実装編

OpenWeatherMap のサービスを使って、天気情報を取得できるようになり、JSON の内容も確認しました.
いよいよ Slack のボットに組み込んで、毎朝の天気を通知してもらいましょう.

作業環境

Slack
Node.js 6.9.1 LTS
Botkit 0.4.9
node-cron 1.2.1
moment-timezone 0.5.10

通知方法の検討

天気は毎日の事なので、毎朝 7:00 に通知してもらうことにしたいとおもいます. 土日はもう少し遅くてよいかもしれませんが… とりあえず使ってみて、調整しましょう.
通知内容は、天気、気温、降雨量(降雪量) にし、せっかくなので OpenWeatherMap のアイコン画像も表示します.

Slack ボットの実装

'use strict';
const Botkit = require('botkit');
const http = require('http');
const cron = require('cron');
const moment = require('moment-timezone');

const controller = Botkit.slackbot();

controller.spawn({
    token: process.env.bot_access_token
}).startRTM((err, bot, payload) => {
    moment.locale('ja');
    moment.tz.setDefault('Asia/Tokyo');

    const city = '1850147';       // Tokyo
    const channel = 'sandbox';    // #sandbox
    const apikey = '[API_KEY]';   // Please replace with your API_KEY

    new cron.CronJob({
        cronTime: '00 00 7 * * *',
        onTick: () => {
            http.get(`http://api.openweathermap.org/data/2.5/weather?id=${city}&units=metric&appid=${apikey}`, (response) => {
                let body = '';
                response.setEncoding('utf8').on('data', (chunk) => {  body += chunk;  });
                response.on('end', () => {
                    let current = JSON.parse(body);
                    let text =
                            `${moment.unix(current.dt).format('H:mm')} 現在 ${current.name} の 天気` +
                            `<http://openweathermap.org/img/w/${current.weather[0].icon.replace('n', 'd')}.png?${moment().unix()}| > ` +
                            `${current.weather[0].main}(${current.weather[0].description}) / ` +
                            `気温 ${Math.round(current.main.temp)} ℃ ` +
                            `${current.rain && current.rain['3h'] ? '/ 降雨量 ' + Math.ceil(current.rain['3h'] * 10) / 10 + ' mm ' : '' }` +
                            `${current.snow && current.snow['3h'] ? '/ 降雪量 ' + Math.ceil(current.snow['3h'] * 10) / 10 + ' mm ' : '' }`;
                    bot.say({  text: text,  channel: channel  });
                });
            });
        },
        start: true,
        timeZone: 'Asia/Tokyo'
    });

});

Slack ボットの基本的な作りは Slack のボットで定時アクションの実装と変わりがありません.
※ 今回は #sandbox へ発言するので const channel = 'sandbox'; としていますが、ID で指定したほうがよいので https://slack.com/api/channels.list?token=[API_TOKEN] へアクセスして、ID を調べます. また、発言先のチャンネルへボットが参加している必要があります.

今回は Unix Timestamp の処理のために、moment-timezone を使いました. Unix Timestamp から、指定したタイムゾーンでの表記にするには、moment ではなく moment-timezone が必要となります. また、クラウド環境などでタイムゾーンが異なる環境で動作させる場合も、タイムゾーンを指定しておく必要があります. 今回はロケールに関する出力はありませんが、合わせて設定しておきます. 設定方法は以下のコードとなります.

1 2	moment.locale('ja'); moment.tz.setDefault('Asia/Tokyo');

続いて、cron.CronJob の onTick で OpenWeatherMap の API へ HTTP GET して、天気情報を取得して、Botkit で話してもらう処理になります.
天気情報の JSON も確認できましたので、この内容を文章化するだけになります. その辺が let text = ...; になりますが、JSON (ここでは current 変数) から取り出してつなぐだけですが、文字列の連結なのでかなり、ごった煮状態です…

文章を作っているところを 1行ずつ確認したいと思います.

1	`${moment.unix(current.dt).format('H:mm')} 現在 ${current.name} の天気` +

日付を扱う Moment.js を使い、データ計算時間の Unix 秒をフォーマットし、${current.name} で都市名を取り出しています.
都市名は ID を指定している時点でわっているので明示しても良いのですが、都市 ID を切り替えるだけで動作できるので、JSON から取り出しています.

1	`<http://openweathermap.org/img/w/${current.weather[0].icon.replace('n', 'd')}.png?${moment().unix()}\| > ` +

OpenWeatherMap のアイコンを表示する部分になります. <url|text> の形式でポストすることで、URL の代わりに文字列のリンクをポストできます. 今回はリンクを出す必要がないので <url| > とスペースを入れることで潰しています. スペースなしだと URL が表示されたのでスペースにしました.
アイコンのファイル名ですが、${current.weather[0].icon.replace('n', 'd')}.png としています. 午前 7時だと夜用アイコンが表示されるので、常に昼用のアイコンを使うようにしています.
また URL の最後の ?${moment().unix()} ですが、Slack が同じ画像の URL がポストされた際に展開されない(画像表示されない) という動作をしました. そのため現在の Unix timestamp を付けています. current.dt をつけるのも手です. (開発時に困ったので Unix timestamp にしました)

1	`${current.weather[0].main}(${current.weather[0].description}) / ` +

現在の天気グループと天気状態の出力になります. (どちらかだけ、でもよかったかも…)

1	`気温 ${Math.round(current.main.temp)} ℃ ` +

気温です. 読みやすさ重視で、ざっくり小数点以下を四捨五入して、整数表示にしてます.

1
2

`${current.rain && current.rain['3h'] ? '/ 降雨量 ' + Math.ceil(current.rain['3h'] * 10) / 10 + ' mm ' : '' }` +
`${current.snow && current.snow['3h'] ? '/ 降雪量 ' + Math.ceil(current.snow['3h'] * 10) / 10 + ' mm ' : '' }`;

降水量です. 雨と雪でデータが異なり、また両方に値が入っているケースがあります. しかも、current.rain と current.snow に空オブジェクトが入るケースがあったので、current.rain && current.rain['3h'] と両方を確認して、値が存在したら出力するようにしています.
また四捨五入すると天気が雨なのに 0 mm になるケースもあるので、切り上げにしています.