Feat #7: Support fetching branch data using GitHub API V4

spec/V4/Repository/BranchApiSpec.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\DevboardLib\GitHubApi\V4\Repository;
+
+use DevboardLib\GitHubApi\V3\GitHubClientFactory;
+use DevboardLib\GitHubApi\V4\Repository\BranchApi;
+use DevboardLib\GitHubApi\V4\Repository\Factory\BranchFactory;
+use PhpSpec\ObjectBehavior;
+
+class BranchApiSpec extends ObjectBehavior
+{
+    public function let(GitHubClientFactory $clientFactory, BranchFactory $branchFactory)
+    {
+        $this->beConstructedWith($clientFactory, $branchFactory);
+    }
+
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(BranchApi::class);
+    }
+}

spec/V4/Repository/Factory/BranchFactorySpec.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\DevboardLib\GitHubApi\V4\Repository\Factory;
+
+use DevboardLib\GitHubApi\V4\Repository\Factory\BranchFactory;
+use DevboardLib\GitHubApi\V4\Repository\Factory\CommitFactory;
+use PhpSpec\ObjectBehavior;
+
+class BranchFactorySpec extends ObjectBehavior
+{
+    public function let(CommitFactory $commitFactory)
+    {
+        $this->beConstructedWith($commitFactory);
+    }
+
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(BranchFactory::class);
+    }
+}

spec/V4/Repository/Factory/Commit/CommitAuthorFactorySpec.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\DevboardLib\GitHubApi\V4\Repository\Factory\Commit;
+
+use DevboardLib\GitHubApi\V4\Repository\Factory\Commit\CommitAuthorFactory;
+use PhpSpec\ObjectBehavior;
+
+class CommitAuthorFactorySpec extends ObjectBehavior
+{
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(CommitAuthorFactory::class);
+    }
+}

spec/V4/Repository/Factory/Commit/CommitCommitterFactorySpec.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\DevboardLib\GitHubApi\V4\Repository\Factory\Commit;
+
+use DevboardLib\GitHubApi\V4\Repository\Factory\Commit\CommitCommitterFactory;
+use PhpSpec\ObjectBehavior;
+
+class CommitCommitterFactorySpec extends ObjectBehavior
+{
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(CommitCommitterFactory::class);
+    }
+}

spec/V4/Repository/Factory/CommitFactorySpec.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\DevboardLib\GitHubApi\V4\Repository\Factory;
+
+use DevboardLib\GitHubApi\V4\Repository\Factory\Commit\CommitAuthorFactory;
+use DevboardLib\GitHubApi\V4\Repository\Factory\Commit\CommitCommitterFactory;
+use DevboardLib\GitHubApi\V4\Repository\Factory\CommitFactory;
+use PhpSpec\ObjectBehavior;
+
+class CommitFactorySpec extends ObjectBehavior
+{
+    public function let(CommitCommitterFactory $committerFactory, CommitAuthorFactory $authorFactory)
+    {
+        $this->beConstructedWith($committerFactory, $authorFactory);
+    }
+
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(CommitFactory::class);
+    }
+}

src/V4/Repository/BranchApi.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DevboardLib\GitHubApi\V4\Repository;
+
+use DevboardLib\GitHub\GitHubBranch;
+use DevboardLib\GitHub\Installation\InstallationId;
+use DevboardLib\GitHub\Repo\RepoFullName;
+use DevboardLib\GitHub\User\UserId;
+use DevboardLib\GitHubApi\V3\GitHubClientFactory;
+use DevboardLib\GitHubApi\V4\Repository\Factory\BranchFactory;
+
+class BranchApi
+{
+    /** @var GitHubClientFactory */
+    private $clientFactory;
+
+    /**
+     * @var BranchFactory
+     */
+    private $branchFactory;
+
+    public function __construct(GitHubClientFactory $clientFactory, BranchFactory $branchFactory)
+    {
+        $this->clientFactory = $clientFactory;
+        $this->branchFactory = $branchFactory;
+    }
+
+    /** @return array|GitHubBranch[] */
+    public function getBranches(RepoFullName $repoFullName, InstallationId $installationId, UserId $githubUserId): array
+    {
+        $data = $this->getRawBranches($repoFullName, $installationId, $githubUserId);
+
+        $results = [];
+
+        foreach ($data['data']['repository']['refs']['edges'] as $item) {
+            $results[] = $this->branchFactory->createFromBranchData($repoFullName, $item['node']);
+        }
+
+        return $results;
+    }
+
+    public function getRawBranches(RepoFullName $repoFullName, InstallationId $installationId, UserId $githubUserId)
+    {
+        $query = file_get_contents(__DIR__.'/branches.graphql');
+
+        $variables = [
+            'owner' => $repoFullName->getOwner()->getValue(),
+            'name'  => $repoFullName->getRepoName()->getValue(),
+        ];
+        $client = $this->clientFactory->createAppAndUserAuthenticatedClient($installationId, $githubUserId);
+
+        $data = $client->graphql()->execute($query, $variables);
+
+        return $data;
+    }
+}

src/V4/Repository/Factory/BranchFactory.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DevboardLib\GitHubApi\V4\Repository\Factory;
+
+use DevboardLib\Git\Branch\BranchName;
+use DevboardLib\GitHub\GitHubBranch;
+use DevboardLib\GitHub\Repo\RepoFullName;
+
+class BranchFactory
+{
+    /** @var CommitFactory */
+    private $commitFactory;
+
+    public function __construct(CommitFactory $commitFactory)
+    {
+        $this->commitFactory = $commitFactory;
+    }
+
+    public function createFromBranchData(RepoFullName $repoFullName, array $data): GitHubBranch
+    {
+        return new GitHubBranch(
+            $repoFullName,
+            new BranchName($data['name']),
+            $this->commitFactory->createFromBranchData($data['target'])
+        );
+    }
+}

src/V4/Repository/Factory/Commit/CommitAuthorFactory.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DevboardLib\GitHubApi\V4\Repository\Factory\Commit;
+
+use DevboardLib\Generix\EmailAddress;
+use DevboardLib\Git\Commit\Author\AuthorName;
+use DevboardLib\Git\Commit\CommitDate;
+use DevboardLib\GitHub\Account\AccountType;
+use DevboardLib\GitHub\Commit\CommitAuthor;
+use DevboardLib\GitHub\Commit\CommitAuthorDetails;
+use DevboardLib\GitHub\User\UserApiUrl;
+use DevboardLib\GitHub\User\UserAvatarUrl;
+use DevboardLib\GitHub\User\UserHtmlUrl;
+use DevboardLib\GitHub\User\UserId;
+use DevboardLib\GitHub\User\UserLogin;
+
+/**
+ * @see CommitAuthorFactorySpec
+ * @see CommitAuthorFactoryTest
+ */
+class CommitAuthorFactory
+{
+    public function createFromBranchData(array $data): CommitAuthor
+    {
+        if (null === $data['user']) {
+            $authorDetails = null;
+        } else {
+            $authorDetails = new CommitAuthorDetails(
+                new UserId((int) $data['user']['id']),
+                new UserLogin($data['user']['login']),
+                new AccountType($data['user']['__typename']),
+                new UserAvatarUrl($data['user']['avatarUrl']),
+                null,
+                new UserHtmlUrl('TODO'),
+                new UserApiUrl('TODO'),
+                $data['user']['isSiteAdmin']
+            );
+        }
+
+        return new CommitAuthor(
+            new AuthorName($data['name']),
+            new EmailAddress($data['email']),
+            new CommitDate($data['date']),
+            $authorDetails
+        );
+    }
+}

src/V4/Repository/Factory/Commit/CommitCommitterFactory.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DevboardLib\GitHubApi\V4\Repository\Factory\Commit;
+
+use DevboardLib\Generix\EmailAddress;
+use DevboardLib\Git\Commit\CommitDate;
+use DevboardLib\Git\Commit\Committer\CommitterName;
+use DevboardLib\GitHub\Account\AccountType;
+use DevboardLib\GitHub\Commit\CommitCommitter;
+use DevboardLib\GitHub\Commit\CommitCommitterDetails;
+use DevboardLib\GitHub\User\UserApiUrl;
+use DevboardLib\GitHub\User\UserAvatarUrl;
+use DevboardLib\GitHub\User\UserHtmlUrl;
+use DevboardLib\GitHub\User\UserId;
+use DevboardLib\GitHub\User\UserLogin;
+
+/**
+ * @see CommitCommitterFactorySpec
+ * @see CommitCommitterFactoryTest
+ */
+class CommitCommitterFactory
+{
+    public function createFromBranchData(array $data): CommitCommitter
+    {
+        if (null === $data['user']) {
+            $committerDetails = null;
+        } else {
+            $committerDetails = new CommitCommitterDetails(
+                new UserId((int) $data['user']['id']),
+                new UserLogin($data['user']['login']),
+                new AccountType($data['user']['__typename']),
+                new UserAvatarUrl($data['user']['avatarUrl']),
+                null,
+                new UserHtmlUrl('TODO'),
+                new UserApiUrl('TODO'),
+                $data['user']['isSiteAdmin']
+            );
+        }
+
+        return new CommitCommitter(
+            new CommitterName($data['name']),
+            new EmailAddress($data['email']),
+            new CommitDate($data['date']),
+            $committerDetails
+        );
+    }
+}

src/V4/Repository/Factory/CommitFactory.php

@@ -0,0 +1,103 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DevboardLib\GitHubApi\V4\Repository\Factory;
+
+use DevboardLib\Git\Commit\CommitDate;
+use DevboardLib\Git\Commit\CommitMessage;
+use DevboardLib\Git\Commit\CommitSha;
+use DevboardLib\GitHub\Commit\CommitApiUrl;
+use DevboardLib\GitHub\Commit\CommitHtmlUrl;
+use DevboardLib\GitHub\Commit\CommitParent;
+use DevboardLib\GitHub\Commit\CommitParentCollection;
+use DevboardLib\GitHub\Commit\CommitTree;
+use DevboardLib\GitHub\Commit\CommitVerification;
+use DevboardLib\GitHub\Commit\Tree\TreeApiUrl;
+use DevboardLib\GitHub\Commit\Verification\VerificationPayload;
+use DevboardLib\GitHub\Commit\Verification\VerificationReason;
+use DevboardLib\GitHub\Commit\Verification\VerificationSignature;
+use DevboardLib\GitHub\Commit\Verification\VerificationVerified;
+use DevboardLib\GitHub\GitHubCommit;
+use DevboardLib\GitHubApi\V4\Repository\Factory\Commit\CommitAuthorFactory;
+use DevboardLib\GitHubApi\V4\Repository\Factory\Commit\CommitCommitterFactory;
+
+/**
+ * @see CommitFactorySpec
+ * @see CommitFactoryTest
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
+class CommitFactory
+{
+    /** @var CommitCommitterFactory */
+    private $committerFactory;
+
+    /** @var CommitAuthorFactory */
+    private $authorFactory;
+
+    public function __construct(CommitCommitterFactory $commitCommitterFactory, CommitAuthorFactory $authorFactory)
+    {
+        $this->committerFactory = $commitCommitterFactory;
+        $this->authorFactory    = $authorFactory;
+    }
+
+    public function createFromBranchData(array $data): GitHubCommit
+    {
+        if (true === array_key_exists('verification', $data)) {
+            $verification = $this->createVerification($data['verification']);
+        } else {
+            $verification = null;
+        }
+
+        return new GitHubCommit(
+            new CommitSha($data['oid']),
+            new CommitMessage($data['message']),
+            new CommitDate($data['authoredDate']),
+            $this->authorFactory->createFromBranchData($data['author']),
+            $this->committerFactory->createFromBranchData($data['committer']),
+            new CommitTree(new CommitSha($data['tree']['oid']), new TreeApiUrl('TODO')),
+            $this->createParentCollection($data['parents']['edges']),
+            $verification,
+            new CommitApiUrl('TODO'),
+            new CommitHtmlUrl('TODO')
+        );
+    }
+
+    private function createVerification(array $data): CommitVerification
+    {
+        if (null !== $data['signature']) {
+            $signature = new VerificationSignature($data['signature']);
+        } else {
+            $signature = null;
+        }
+        if (null !== $data['payload']) {
+            $payload = new VerificationPayload($data['payload']);
+        } else {
+            $payload = null;
+        }
+
+        return new CommitVerification(
+            new VerificationVerified($data['verified']),
+            new VerificationReason($data['reason']),
+            $signature,
+            $payload
+        );
+    }
+
+    private function createParentCollection(array $data): CommitParentCollection
+    {
+        $commitParentCollection = new CommitParentCollection();
+
+        foreach ($data as $parentData) {
+            $parent = new CommitParent(
+                new CommitSha($parentData['node']['oid']),
+                new CommitParent\ParentApiUrl('TODO'),
+                new CommitParent\ParentHtmlUrl($parentData['node']['commitUrl'])
+            );
+
+            $commitParentCollection->add($parent);
+        }
+
+        return $commitParentCollection;
+    }
+}