Merge branch 'release/0.3.0'

Author: Phil Sturgeon

.gitignore

@@ -0,0 +1 @@
+.DS_Store

README.md

@@ -4,21 +4,26 @@ Authorize users with your application in a driver-base fashion meaning one imple
 
 Note that this Spark ONLY provides the authorization mechanism. There's an example controller below, however in a later version there will be a full controller.
 
-## Currently Supported
+## Examples
+
+OAuth 2 is split into two sections, clients and providers. A client is an application - perhaps a basic Twitter feed aggregator - which 
+authenticates with an OAuth 2 provider, which in this example would be Twitter itself. You can interact with any provider which is supported in the list below:
 
 - Facebook
 - Foursquare
 - GitHub
 - Google
+- PayPal
 - Instagram
+- Soundcloud
 - Windows Live
 - YouTube
 
-## TODO
 
-This is a developing library and currently only supports a small number of OAuth2 providers - more refactoring of code is to follow with a full implementation of an authentication class to store users details.
+## TODO
 
-Requests should be done through a more stable system, there however isn't a request class in CodeIgniter.
+- Requests should be done through a more stable system, there however isn't a Request class in CodeIgniter.
+- Add unit tests and get on Travis
 
 ## Usage Example
 
@@ -75,4 +80,15 @@ class Auth extends CI_Controller
 }
 ```
 
-If all goes well you should see a dump of user data and have `$token` available. If all does not go well you'll likely have a bunch of errors on your screen.
+If all goes well you should see a dump of user data and have `$token` available. If all does not go well you'll likely have a bunch of errors on your screen.
+
+Contribute
+----------
+
+1. Check for open issues or open a new issue for a feature request or a bug
+2. Fork [the repository][] on Github to start making your changes to the
+    `develop` branch (or branch off of it)
+3. Write a test which shows that the bug was fixed or that the feature works as expected
+4. Send a pull request and bug me until I merge it
+
+[the repository]: https://github.com/philsturgeon/codeigniter-oauth2

config/autoload.php

@@ -1,3 +1,3 @@
 <?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
 
-$autoload['libraries'] = array('OAuth2');
+$autoload['libraries'] = array('oauth2');

libraries/Provider.php

@@ -1,16 +1,16 @@
 <?php
 /**
- * OAuth Provider
+ * OAuth2 Provider
  *
- * @package    CodeIgniter/OAuth
+ * @package    CodeIgniter/OAuth2
  * @category   Provider
  * @author     Phil Sturgeon
- * @copyright  Phil Sturgeon
+ * @copyright  (c) 2012 HappyNinjas Ltd
  * @license    http://philsturgeon.co.uk/code/dbad-license
  */
 
-abstract class OAuth2_Provider {
-
+abstract class OAuth2_Provider
+{
 	/**
 	 * @var  string  provider name
 	 */
@@ -21,15 +21,10 @@ abstract class OAuth2_Provider {
 	 */
 	public $uid_key = 'uid';
 
-	/**
-	 * @var  string  scope separator, most use "," but some like Google are spaces
-	 */
-	public $scope_seperator = ',';
-
 	/**
 	 * @var  string  additional request parameters to be used for remote requests
 	 */
-	public $callback = null;
+	public $callback;
 
 	/**
 	 * @var  array  additional request parameters to be used for remote requests
@@ -41,6 +36,16 @@ abstract class OAuth2_Provider {
 	 */
 	protected $method = 'GET';
 
+	/**
+	 * @var  string  default scope (useful if a scope is required for user info)
+	 */
+	protected $scope;
+
+	/**
+	 * @var  string  scope separator, most use "," but some like Google are spaces
+	 */
+	protected $scope_seperator = ',';
+
 	/**
 	 * Overloads default class properties from the options.
 	 *
@@ -160,20 +165,31 @@ public function access($code, $options = array())
 				$url .= '?'.http_build_query($params);
 				$response = file_get_contents($url);
 
-				parse_str($response, $return); 
+				parse_str($response, $return);
 
 			break;
 
 			case 'POST':
 
-				$postdata = http_build_query($params);
+				/* 	$ci = get_instance();
+
+				$ci->load->spark('curl/1.2.1');
+
+				$ci->curl
+					->create($url)
+					->post($params, array('failonerror' => false));
+
+				$response = $ci->curl->execute();
+				*/
+
 				$opts = array(
 					'http' => array(
 						'method'  => 'POST',
 						'header'  => 'Content-type: application/x-www-form-urlencoded',
-						'content' => $postdata
+						'content' => http_build_query($params),
 					)
 				);
+
 				$_default_opts = stream_context_get_params(stream_context_get_default());
 				$context = stream_context_create(array_merge_recursive($_default_opts['options'], $opts));
 				$response = file_get_contents($url, false, $context);
@@ -186,7 +202,7 @@ public function access($code, $options = array())
 				throw new OutOfBoundsException("Method '{$this->method}' must be either GET or POST");
 		}
 
-		if (isset($return['error']))
+		if ( ! empty($return['error']))
 		{
 			throw new OAuth2_Exception($return);
 		}

libraries/Provider/Facebook.php

@@ -1,12 +1,17 @@
 <?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+/**
+ * Facebook OAuth2 Provider
+ *
+ * @package    CodeIgniter/OAuth2
+ * @category   Provider
+ * @author     Phil Sturgeon
+ * @copyright  (c) 2012 HappyNinjas Ltd
+ * @license    http://philsturgeon.co.uk/code/dbad-license
+ */
 
 class OAuth2_Provider_Facebook extends OAuth2_Provider
-{  
-	public $name = 'facebook';
-
-	public $uid_key = 'uid';
-	
-	public $scope = array('offline_access', 'email', 'read_stream');
+{
+	protected $scope = array('offline_access', 'email', 'read_stream');
 
 	public function url_authorize()
 	{

libraries/Provider/Foursquare.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * Foursquare OAuth2 Provider
+ *
+ * @package    CodeIgniter/OAuth2
+ * @category   Provider
+ * @author     Phil Sturgeon
+ * @copyright  (c) 2012 HappyNinjas Ltd
+ * @license    http://philsturgeon.co.uk/code/dbad-license
+ */
+
+class OAuth2_Provider_Foursquare extends OAuth2_Provider
+{  
+	public $method = 'POST';
+
+	public function url_authorize()
+	{
+		return 'https://foursquare.com/oauth2/authenticate';
+	}
+
+	public function url_access_token()
+	{
+		return 'https://foursquare.com/oauth2/access_token';
+	}
+
+	public function get_user_info(OAuth2_Token_Access $token)
+	{
+		$url = 'https://api.foursquare.com/v2/users/self?'.http_build_query(array(
+			'oauth_token' => $token->access_token,
+		));
+
+		$response = json_decode(file_get_contents($url));
+
+		$user = $response->response->user;
+
+		// Create a response from the request
+		return array(
+			'uid' => $user->id,
+			//'nickname' => $user->login,
+			'name' => sprintf('%s %s', $user->firstName, $user->lastName),
+			'email' => $user->contact->email,
+			'image' => $user->photo,
+			'location' => $user->homeCity,
+		);
+	}
+}

libraries/Provider/Github.php

@@ -1,11 +1,16 @@
 <?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+/**
+ * GitHub OAuth2 Provider
+ *
+ * @package    CodeIgniter/OAuth2
+ * @category   Provider
+ * @author     Phil Sturgeon
+ * @copyright  (c) 2012 HappyNinjas Ltd
+ * @license    http://philsturgeon.co.uk/code/dbad-license
+ */
 
-class OAuth2_Provider_Github extends OAuth2_Provider {
-	
-	public $name = 'github';
-	
-	// https://api.github.com
-
+class OAuth2_Provider_Github extends OAuth2_Provider
+{
 	public function url_authorize()
 	{
 		return 'https://github.com/login/oauth/authorize';

libraries/Provider/Google.php

@@ -1,15 +1,24 @@
-<?php
+<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+/**
+ * Google OAuth2 Provider
+ *
+ * @package    CodeIgniter/OAuth2
+ * @category   Provider
+ * @author     Phil Sturgeon
+ * @copyright  (c) 2012 HappyNinjas Ltd
+ * @license    http://philsturgeon.co.uk/code/dbad-license
+ */
 
-class OAuth2_Provider_Google extends OAuth2_Provider {  
-	
-	public $name = 'google';
-	
-	public $human = 'Google';
-
-	public $uid_key = 'uid';
-	
+class OAuth2_Provider_Google extends OAuth2_Provider
+{
+	/**
+	 * @var  string  the method to use when requesting tokens
+	 */
 	public $method = 'POST';
 
+	/**
+	 * @var  string  scope separator, most use "," but some like Google are spaces
+	 */
 	public $scope_seperator = ' ';
 
 	public function url_authorize()

libraries/Provider/Instagram.php

@@ -0,0 +1,48 @@
+<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+/**
+ * Instagram OAuth2 Provider
+ *
+ * @package    CodeIgniter/OAuth2
+ * @category   Provider
+ * @author     Phil Sturgeon
+ * @copyright  (c) 2012 HappyNinjas Ltd
+ * @license    http://philsturgeon.co.uk/code/dbad-license
+ */
+
+class OAuth_Provider_Instagram extends OAuth2_Provider 
+{
+	/**
+	 * @var  string  scope separator, most use "," but some like Google are spaces
+	 */
+	public $scope_seperator = '+';
+
+	/**
+	 * @var  string  the method to use when requesting tokens
+	 */
+	public $method = 'POST';
+
+	public function url_authorize()
+	{
+		return 'https://api.instagram.com/oauth/authorize';
+	}
+
+	public function url_access_token()
+	{
+		return 'https://api.instagram.com/oauth/access_token';
+	}
+
+	public function get_user_info(OAuth2_Token_Access $token)
+	{
+		$user = $token->user;
+
+		return array(
+			'uid' => $user->id,
+			'nickname' => $user->username,
+			'name' => $user->full_name,
+			'image' => $user->profile_picture,
+			'urls' => array(
+			  'website' => $user->website,
+			),
+		);
+	}
+}

libraries/Provider/Mailchimp.php

@@ -1,4 +1,13 @@
 <?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
+/**
+ * Mailchimp OAuth2 Provider
+ *
+ * @package    CodeIgniter/OAuth2
+ * @category   Provider
+ * @author     Phil Sturgeon
+ * @copyright  (c) 2012 HappyNinjas Ltd
+ * @license    http://philsturgeon.co.uk/code/dbad-license
+ */
 
 class OAuth2_Provider_Mailchimp extends OAuth2_Provider
 {