Tuitter_Account

名前や所在地などの設定、アイコン、プロフィール画面のデザイン変更などをプログラムから行うことが出来ます。

Twitter APIでは、特にアイコンや背景画像などのイメージを変更するのにマルチパート・フォーマットのPOSTを必要とするので、PHPから行うのは少し手間です。TuitterではHTTP通信に自前のモジュールを使っているのですが、そこに multipart の機能を追加して実装しました。OAuthの方にも対応させています。

プロフィール情報を変えられるのは、Tuitterオブジェクト作成時に認証しているユーザのものだけです。
まず、以下の例ではベーシック認証を用いて、ユーザの所在地を変更させています。

$t = new Tuitter($user, $pass);
$a = $t->getAccount();
$a->updateProf(array('location'=>'沖縄'));

次の例は、アイコンを更新しています。アイコンは、PNGフォーマットであると仮定。認証はOAuth。画像を更新する場合、URLやパスなどの所在を渡すのではなく、あくまで画像データそのものを渡すことに注意して下さい。

$t = new TuitterOAuth(
     $consKey, $consSec, $acKey, $acSec);
$a = $t->getAccount();
$img = file_get_contents('/path/to/img');
$a->updateProfImage(
    $img, 'icon.png', 'image/png');

Related posts:

1. [Tuitter] OAuth認証機能を追加

TuitterをOAuthで使う
TuiBotter環境設定

あまり難しく考えないで、サクッと。おかげで外部ライブラリが結構な環境依存になってしまいましたが。

まずOAuthクライアントですが、自作するのも手間だったのでPECLのOAuthを使うようにしています。
最初はtwitteroauthなど配置するだけのライブラリを使おうかとも思ったのですが、いずれにしろ libcurl が必要ですし、ライブラリの場所を指定する手間も発生します。おまけに PECL/oauth を入れると OAuthException の定義が干渉しあって twitteroauth は動かなくなってしまうことが判明したので、思い切ってPECLのみの対応で割り切りました。

実装は単純で、従来の Tuitter クラスを継承して、新たに TuitterOAuth というクラスを作ります。コンストラクタの引数だけが異なりますが、インスタンス化してしまえば以前と全く同様に使えるという寸法です。
つまり、以下のようなコードがあったとすると

$tuitter = new Tuitter($user, $pass);
$tuitter->sendMessage("Hellow");
$user = $tuitter->getUser('nao58');
    :

最初のインスタンス作成部分を修正するだけでOAuth対応になります。

$tuitter = new TuitterOAuth(
     $consKey, $consSec, $acKey, $acSec);
$tuitter->sendMessage("Hellow");
$user = $tuitter->getUser('nao58');
    :

TuiBotter側に至っては、INIファイルの記述を書き換えるだけで対応完了です。

ただ、ベーシック認証に比べると複雑なことをやっているため、動作がちょっと重くなったような…ま、ここはトレードオフとしてください。

Related posts:

1. [Tuitter] Twitterのプロフィール設定変更機能を追加
2. [TuiBotter] Twitterボット専用PHPフレームワーク
3. [Tuitter] オブジェクト指向型Twitterクライアント

TuiBotter – Object-oriented PHP framework for Twitter-Bot

最大の特徴は、イベントドリブンでボットが書けること。例えば「フォローされたら、フォローバックする」というコードを書くには、「フォローされた」というイベントに渡ってくる「フォロワー」オブジェクトに対して、「フォローする」というメソッドを投げるだけで実装できます。
実際にコード例を見ながら、簡単に説明します。

class GreetingBot implements TuiBotter_Event_BeFollowed
{
  public function eventBeFollowed(Tuitter_User $user, Tuitter $tuitter)
  {
    if(!$user->isFollowing()){
      $user->follow();
      $user->sendDM('フォローありがとう!');
    }
  }
}

基本的には、このBehaviourという「振る舞い」をあらわすクラスを作ることが、そのままボットの人格を作ることになります。

1行目: ボットの名前(GreetingBot)と、必要なイベント(TuiBotter_Event_BeFollowed)
3行目: 「フォローされた」イベント
5行目: フォローしてきたユーザを、こちらから既にフォローしていなかったら…
6行目: フォローする
7行目: DMを送る

これだけで完了です。

イベントは他にも「TLが更新された」「自分が言及された」「自分の発言がRTされた」など種々あり、これらを自由に組み合わせることでボットの人格を比較的容易に形成できます。

動作するのは、PHP5以上。パースにはXMLを用いましたので、json_decodeが含まれていなくても動作します。
ただし、将来的に検索モジュールを追加した場合、必要になるかもしれません。

Related posts:

1. [Tuitter] OAuth認証機能を追加
2. [Tuitter] Twitterのプロフィール設定変更機能を追加
3. [Tuitter] オブジェクト指向型Twitterクライアント

で、ボット用フレームワークを作るにあたって結局はクライントライブラリが必要なのですが、どうもAPIコールを媒してくれるだけの手続き型ライブラリが多くてシックリ来ない。というわけで、クライアントライブラリの作成まで遡ってしまったのが、この「Tuitter」です。

既にボット用フレームワークも完成しているのですが、テストとドキュメンテーションがまだで、とりあえずライブラリ単体でのリリース。
詳細は、次のドキュメントページを見てください。

Tuitter – Object oriented Twitter client for PHP5

ちなみに、いかにもタイポのようでダサいライブラリ名ですが、ニュージーランドに住んでいた頃によく近所で見かけた「Tui」という鳥の名前からつけました。
黒くてギャーギャーとやかましく啼く鳥で、胸のあたりだけ白いのが特徴。ちょうどオールブラックスのユニフォームのようでもあって、ちょうどいいかなと。(何が?)
オークランドには同名のビールもあり、国鳥ともいえるほどポピュラーな鳥です。

フレームワークの方も、近日中に公開予定。
気づいた点などあれば、指摘いただけると幸いです。

Related posts:

1. [Tuitter] OAuth認証機能を追加
2. [Tuitter] Twitterのプロフィール設定変更機能を追加