Zend_Auth_Adapter_Twitter - Jason Austin

{zone-template-instance:ZFPROP:Proposal Zone Template}

{zone-data:component-name}
Zend_Auth_Adapter_Twitter
{zone-data}

{zone-data:proposer-list}
[Jason Austin|mailto:jfaustin@gmail.com]
{zone-data}

{zone-data:liaison}
TBD
{zone-data}

{zone-data:revision}
1.0 - 17 November 2010: Initial Draft.
{zone-data}

{zone-data:overview}
Zend_Auth_Adapter_Twitter is an authentication adapter designed to use twitter's OAuth service to authenticate a user.
{zone-data}

{zone-data:references}
* [Twitter OAuth Documentation|http://dev.twitter.com/pages/oauth_faq]
{zone-data}

{zone-data:requirements}
* This component *will* conform to the requirements of the Zend_Auth_Adapter component (class Zend_Auth_Adapter_Twitter implements Zend_Auth_Adapter_Interface).
* The Zend_Auth_Adapter::authenticate() method *will not* return Zend_Auth_Result::SUCCESS unless a valid OAuth access token is obtained from twitter
* This adapter *will not* throw exceptions for conditions that may occur during normal operation with a properly configured adapter (i.e. authentication failure). All such exceptions will be caught in the adapter's authenticate method and translated into an appropriate Zend_Auth_Result::FAILURE response.
* This adapter *will* throw exceptions for configuration errors, environmental issues and invalid usage such as invalid configuration options for OAuth settings (i.e. consumer key/secret).
* This adapter *will* return Zend_Auth_Result::FAILURE if access was not granted by the user from twitter's access challenge (i.e. they deny access to the application)
* This adapter *will* take advantage of the existing Zend_Oauth component to obtain and exchange tokens from twitter.
* This adapter *will* take advantage of Zend_Session_Namespace to save state while the user is taken away to twitter's site, then back to the application

{zone-data}

{zone-data:dependencies}
* Zend_Oauth
* Zend_Session
{zone-data}

{zone-data:operation}
The component will be used as an instance of Zend_Auth_Adapter_Interface, implementing the authenticate() method. What makes this component unique is it's need to leave the user's application to authenticate with twitter's OAuth service, then return back to a state within the application.

The workflow would be something like:

* Create an options array containing 'consumerKey', 'consumerSecret', and 'callbackUrl'
* Instantiate Zend_Auth_Adapter_Twitter, passing the options array to the constructor
* Call the authenticate method

{code:php}
<?php

$options = array(
'consumerKey' => '2342kljv23onv34ij34',
'consumerSecret' => '23lkjalkjoij408afkljjr09j4afseaf',
'callbackUrl' => 'http://mywebsite.com/login'
);

$adapter = new Zend_Auth_Adapter_Twitter($options);

$auth = Zend_Auth::getInstance();

$result = $auth->authenticate($adapter);

?>
{code}

* Authenticate method would acquire a request token
* Store the request token in a Zend_Session object
* Redirect the user to twitter to authenticate
* User will allow or deny access from twitter's website
* Twitter will redirect the user back to the application through the callbackUrl passed in the options
* Obtain an access token based on the request token stored in the Zend_Session object
* Unset the Zend_Session object

{zone-data:milestones}

* Milestone 1: \[DONE\] Prototype
* Milestone 2: Create documentation necessary to use the component
* Milestone 3: Working prototype checked into the incubator
* Milestone 4: Create Unit Tests

{zone-data}

{zone-data:class-list}
* Zend_Auth_Adapter_Twitter
{zone-data}

{zone-data:use-cases}

{zone-data}

{zone-data:skeletons}
{code}
class Zend_Auth_Adapter_Twitter implements Zend_Auth_Adapter_Interface
{
public function __construct($options)
{}

public function authenticate()
}

{code}
{zone-data}

{zone-template-instance}