vimeo_source.php

<?php
/** 
* Vimeo Datasource 0.2 
* 
* Vimeo datasource to communicate with the Vimeo Simple API (Advanced on the way...) 
* Also utilizes the Vimeo oEmbed API for generating embed code.
* 
* Licensed under The MIT License 
* Redistributions of files must retain the above copyright notice. 
* 
* 
* @author Jon (pointlessjon) Adams <jon@anti-gen.com> 
* @copyright (c) n/a
* @link http://github.com/pointlessjon/CakePHP-Vimeo-Datasource/tree/master
* @license http://www.opensource.org/licenses/mit-license.php The MIT License 
* @created May 7, 2009 
* @updated June 18, 2009
* @version 0.1 * 
*/
App::import('Core', array('HttpSocket'));
 
class VimeoSource extends DataSource {

	var $description = 'Vimeo Simple API';
	var $Http = null;
	var $allowedRequests = array(
		'user' => array(
			'info',
			'clips',
			'likes',
			'appears_in',
			'all_clips',
			'subscriptions',
			'albums',
			'channels',
			'groups',
			'contacts_clips',
			'contacts_like'
		),
		'activity' => array(
			'user_did',
			'happened_to_user',
			'contacts_did',
			'happened_to_contacts',
			'everyone_did'
		),
		'group' => array(
			'clips',
			'users',
			'info'
		),
		'channel' => array(
			'clips',
			'info'
		),
		'album' => array(
			'clips',
			'info'
		)
	);
	
	/** 
	* Constructor sets configuration and instantiates HttpSocket
	* 
	* @param array config Optional. 
	* @see http://www.vimeo.com/api/docs/simple-api
	*/ 
	function __construct($config = null) {
		parent::__construct($config);
		$this->Http =& new HttpSocket();
		Cache::config('vimeo', array('engine' => 'File', 'duration'=> '+1 days', 'path' => CACHE . DS . 'vimeo' . DS,'prefix' => 'vimeo_cache_'));
	}
	
	/** 
	* Shortcut to retrieve only the embed code of the oembed object for a specific video.
	* 
	* @param string videoId Required.
	* @param array options Optional. 
	* @see http://www.vimeo.com/api/docs/oembed
	*/ 
	function embed($videoId = null, $options = null) {
		if (!empty($videoId)) {
			$_oembed = $this->oembed($videoId, $options);
			return $_oembed->html;
		}
		return false;
	}
	
	
	/** 
	* Retrieve oembed object for a specific video
	* 
	* @param string videoId Required.
	* @param array options Optional. 
	* @see http://www.vimeo.com/api/docs/oembed
	*/ 
	function oembed($videoId = null, $options = null) {
		if (!empty($videoId)) {
			$request = "http://vimeo.com/api/oembed.json?url=http://vimeo.com/{$videoId}";
			if (!empty($options)) {
				foreach ($options as $key => $value) {
					$request .= "&{$key}={$value}";
				}
			}
			if ($cached = $this->_getCache($request)) {
				// keep it going...
			} else {
				$response = $this->Http->get($request);
				$data = json_decode($response);
				$cached = $this->_createCache($request, $data);
			}
			return $cached;
		}
		return false;
	}
	
	/** 
	* Retrieve data about a specific video
	* 
	* @param string videoId Required.
	* @see http://www.vimeo.com/api/docs/simple-api
	*/ 
	function video($videoId = null) {
		if (!empty($videoId)) {
			return $this->__vimeoApiRequest("clip/{$videoId}");
		}
		return false;
	}
	
	/** 
	* Retrieve data for a specific user
	* 
	* @param string username Required.
	* @param string request Required. See allowed requests in api documentation
	* @see http://www.vimeo.com/api/docs/simple-api
	*/ 
	function userRequest($username = null, $request = null) {
		if (!empty($username) && !empty($request)) {
			if (in_array($request, $this->allowedRequests['user'])) {
				return $this->__vimeoApiRequest("{$username}/{$request}");
			}
		}
		return false;
	}
	
	/** 
	* Retrieve activity data for a specific user
	* 
	* @param string username Required.
	* @param string request Required. See allowed requests in api documentation
	* @see http://www.vimeo.com/api/docs/simple-api
	*/ 
	function activityRequest($username = null, $request = null) {
		if (!empty($username) && !empty($request)) {
			if (in_array($request, $this->allowedRequests['activity'])) {
				return $this->__vimeoApiRequest("activity/{$username}/{$request}");
			}
		}
		return false;
	}
	
	/** 
	* Retrieve data for a specific group
	* 
	* @param string groupname Required.
	* @param string request Required. See allowed requests in api documentation
	* @see http://www.vimeo.com/api/docs/simple-api
	*/ 
	function groupRequest($groupname = null, $request = null) {
		if (!empty($groupname) && !empty($request)) {
			if (in_array($request, $this->allowedRequests['group'])) {
				return $this->__vimeoApiRequest("group/{$groupname}/{$request}");
			}
		}
		return false;
	}
	
	/** 
	* Retrieve data for a specific channel
	* 
	* @param string channelname Required.
	* @param string request Required. See allowed requests in api documentation
	* @see http://www.vimeo.com/api/docs/simple-api
	*/ 
	function channelRequest($channelname = null, $request = null) {
		if (!empty($channelname) && !empty($request)) {
			if (in_array($request, $this->allowedRequests['channel'])) {
				return $this->__vimeoApiRequest("channel/{$channelname}/{$request}");
			}
		}
		return false;
	}
	
	/** 
	* Retrieve data for a specific album
	* 
	* @param string albumname Required.
	* @param string request Required. See allowed requests in api documentation
	* @see http://www.vimeo.com/api/docs/simple-api
	*/ 
	function albumRequest($albumname = null, $request = null) {
		if (!empty($albumname) && !empty($request)) {
			if (in_array($request, $this->allowedRequests['album'])) {
				return $this->__vimeoApiRequest("album/{$albumname}/{$request}");
			}
		}
		return false;
	}
	
	/** 
	* Internal function to make the requests to the Vimeo Simple API
	* 
	* @param string data Required.
	* @see http://www.vimeo.com/api/docs/simple-api
	*/ 
	function __vimeoApiRequest($request = null) {
		if (!empty($request)) {
			$request = "http://vimeo.com/api/{$request}.php";
			if ($cached = $this->_getCache($request)) {
				// keep it going...
			} else {
				$data = unserialize($this->Http->get($request, null));
				$cached = $this->_createCache($request, $data);
			}
			return $cached;
		}
		return false;
	}
	
	function _getCache($request = null) {
		return Cache::read($this->_requestToCacheKey($request), 'vimeo');
	}
	
	function _createCache($request = null, $data = null) {
		if (!empty($request) && !empty($data)) {
			Cache::write($this->_requestToCacheKey($request), $data, 'vimeo');
		}
		return $data;
	}
	
	function _requestToCacheKey($request = null) {	
		return md5($request);
	}
 
}
?>