tweet_live: comparison web/lib/Zend/Service/Twitter.php

equal deleted inserted replaced

-:2251fb41dbc7
+:1e110b03ae96
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Service
 * @subpackage Twitter
-* @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+* @copyright  Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
-* @version    $Id: Twitter.php 23312 2010-11-08 19:45:00Z matthew $
+* @version    $Id: Twitter.php 25288 2013-03-13 13:36:39Z matthew $
 */
 /**
-* @see Zend_Rest_Client
+* @see Zend_Http_Client
 */
-require_once 'Zend/Rest/Client.php';
+require_once 'Zend/Http/Client.php';
 /**
-* @see Zend_Rest_Client_Result
+* @see Zend_Http_CookieJar
 */
-require_once 'Zend/Rest/Client/Result.php';
+require_once 'Zend/Http/CookieJar.php';
 /**
 * @see Zend_Oauth_Consumer
 */
 require_once 'Zend/Oauth/Consumer.php';
 /**
+* @see Zend_Oauth_Token_Access
+*/
+require_once 'Zend/Oauth/Token/Access.php';
+/**
+* @see Zend_Service_Twitter_Response
+*/
+require_once 'Zend/Service/Twitter/Response.php';
+/**
 * @category   Zend
 * @package    Zend_Service
 * @subpackage Twitter
-* @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+* @copyright  Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
-class Zend_Service_Twitter extends Zend_Rest_Client
+class Zend_Service_Twitter
 {
+/**
+* Base URI for all API calls
+*/
+const API_BASE_URI = 'https://api.twitter.com/1.1/';
+/**
+* OAuth Endpoint
+*/
+const OAUTH_BASE_URI = 'https://api.twitter.com/oauth';
 /**
 * 246 is the current limit for a status message, 140 characters are displayed
 * initially, with the remainder linked from the web UI or client. The limit is
 * applied to a html encoded UTF-8 string (i.e. entities are counted in the limit
 * which may appear unusual but is a security measure).
 *
 * This should be reviewed in the future...
 */
 const STATUS_MAX_CHARACTERS = 246;
 /**
-* OAuth Endpoint
+* @var array
 */
-const OAUTH_BASE_URI = 'http://twitter.com/oauth';
+protected $cookieJar;
-/**
-* @var Zend_Http_CookieJar
-*/
-protected $_cookieJar;
 /**
 * Date format for 'since' strings
 *
 * @var string
 */
-protected $_dateFormat = 'D, d M Y H:i:s T';
+protected $dateFormat = 'D, d M Y H:i:s T';
+/**
+* @var Zend_Http_Client
+*/
+protected $httpClient = null;
+/**
+* Current method type (for method proxying)
+*
+* @var string
+*/
+protected $methodType;
+/**
+* Oauth Consumer
+*
+* @var Zend_Oauth_Consumer
+*/
+protected $oauthConsumer = null;
+/**
+* Types of API methods
+*
+* @var array
+*/
+protected $methodTypes = array(
+'account',
+'application',
+'blocks',
+'directmessages',
+'favorites',
+'friendships',
+'search',
+'statuses',
+'users',
+);
+/**
+* Options passed to constructor
+*
+* @var array
+*/
+protected $options = array();
 /**
 * Username
 *
 * @var string
 */
-protected $_username;
+protected $username;
-/**
-* Current method type (for method proxying)
-*
-* @var string
-*/
-protected $_methodType;
-/**
-* Zend_Oauth Consumer
-*
-* @var Zend_Oauth_Consumer
-*/
-protected $_oauthConsumer = null;
-/**
-* Types of API methods
-*
-* @var array
-*/
-protected $_methodTypes = array(
-'status',
-'user',
-'directMessage',
-'friendship',
-'account',
-'favorite',
-'block'
-);
-/**
-* Options passed to constructor
-*
-* @var array
-*/
-protected $_options = array();
-/**
-* Local HTTP Client cloned from statically set client
-*
-* @var Zend_Http_Client
-*/
-protected $_localHttpClient = null;
 /**
 * Constructor
 *
-* @param  array $options Optional options array
+* @param  null|array|Zend_Config $options
-* @return void
+* @param  null|Zend_Oauth_Consumer $consumer
-*/
+* @param  null|Zend_Http_Client $httpClient
-public function __construct($options = null, Zend_Oauth_Consumer $consumer = null)
+*/
-{
+public function __construct($options = null, Zend_Oauth_Consumer $consumer = null, Zend_Http_Client $httpClient = null)
-$this->setUri('http://api.twitter.com');
+{
-if (!is_array($options)) $options = array();
-$options['siteUrl'] = self::OAUTH_BASE_URI;
 if ($options instanceof Zend_Config) {
 $options = $options->toArray();
 }
-$this->_options = $options;
+if (!is_array($options)) {
+$options = array();
+}
+$this->options = $options;
 if (isset($options['username'])) {
 $this->setUsername($options['username']);
 }
-if (isset($options['accessToken'])
-&& $options['accessToken'] instanceof Zend_Oauth_Token_Access) {
+$accessToken = false;
-$this->setLocalHttpClient($options['accessToken']->getHttpClient($options));
+if (isset($options['accessToken'])) {
+$accessToken = $options['accessToken'];
+} elseif (isset($options['access_token'])) {
+$accessToken = $options['access_token'];
+}
+$oauthOptions = array();
+if (isset($options['oauthOptions'])) {
+$oauthOptions = $options['oauthOptions'];
+} elseif (isset($options['oauth_options'])) {
+$oauthOptions = $options['oauth_options'];
+}
+$oauthOptions['siteUrl'] = self::OAUTH_BASE_URI;
+$httpClientOptions = array();
+if (isset($options['httpClientOptions'])) {
+$httpClientOptions = $options['httpClientOptions'];
+} elseif (isset($options['http_client_options'])) {
+$httpClientOptions = $options['http_client_options'];
+}
+// If we have an OAuth access token, use the HTTP client it provides
+if ($accessToken && is_array($accessToken)
+&& (isset($accessToken['token']) && isset($accessToken['secret']))
+) {
+$token = new Zend_Oauth_Token_Access();
+$token->setToken($accessToken['token']);
+$token->setTokenSecret($accessToken['secret']);
+$accessToken = $token;
+}
+if ($accessToken && $accessToken instanceof Zend_Oauth_Token_Access) {
+$oauthOptions['token'] = $accessToken;
+$this->setHttpClient($accessToken->getHttpClient($oauthOptions, self::OAUTH_BASE_URI, $httpClientOptions));
+return;
+}
+// See if we were passed an http client
+if (isset($options['httpClient']) && null === $httpClient) {
+$httpClient = $options['httpClient'];
+} elseif (isset($options['http_client']) && null === $httpClient) {
+$httpClient = $options['http_client'];
+}
+if ($httpClient instanceof Zend_Http_Client) {
+$this->httpClient = $httpClient;
 } else {
-$this->setLocalHttpClient(clone self::getHttpClient());
+$this->setHttpClient(new Zend_Http_Client(null, $httpClientOptions));
-if ($consumer === null) {
+}
-$this->_oauthConsumer = new Zend_Oauth_Consumer($options);
-} else {
+// Set the OAuth consumer
-$this->_oauthConsumer = $consumer;
+if ($consumer === null) {
-}
+$consumer = new Zend_Oauth_Consumer($oauthOptions);
 }
-}
+$this->oauthConsumer = $consumer;
-/**
-* Set local HTTP client as distinct from the static HTTP client
-* as inherited from Zend_Rest_Client.
-*
-* @param Zend_Http_Client $client
-* @return self
-*/
-public function setLocalHttpClient(Zend_Http_Client $client)
-{
-$this->_localHttpClient = $client;
-$this->_localHttpClient->setHeaders('Accept-Charset', 'ISO-8859-1,utf-8');
-return $this;
-}
-/**
-* Get the local HTTP client as distinct from the static HTTP client
-* inherited from Zend_Rest_Client
-*
-* @return Zend_Http_Client
-*/
-public function getLocalHttpClient()
-{
-return $this->_localHttpClient;
-}
-/**
-* Checks for an authorised state
-*
-* @return bool
-*/
-public function isAuthorised()
-{
-if ($this->getLocalHttpClient() instanceof Zend_Oauth_Client) {
-return true;
-}
-return false;
-}
-/**
-* Retrieve username
-*
-* @return string
-*/
-public function getUsername()
-{
-return $this->_username;
-}
-/**
-* Set username
-*
-* @param  string $value
-* @return Zend_Service_Twitter
-*/
-public function setUsername($value)
-{
-$this->_username = $value;
-return $this;
 }
 /**
 * Proxy service methods
 *
 * @param  string $type
-* @return Zend_Service_Twitter
+* @return Twitter
-* @throws Zend_Service_Twitter_Exception If method not in method types list
+* @throws Exception\DomainException If method not in method types list
 */
 public function __get($type)
 {
-if (!in_array($type, $this->_methodTypes)) {
+$type = strtolower($type);
-include_once 'Zend/Service/Twitter/Exception.php';
+$type = str_replace('_', '', $type);
+if (!in_array($type, $this->methodTypes)) {
+require_once 'Zend/Service/Twitter/Exception.php';
 throw new Zend_Service_Twitter_Exception(
 'Invalid method type "' . $type . '"'
 );
 }
-$this->_methodType = $type;
+$this->methodType = $type;
 return $this;
 }
 /**
 * Method overloading
 *
 * @param  string $method
 * @param  array $params
 * @return mixed
-* @throws Zend_Service_Twitter_Exception if unable to find method
+* @throws Exception\BadMethodCallException if unable to find method
 */
 public function __call($method, $params)
 {
-if (method_exists($this->_oauthConsumer, $method)) {
+if (method_exists($this->oauthConsumer, $method)) {
-$return = call_user_func_array(array($this->_oauthConsumer, $method), $params);
+$return = call_user_func_array(array($this->oauthConsumer, $method), $params);
 if ($return instanceof Zend_Oauth_Token_Access) {
-$this->setLocalHttpClient($return->getHttpClient($this->_options));
+$this->setHttpClient($return->getHttpClient($this->options));
 }
 return $return;
 }
-if (empty($this->_methodType)) {
+if (empty($this->methodType)) {
-include_once 'Zend/Service/Twitter/Exception.php';
+require_once 'Zend/Service/Twitter/Exception.php';
 throw new Zend_Service_Twitter_Exception(
 'Invalid method "' . $method . '"'
 );
 }
-$test = $this->_methodType . ucfirst($method);
+$test = str_replace('_', '', strtolower($method));
+$test = $this->methodType . $test;
 if (!method_exists($this, $test)) {
-include_once 'Zend/Service/Twitter/Exception.php';
+require_once 'Zend/Service/Twitter/Exception.php';
 throw new Zend_Service_Twitter_Exception(
 'Invalid method "' . $test . '"'
 );
 }
 return call_user_func_array(array($this, $test), $params);
 }
 /**
-* Initialize HTTP authentication
+* Set HTTP client
 *
-* @return void
+* @param Zend_Http_Client $client
-*/
+* @return self
-protected function _init()
+*/
-{
+public function setHttpClient(Zend_Http_Client $client)
-if (!$this->isAuthorised() && $this->getUsername() !== null) {
+{
+$this->httpClient = $client;
+$this->httpClient->setHeaders(array('Accept-Charset' => 'ISO-8859-1,utf-8'));
+return $this;
+}
+/**
+* Get the HTTP client
+*
+* Lazy loads one if none present
+*
+* @return Zend_Http_Client
+*/
+public function getHttpClient()
+{
+if (null === $this->httpClient) {
+$this->setHttpClient(new Zend_Http_Client());
+}
+return $this->httpClient;
+}
+/**
+* Retrieve username
+*
+* @return string
+*/
+public function getUsername()
+{
+return $this->username;
+}
+/**
+* Set username
+*
+* @param  string $value
+* @return self
+*/
+public function setUsername($value)
+{
+$this->username = $value;
+return $this;
+}
+/**
+* Checks for an authorised state
+*
+* @return bool
+*/
+public function isAuthorised()
+{
+if ($this->getHttpClient() instanceof Zend_Oauth_Client) {
+return true;
+}
+return false;
+}
+/**
+* Verify Account Credentials
+*
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function accountVerifyCredentials()
+{
+$this->init();
+$response = $this->get('account/verify_credentials');
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Returns the number of api requests you have left per hour.
+*
+* @todo   Have a separate payload object to represent rate limits
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function applicationRateLimitStatus()
+{
+$this->init();
+$response = $this->get('application/rate_limit_status');
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Blocks the user specified in the ID parameter as the authenticating user.
+* Destroys a friendship to the blocked user if it exists.
+*
+* @param  integer|string $id       The ID or screen name of a user to block.
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function blocksCreate($id)
+{
+$this->init();
+$path     = 'blocks/create';
+$params   = $this->createUserParameter($id, array());
+$response = $this->post($path, $params);
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Un-blocks the user specified in the ID parameter for the authenticating user
+*
+* @param  integer|string $id       The ID or screen_name of the user to un-block.
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function blocksDestroy($id)
+{
+$this->init();
+$path   = 'blocks/destroy';
+$params = $this->createUserParameter($id, array());
+$response = $this->post($path, $params);
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Returns an array of user ids that the authenticating user is blocking
+*
+* @param  integer $cursor  Optional. Specifies the cursor position at which to begin listing ids; defaults to first "page" of results.
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function blocksIds($cursor = -1)
+{
+$this->init();
+$path = 'blocks/ids';
+$response = $this->get($path, array('cursor' => $cursor));
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Returns an array of user objects that the authenticating user is blocking
+*
+* @param  integer $cursor  Optional. Specifies the cursor position at which to begin listing ids; defaults to first "page" of results.
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function blocksList($cursor = -1)
+{
+$this->init();
+$path = 'blocks/list';
+$response = $this->get($path, array('cursor' => $cursor));
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Destroy a direct message
+*
+* @param  int $id ID of message to destroy
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function directMessagesDestroy($id)
+{
+$this->init();
+$path     = 'direct_messages/destroy';
+$params   = array('id' => $this->validInteger($id));
+$response = $this->post($path, $params);
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Retrieve direct messages for the current user
+*
+* $options may include one or more of the following keys
+* - count: return page X of results
+* - since_id: return statuses only greater than the one specified
+* - max_id: return statuses with an ID less than (older than) or equal to that specified
+* - include_entities: setting to false will disable embedded entities
+* - skip_status:setting to true, "t", or 1 will omit the status in returned users
+*
+* @param  array $options
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function directMessagesMessages(array $options = array())
+{
+$this->init();
+$path   = 'direct_messages';
+$params = array();
+foreach ($options as $key => $value) {
+switch (strtolower($key)) {
+case 'count':
+$params['count'] = (int) $value;
+break;
+case 'since_id':
+$params['since_id'] = $this->validInteger($value);
+break;
+case 'max_id':
+$params['max_id'] = $this->validInteger($value);
+break;
+case 'include_entities':
+$params['include_entities'] = (bool) $value;
+break;
+case 'skip_status':
+$params['skip_status'] = (bool) $value;
+break;
+default:
+break;
+}
+}
+$response = $this->get($path, $params);
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Send a direct message to a user
+*
+* @param  int|string $user User to whom to send message
+* @param  string $text Message to send to user
+* @throws Exception\InvalidArgumentException if message is empty
+* @throws Exception\OutOfRangeException if message is too long
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function directMessagesNew($user, $text)
+{
+$this->init();
+$path = 'direct_messages/new';
+$len = iconv_strlen($text, 'UTF-8');
+if (0 == $len) {
 require_once 'Zend/Service/Twitter/Exception.php';
 throw new Zend_Service_Twitter_Exception(
-'Twitter session is unauthorised. You need to initialize '
+'Direct message must contain at least one character'
-. 'Zend_Service_Twitter with an OAuth Access Token or use '
-. 'its OAuth functionality to obtain an Access Token before '
-. 'attempting any API actions that require authorisation'
 );
-}
+} elseif (140 < $len) {
-$client = $this->_localHttpClient;
+require_once 'Zend/Service/Twitter/Exception.php';
-$client->resetParameters();
+throw new Zend_Service_Twitter_Exception(
-if (null == $this->_cookieJar) {
+'Direct message must contain no more than 140 characters'
-$client->setCookieJar();
+);
-$this->_cookieJar = $client->getCookieJar();
+}
-} else {
-$client->setCookieJar($this->_cookieJar);
+$params         = $this->createUserParameter($user, array());
-}
+$params['text'] = $text;
-}
+$response       = $this->post($path, $params);
+return new Zend_Service_Twitter_Response($response);
-/**
+}
-* Set date header
-*
+/**
-* @param  int|string $value
+* Retrieve list of direct messages sent by current user
-* @deprecated Not supported by Twitter since April 08, 2009
+*
-* @return void
+* $options may include one or more of the following keys
-*/
+* - count: return page X of results
-protected function _setDate($value)
+* - page: return starting at page
-{
+* - since_id: return statuses only greater than the one specified
-if (is_int($value)) {
+* - max_id: return statuses with an ID less than (older than) or equal to that specified
-$date = date($this->_dateFormat, $value);
+* - include_entities: setting to false will disable embedded entities
-} else {
+*
-$date = date($this->_dateFormat, strtotime($value));
+* @param  array $options
-}
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-$this->_localHttpClient->setHeaders('If-Modified-Since', $date);
+* @throws Exception\DomainException if unable to decode JSON payload
-}
+* @return Zend_Service_Twitter_Response
+*/
-/**
+public function directMessagesSent(array $options = array())
-* Public Timeline status
+{
-*
+$this->init();
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+$path   = 'direct_messages/sent';
-* @return Zend_Rest_Client_Result
+$params = array();
-*/
+foreach ($options as $key => $value) {
-public function statusPublicTimeline()
-{
-$this->_init();
-$path = '/1/statuses/public_timeline.xml';
-$response = $this->_get($path);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Friend Timeline Status
-*
-* $params may include one or more of the following keys
-* - id: ID of a friend whose timeline you wish to receive
-* - count: how many statuses to return
-* - since_id: return results only after the specific tweet
-* - page: return page X of results
-*
-* @param  array $params
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return void
-*/
-public function statusFriendsTimeline(array $params = array())
-{
-$this->_init();
-$path = '/1/statuses/friends_timeline';
-$_params = array();
-foreach ($params as $key => $value) {
 switch (strtolower($key)) {
 case 'count':
-$count = (int) $value;
+$params['count'] = (int) $value;
-if (0 >= $count) {
+break;
-$count = 1;
+case 'page':
-} elseif (200 < $count) {
+$params['page'] = (int) $value;
-$count = 200;
+break;
+case 'since_id':
+$params['since_id'] = $this->validInteger($value);
+break;
+case 'max_id':
+$params['max_id'] = $this->validInteger($value);
+break;
+case 'include_entities':
+$params['include_entities'] = (bool) $value;
+break;
+default:
+break;
+}
+}
+$response = $this->get($path, $params);
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Mark a status as a favorite
+*
+* @param  int $id Status ID you want to mark as a favorite
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function favoritesCreate($id)
+{
+$this->init();
+$path     = 'favorites/create';
+$params   = array('id' => $this->validInteger($id));
+$response = $this->post($path, $params);
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Remove a favorite
+*
+* @param  int $id Status ID you want to de-list as a favorite
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function favoritesDestroy($id)
+{
+$this->init();
+$path     = 'favorites/destroy';
+$params   = array('id' => $this->validInteger($id));
+$response = $this->post($path, $params);
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Fetch favorites
+*
+* $options may contain one or more of the following:
+* - user_id: Id of a user for whom to fetch favorites
+* - screen_name: Screen name of a user for whom to fetch favorites
+* - count: number of tweets to attempt to retrieve, up to 200
+* - since_id: return results only after the specified tweet id
+* - max_id: return results with an ID less than (older than) or equal to the specified ID
+* - include_entities: when set to false, entities member will be omitted
+*
+* @param  array $params
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function favoritesList(array $options = array())
+{
+$this->init();
+$path = 'favorites/list';
+$params = array();
+foreach ($options as $key => $value) {
+switch (strtolower($key)) {
+case 'user_id':
+$params['user_id'] = $this->validInteger($value);
+break;
+case 'screen_name':
+$params['screen_name'] = $value;
+break;
+case 'count':
+$params['count'] = (int) $value;
+break;
+case 'since_id':
+$params['since_id'] = $this->validInteger($value);
+break;
+case 'max_id':
+$params['max_id'] = $this->validInteger($value);
+break;
+case 'include_entities':
+$params['include_entities'] = (bool) $value;
+break;
+default:
+break;
+}
+}
+$response = $this->get($path, $params);
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Create friendship
+*
+* @param  int|string $id User ID or name of new friend
+* @param  array $params Additional parameters to pass
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function friendshipsCreate($id, array $params = array())
+{
+$this->init();
+$path    = 'friendships/create';
+$params  = $this->createUserParameter($id, $params);
+$allowed = array(
+'user_id'     => null,
+'screen_name' => null,
+'follow'      => null,
+);
+$params = array_intersect_key($params, $allowed);
+$response = $this->post($path, $params);
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Destroy friendship
+*
+* @param  int|string $id User ID or name of friend to remove
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function friendshipsDestroy($id)
+{
+$this->init();
+$path     = 'friendships/destroy';
+$params   = $this->createUserParameter($id, array());
+$response = $this->post($path, $params);
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Search tweets
+*
+* $options may include any of the following:
+* - geocode: a string of the form "latitude, longitude, radius"
+* - lang: restrict tweets to the two-letter language code
+* - locale: query is in the given two-letter language code
+* - result_type: what type of results to receive: mixed, recent, or popular
+* - count: number of tweets to return per page; up to 100
+* - until: return tweets generated before the given date
+* - since_id: return resutls with an ID greater than (more recent than) the given ID
+* - max_id: return results with an ID less than (older than) the given ID
+* - include_entities: whether or not to include embedded entities
+*
+* @param  string $query
+* @param  array $options
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function searchTweets($query, array $options = array())
+{
+$this->init();
+$path = 'search/tweets';
+$len = iconv_strlen($query, 'UTF-8');
+if (0 == $len) {
+require_once 'Zend/Service/Twitter/Exception.php';
+throw new Zend_Service_Twitter_Exception(
+'Query must contain at least one character'
+);
+}
+$params = array('q' => $query);
+foreach ($options as $key => $value) {
+switch (strtolower($key)) {
+case 'geocode':
+if (!substr_count($value, ',') !== 2) {
+require_once 'Zend/Service/Twitter/Exception.php';
+throw new Zend_Service_Twitter_Exception(
+'"geocode" must be of the format "latitude,longitude,radius"'
+);
 }
-$_params['count'] = (int) $count;
+list($latitude, $longitude, $radius) = explode(',', $value);
+$radius = trim($radius);
+if (!preg_match('/^\d+(mi|km)$/', $radius)) {
+require_once 'Zend/Service/Twitter/Exception.php';
+throw new Zend_Service_Twitter_Exception(
+'Radius segment of "geocode" must be of the format "[unit](mi|km)"'
+);
+}
+$latitude  = (float) $latitude;
+$longitude = (float) $longitude;
+$params['geocode'] = $latitude . ',' . $longitude . ',' . $radius;
+break;
+case 'lang':
+if (strlen($value) > 2) {
+require_once 'Zend/Service/Twitter/Exception.php';
+throw new Zend_Service_Twitter_Exception(
+'Query language must be a 2 character string'
+);
+}
+$params['lang'] = strtolower($value);
+break;
+case 'locale':
+if (strlen($value) > 2) {
+require_once 'Zend/Service/Twitter/Exception.php';
+throw new Zend_Service_Twitter_Exception(
+'Query locale must be a 2 character string'
+);
+}
+$params['locale'] = strtolower($value);
+break;
+case 'result_type':
+$value = strtolower($value);
+if (!in_array($value, array('mixed', 'recent', 'popular'))) {
+require_once 'Zend/Service/Twitter/Exception.php';
+throw new Zend_Service_Twitter_Exception(
+'result_type must be one of "mixed", "recent", or "popular"'
+);
+}
+$params['result_type'] = $value;
+break;
+case 'count':
+$value = (int) $value;
+if (1 > $value || 100 < $value) {
+require_once 'Zend/Service/Twitter/Exception.php';
+throw new Zend_Service_Twitter_Exception(
+'count must be between 1 and 100'
+);
+}
+$params['count'] = $value;
+break;
+case 'until':
+if (!preg_match('/^\d{4}-\d{2}-\d{2}$/', $value)) {
+require_once 'Zend/Service/Twitter/Exception.php';
+throw new Zend_Service_Twitter_Exception(
+'"until" must be a date in the format YYYY-MM-DD'
+);
+}
+$params['until'] = $value;
 break;
 case 'since_id':
-$_params['since_id'] = $this->_validInteger($value);
+$params['since_id'] = $this->validInteger($value);
 break;
-case 'page':
+case 'max_id':
-$_params['page'] = (int) $value;
+$params['max_id'] = $this->validInteger($value);
+break;
+case 'include_entities':
+$params['include_entities'] = (bool) $value;
 break;
 default:
 break;
 }
 }
-$path .= '.xml';
+$response = $this->get($path, $params);
-$response = $this->_get($path, $_params);
+return new Zend_Service_Twitter_Response($response);
-return new Zend_Rest_Client_Result($response->getBody());
+}
-}
+/**
-/**
+* Destroy a status message
-* User Timeline status
+*
-*
+* @param  int $id ID of status to destroy
-* $params may include one or more of the following keys
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* - id: ID of a friend whose timeline you wish to receive
+* @throws Exception\DomainException if unable to decode JSON payload
-* - since_id: return results only after the tweet id specified
+* @return Zend_Service_Twitter_Response
-* - page: return page X of results
+*/
-* - count: how many statuses to return
+public function statusesDestroy($id)
-* - max_id: returns only statuses with an ID less than or equal to the specified ID
+{
-* - user_id: specifies the ID of the user for whom to return the user_timeline
+$this->init();
-* - screen_name: specfies the screen name of the user for whom to return the user_timeline
+$path = 'statuses/destroy/' . $this->validInteger($id);
-* - include_rts: whether or not to return retweets
+$response = $this->post($path);
-* - trim_user: whether to return just the user ID or a full user object; omit to return full object
+return new Zend_Service_Twitter_Response($response);
-* - include_entities: whether or not to return entities nodes with tweet metadata
+}
-*
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+/**
-* @return Zend_Rest_Client_Result
+* Friend Timeline Status
-*/
+*
-public function statusUserTimeline(array $params = array())
+* $options may include one or more of the following keys
-{
+* - count: number of tweets to attempt to retrieve, up to 200
-$this->_init();
+* - since_id: return results only after the specified tweet id
-$path = '/1/statuses/user_timeline';
+* - max_id: return results with an ID less than (older than) or equal to the specified ID
-$_params = array();
+* - trim_user: when set to true, "t", or 1, user object in tweets will include only author's ID.
-foreach ($params as $key => $value) {
+* - contributor_details: when set to true, includes screen_name of each contributor
+* - include_entities: when set to false, entities member will be omitted
+* - exclude_replies: when set to true, will strip replies appearing in the timeline
+*
+* @param  array $params
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function statusesHomeTimeline(array $options = array())
+{
+$this->init();
+$path = 'statuses/home_timeline';
+$params = array();
+foreach ($options as $key => $value) {
 switch (strtolower($key)) {
-case 'id':
-$path .= '/' . $value;
-break;
-case 'page':
-$_params['page'] = (int) $value;
-break;
 case 'count':
-$count = (int) $value;
+$params['count'] = (int) $value;
-if (0 >= $count) {
+break;
-$count = 1;
+case 'since_id':
-} elseif (200 < $count) {
+$params['since_id'] = $this->validInteger($value);
-$count = 200;
+break;
+case 'max_id':
+$params['max_id'] = $this->validInteger($value);
+break;
+case 'trim_user':
+if (in_array($value, array(true, 'true', 't', 1, '1'))) {
+$value = true;
+} else {
+$value = false;
 }
-$_params['count'] = $count;
+$params['trim_user'] = $value;
 break;
-case 'user_id':
+case 'contributor_details:':
-$_params['user_id'] = $this->_validInteger($value);
+$params['contributor_details:'] = (bool) $value;
 break;
-case 'screen_name':
+case 'include_entities':
-$_params['screen_name'] = $this->_validateScreenName($value);
+$params['include_entities'] = (bool) $value;
+break;
+case 'exclude_replies':
+$params['exclude_replies'] = (bool) $value;
+break;
+default:
+break;
+}
+}
+$response = $this->get($path, $params);
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Get status replies
+*
+* $options may include one or more of the following keys
+* - count: number of tweets to attempt to retrieve, up to 200
+* - since_id: return results only after the specified tweet id
+* - max_id: return results with an ID less than (older than) or equal to the specified ID
+* - trim_user: when set to true, "t", or 1, user object in tweets will include only author's ID.
+* - contributor_details: when set to true, includes screen_name of each contributor
+* - include_entities: when set to false, entities member will be omitted
+*
+* @param  array $options
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function statusesMentionsTimeline(array $options = array())
+{
+$this->init();
+$path   = 'statuses/mentions_timeline';
+$params = array();
+foreach ($options as $key => $value) {
+switch (strtolower($key)) {
+case 'count':
+$params['count'] = (int) $value;
 break;
 case 'since_id':
-$_params['since_id'] = $this->_validInteger($value);
+$params['since_id'] = $this->validInteger($value);
 break;
 case 'max_id':
-$_params['max_id'] = $this->_validInteger($value);
+$params['max_id'] = $this->validInteger($value);
 break;
-case 'include_rts':
 case 'trim_user':
+if (in_array($value, array(true, 'true', 't', 1, '1'))) {
+$value = true;
+} else {
+$value = false;
+}
+$params['trim_user'] = $value;
+break;
+case 'contributor_details:':
+$params['contributor_details:'] = (bool) $value;
+break;
 case 'include_entities':
-$_params[strtolower($key)] = $value ? '1' : '0';
+$params['include_entities'] = (bool) $value;
 break;
 default:
 break;
 }
 }
-$path .= '.xml';
+$response = $this->get($path, $params);
-$response = $this->_get($path, $_params);
+return new Zend_Service_Twitter_Response($response);
-return new Zend_Rest_Client_Result($response->getBody());
+}
+/**
+* Public Timeline status
+*
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function statusesSample()
+{
+$this->init();
+$path = 'statuses/sample';
+$response = $this->get($path);
+return new Zend_Service_Twitter_Response($response);
 }
 /**
 * Show a single status
 *
 * @param  int $id Id of status to show
 * @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return Zend_Rest_Client_Result
+* @throws Exception\DomainException if unable to decode JSON payload
-*/
+* @return Zend_Service_Twitter_Response
-public function statusShow($id)
+*/
-{
+public function statusesShow($id)
-$this->_init();
+{
-$path = '/1/statuses/show/' . $this->_validInteger($id) . '.xml';
+$this->init();
-$response = $this->_get($path);
+$path = 'statuses/show/' . $this->validInteger($id);
-return new Zend_Rest_Client_Result($response->getBody());
+$response = $this->get($path);
+return new Zend_Service_Twitter_Response($response);
 }
 /**
 * Update user's current status
 *
+* @todo   Support additional parameters supported by statuses/update endpoint
 * @param  string $status
-* @param  int $in_reply_to_status_id
+* @param  null|int $inReplyToStatusId
-* @return Zend_Rest_Client_Result
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\OutOfRangeException if message is too long
-* @throws Zend_Service_Twitter_Exception if message is too short or too long
+* @throws Exception\InvalidArgumentException if message is empty
-*/
+* @throws Exception\DomainException if unable to decode JSON payload
-public function statusUpdate($status, $inReplyToStatusId = null)
+* @return Zend_Service_Twitter_Response
-{
+*/
-$this->_init();
+public function statusesUpdate($status, $inReplyToStatusId = null)
-$path = '/1/statuses/update.xml';
+{
+$this->init();
+$path = 'statuses/update';
 $len = iconv_strlen(htmlspecialchars($status, ENT_QUOTES, 'UTF-8'), 'UTF-8');
 if ($len > self::STATUS_MAX_CHARACTERS) {
-include_once 'Zend/Service/Twitter/Exception.php';
+require_once 'Zend/Service/Twitter/Exception.php';
 throw new Zend_Service_Twitter_Exception(
 'Status must be no more than '
 . self::STATUS_MAX_CHARACTERS
 . ' characters in length'
 );
 } elseif (0 == $len) {
-include_once 'Zend/Service/Twitter/Exception.php';
+require_once 'Zend/Service/Twitter/Exception.php';
 throw new Zend_Service_Twitter_Exception(
 'Status must contain at least one character'
 );
 }
-$data = array('status' => $status);
-if (is_numeric($inReplyToStatusId) && !empty($inReplyToStatusId)) {
+$params = array('status' => $status);
-$data['in_reply_to_status_id'] = $inReplyToStatusId;
+$inReplyToStatusId = $this->validInteger($inReplyToStatusId);
-}
+if ($inReplyToStatusId) {
-$response = $this->_post($path, $data);
+$params['in_reply_to_status_id'] = $inReplyToStatusId;
-return new Zend_Rest_Client_Result($response->getBody());
+}
-}
+$response = $this->post($path, $params);
+return new Zend_Service_Twitter_Response($response);
-/**
+}
-* Get status replies
-*
+/**
-* $params may include one or more of the following keys
+* User Timeline status
+*
+* $options may include one or more of the following keys
+* - user_id: Id of a user for whom to fetch favorites
+* - screen_name: Screen name of a user for whom to fetch favorites
+* - count: number of tweets to attempt to retrieve, up to 200
 * - since_id: return results only after the specified tweet id
-* - page: return page X of results
+* - max_id: return results with an ID less than (older than) or equal to the specified ID
-*
+* - trim_user: when set to true, "t", or 1, user object in tweets will include only author's ID.
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* - exclude_replies: when set to true, will strip replies appearing in the timeline
-* @return Zend_Rest_Client_Result
+* - contributor_details: when set to true, includes screen_name of each contributor
-*/
+* - include_rts: when set to false, will strip native retweets
-public function statusReplies(array $params = array())
+*
-{
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-$this->_init();
+* @throws Exception\DomainException if unable to decode JSON payload
-$path = '/1/statuses/mentions.xml';
+* @return Zend_Service_Twitter_Response
-$_params = array();
+*/
-foreach ($params as $key => $value) {
+public function statusesUserTimeline(array $options = array())
+{
+$this->init();
+$path = 'statuses/user_timeline';
+$params = array();
+foreach ($options as $key => $value) {
 switch (strtolower($key)) {
+case 'user_id':
+$params['user_id'] = $this->validInteger($value);
+break;
+case 'screen_name':
+$params['screen_name'] = $this->validateScreenName($value);
+break;
+case 'count':
+$params['count'] = (int) $value;
+break;
 case 'since_id':
-$_params['since_id'] = $this->_validInteger($value);
+$params['since_id'] = $this->validInteger($value);
+break;
+case 'max_id':
+$params['max_id'] = $this->validInteger($value);
+break;
+case 'trim_user':
+if (in_array($value, array(true, 'true', 't', 1, '1'))) {
+$value = true;
+} else {
+$value = false;
+}
+$params['trim_user'] = $value;
+break;
+case 'contributor_details:':
+$params['contributor_details:'] = (bool) $value;
+break;
+case 'exclude_replies':
+$params['exclude_replies'] = (bool) $value;
+break;
+case 'include_rts':
+$params['include_rts'] = (bool) $value;
+break;
+default:
+break;
+}
+}
+$response = $this->get($path, $params);
+return new Zend_Service_Twitter_Response($response);
+}
+/**
+* Search users
+*
+* $options may include any of the following:
+* - page: the page of results to retrieve
+* - count: the number of users to retrieve per page; max is 20
+* - include_entities: if set to boolean true, include embedded entities
+*
+* @param  string $query
+* @param  array $options
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @throws Exception\DomainException if unable to decode JSON payload
+* @return Zend_Service_Twitter_Response
+*/
+public function usersSearch($query, array $options = array())
+{
+$this->init();
+$path = 'users/search';
+$len = iconv_strlen($query, 'UTF-8');
+if (0 == $len) {
+require_once 'Zend/Service/Twitter/Exception.php';
+throw new Zend_Service_Twitter_Exception(
+'Query must contain at least one character'
+);
+}
+$params = array('q' => $query);
+foreach ($options as $key => $value) {
+switch (strtolower($key)) {
+case 'count':
+$value = (int) $value;
+if (1 > $value || 20 < $value) {
+require_once 'Zend/Service/Twitter/Exception.php';
+throw new Zend_Service_Twitter_Exception(
+'count must be between 1 and 20'
+);
+}
+$params['count'] = $value;
 break;
 case 'page':
-$_params['page'] = (int) $value;
+$params['page'] = (int) $value;
+break;
+case 'include_entities':
+$params['include_entities'] = (bool) $value;
 break;
 default:
 break;
 }
 }
-$response = $this->_get($path, $_params);
+$response = $this->get($path, $params);
-return new Zend_Rest_Client_Result($response->getBody());
+return new Zend_Service_Twitter_Response($response);
 }
-/**
-* Destroy a status message
+/**
-*
+* Show extended information on a user
-* @param  int $id ID of status to destroy
+*
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* @param  int|string $id User ID or name
-* @return Zend_Rest_Client_Result
+* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-*/
+* @throws Exception\DomainException if unable to decode JSON payload
-public function statusDestroy($id)
+* @return Zend_Service_Twitter_Response
-{
+*/
-$this->_init();
+public function usersShow($id)
-$path = '/1/statuses/destroy/' . $this->_validInteger($id) . '.xml';
+{
-$response = $this->_post($path);
+$this->init();
-return new Zend_Rest_Client_Result($response->getBody());
+$path     = 'users/show';
-}
+$params   = $this->createUserParameter($id, array());
+$response = $this->get($path, $params);
-/**
+return new Zend_Service_Twitter_Response($response);
-* User friends
+}
-*
-* @param  int|string $id Id or username of user for whom to fetch friends
+/**
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
+* Initialize HTTP authentication
-* @return Zend_Rest_Client_Result
+*
-*/
+* @return void
-public function userFriends(array $params = array())
+* @throws Exception\DomainException if unauthorised
-{
+*/
-$this->_init();
+protected function init()
-$path = '/1/statuses/friends';
+{
-$_params = array();
+if (!$this->isAuthorised() && $this->getUsername() !== null) {
+require_once 'Zend/Service/Twitter/Exception.php';
-foreach ($params as $key => $value) {
+throw new Zend_Service_Twitter_Exception(
-switch (strtolower($key)) {
+'Twitter session is unauthorised. You need to initialize '
-case 'id':
+. __CLASS__ . ' with an OAuth Access Token or use '
-$path .= '/' . $value;
+. 'its OAuth functionality to obtain an Access Token before '
-break;
+. 'attempting any API actions that require authorisation'
-case 'page':
+);
-$_params['page'] = (int) $value;
+}
-break;
+$client = $this->getHttpClient();
-default:
+$client->resetParameters();
-break;
+if (null === $this->cookieJar) {
+$cookieJar = $client->getCookieJar();
+if (null === $cookieJar) {
+$cookieJar = new Zend_Http_CookieJar();
 }
-}
+$this->cookieJar = $cookieJar;
-$path .= '.xml';
+$this->cookieJar->reset();
+} else {
-$response = $this->_get($path, $_params);
+$client->setCookieJar($this->cookieJar);
-return new Zend_Rest_Client_Result($response->getBody());
+}
-}
-/**
-* User Followers
-*
-* @param  bool $lite If true, prevents inline inclusion of current status for followers; defaults to false
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return Zend_Rest_Client_Result
-*/
-public function userFollowers($lite = false)
-{
-$this->_init();
-$path = '/1/statuses/followers.xml';
-if ($lite) {
-$this->lite = 'true';
-}
-$response = $this->_get($path);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Show extended information on a user
-*
-* @param  int|string $id User ID or name
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return Zend_Rest_Client_Result
-*/
-public function userShow($id)
-{
-$this->_init();
-$path = '/1/users/show.xml';
-$response = $this->_get($path, array('id'=>$id));
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Retrieve direct messages for the current user
-*
-* $params may include one or more of the following keys
-* - since_id: return statuses only greater than the one specified
-* - page: return page X of results
-*
-* @param  array $params
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return Zend_Rest_Client_Result
-*/
-public function directMessageMessages(array $params = array())
-{
-$this->_init();
-$path = '/1/direct_messages.xml';
-$_params = array();
-foreach ($params as $key => $value) {
-switch (strtolower($key)) {
-case 'since_id':
-$_params['since_id'] = $this->_validInteger($value);
-break;
-case 'page':
-$_params['page'] = (int) $value;
-break;
-default:
-break;
-}
-}
-$response = $this->_get($path, $_params);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Retrieve list of direct messages sent by current user
-*
-* $params may include one or more of the following keys
-* - since_id: return statuses only greater than the one specified
-* - page: return page X of results
-*
-* @param  array $params
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return Zend_Rest_Client_Result
-*/
-public function directMessageSent(array $params = array())
-{
-$this->_init();
-$path = '/1/direct_messages/sent.xml';
-$_params = array();
-foreach ($params as $key => $value) {
-switch (strtolower($key)) {
-case 'since_id':
-$_params['since_id'] = $this->_validInteger($value);
-break;
-case 'page':
-$_params['page'] = (int) $value;
-break;
-default:
-break;
-}
-}
-$response = $this->_get($path, $_params);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Send a direct message to a user
-*
-* @param  int|string $user User to whom to send message
-* @param  string $text Message to send to user
-* @return Zend_Rest_Client_Result
-* @throws Zend_Service_Twitter_Exception if message is too short or too long
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-*/
-public function directMessageNew($user, $text)
-{
-$this->_init();
-$path = '/1/direct_messages/new.xml';
-$len = iconv_strlen($text, 'UTF-8');
-if (0 == $len) {
-throw new Zend_Service_Twitter_Exception(
-'Direct message must contain at least one character'
-);
-} elseif (140 < $len) {
-throw new Zend_Service_Twitter_Exception(
-'Direct message must contain no more than 140 characters'
-);
-}
-$data = array('user' => $user, 'text' => $text);
-$response = $this->_post($path, $data);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Destroy a direct message
-*
-* @param  int $id ID of message to destroy
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return Zend_Rest_Client_Result
-*/
-public function directMessageDestroy($id)
-{
-$this->_init();
-$path = '/1/direct_messages/destroy/' . $this->_validInteger($id) . '.xml';
-$response = $this->_post($path);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Create friendship
-*
-* @param  int|string $id User ID or name of new friend
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return Zend_Rest_Client_Result
-*/
-public function friendshipCreate($id)
-{
-$this->_init();
-$path = '/1/friendships/create/' . $id . '.xml';
-$response = $this->_post($path);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Destroy friendship
-*
-* @param  int|string $id User ID or name of friend to remove
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return Zend_Rest_Client_Result
-*/
-public function friendshipDestroy($id)
-{
-$this->_init();
-$path = '/1/friendships/destroy/' . $id . '.xml';
-$response = $this->_post($path);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Friendship exists
-*
-* @param int|string $id User ID or name of friend to see if they are your friend
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return Zend_Rest_Client_result
-*/
-public function friendshipExists($id)
-{
-$this->_init();
-$path = '/1/friendships/exists.xml';
-$data = array('user_a' => $this->getUsername(), 'user_b' => $id);
-$response = $this->_get($path, $data);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Verify Account Credentials
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-*
-* @return Zend_Rest_Client_Result
-*/
-public function accountVerifyCredentials()
-{
-$this->_init();
-$response = $this->_get('/1/account/verify_credentials.xml');
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* End current session
-*
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return true
-*/
-public function accountEndSession()
-{
-$this->_init();
-$this->_get('/1/account/end_session');
-return true;
-}
-/**
-* Returns the number of api requests you have left per hour.
-*
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return Zend_Rest_Client_Result
-*/
-public function accountRateLimitStatus()
-{
-$this->_init();
-$response = $this->_get('/1/account/rate_limit_status.xml');
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Fetch favorites
-*
-* $params may contain one or more of the following:
-* - 'id': Id of a user for whom to fetch favorites
-* - 'page': Retrieve a different page of resuls
-*
-* @param  array $params
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return Zend_Rest_Client_Result
-*/
-public function favoriteFavorites(array $params = array())
-{
-$this->_init();
-$path = '/1/favorites';
-$_params = array();
-foreach ($params as $key => $value) {
-switch (strtolower($key)) {
-case 'id':
-$path .= '/' . $this->_validInteger($value);
-break;
-case 'page':
-$_params['page'] = (int) $value;
-break;
-default:
-break;
-}
-}
-$path .= '.xml';
-$response = $this->_get($path, $_params);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Mark a status as a favorite
-*
-* @param  int $id Status ID you want to mark as a favorite
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return Zend_Rest_Client_Result
-*/
-public function favoriteCreate($id)
-{
-$this->_init();
-$path = '/1/favorites/create/' . $this->_validInteger($id) . '.xml';
-$response = $this->_post($path);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Remove a favorite
-*
-* @param  int $id Status ID you want to de-list as a favorite
-* @throws Zend_Http_Client_Exception if HTTP request fails or times out
-* @return Zend_Rest_Client_Result
-*/
-public function favoriteDestroy($id)
-{
-$this->_init();
-$path = '/1/favorites/destroy/' . $this->_validInteger($id) . '.xml';
-$response = $this->_post($path);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Blocks the user specified in the ID parameter as the authenticating user.
-* Destroys a friendship to the blocked user if it exists.
-*
-* @param integer|string $id       The ID or screen name of a user to block.
-* @return Zend_Rest_Client_Result
-*/
-public function blockCreate($id)
-{
-$this->_init();
-$path = '/1/blocks/create/' . $id . '.xml';
-$response = $this->_post($path);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Un-blocks the user specified in the ID parameter for the authenticating user
-*
-* @param integer|string $id       The ID or screen_name of the user to un-block.
-* @return Zend_Rest_Client_Result
-*/
-public function blockDestroy($id)
-{
-$this->_init();
-$path = '/1/blocks/destroy/' . $id . '.xml';
-$response = $this->_post($path);
-return new Zend_Rest_Client_Result($response->getBody());
-}
-/**
-* Returns if the authenticating user is blocking a target user.
-*
-* @param string|integer $id    The ID or screen_name of the potentially blocked user.
-* @param boolean $returnResult Instead of returning a boolean return the rest response from twitter
-* @return Boolean|Zend_Rest_Client_Result
-*/
-public function blockExists($id, $returnResult = false)
-{
-$this->_init();
-$path = '/1/blocks/exists/' . $id . '.xml';
-$response = $this->_get($path);
-$cr = new Zend_Rest_Client_Result($response->getBody());
-if ($returnResult === true)
-return $cr;
-if (!empty($cr->request)) {
-return false;
-}
-return true;
-}
-/**
-* Returns an array of user objects that the authenticating user is blocking
-*
-* @param integer $page         Optional. Specifies the page number of the results beginning at 1. A single page contains 20 ids.
-* @param boolean $returnUserIds  Optional. Returns only the userid's instead of the whole user object
-* @return Zend_Rest_Client_Result
-*/
-public function blockBlocking($page = 1, $returnUserIds = false)
-{
-$this->_init();
-$path = '/1/blocks/blocking';
-if ($returnUserIds === true) {
-$path .= '/ids';
-}
-$path .= '.xml';
-$response = $this->_get($path, array('page' => $page));
-return new Zend_Rest_Client_Result($response->getBody());
 }
 /**
 * Protected function to validate that the integer is valid or return a 0
-* @param $int
+*
+* @param  $int
 * @throws Zend_Http_Client_Exception if HTTP request fails or times out
 * @return integer
 */
-protected function _validInteger($int)
+protected function validInteger($int)
 {
 if (preg_match("/(\d+)/", $int)) {
 return $int;
 }
 return 0;
 /**
 * Validate a screen name using Twitter rules
 *
 * @param string $name
-* @throws Zend_Service_Twitter_Exception
 * @return string
-*/
+* @throws Exception\InvalidArgumentException
-protected function _validateScreenName($name)
+*/
-{
+protected function validateScreenName($name)
-if (!preg_match('/^[a-zA-Z0-9_]{0,15}$/', $name)) {
+{
+if (!preg_match('/^[a-zA-Z0-9_]{0,20}$/', $name)) {
 require_once 'Zend/Service/Twitter/Exception.php';
 throw new Zend_Service_Twitter_Exception(
 'Screen name, "' . $name
 . '" should only contain alphanumeric characters and'
 . ' underscores, and not exceed 15 characters.');
 }
 return $name;
 }
 /**
-* Call a remote REST web service URI and return the Zend_Http_Response object
+* Call a remote REST web service URI
 *
-* @param  string $path            The path to append to the URI
+* @param  string $path The path to append to the URI
-* @throws Zend_Rest_Client_Exception
+* @param  Zend_Http_Client $client
+* @throws Zend_Http_Client_Exception
 * @return void
 */
-protected function _prepare($path)
+protected function prepare($path, Zend_Http_Client $client)
 {
-// Get the URI object and configure it
+$client->setUri(self::API_BASE_URI . $path . '.json');
-if (!$this->_uri instanceof Zend_Uri_Http) {
-require_once 'Zend/Rest/Client/Exception.php';
-throw new Zend_Rest_Client_Exception(
-'URI object must be set before performing call'
-);
-}
-$uri = $this->_uri->getUri();
-if ($path[0] != '/' && $uri[strlen($uri) - 1] != '/') {
-$path = '/' . $path;
-}
-$this->_uri->setPath($path);
 /**
-* Get the HTTP client and configure it for the endpoint URI.
+* Do this each time to ensure oauth calls do not inject new params
-* Do this each time because the Zend_Http_Client instance is shared
-* among all Zend_Service_Abstract subclasses.
 */
-$this->_localHttpClient->resetParameters()->setUri((string) $this->_uri);
+$client->resetParameters();
 }
 /**
 * Performs an HTTP GET request to the $path.
 *
 * @param string $path
 * @param array  $query Array of GET parameters
 * @throws Zend_Http_Client_Exception
 * @return Zend_Http_Response
 */
-protected function _get($path, array $query = null)
+protected function get($path, array $query = array())
 {
-$this->_prepare($path);
+$client = $this->getHttpClient();
-$this->_localHttpClient->setParameterGet($query);
+$this->prepare($path, $client);
-return $this->_localHttpClient->request(Zend_Http_Client::GET);
+$client->setParameterGet($query);
+$response = $client->request(Zend_Http_Client::GET);
+return $response;
 }
 /**
 * Performs an HTTP POST request to $path.
 *
 * @param string $path
 * @param mixed $data Raw data to send
 * @throws Zend_Http_Client_Exception
 * @return Zend_Http_Response
 */
-protected function _post($path, $data = null)
+protected function post($path, $data = null)
 {
-$this->_prepare($path);
+$client = $this->getHttpClient();
-return $this->_performPost(Zend_Http_Client::POST, $data);
+$this->prepare($path, $client);
+$response = $this->performPost(Zend_Http_Client::POST, $data, $client);
+return $response;
 }
 /**
 * Perform a POST or PUT
 *
 *
 * @param mixed $method
 * @param mixed $data
 * @return Zend_Http_Response
 */
-protected function _performPost($method, $data = null)
+protected function performPost($method, $data, Zend_Http_Client $client)
 {
-$client = $this->_localHttpClient;
 if (is_string($data)) {
 $client->setRawData($data);
 } elseif (is_array($data) || is_object($data)) {
 $client->setParameterPost((array) $data);
 }
 return $client->request($method);
 }
+/**
+* Create a parameter representing the user
+*
+* Determines if $id is an integer, and, if so, sets the "user_id" parameter.
+* If not, assumes the $id is the "screen_name".
+*
+* @param  int|string $id
+* @param  array $params
+* @return array
+*/
+protected function createUserParameter($id, array $params)
+{
+if ($this->validInteger($id)) {
+$params['user_id'] = $id;
+return $params;
+}
+$params['screen_name'] = $this->validateScreenName($id);
+return $params;
+}
 }

changeset 886	1e110b03ae96
parent 807	877f952ae2bd
child 1230	68c69c656a2c