NHK番組表APIを使ってキーワード監視と通知

-
Rubyでプログラムする人のための内容ですが、僕が勝手に作って使っているプログラムを公開します。NHKの番組表AIPを使って、興味のあるキーワードを含む番組情報を抽出して通知するプログラムです。

NHKの番組表AIPというのは、NHKが提供しているサービスで、そこで決められているプロトコルでNHKのサービスサーバーと通信して番組表のデータを取得できるもです。登録さえすれば無料で利用できます（但しアクセス回数に制限があるようです）。

この監視通知プログラムは僕のGitHUBのアカウントのGistsという場所で公開しているものですが、まずは下に貼り付けておきます。（Gists上で逐次修正しているので、貼り付けたものもそれに応じて更新されます。コードそのものについて何かあればGistsの方へコメントください）
＞ smallmake/nhkkw.rb
説明は後半へ。


NHK番組表APIのユーザー登録


NHK番組表APIを使うには、専用サイトでユーザー登録してログインし、自分のプログラムをアプリケーションとして登録して、専用のAPIキーを取得しなければなりません。

＞ NHK番組表APIサイト

NHK番組表APIのサイト

登録方法などは僕は下記のQiitaの記事を参考にさせていただきました。本当に助かります。

＞ NHK番組表API（5さい）- Qiita @kazuchika

ここにも書かれているように取得できるのは当日から１週間先までの番組情報です。

プログラムの説明（使い方）


gem は faraday, json, time, csv, mail, active_support を使いますので、それぞれインストールしておいてください。

以下、プログラムの中身に説明です。
基本的にはプログラムの冒頭部分の各変数の設定さえちゃんと書いてもらえば、使えるはずです。

NHK_API_KEY 

↓
NHK番組表APIのサイトで、自分のアプリ用にAPIキー（Program List API）を生成して入手してください。APIキーは "doksoHhdwh8shPsd6dsJshdjsjhsmrhdw"（テキトー） みたいな感じの文字列です。
プログラムではNHK_API_KEY の設定に ENV を使っています。つまり環境変数から取得するようにしていますが、プログラムファイルにじかに書いても結構です。（通常、サーバーなどに設置する場合はセキュリティの観点から環境変数から読み込むようにします。）

GMAIL_APP_USERNAME, GMAIL_APP_PASSWORD, GMAIL_ADDRESS

↓
通知をgmailに送れるようにしています。
後で説明しますが、僕の場合、このプログラムをサーバーに置いて crontab で毎朝1回起動するようにしています。キーワードに引っかかる番組があると自動でメール通知してくれるわけです。

メール通知が不要な場合、つまり、例えばその都度手元で起動して表示される抽出結果を見るだけでよいなら、これらの変数は設定不要です。設定しなければメール送信しません。（これらも環境変数を参照するようにしているので、この場合、これらの環境変数を設定しなければメールは送信されません。なおgmailを二段階認証にしている場合、Googleからアプリ用パスワードの取得が必要です。）

REGION_CODE

↓
住んでいる地域を示すコードを指定しなければなりません。NHKは地域毎に番組表が違う場合があるので、これは重要です。
地域コードは下記URLのページの「area」欄を参照してください。


GENRE_CODES

↓
これは番組のジャンル（バラエティ、情報番組、ドラマなど）を絞り込むためのパラメータなのですが、実はジャンルのコードがどのようになっているのかはNHKのAPIサイト自体には詳しい説明がなく、僕は下記のブログで簡潔に知ることができました。助かります。


分類が多いので、大分類を示す最初の2桁だけで絞り込むようにしています（ニュース/報道は1, スポーツは2 ですが、それぞれ 01, 02 と記述します）


KEYWORDS

↓
自分の興味を示すキーワードを並べてください。番組情報に半角英数字は使っていないようなので「UFO」も全角で「ＵＦＯ」でなければなりません。


LOG_FILE

↓
これは特に変更していただく必要はないと思います。ただし、このような名前のファイルが同じディレクトリ（フォルダ）に作られることを知っておいてください。また、プログラムに書き込みの権限が必要となりますのでご注意ください。

このファイルは、取得済み（通知済み）の番組を記憶しておくために使っています。そうしないと、プログラムが動くたびに通知済みの番組をその番組が終わるまでは何度も通知してしまうからです。

この記録は、プログラムの最後で、当日の前の日以前のから消去していますので、容量が増え続けるということはありません。


NHK_CHANNELS

↓
抽出するTVチャンネルのコードと表示用の名前を設定します。NHK番組表APIはテレビだけでなくワンセグやラジオ放送も取得できます。コードと名前の対応一覧はNHK番組表APIサイトの下記のURLに「service」欄を参照してください。Rubyのhashで記述してください。


プログラム上などで各自が設定すべきことは以上です。

上にも書きましたが、取得できるのは1週間先までの番組表データです。それより先のものは取得できません。
ですので、できれば毎日1回自動起動して、プログラムにあるようにメールで通知させるのがいいと思います。

僕の場合は、これを自分のサーバーに設置してcrontabを設定して、毎朝8時5分に起動させています。以下のような設定ですね。

まず、シェル起動できるように

% chmod 755 nhkkw.rb

して、crontabでRuby環境を読み込んで起動するシェルスクリプトを nhkkw.sh を用意して
--------
#!/bin/sh

cd /home/eijin
source ./.bash_profile
./nhkkw.rb > /dev/null 2>&1
--------
で、

% chmod 755 nhkkw.sh

して、そして

% ctontab -e

で

5 8 * * * /home/eijin/nhkkw.sh

ですね。

以上です。

なお、コードに関しての質問については基本はノーサポートといたしますのでご了承ください。

【重要】また、コードを実行したことによって万が一に も発生した事故や損害などについては免責とさせていただきます。全て自己責任でお願いいたします。










コメント

コメントを投稿

このブログの人気の投稿

facebookはポートフォリオになり得るだろうか？

-
ソーシャルネットワークというか、facebookはどういう方向に進むのだろうか。 コミュニティ形成や情報交換がより容易になり、いろいろな活動が可能になったり、それを活性化できるということは既に証明されていると思う。一方で、facebookは個人の履歴書のような役割になっていきつつあるようにも思う。将来、facebookにアカウントを持って個人情報の公開（ただし排他的な公開）をすることが、社会活動において有利になる状況がくるのだろうと思う。社会活動において有利とは、地域や特定分野のコミュニティ活動だけでなくもっと一般的な仕事においてもということでもある。例えば、仕事で名刺交換をしたあと、その交換相手に一定レベルの個人情報を公開する設定しておけば、お互いのポートフォリオを交換できる。あるいは一方的に提供または取得でもよい。ポートフォリオは自分の公開したい範囲で公開できるようになるだろう。例えば、仕事相手に自分の個人的に興味を持っていることや、それに関連した活動を知ってもらうことによって、新しい機会を生み出すこともあるだろう。もちろん、逆の場合もあり、人間関係としてはマイナスに働く場合もある。しかし、人によってはそのマイナスもメリットとなることもあるだろう。 もちろん、そこの書かれていることが必ずしも事実とは限らないという可能性はある。だから、読み取る側のリテラシーが必要になる。僕はfacebook上では事実と虚飾は意外と容易に見分けられるようになるのではないかと想像している。なぜなら個人の情報発信であった従来のブログとは違い、facebookではそこに展開される人間の関係性の成果に注目できるからだ。 一方で、そのようなものを見通せるだけの公開性ということと、排他的にして公開できる情報を制限できることの間には確かに矛盾はある。これを何らかの技術的手法で解決できればすごいと思うし、多分facebookがこれほど注目されるのは、そのような問題を技術的に解決しようとその当初から試みてきたからではなかろうか。もっと言えば、その辺が従来のインターネット技術という側面を超える新しい何かなのだということだと思う。 話しを元にもどそう。誰もが表現者として作品を作ったり、あるいは作品があるにしてもそれをわざわざWEB上で公開する手間暇をかけられるわけではない。その個人にアク
続きを読む

WinSCPをタスクで自動起動 — SSH鍵とパスフレーズの問題（ただしWindows2000の話し）

-
イメージ
Windows2000の話しです。今年は2013年ですがまだ使っています。 定期的にデータを別のFreeBSDサーバーに転送するためにWinSCPを使います。 ここからFreeBSDサーバーへは既にSSHで接続しているので、普通にパスフレーズのあるSSHキーを使って認証していました。 同じキーを使って WinSCP で転送しようと思い、まずはWinSCPスクリプトとそれらを起動するバッチを書きます。 以下に例を掲載しますが、これでPagent を常駐させてキーとパスフレーズを登録しておけば trans.bat をダブルクリックして、問題なく転送できました。 trans.winscpscript （WinSCPスクリプト） option batch on open username@myserver.example.com option confirm off put "d:\document\*.*" exit trans.bat （バッチ） "C:\Program Files\WinSCP\WinSCP.com" /console /script=c:\...\trans.winscpscript しかし、タスクスケジューラにこのバッチを登録して定期的にバッチを起動させようとしても転送はされません。 ログを見てみるとサーバー側からpublicキーに対応するprivateキーがないというような「お断り」のメッセージが来ています。 どうも、タスクスケジューラで起動した場合は Pagentが効かないようです。 そこで、バッチを少し書き直してprivateキーを指定するようにします。 trans.bat （バッチ）修正版 "C:\Program Files\WinSCP\WinSCP.com" /console /script=c:\...\trans.winscpscript /privatekey="C:\Documents and Settings\.....\mypravatekey.ppk" しかし、これではパスフレーズが渡せていません。WinSCPにパスフレーズのコマンドオプションはないようです。 仕方ないので、転送用にパスフレ
続きを読む

iPad用PDFビュワーの縦書きテキスト対応について

-
イメージ
iPad用のPDFビュワーを何か新しいものに変えるべくいくつかのアプリを調べてみましたので、簡単ですが下に一覧します。ただし、今使っている  GoodReader  を含め、どれも一長一短があります。いろいろ調べたものの、結論的には  GoodReader  をまだしばらくは使うことにしました。理由は最後に書きます。 実は  GoodReader  には、iOS 10.3になってから日本語ファイル名が同期できない障害が発生しています。AppStoreのレビューにもこの件はいくつか対応要望のコメントが上がっているものの、未だに対応はなく、GoodReaderサイトのSupportページがアクセス不可になっています。 ちなみに、AppStoreレビューに上がっている問題の多くはクラウド同期での問題のようですが、僕の場合はSMB同期で障害が発生しています。実際は、これはAFP同期に変えること解消しました。しかし、AppleはAFPをいつかやめるらしいので、あまりうれしくありません。また、上に書いたGoodReaderサポートページの件もあり不安になり、今回いろいろ他のアプリを調べてみたわけです（なお、現在2017年5月15日時点の話です。記事を書いている最中の本日5月16日にiOS10.3.2がリリースされました。直っているかも知れませんが未確認です。） まず、私的iPad用PDFビュワーの要件です。 １）クラウド同期またはSMB(AFP)同期ができる（ダウンロードでなく同期） ２）縦スクロールができる ３）ページ移動してもズームと左右ポジションが保持される ４）縦書き埋め込みテキストに対応して検索ができる ５）縦書き埋め込みテキストに対応してテキスト選択ができる ６）縦書き埋め込みテキストに対応してカラーマーカー付けができる １）はアノテーションを付けることを前提としているからです。ダウンロードだけだとiPadでアノテーションを付けたものを自動アップロードして、他のデバイスでアノテーションを含め共有するということができません。 ２）の縦スクロールができたほうがいいというのは、縦書きの本を読む時、横スワイプ移動の方向が大抵横書き用で気持ち悪いからです。縦スクロールであれば問題ありません。 （横書き本は左開きですが縦書き本は右開きの違いが
続きを読む