Merge pull request #54 from jwage/github-auth

Add support for authentication when making requests to GitHub API.

README.md

@@ -161,3 +161,49 @@ return [
     ,
 ];
 ```
+
+## GitHub Authentication
+
+By default it is not required to authenticate with GitHub to use this tool. But if you want
+higher rate limits or want to use it with private repositories then you will need to authenticate.
+
+### Personal Credentials
+
+You can authenticate with your `username` and `password` or a personal access token
+instead of your password using the `ChangelogGenerator\GitHubUsernamePassword` class:
+
+```php
+<?php
+
+declare(strict_types=1);
+
+use ChangelogGenerator\ChangelogConfig;
+use ChangelogGenerator\GitHubUsernamePassword;
+
+return [
+    'changelog-generator' => (new ChangelogConfig())
+        // ...
+        ->setGitHubCredentials(new GitHubUsernamePassword('username', 'passwordOrToken'))
+    ,
+];
+```
+
+### OAuth Token
+
+You can authenticate with an OAuth token as well using the `ChangelogGenerator\GitHubOAuthToken` class:
+
+```php
+<?php
+
+declare(strict_types=1);
+
+use ChangelogGenerator\ChangelogConfig;
+use ChangelogGenerator\GitHubOAuthToken;
+
+return [
+    'changelog-generator' => (new ChangelogConfig())
+        // ...
+        ->setGitHubCredentials(new GitHubOAuthToken('the oauth token'))
+    ,
+];
+```

src/ChangelogGenerator/ChangelogConfig.php

@@ -31,6 +31,9 @@ class ChangelogConfig
     /** @var bool */
     private $showContributors = false;
 
+    /** @var GitHubCredentials|null */
+    private $gitHubCredentials;
+
     /** @var mixed[] */
     private $options = ['rootGitHubUrl' => self::DEFAULT_ROOT_GITHUB_URL];
 
@@ -132,6 +135,18 @@ public function setShowContributors(bool $showContributors) : self
         return $this;
     }
 
+    public function getGitHubCredentials() : ?GitHubCredentials
+    {
+        return $this->gitHubCredentials;
+    }
+
+    public function setGitHubCredentials(GitHubCredentials $gitHubCredentials) : self
+    {
+        $this->gitHubCredentials = $gitHubCredentials;
+
+        return $this;
+    }
+
     /**
      * @return mixed[]
      */

src/ChangelogGenerator/GitHubCredentials.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ChangelogGenerator;
+
+interface GitHubCredentials
+{
+    public function getAuthorizationHeader() : string;
+}

src/ChangelogGenerator/GitHubOAuthToken.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ChangelogGenerator;
+
+use function sprintf;
+
+final class GitHubOAuthToken implements GitHubCredentials
+{
+    /** @var string */
+    private $oAuthToken;
+
+    public function __construct(string $oAuthToken)
+    {
+        $this->oAuthToken = $oAuthToken;
+    }
+
+    public function getAuthorizationHeader() : string
+    {
+        return sprintf('token %s', $this->oAuthToken);
+    }
+}

src/ChangelogGenerator/GitHubUsernamePassword.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ChangelogGenerator;
+
+use function base64_encode;
+use function sprintf;
+
+final class GitHubUsernamePassword implements GitHubCredentials
+{
+    /** @var string */
+    private $username;
+
+    /** @var string */
+    private $passwordOrToken;
+
+    public function __construct(string $username, string $passwordOrToken)
+    {
+        $this->username        = $username;
+        $this->passwordOrToken = $passwordOrToken;
+    }
+
+    public function getAuthorizationHeader() : string
+    {
+        return sprintf('Basic %s', base64_encode(sprintf('%s:%s', $this->username, $this->passwordOrToken)));
+    }
+}

src/ChangelogGenerator/IssueClient.php

@@ -7,8 +7,10 @@
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
 use Psr\Http\Message\ResponseInterface;
+use RuntimeException;
 use function json_decode;
 use function preg_match;
+use function sprintf;
 
 class IssueClient
 {
@@ -26,12 +28,21 @@ public function __construct(
         $this->client         = $client;
     }
 
-    public function execute(string $url) : IssueClientResponse
-    {
+    public function execute(
+        string $url,
+        ?GitHubCredentials $gitHubCredentials = null
+    ) : IssueClientResponse {
         $request = $this->messageFactory
             ->createRequest('GET', $url)
             ->withAddedHeader('User-Agent', 'jwage/changelog-generator');
 
+        if ($gitHubCredentials !== null) {
+            $request = $request->withAddedHeader(
+                'Authorization',
+                $gitHubCredentials->getAuthorizationHeader()
+            );
+        }
+
         $response = $this->client->sendRequest($request);
 
         $responseBody = $response
@@ -40,6 +51,16 @@ public function execute(string $url) : IssueClientResponse
 
         $body = json_decode($responseBody, true);
 
+        $statusCode = $response->getStatusCode();
+
+        if ($statusCode !== 200) {
+            throw new RuntimeException(sprintf(
+                'API call to GitHub failed with status code %d%s',
+                $statusCode,
+                isset($body['message']) ? sprintf(' and message "%s"', $body['message']) : ''
+            ));
+        }
+
         return new IssueClientResponse($body, $this->getNextUrl($response));
     }
 

src/ChangelogGenerator/IssueFetcher.php

@@ -30,7 +30,7 @@ public function fetchMilestoneIssues(ChangelogConfig $changelogConfig) : array
             $url = $changelogConfig->getMilestoneIssuesUrl($label);
 
             while (true) {
-                $response = $this->issueClient->execute($url);
+                $response = $this->issueClient->execute($url, $changelogConfig->getGitHubCredentials());
 
                 $body = $response->getBody();
 

tests/ChangelogGenerator/Tests/ChangelogConfigTest.php

@@ -5,6 +5,8 @@
 namespace ChangelogGenerator\Tests;
 
 use ChangelogGenerator\ChangelogConfig;
+use ChangelogGenerator\GitHubCredentials;
+use ChangelogGenerator\GitHubUsernamePassword;
 use PHPUnit\Framework\TestCase;
 
 final class ChangelogConfigTest extends TestCase
@@ -140,6 +142,20 @@ public function testIsValid() : void
         self::assertFalse($changelogConfig->isValid());
     }
 
+    public function testGetSetGitHubCredentials() : void
+    {
+        self::assertNull($this->changelogConfig->getGitHubCredentials());
+
+        $expectedGitHubCredentials = new GitHubUsernamePassword('username', 'password');
+
+        $this->changelogConfig->setGitHubCredentials($expectedGitHubCredentials);
+
+        /** @var GitHubCredentials $gitHubCredentials */
+        $gitHubCredentials = $this->changelogConfig->getGitHubCredentials();
+
+        self::assertSame($expectedGitHubCredentials, $gitHubCredentials);
+    }
+
     protected function setUp() : void
     {
         $this->user       = 'jwage';

tests/ChangelogGenerator/Tests/GitHubOAuthTokenTest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ChangelogGenerator\Tests;
+
+use ChangelogGenerator\GitHubOAuthToken;
+use PHPUnit\Framework\TestCase;
+
+final class GitHubOAuthTokenTest extends TestCase
+{
+    public function testGetHttpBasicAuthorization() : void
+    {
+        self::assertSame(
+            'token oauthtoken',
+            (new GitHubOAuthToken('oauthtoken'))->getAuthorizationHeader()
+        );
+    }
+}

tests/ChangelogGenerator/Tests/GitHubUsernamePasswordTest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ChangelogGenerator\Tests;
+
+use ChangelogGenerator\GitHubUsernamePassword;
+use PHPUnit\Framework\TestCase;
+
+final class GitHubUsernamePasswordTest extends TestCase
+{
+    public function testGetHttpBasicAuthorization() : void
+    {
+        self::assertSame(
+            'Basic dXNlcm5hbWU6cGFzc3dvcmQ=',
+            (new GitHubUsernamePassword('username', 'password'))->getAuthorizationHeader()
+        );
+    }
+}