BitBar + Node.jsで天気予報を表示させてみた

14795 ワード
OpenWeatherMap npm Node.js ipinfo.io BitBar Node.js テキストリンク

作成したツール

今回、BitBarというツールとNode.jsを使って、天気予報を表示させるツールを作成してみた。
ツール名は「BitWeather」

一応gitにも公開したので、是非とも閲覧且つ、インストール且つ、スターをつけるをお願いします!!

そんでもって、今回の投稿が初投稿になります。皆さんよろしくです。

BitBarとは

任意のスクリプトまたはプログラムからの出力をMac OS Xのメニューバーに直接表示できる無料ツール。
また、cronのように任意の実行間隔でスクリプトなど、処理を実行できるそう。

なるほどってことで、使ってみました。

結論から言うと、導入がクッソ簡単ですww
公式ページ、またはターミナル上からBitBarをインストールします。ターミナルだと、以下の感じで

$ brew cask install bitbar

インストールされたら、それを実行するだけ( ・∇・)
すると、あら不思議!!メニューバーにBitBarが表示されたじゃないのよ( ・∇・)!!

あとは、BitBar専用のプラグインフォルダを作成して、そのディレクトリにshellやらRubyやらnodeやらのスクリプトを記述すれば、メニューバーに色々な機能が追加できるって感じっす( ・∇・)

BitBarについては以下のサイトがとてもわかりやすくまとめているため、詳細などは以下を参照してください!!

天気予報の取得

今回作成したツールでは、OpenWeatherMapっていう無料天気予報APIを使用して天気予報を取得しました。
「天気予報　取得」で検索すると、結構ヒットするのがOpenWeatherMapだったので、自分も使ってみようという感じですね。

あまり、お金かけるの嫌なんで、有料枠のプランではなく無料枠のプランで使用してみることに。
無料のFreeプランだと5日後までの3時間毎の天気予報を取得できて、1分間に60回までAPIコールできるそう。(所感としては、全然無料枠でええやろって感じっす)
あとは、公式サイトからAPI keyを発行し、APIにリクエストを投げれば、天気予報が簡単に取得できます。(説明大分省略してます。。。)

試しにターミナル上でcurlコマンドを用いてAPIにリクエストを送ってみました。
以下のURLにおけるリクエストパラメータのappidは公式サイトでのAPI keyなので、皆さんも実際にリクエスト送ってみてください!!

$ curl https://samples.openweathermap.org/data/2.5/find?lat=57&lon=-2.15&cnt=3&appid=b6907d289e10d714a6e88b30761fae22 | jq

レスポンスはjsonやxmlを指定できるそうです。
以下のレスポンスはjson形式となります。

{
    "message":"accurate",
    "cod":"200",
    "count":3,
    "list":[
        {"id":2641549,
         "name":"Newtonhill",
         "coord":{"lat":57.0333,"lon":-2.15},
         "main":{"temp":275.15,
                 "pressure":1010,
                 "humidity":93,
                 "temp_min":275.15,
                 "temp_max":275.15},
                 "dt":1521204600,
                 以下省略...

取得できれば、あとはJSON.parseしてあげて、表示したいように表示するだけです( ・∇・)

現在地の取得

せっかくだし、現在地も取得したいなぁっと思ったので、色々調べてみました。
色々調べてみた結果、「ipinfo.io」というAPIと出会うことができました。
こちらのAPIは意外と正確に現在地を取得してくれます。
何より

10万人以上の企業や開発者から信頼されています。

っとか言われたら、そりゃ安心して使っちゃうでしょ!!
また、こちらのAPIも使うのが簡単で、公式ページから「SIGN UP」を選択し、アカウント登録するとtokenが発行できます。
そのtokenをリクエストパラメータとして使用しAPIをたたくと現在地情報など取得できます。

こちらも、試しにターミナル上でcurlコマンドを用いてAPIにリクエストを送ってみました。
URLのtoken情報は、実際に発行した、トークン情報となります。

$ curl https://ipinfo.io/?token={token} | jq

レスポンスはjson形式のみ？だと思われます。
結果は、以下のような感じです。

{
  "ip": "118.103.63.151",
  "city": "city name",
  "region": "region name",
  "country": "JP",
  "loc": "lat, lon",
  "postal": "Postal code",
  "org": "AS17676 Softbank BB Corp."
}

取得できたら、こちらもOpenWeatherMap同様、JSON.parseしてあげ、必要な情報だけ抜き取ったりする感じですね。
今回のツールでは、取得されたデータからOpenWeatherMapのリクエスト情報に緯度、経度の情報を渡してあげて、現在地の天気予報を取得する処理にしました。

実装におけるプチこだわり

今回の実装では、なるべくドメイン駆動っぽく実装したかったため、1つのjsファイルに1つの関心事を詰めること意識し実装しました。
jsでのオブジェクトとして、以下のような雛形からオブジェクトを作成しました。

var Obj = {
    create: (arg) => {
        var obj = Object.create(Obj.prototype);
        obj.arg = arg;
        return obj;
    },
    prototype: {
        method() {
            // Use arg process.
        }
    }
}

割と上記の書き方は好きです。わかる人にはわかりやすいオブジェクトの書き方ではないかと(勝手に)思ってます。

上記の雛形より、例えばリクエストURLとかのオブジェクトは以下のように作成しました。

url.js
exports.create = (url, parameter) => {
    return Url.create(url, parameter);
}

var Url = {
    create: (requestUrl, requestParameter) => {
        var url = Object.create(Url.prototype);

        url.requestUrl = requestUrl;

        url.requestParameter = requestParameter;

        return url;
    },
    prototype: {
        createUrl() {

            if(this.requestParameter === undefined) {
                return this.requestUrl;
            }

            var keys = Object.keys(this.requestParameter);

            var mappingKeys = keys.map((key, index) => {
                return key + '=' + this.requestParameter[key];
            });

            return this.requestUrl + '?' + mappingKeys.join('&');
        }
    }
}

// 使用する側
var Url = require('./url');
var url = Url.create('https://request/url', {id: 111, value: 'hoge'});
url.createUrl(); // -> "https://request/url?id=111&value=hoge"

まぁ、車輪の再発明感はあるはメソッド名はわかりにくいやら。。。
リファクタリングはまだまだやります。。。

まとめ

今回、BitWeatherを作成してみましたが、まずは使ってみる価値ありだと思われます!!(笑)
Node.jsでドメイン駆動っぽく実装したのが初めてだったので、開発には時間がかかりました。

まだまだBitWeatherは拡張していくつもりなのでバージョンをどんどん上げていこうと思っていますはい!!
バージョンの付け方やら細かいことは全くよくわかってないので雰囲気でどんどん進めていこうと思っていますですはい!!

以上です。
最後まで閲覧してくれた方、ありがとうございます🙇‍♂️