Provide access_token in header instead of URI

Author: nibra

.gitignore

@@ -2,3 +2,4 @@ vendor/
 composer.phar
 composer.lock
 phpunit.xml
+build/

Tests/GithubObjectTest.php

@@ -72,9 +72,14 @@ public function testFetchUrl($apiUrl, $path, $page, $limit, $expected)
 	{
 		$this->options->set('api.url', $apiUrl);
 
-		$this->assertThat(
-			$this->object->fetchUrl($path, $page, $limit),
-			$this->equalTo($expected)
+		self::assertEquals(
+			$expected,
+			$this->object->fetchUrl($path, $page, $limit)
+		);
+
+		self::assertEquals(
+			array(),
+			$this->object->authHeader()
 		);
 	}
 
@@ -109,9 +114,14 @@ public function testFetchUrlToken()
 
 		$this->options->set('gh.token', 'MyTestToken');
 
-		$this->assertThat(
-			$this->object->fetchUrl('/gists', 0, 0),
-			$this->equalTo('https://api.github.com/gists?access_token=MyTestToken')
+		self::assertEquals(
+			'https://api.github.com/gists',
+			$this->object->fetchUrl('/gists', 0, 0)
+		);
+
+		self::assertEquals(
+			array('Authorization: MyTestToken'),
+			$this->object->authHeader()
 		);
 	}
 }

Tests/Stub/ObjectMock.php

@@ -32,4 +32,21 @@ public function fetchUrl($path, $page = 0, $limit = 0)
 	{
 		return parent::fetchUrl($path, $page, $limit);
 	}
+
+	/**
+	 * Returns the Authorization header, if required.
+	 *
+	 * If the options passed to the constructor contain a value for `gh.token`,
+	 * an array with a suitable Authorization header is returned, an empty array
+	 * otherwise.
+	 *
+	 * @return  array    Authorization header if set in options.
+	 *
+	 * @since   1.8.0
+	 */
+	public function authHeader()
+	{
+		return parent::authHeader();
+	}
+
 }

src/AbstractGithubObject.php

@@ -114,12 +114,7 @@ protected function fetchUrl($path, $page = 0, $limit = 0)
 		// Get a new Uri object focusing the api url and given path.
 		$uri = new Uri($this->options->get('api.url') . $path);
 
-		if ($this->options->get('gh.token', false))
-		{
-			// Use oAuth authentication - @todo set in request header ?
-			$uri->setVar('access_token', $this->options->get('gh.token'));
-		}
-		else
+		if (!$this->options->get('gh.token', false))
 		{
 			// Use basic authentication
 			if ($this->options->get('api.username', false))
@@ -136,16 +131,37 @@ protected function fetchUrl($path, $page = 0, $limit = 0)
 		// If we have a defined page number add it to the JUri object.
 		if ($page > 0)
 		{
-			$uri->setVar('page', (int) $page);
+			$uri->setVar('page', (int)$page);
 		}
 
 		// If we have a defined items per page add it to the JUri object.
 		if ($limit > 0)
 		{
-			$uri->setVar('per_page', (int) $limit);
+			$uri->setVar('per_page', (int)$limit);
 		}
 
-		return (string) $uri;
+		return (string)$uri;
+	}
+
+	/**
+	 * Returns the Authorization header, if required.
+	 *
+	 * If the options passed to the constructor contain a value for `gh.token`,
+	 * an array with a suitable Authorization header is returned, an empty array
+	 * otherwise.
+	 *
+	 * @return  array    Authorization header if set in options.
+	 *
+	 * @since   1.8.0
+	 */
+	protected function authHeader()
+	{
+		if ($this->options->get('gh.token', false))
+		{
+			return array('Authorization: ' . $this->options->get('gh.token'));
+		}
+
+		return array();
 	}
 
 	/**
@@ -156,8 +172,8 @@ protected function fetchUrl($path, $page = 0, $limit = 0)
 	 *
 	 * @return  mixed
 	 *
-	 * @since   1.0
 	 * @throws  UnexpectedResponseException
+	 * @since   1.0
 	 */
 	protected function processResponse(Response $response, $expectedCode = 200)
 	{