Mise à jour du plugin Twitter pour CakePHP 1.3 et prise en charge d’OAuth

Nous présentons la nouvelle version de notre plugin Twitter, qui permet de faire communiquer facilement une appli CakePHP et un compte Twitter. Cette nouvelle mouture intègre la nouvelle méthode d’authentification par OAuth, mise en place par Twitter et qui va remplacer définitivement l’authentification basique le 30 juin 2010. Nous avons profité de l’occasion pour tester le plugin sur la version 1.3 de CakePHP.

1. Installation

Pour installer le plugin depuis Github, nous lançons la commande suivante depuis le répertoire APP/plugins :

git clone git://github.com/kalt/twitter-oauth.git twitter

Nous tenons à remercier Michael « MiDri » Riddle, Daniel Hofstetter et Alexandru Ciobanu pour leur travail largement repris dans la DataSource incluse dans le plugin.

2. Configuration

2.1. Paramètres du compte Twitter

Nous nous rendons sur dev.twitter.com, nous connectons avec l’identifiant et le mot de passe du compte, puis nous cliquons sur le lien « register an app ». Nous renseignons les informations demandées, en particulier :

• Application Type: Browser
• Default Access type: Read & Write

Une fois cette étape terminée, notre application est déclarée sur Twitter qui va lui autoriser l’accès à son API. Nous pouvons maintenant configurer le plugin, en dupliquant le fichier APP/plugins/twitter/config/twitter.default. Nous renommons cette copie en twitter.php avant de l’ouvrir dans un éditeur :

class TWITTER_CONFIG {
	var $twitter = array(
		'datasource'         => 'twitter_oauth',
		'consumer_key'       => '',
		'consumer_secret'    => '',
		'oauth_token'        => '',
		'oauth_token_secret' => ''
	);
}

Les « consumer key » et « consumer secret » se trouvent dans la page nommée « Application details » sur dev.twitter.com. Les « oauthtoken » et « oauthtoken_secret » se trouvent eux dans la page nommée « My Access Token », dont le lien se trouve dans le panneau de navigation à droite.

2.2. Attacher à un Modèle

Le plugin inclut un Comportement (Behavior) qui peut être lié à un Modèle. La seule configuration à définir est si l’on veut poster un status lors d’une création d’un nouvel enregistrement de ce modèle ('on' => 'create'), lors d’une mise à jour ('on' => 'update') ou les deux ('on' => 'both').

class Post extends AppModel {
	var $actsAs = array('Twitter.Twitterable' => array(
		'on' => 'create'
	));
}

Dans cet exemple, chaque fois qu’un Post sera créé, une notification sera envoyée sur notre compte Twitter, avertissant ainsi nos abonnés.

2.3. Création d’une méthode Model::twitterStatus()

Le Behavior va chercher l’existence d’une méthode de modèle nommée twitterStatus(). Le fonctionnement de cette méthode est à l’entière convenance du lecteur, elle doit simplement renvoyer une chaine de caractères qui sera postée sur Twitter. N’oublions pas qu’un status est limité à 140 caractères.

Afin de rendre les choses simples, nous avons fourni une méthode qui va formater un status comme l’attend Twitter. Cette méthode prend 3 arguments :

• $message : (requis) il s’agit du texte qui sera envoyé ;
• $url : URL facultative, un lien vers l’article complet par exemple. Elle sera automatiquement raccourcie (nous avons choisi le service gratuit http://is.gd) ;
• $ending : chaine de caractère optionnelle : si $message est trop long, il sera coupé et $ending sera ajoutée après la coupure. Vaut « … » par défaut.

Exemple complet :

class Post extends AppModel {
	var $actsAs = array('Twitter.Twitterable' => array(
		'on' => 'create'
	));
 
	function twitterStatus() {
		$title = $this->data['Post']['title'];
		$url   = Router::url(array('controller' => 'posts', 'action' => 'view', $this->id), true);
 
		return $this->twitterFormatStatus($title, $url, '...');
	}
}

Ici nous choisissons de composer le status qui sera envoyé avec le titre du Post (coupé et suivi de ‘…’ si trop long), suivi de l’url vers l’article complet.

3. Autres interactions avec Twitter

Puisque nous utilisons une DataSource bien complète, nous pouvons accèser aux autres méthodes de l’API Twitter. Nous renvoyons le lecteur à la lecture de la documentation de l’API.

Notons qu’il n’est pas nécessaire d’utiliser le Behavior pour accèder aux méthodes de la DataSource, il suffit de l’appeler lorsque nous en avons besoin.

Exemple: nous recherchons l’expression « cakephp » sur Twitter et imprimons le résultat à l’écran :

class TrucsController extends AppController {
	function index() {
		$ds = ConnectionManager::getDataSource('twitter');
 
		$results = $ds->search(array('q' => 'cakephp');
 
		debug($results);
	}
}

Pierre-Emmanuel Fringant