(cache) GitHub で特定ユーザの行動を逐一追いかけたい

アイドルファンがアイドルの言動を逐一追いかけるように、我々凡人 GitHubber が著名な GitHubber や可愛い GitHubber 、その他知り合いの GitHubber などの言動を逐一追いかけたいのは自然なことである。

しかし GitHub ウェブサイトの更新通知機能は貧弱であり、逐一追いかけるには値しない。何とかして追いかけられないか。

最初に結論

GitHub の Web API を使えば可能。使いこなすにはスクリプトで REST API を叩ける程度の技術力が必要だが。
GitHub ウェブサイトでもある程度は更新を追えるが、通知されてくる情報が限られており、とても逐一追いかけるレベルではない

Watch じゃダメなの？

GitHub.com にログインし、Aさんのリポジトリrepo1を Watch すると、Notifications画面にて repo1 の更新情報が表示されるようになる。

が、こいつはあまり使い物にならない。表示されるのは自分に関するイベントのみ。もっというと自分に対してメンションされてたり自分が書いた Issue に対してコメントが書き込まれたりなど自分に絡む更新のみ。

したがって、傍観者として特定リポジトリの更新内容を知りたい、なんてことはできない。

Follow はダメなの？

GitHub.com にログインし、Aさんを Follow するとトップページのタイムラインに「Aが～～しました。n hours ago」みたいな一行更新情報が表示される。

が、こいつもあまり使い物にならない。表示される情報は

UserA created repository hogehoge(リポジトリhogehogeを作った)
UserA starred hogehoge (リポジトリhogehogeにスターを付けた)
UserA forked hogehoge to fugafuga(リポジトリhogehogeをfugafugaとしてフォークした)
UserA made hogehoge public(Aさんがプライベートで運用してたリポジトリhogehogeをパブリックにした)

くらいである。

じゃあどうするの？ → GitHub API を使う

GitHub API には Events という API がある。こいつを使うと以下のようなことができる。

特定ユーザの更新情報を取得
特定ユーザの特定リポジトリに関する更新情報を取得

しかも、ここでいう更新情報とは以下を含む。

リポジトリ作ったよ(CreateEvent)
リポジトリ消したよ(DeleteEvent)
とあるコミットに対してコメントを書いたよ(CommitCommentEvent)
フォローしたよ(FollowEvent)
スターを付けたよ(WatchEvent)

DeleteEvent や FollowEvent など GitHub ウェブサイトでは取得されてなかったイベントもキャッチできる。というか、たぶん GitHub 上の行動ならほぼ何でも取得できるように見える。詳しくは Event Types & Payloads | GitHub Developer Guide を参照、取得できるイベントの種類が網羅してある。

ただし、これらイベント情報には以下制約がある。

保持されるイベントは直近90日以内あるいは最大300件まで
一度の API リクエストで取得できる件数は30件固定
(後述する)更新有無チェック機能を使う場合、チェック可能な間隔(x-poll-interval)は60秒
- サーバ負荷が高いと増える可能性アリ
- x-poll-interval より短い間隔でチェックしてもよいが（たぶん GitHub 側で更新内容をつくる間隔が x-poll-interval だと思うので）意味ない

ターゲットがいつ何をしたかの過去全てを知ることはできないということだ。Twitter と同じく、今を追うべきなのだろう。

あと、API リクエスト数の削減(APIにもリクエスト数に上限があるので削減できるならしたいですよね)と更新有無の簡易チェックを兼ねることのできる、良い手段があるので使うと便利。名を ETag という。

Events API で情報をゲットすると、返却されたヘッダ内に ETag という 更新情報のコミットIDみたいなもの がある
Events API リクエスト時、この ETag をヘッダに指定してリクエストしてやると、もし新たな更新がない場合にステータスコード304 Not Modified を返却してくれる＆APIリクエスト数もカウントされない
- ちなみに更新がある場合、直近30件をそのまま取得する(差分のみ取得する機能はない)