Merge pull request #49 from nibra/auth

nibra · web-flow · commit efed7df41a3c · 2020-11-28T15:43:49.000+01:00
Provide access_token in header instead of URI. Fixes #48
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@ vendor/
 composer.phar
 composer.lock
 phpunit.xml
+build/
diff --git a/Tests/GithubObjectTest.php b/Tests/GithubObjectTest.php
@@ -6,8 +6,11 @@
 
 namespace Joomla\Github\Tests;
 
+use Joomla\Github\AbstractGithubObject;
 use Joomla\Github\Tests\Stub\GitHubTestCase;
 use Joomla\Github\Tests\Stub\ObjectMock;
+use Joomla\Http\Http;
+use Joomla\Http\Transport\Curl;
 
 /**
  * Test class for Joomla\Github\Object.
@@ -17,11 +20,17 @@
 class GithubObjectTest extends GitHubTestCase
 {
 	/**
-	 * @var    ObjectMock  Object under test.
+	 * @var    AbstractGithubObject  Object under test.
 	 * @since  1.0
 	 */
 	protected $object;
 
+	/**
+	 * @var    Http  The HTTP client
+	 * @since  __DEPLOY_VERSION__
+	 */
+	protected $client;
+
 	/**
 	 * Sets up the fixture, for example, opens a network connection.
 	 * This method is called before a test is executed.
@@ -34,6 +43,8 @@ protected function setUp()
 	{
 		parent::setUp();
 
+		$transport    = new Curl(array());
+		$this->client = new Http(array(), $transport);
 		$this->object = new ObjectMock($this->options, $this->client);
 	}
 
@@ -47,10 +58,34 @@ protected function setUp()
 	public function fetchUrlData()
 	{
 		return array(
-			'Standard github - no pagination data' => array('https://api.github.com', '/gists', 0, 0, 'https://api.github.com/gists'),
-			'Enterprise github - no pagination data' => array('https://mygithub.com', '/gists', 0, 0, 'https://mygithub.com/gists'),
-			'Standard github - page 3' => array('https://api.github.com', '/gists', 3, 0, 'https://api.github.com/gists?page=3'),
-			'Enterprise github - page 3, 50 per page' => array('https://mygithub.com', '/gists', 3, 50, 'https://mygithub.com/gists?page=3&per_page=50'),
+			'Standard github - no pagination data'    => array(
+				'https://api.github.com',
+				'/gists',
+				0,
+				0,
+				'https://api.github.com/gists'
+			),
+			'Enterprise github - no pagination data'  => array(
+				'https://mygithub.com',
+				'/gists',
+				0,
+				0,
+				'https://mygithub.com/gists'
+			),
+			'Standard github - page 3'                => array(
+				'https://api.github.com',
+				'/gists',
+				3,
+				0,
+				'https://api.github.com/gists?page=3'
+			),
+			'Enterprise github - page 3, 50 per page' => array(
+				'https://mygithub.com',
+				'/gists',
+				3,
+				50,
+				'https://mygithub.com/gists?page=3&per_page=50'
+			),
 		);
 	}
 
@@ -72,9 +107,10 @@ public function testFetchUrl($apiUrl, $path, $page, $limit, $expected)
 	{
 		$this->options->set('api.url', $apiUrl);
 
-		$this->assertThat(
+		self::assertEquals(
+			$expected,
 			$this->object->fetchUrl($path, $page, $limit),
-			$this->equalTo($expected)
+			'URL is not as expected.'
 		);
 	}
 
@@ -92,9 +128,10 @@ public function testFetchUrlBasicAuth()
 		$this->options->set('api.username', 'MyTestUser');
 		$this->options->set('api.password', 'MyTestPass');
 
-		$this->assertThat(
+		self::assertEquals(
+			'https://MyTestUser:MyTestPass@api.github.com/gists',
 			$this->object->fetchUrl('/gists', 0, 0),
-			$this->equalTo('https://MyTestUser:MyTestPass@api.github.com/gists')
+			'URL is not as expected.'
 		);
 	}
 
@@ -109,9 +146,16 @@ public function testFetchUrlToken()
 
 		$this->options->set('gh.token', 'MyTestToken');
 
-		$this->assertThat(
+		self::assertEquals(
+			'https://api.github.com/gists',
 			$this->object->fetchUrl('/gists', 0, 0),
-			$this->equalTo('https://api.github.com/gists?access_token=MyTestToken')
+			'URL is not as expected.'
+		);
+
+		self::assertEquals(
+			array('Authorization' => 'token MyTestToken'),
+			$this->client->getOption('headers'),
+			'Token should be propagated as a header.'
 		);
 	}
 }
diff --git a/Tests/bootstrap.php b/Tests/bootstrap.php
@@ -0,0 +1,6 @@
+<?php
+require_once 'vendor/autoload.php';
+
+// Turn off E_DEPRECATED caused by outdated PHPUnit
+$errorReporting = error_reporting();
+error_reporting($errorReporting & ~E_DEPRECATED);
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php" colors="false">
+<phpunit bootstrap="Tests/bootstrap.php" colors="false">
 	<testsuites>
 		<testsuite name="Unit">
 			<directory>Tests</directory>
diff --git a/src/AbstractGithubObject.php b/src/AbstractGithubObject.php
@@ -32,7 +32,7 @@ abstract class AbstractGithubObject
 	/**
 	 * The HTTP client object to use in sending HTTP requests.
 	 *
-	 * @var    Http
+	 * @var    BaseHttp
 	 * @since  1.0
 	 */
 	protected $client;
@@ -89,7 +89,19 @@ abstract class AbstractGithubObject
 	public function __construct(Registry $options = null, BaseHttp $client = null)
 	{
 		$this->options = $options ?: new Registry;
-		$this->client  = $client ?: new Http($this->options);
+		$this->client  = $client ?: new BaseHttp($this->options);
+
+		// Make sure the user agent string is defined.
+		if (!isset($this->options['userAgent']))
+		{
+			$this->options['userAgent'] = 'JGitHub/2.0';
+		}
+
+		// Set the default timeout to 120 seconds.
+		if (!isset($this->options['timeout']))
+		{
+			$this->options['timeout'] = 120;
+		}
 
 		$this->package = \get_class($this);
 		$this->package = substr($this->package, strrpos($this->package, '\\') + 1);
@@ -116,8 +128,14 @@ protected function fetchUrl($path, $page = 0, $limit = 0)
 
 		if ($this->options->get('gh.token', false))
 		{
-			// Use oAuth authentication - @todo set in request header ?
-			$uri->setVar('access_token', $this->options->get('gh.token'));
+			// Use oAuth authentication
+			$headers = $this->client->getOption('headers', array());
+
+			if (!isset($headers['Authorization']))
+			{
+				$headers['Authorization'] = 'token ' . $this->options->get('gh.token');
+				$this->client->setOption('headers', $headers);
+			}
 		}
 		else
 		{
