Merge pull request #63 from php-api-clients/fetch-check-runs

Basic check (runs) support

Author: WyriHaximus

examples/user-repositories-commit-checks-async.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types=1);
+use ApiClients\Client\Github\AsyncClient;
+use ApiClients\Client\Github\Resource\Async\Repository;
+use ApiClients\Client\Github\Resource\Async\User;
+use function ApiClients\Foundation\resource_pretty_print;
+use React\EventLoop\Factory;
+
+require \dirname(__DIR__) . \DIRECTORY_SEPARATOR . 'vendor/autoload.php';
+
+$loop = Factory::create();
+
+$client = AsyncClient::create($loop, require 'resolve_token.php');
+
+$client->user($argv[1] ?? 'php-api-clients')->then(function (User $user) use ($argv) {
+    resource_pretty_print($user);
+
+    return $user->repository($argv[2] ?? 'github');
+})->then(function (Repository $repository) {
+    resource_pretty_print($repository, 1, true);
+    $repository->commits()->take(1)->flatMap(function (Repository\Commit $commit) {
+        resource_pretty_print($commit, 2, true);
+
+        return $commit->checks();
+    })->subscribe(function (Repository\Commit\Check $check) {
+        resource_pretty_print($check, 3, true);
+    }, 'display_throwable');
+})->done(null, 'display_throwable');
+
+$loop->run();
+
+displayState($client->getRateLimitState());

src/AcceptHeader.php

@@ -5,6 +5,7 @@
 final class AcceptHeader
 {
     const PRESET_DEFAULT = [
+        self::CHECK_RUNS,
         self::LICENSE,
         self::TOPICS,
         self::DEFAULT,
@@ -27,6 +28,9 @@ final class AcceptHeader
     // Topics on repository object: https://developer.github.com/v3/repos/#repositories
     const TOPICS = 'application/vnd.github.mercy-preview+json';
 
+    // Topics on repository object: https://developer.github.com/v3/repos/#repositories
+    const CHECK_RUNS = 'application/vnd.github.antiope-preview+json';
+
     public static function getHeader(array $chunks): string
     {
         return \implode('; ', $chunks);

src/CommandBus/Command/Repository/Commit/ChecksCommand.php

@@ -0,0 +1,33 @@
+<?php declare(strict_types=1);
+
+namespace ApiClients\Client\Github\CommandBus\Command\Repository\Commit;
+
+use ApiClients\Client\Github\Resource\Async\Repository\Commit;
+use WyriHaximus\Tactician\CommandHandler\Annotations\Handler;
+
+/**
+ * @Handler("ApiClients\Client\Github\CommandBus\Handler\Repository\Commit\ChecksHandler")
+ */
+final class ChecksCommand
+{
+    /**
+     * @var Commit
+     */
+    private $commit;
+
+    /**
+     * @param Commit $commit
+     */
+    public function __construct(Commit $commit)
+    {
+        $this->commit = $commit;
+    }
+
+    /**
+     * @return Commit
+     */
+    public function getCommit(): Commit
+    {
+        return $this->commit;
+    }
+}

src/CommandBus/Handler/Repository/Commit/ChecksHandler.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types=1);
+
+namespace ApiClients\Client\Github\CommandBus\Handler\Repository\Commit;
+
+use ApiClients\Client\Github\CommandBus\Command\Repository\Commit\ChecksCommand;
+use ApiClients\Client\Github\CommandBus\Command\Repository\Commit\StatusesCommand;
+use ApiClients\Client\Github\Resource\Repository\Commit\CheckInterface;
+use ApiClients\Client\Github\Resource\Repository\Commit\StatusInterface;
+use ApiClients\Client\Github\Service\IteratePagesService;
+use ApiClients\Foundation\Hydrator\Hydrator;
+use ApiClients\Tools\Services\Client\FetchAndIterateService;
+use function ApiClients\Tools\Rx\observableFromArray;
+use React\Promise\PromiseInterface;
+use function React\Promise\resolve;
+
+final class ChecksHandler
+{
+    /**
+     * @var FetchAndIterateService
+     */
+    private $fetchAndIterateService;
+
+    /**
+     * @var Hydrator
+     */
+    private $hydrator;
+
+    /**
+     * @param FetchAndIterateService $fetchAndIterateService
+     * @param Hydrator            $hydrator
+     */
+    public function __construct(FetchAndIterateService $fetchAndIterateService, Hydrator $hydrator)
+    {
+        $this->fetchAndIterateService = $fetchAndIterateService;
+        $this->hydrator = $hydrator;
+    }
+
+    /**
+     * @param  ChecksCommand  $command
+     * @return PromiseInterface
+     */
+    public function handle(ChecksCommand $command): PromiseInterface
+    {
+        return resolve(
+            $this->fetchAndIterateService->iterate(
+                $command->getCommit()->url() . '/check-runs',
+                'check_runs',
+                CheckInterface::HYDRATE_CLASS
+            )
+        );
+    }
+}

src/Resource/Async/Repository/Commit.php

@@ -3,6 +3,7 @@
 namespace ApiClients\Client\Github\Resource\Async\Repository;
 
 use ApiClients\Client\Github\CommandBus\Command\RefreshCommand;
+use ApiClients\Client\Github\CommandBus\Command\Repository\Commit\ChecksCommand;
 use ApiClients\Client\Github\CommandBus\Command\Repository\Commit\CreateStatusCommand;
 use ApiClients\Client\Github\CommandBus\Command\Repository\Commit\StatusCommand;
 use ApiClients\Client\Github\CommandBus\Command\Repository\Commit\StatusesCommand;
@@ -34,6 +35,13 @@ public function statuses(): ObservableInterface
         ));
     }
 
+    public function checks(): ObservableInterface
+    {
+        return unwrapObservableFromPromise($this->handleCommand(
+            new ChecksCommand($this)
+        ));
+    }
+
     public function createStatus(string $state, ?string $targetUrl = null, ?string $description = null, ?string $context = null): PromiseInterface
     {
         return $this->handleCommand(

src/Resource/Async/Repository/Commit/Check.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace ApiClients\Client\Github\Resource\Async\Repository\Commit;
+
+use ApiClients\Client\Github\Resource\Repository\Commit\Check as BaseCheck;
+
+class Check extends BaseCheck
+{
+    public function refresh(): Check
+    {
+        throw new \Exception('TODO: create refresh method!');
+    }
+}

src/Resource/Async/Repository/Commit/EmptyCheck.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace ApiClients\Client\Github\Resource\Async\Repository\Commit;
+
+use ApiClients\Client\Github\Resource\Repository\Commit\EmptyCheck as BaseEmptyCheck;
+
+class EmptyCheck extends BaseEmptyCheck
+{
+}