筆者が開発している幾らかのコマンドラインプログラムとシェルスクリプトを使って簡単に Twitter bot を作る方法をご紹介します。

シェルスクリプトで作る Twitter bot 作成入門

この入門書の対象は以下の通り。
<ul>
<li>簡単なシェルスクリプトを書ける</li>
<li>Twitter の bot がどの様に動作するのかおおよそ分かる</li>
</ul>
本書では筆者が開発しているコマンドライン向け Twitter クライアント <code>twty</code> と、UNIX で扱えるコマンドを組み合わせ、シェルスクリプトで動く Twitter bot を作成します。本書を読み内容を理解して頂けると、おおよそどなたでも本書で紹介する様な Twitter bot を作れる様になるでしょう。
本書ではスクリプト言語として bash、コマンドの実装としてGo言語を使用します。 
以下が本書で実装する Twitter bot です。
<ul>
<li>自動で天気予報を呟く bot</li>
<li>今日は何の日を呟く bot</li>
<li>デタラメな文章を喋る bot</li>
<li>しりとりをする bot</li>
</ul>
前半は curl コマンドなど既にインストールされているコマンドと他のコマンドを使ってシェルスクリプトを実装します。後半は Go 言語で専用コマンドを実装し、そのコマンドを呼び出すシェルスクリプトも実装します。

はじめに

本書の内容を実行するには以下のコマンドおよび言語処理系が必要になります。なお環境は Ubuntu Linux を想定していますが、少し変更する事で簡単に他の環境に移植する事もできるでしょう。
<ul>
<li>twty コマンド</li>
<li>jq コマンド</li>
<li>curl コマンド</li>
<li>Go言語</li>
</ul>
与えられたテキストを元に加工されたテキストを出力する。この1つの事をうまくやるコマンドをうまく組み合わせる事でシェルスクリプトはどんな物でも実装できるのです。
<div class="msg ">ただし筆者は目的の機能を実装する為に、全てをシェルスクリプトのみで実装する事は可能な限り避けたいと考えています。
</div>
<h1 id="twty-%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89%E3%81%AE%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB%E6%96%B9%E6%B3%95">twty コマンドのインストール方法</h1>
本章の最後に述べるGo言語をインストールした後に以下を実行します。
<pre><code>$ go get github.com/mattn/twty
</code></pre>
これだけです。Twitter で呟ける様にするには <code>twty</code> コマンドを引数なしに実行します。
<pre><code>Open this URL and enter PIN.
https://api.twitter.com/oauth/authenticate?oauth_token=...
PIN:
</code></pre>
ブラウザが起動するので <code>Authorize app</code> ボタンを押してください。気を付けておいて欲しいのは、これは bot のアカウントでないといけません。いつもログインしている Twitter アカウントのまま 認証してしまうと以降で動作する bot の発言が本アカウントに流れてしまいフォロワに心配されてしまいます。
ボタンを押すと7桁の数字がブラウザに表示されるので、その番号を上記の <code>PIN:</code> の後に入力して下さい。異常なくコマンドが終了すれば <code>twty</code> コマンドの準備は完了です。既に <code>twty</code> コマンドをお使いの方は環境変数 <code>TWTY_ACCOUNT</code> に bot 名などを設定した上で上記の準備を実行して下さい。
以降の解説で <code>twty</code> コマンドを使う箇所では <code>TWTY_ACCOUNT</code> を設定しておくのをお忘れなく。
<h1 id="jq-%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89%E3%81%A8curl%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89">jq コマンドとcurlコマンド</h1>
以下のコマンドでインストールしておいて下さい。
<pre><code>$ sudo apt install jq curl
</code></pre>
<h1 id="go%E8%A8%80%E8%AA%9E">Go言語</h1>
以下のURLから環境にあった、できれば最新のバージョンのアーカイブをダウンロードします。
<a href="https://golang.org/dl" rel="nofollow">https://golang.org/dl</a>
例えば 64bit Linux であれば <code>go1.15.2.linux-amd64.tar.gz</code> をダウンロードし、以下を実行します。
<pre><code>$ sudo rm -rf /usr/local/go
$ sudo tar -C /usr/local xzf go1.15.2.linux-amd64.tar.gz
</code></pre>
最後に <code>go</code> コマンドが使える様に、以下をログインシェルに設定します。<code>bash</code> であれば以下を追加します。
<pre><code>export PATH=$PATH:/usr/local/go/bin:$HOME/go/bin
</code></pre>
ここまで出来れば後は vim や vim、あとは vim といったテキストエディタを使ってシェルスクリプトを実装しましょう。
<div class="msg alert">他のテキストエディタを使って頂いても構いません
</div>
<h1 id="twitter-bot-%E3%82%A2%E3%82%AB%E3%82%A6%E3%83%B3%E3%83%88%E3%81%AE%E6%BA%96%E5%82%99">Twitter bot アカウントの準備</h1>
本書では長くなってしまうので Twitter bot 専用のアカウント取得方法については割愛します。ただしスパムアカウントになってしまわない様、以下を一読しておくと良いです。
<a href="https://blog.twitter.com/developer/ja_jp/topics/tools/2018/at_mul.html" rel="nofollow">https://blog.twitter.com/developer/ja_jp/topics/tools/2018/at_mul.html</a>

まずは準備

Twitter bot とは何かしらの情報を元にテキストの加工等を行い、Twitter 社が提供する API を介して Twitter にツイートする物をいいます。
加工するとは言え、元のテキストはその作者に著作権があります。Twitter に流して良いテキストなのかは事前に確認しておくと良いでしょう。
また bot によってはネットワークを介して情報を収集しますが、高頻度にアクセスすると対象のサーバに負荷を掛けてします。常識の範囲内でアクセスする様、心がけましょう。
Twitter の API についても同様の事が言えます。開発中は何度もコマンドを実行する為、すぐにレート制限に引っかかってしまいます。本書では <code>twty</code> コマンドとシェルスクリプトを使って Twitter bot を実装しますが、例えばリプライを収集している箇所を開発中は静的なファイルから得る様にする等、工夫した方が良いでしょう。
<code>twty</code> コマンドでリプライを JSON 形式で貰う処理は以下になります。
<pre class="language-bash"><code class="language-bash">twty -r json | ...
</code></pre>
これを一時的に以下の様に修正しておきます。
<pre class="language-bash"><code class="language-bash"># 一度だけ実行
#twty -r json > input.json
cat input.json | ...
</code></pre>
スクリプトがうまく動く様になったら元に戻して確認しましょう。

Twitter bot を作る上で気を付ける事

本章では、一定間隔で気象情報をツイートする bot を実装します。天気や気温を呟くには気象情報を得なければなりません。
ちょうど良い事に、全世界の気象情報を無料で返してくれるサーバがあります。それが <a href="http://wttr.in" rel="nofollow">wttr.in</a> です。
<a href="https://wttr.in/" rel="nofollow">https://wttr.in/</a>
このサイトはブラウザから参照した際には綺麗な画面を表示しますが、curl コマンドからアクセスすると端末専用のレスポンスを返してくれます。
<img src="https://storage.googleapis.com/zenn-user-upload/cldonerw36ju8rmsbmj6dp19f9wh" alt="" loading="lazy">
実はこのサイトにはオプションが用意されており、format パラメータを付ける事で色々なフォーマットで出力する事ができます。例えば format 3 は以下の様に出力されます。
<pre><code>$ curl -s wttr.in/Tokyo?format=3
Tokyo: ⛅️ +20°C
</code></pre>
あとはこれを twty コマンドを使ってツイートする様なスクリプトに仕立て上げれば完成です。
<pre class="language-bash"><code class="language-bash">set -e

RESULT=$(curl -fs 'wttr.in/Tokyo?format=3&amp;m')
twty "$RESULT"
</code></pre>
curl を使ったコマンドを実行する際に気を付けるべき事は <code>-s</code> フラグを使って本文以外のコンテンツを表示しない様にする事と、<code>-f</code> フラグを使って HTTP のエラーを curl コマンドのエラーにする事です。
また <a href="http://wttr.in" rel="nofollow">wttr.in</a> は JSON フォーマットで色々な情報を得られる様になっています。独自のコンテンツを作るには便利です。
<pre><code>$ curl -s 'wttr.in/Tokyo?format=j1'
</code></pre>
<img src="https://storage.googleapis.com/zenn-user-upload/zho3zgsqtb3qo6puutmlz0tn7259" alt="" loading="lazy">
現在の気温を得るのであれば以下のコードになります。
<pre class="language-bash"><code class="language-bash">#!/bin/sh

set -e

RESULT=$(curl -fs wttr.in/Tokyo?format=j1 | jq -r '.current_condition[0].temp_C')
twty "東京の現在の気温は $RESULT ℃ です。"
</code></pre>
<code>if</code> 文を使って気温によって投稿する内容を変えても面白いと思います。<code>twty</code> コマンドはテキストだけでなく、画像や動画ファイルもアップロード可能ですので是非活用下さい。
出来上がったシェルスクリプトを1時間置きに実行するには crontab で以下の様に設定します。
<pre><code>0 * * * * /home/mattn/bin/weather.sh
</code></pre>
※シェルスクリプトに実行権限を付けるのをお忘れなく
簡単ですね。

天気を呟くbot

本章では、一定間隔で「今日は何の日」かをツイートする bot を作ります。
今日が何の日かを得るには Wikipedia の <a href="https://www.mediawiki.org/wiki/API:Main_page/ja" rel="nofollow">Mediawiki API</a> を利用するのが便利です。
<pre><code>https://ja.wikipedia.org/w/api.php?format=json&amp;action=query&amp;prop=revisions&amp;rvprop=content&amp;exintro&amp;explaintext&amp;redirects=1&amp;titles=クリスマス
</code></pre>
この <code>titles</code> に URL エンコードされた日付を埋め込めば良いですね。0埋めされていない日付を得るには <code>date +%-m月%-d日</code> で得られます。ちなみに <code>%m</code> と書くと0埋めされます。
MediaWiki API は URL エンコードされていないクエリ文字列では動かないので、予め URL エンコードしておきます。
<pre><code>date +%-m%%E6%%9C%%88%-d%%E6%%97%%A5
</code></pre>
<div class="msg "><code>%</code> 自身は <code>%%</code> と書く必要があります。
</div>
<pre><code>URL=&quot;https://ja.wikipedia.org/w/api.php?format=json&amp;action=query&amp;prop=revisions&amp;rvprop=content&amp;exintro&amp;explaintext&amp;redirects=1&amp;titles=$(date +%-m%%E6%%9C%%88%-d%%E6%%97%%A5)&quot;
</code></pre>
出来上がった URL を curl でアクセスし、jq で整形しながら、目的の項目を抽出していきます。
<img src="https://storage.googleapis.com/zenn-user-upload/yby7ye6d73jg9sk3q6evcdnz3ais" alt="" loading="lazy">
この時注意すべきは、何度も実行する事で Wikipedia に負荷を掛けない事です。負荷を掛けてしまう可能性があるのであれば、一旦 curl の出力をファイルにリダイレクトしておき、<code>cat result.txt | jq .</code> の様に実行すると良いでしょう。
出来上がったクエリ式は如何になります。
<pre><code>.query.pages[.query.pages|keys[0]].revisions[0][&quot;*&quot;]
</code></pre>
オブジェクトのキー一覧 <code>.query.pages|keys</code> から最初のキー <code>[0]</code> を得て、その値を元に <code>.query.pages</code> を参照します。そこから <code>.revisions</code> の最初のアイテムを得てオブジェクトを <code>*</code> というキーでアイテム参照します。
jq に渡して得られるテキストは以下の様になっています。
<img src="https://storage.googleapis.com/zenn-user-upload/k61k65xdy5ibjawb4gc1cwlh14p9" alt="" loading="lazy">
欲しい部分は <code>== 記念日・年中行事 ==</code> から <code>== フィクションのできごと</code> までの、先頭に <code>* </code> が付いいる行の様です。sed で切り取り、HTML コメントの様な部分を捨ててしまいましょう。
<pre class="language-bash"><code class="language-bash">curl -fs "$URL" | jq -r "$QUERY" | sed -n '/== 記念日・年中行事 ==/,/== フィクションのできごと ==/p' | sed -z 's/&lt;!--.*\?-->//g' | grep '^* .*の日'
</code></pre>
Wikipedia 独特の記述方法なのですが
<pre><code>* [[フグ|河豚]]（ふぐ）の日（日本）
* {{仮リンク|世界翻訳の日|en|International Translation Day}}
* [[独立記念日]]（{{BWA}}）
* 国有化の日（{{STP}}）&lt;!-- enではAgricultural Reform Dayとなっているが、日本語訳が不明 --&gt;
</code></pre>
この様に、色々なパターンがあり得ます。<code>[[</code> を使ったパターンでは読みと漢字が両方書かれていて、最後に <code>（日本）</code> や <code>（{{JPN}}）</code> が付いている物もあれば無い物もあります。うまく整形しましょう。順番は、記念日のテキストの範囲抽出、HTML コメントの削除、<code>の日</code> だけの抽出、後ろのカッコ(<code>（）</code>)の削除、<code>[[xxx|yyy]]</code> の最後(<code>yyy</code>)だけを残す、<code>{{xxx|yyyの日|zzz}}</code> の<code>日</code>が書かれている箇所だけ残す、です。
<pre class="language-bash"><code class="language-bash">curl -fs "$URL" | jq -r "$QUERY" | sed -n '/== 記念日・年中行事 ==/,/== フィクションのできごと ==/p' | sed -z 's/&lt;!--.*\?-->//g' | grep '^* .*の日' | while read -r LINE; do
 echo "$LINE" |\
 sed -e 's/^$.*$（[^）]\+）\?$/\1/' \
 -e's/\[\[$[^]|]\+|$*$[^]]\+$\]\]/\2/g' \
 -e 's/${[^日|]\+\|[^日]\+}\||[^日]\+|$//g' \
 -e 's/[{}|]//g'
done
</code></pre>
<div class="msg ">既にシェルスクリプトのみでやる領域を超えてきています。本来ならば正しいプログラミング言語を選んで正しくフィルタリングすべきだと思います。
</div>
<div class="msg alert">筆者はこういったフィルタリングに awk を使わず sed を使っていますが、決して awk が嫌いなわけでも awk が使えない訳でもありません。単なる趣味です。
</div>
<code>sed -n '/== 記念日・年中行事 ==/,/== フィクションのできごと ==/p'</code> について解説します。これは検索パターンでレンジを作り <code>p</code> コマンドを実行する事で範囲のみ抽出する様にしています。
<code>sed -z 's/&lt;!--.*\?--&gt;//g' </code> について解説します。通常 sed は行で処理される為、この sed の置換は単一行でしかマッチしません。
<pre><code>ごみ
&lt;!--
はじめ
ほんぶん
おわり
--&gt;
ごみ
</code></pre>
この様なテキストの <code>&lt;!--</code> から <code>--&gt;</code> を削除する為には <code>-z</code> フラグを付けて実行します。
<div class="msg ">なお <code>-z</code> は GNU 拡張の為、幾らかの環境では使えません。
</div>
あとはこれをツイートする様に仕立て上げます。
<pre class="language-bash"><code class="language-bash">#!/bin/bash

set -e

URL="https://ja.wikipedia.org/w/api.php?format=json&amp;action=query&amp;prop=revisions&amp;rvprop=content&amp;exintro&amp;explaintext&amp;redirects=1&amp;titles=$(date +%-m%%E6%%9C%%88%-d%%E6%%97%%A5)"
QUERY='.query.pages[.query.pages|keys[0]].revisions[0]["*"]'


RESULT=$(
curl -fs "$URL" | jq -r "$QUERY" | sed -n '/== 記念日・年中行事 ==/,/== フィクションのできごと ==/p' | sed ':l; N; s/&lt;!--.*-->//; b l;' | grep '^* .*の日' | while read -r LINE; do
 echo "$LINE" |\
 sed -e 's/^$.*$（[^）]\+）\?$/\1/' \
 -e's/\[\[$[^]|]\+|$*$[^]]\+$\]\]/\2/g' \
 -e 's/${[^日|]\+\|[^日]\+}\||[^日]\+|$//g' \
 -e 's/[{}|]//g'
done
)
RESULT=$(echo -e "$(date +%-m月%-d日は)\n$RESULT")
twty "${RESULT:0:255}"
</code></pre>
これで以下の様な内容がツイートされます。
<pre><code>9月29日は
* 発明家の日
* クリーニングの日
* 招き猫の日
* 洋菓子の日
* 接着の日
</code></pre>
これを1日1回実行するには crontab で以下の様に設定します。
<pre><code>0 0 * * * /home/mattn/bin/today.sh
</code></pre>
簡単ですね。