Basic client with meta method

Author: WyriHaximus

examples/meta-async.php

@@ -0,0 +1,17 @@
+<?php declare(strict_types=1);
+
+use ApiClients\Client\Scrutinizer\AsyncClient;
+use ApiClients\Client\Scrutinizer\Resource\MetaInterface;
+use React\EventLoop\Factory;
+use function ApiClients\Foundation\resource_pretty_print;
+
+require dirname(__DIR__) . DIRECTORY_SEPARATOR . 'vendor/autoload.php';
+
+$loop = Factory::create();
+$client = AsyncClient::create($loop);
+
+$client->meta()->done(function (MetaInterface $meta) {
+    resource_pretty_print($meta);
+});
+
+$loop->run();

examples/meta.php

@@ -0,0 +1,11 @@
+<?php declare(strict_types=1);
+
+use ApiClients\Client\Scrutinizer\Client;
+use function ApiClients\Foundation\resource_pretty_print;
+
+require dirname(__DIR__) . DIRECTORY_SEPARATOR . 'vendor/autoload.php';
+
+$client = Client::create();
+
+$meta = $client->meta();
+resource_pretty_print($meta);

src/ApiSettings.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiClients\Client\Scrutinizer;
+
+use ApiClients\Foundation\Hydrator\Options as HydratorOptions;
+use ApiClients\Foundation\Options as FoundationOptions;
+use ApiClients\Foundation\Transport\Options as TransportOptions;
+use ApiClients\Middleware\HttpExceptions\HttpExceptionsMiddleware;
+use ApiClients\Middleware\Json\JsonDecodeMiddleware;
+use ApiClients\Middleware\Json\JsonEncodeMiddleware;
+use ApiClients\Middleware\UserAgent\Options as UserAgentMiddlewareOptions;
+use ApiClients\Middleware\UserAgent\UserAgentMiddleware;
+use ApiClients\Middleware\UserAgent\UserAgentStrategies;
+use function ApiClients\Foundation\options_merge;
+
+final class ApiSettings
+{
+    const NAMESPACE = 'ApiClients\\Client\\Scrutinizer\\Resource';
+    const TRANSPORT_OPTIONS = [
+        FoundationOptions::HYDRATOR_OPTIONS => [
+            HydratorOptions::NAMESPACE => self::NAMESPACE,
+            HydratorOptions::NAMESPACE_DIR => __DIR__ . DIRECTORY_SEPARATOR . 'Resource' . DIRECTORY_SEPARATOR,
+        ],
+        FoundationOptions::TRANSPORT_OPTIONS => [
+            TransportOptions::HOST => 'scrutinizer-ci.com',
+            TransportOptions::PATH => '/api/',
+            TransportOptions::MIDDLEWARE => [
+                HttpExceptionsMiddleware::class,
+                UserAgentMiddleware::class,
+                JsonDecodeMiddleware::class,
+                JsonEncodeMiddleware::class,
+            ],
+            TransportOptions::DEFAULT_REQUEST_OPTIONS => [
+                UserAgentMiddleware::class => [
+                    UserAgentMiddlewareOptions::STRATEGY => UserAgentStrategies::PACKAGE_VERSION,
+                    UserAgentMiddlewareOptions::PACKAGE => 'api-clients/scrutinizer',
+                ],
+            ],
+        ],
+    ];
+
+    public static function getOptions(array $suppliedOptions, string $suffix): array
+    {
+        $options = options_merge(self::TRANSPORT_OPTIONS, $suppliedOptions);
+        $options[FoundationOptions::HYDRATOR_OPTIONS][HydratorOptions::NAMESPACE_SUFFIX] = $suffix;
+
+        return $options;
+    }
+}

src/AsyncClient.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiClients\Client\Scrutinizer;
+
+use ApiClients\Client\Scrutinizer\CommandBus\Command\MetaCommand;
+use ApiClients\Foundation\ClientInterface;
+use ApiClients\Foundation\Factory;
+use ApiClients\Foundation\Resource\ResourceInterface;
+use React\EventLoop\LoopInterface;
+use React\Promise\CancellablePromiseInterface;
+use React\Promise\PromiseInterface;
+
+final class AsyncClient implements AsyncClientInterface
+{
+    /**
+     * @var ClientInterface
+     */
+    private $client;
+
+    /**
+     * @param ClientInterface $client
+     */
+    private function __construct(ClientInterface $client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * @param  LoopInterface $loop
+     * @param  array         $options
+     * @return AsyncClient
+     */
+    public static function create(LoopInterface $loop, array $options = []): self
+    {
+        $options = ApiSettings::getOptions($options, 'Async');
+        $client = Factory::create($loop, $options);
+
+        return new self($client);
+    }
+
+    /**
+     * @internal
+     * @param  ClientInterface $client
+     * @return AsyncClient
+     */
+    public static function createFromClient(ClientInterface $client): self
+    {
+        return new self($client);
+    }
+
+    public function hydrate(string $resource): CancellablePromiseInterface
+    {
+        return $this->client->hydrate($resource);
+    }
+
+    public function extract(ResourceInterface $resource): CancellablePromiseInterface
+    {
+        return $this->client->extract($resource);
+    }
+
+    public function meta(): PromiseInterface
+    {
+        return $this->client->handle(new MetaCommand());
+    }
+}

src/AsyncClientInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiClients\Client\Scrutinizer;
+
+use React\Promise\PromiseInterface;
+
+interface AsyncClientInterface
+{
+    public function meta(): PromiseInterface;
+}

src/Client.php

@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiClients\Client\Scrutinizer;
+
+use ApiClients\Client\Scrutinizer\Resource\MetaInterface;
+use ApiClients\Foundation\Factory as FoundationClientFactory;
+use React\EventLoop\Factory;
+use React\EventLoop\LoopInterface;
+use function ApiClients\Tools\Rx\setAsyncScheduler;
+use function Clue\React\Block\await;
+
+final class Client implements ClientInterface
+{
+    /**
+     * @var LoopInterface
+     */
+    private $loop;
+    /**
+     * @var AsyncClient
+     */
+    private $client;
+
+    /**
+     * @param LoopInterface $loop
+     * @param AsyncClient   $client
+     */
+    private function __construct(LoopInterface $loop, AsyncClient $client)
+    {
+        $this->loop = $loop;
+        $this->client = $client;
+    }
+
+    /**
+     * @param  array  $options
+     * @return Client
+     */
+    public static function create(array $options = []): self
+    {
+        $loop = Factory::create();
+        $options = ApiSettings::getOptions($options, 'Sync');
+        $client = FoundationClientFactory::create($loop, $options);
+        setAsyncScheduler($loop);
+        $asyncClient = AsyncClient::createFromClient($client);
+
+        return new self($loop, $asyncClient);
+    }
+
+    /**
+     * @param  string        $input
+     * @return MetaInterface
+     */
+    public function meta(): MetaInterface
+    {
+        return await($this->client->meta(), $this->loop);
+    }
+}

src/ClientInterface.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace ApiClients\Client\Scrutinizer;
+
+use ApiClients\Client\Scrutinizer\Resource\MetaInterface;
+
+interface ClientInterface
+{
+    public function meta(): MetaInterface;
+}

src/CommandBus/Command/MetaCommand.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiClients\Client\Scrutinizer\CommandBus\Command;
+
+use WyriHaximus\Tactician\CommandHandler\Annotations\Handler;
+
+/**
+ * @Handler("ApiClients\Client\Scrutinizer\CommandBus\Handler\MetaHandler")
+ */
+final class MetaCommand
+{
+}

src/CommandBus/Handler/MetaHandler.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiClients\Client\Scrutinizer\CommandBus\Handler;
+
+use ApiClients\Client\Scrutinizer\CommandBus\Command\MetaCommand;
+use ApiClients\Client\Scrutinizer\Resource\MetaInterface;
+use ApiClients\Tools\Services\Client\FetchAndHydrateService;
+use React\Promise\PromiseInterface;
+
+final class MetaHandler
+{
+    /**
+     * @var FetchAndHydrateService
+     */
+    private $service;
+
+    /**
+     * @param FetchAndHydrateService $service
+     */
+    public function __construct(FetchAndHydrateService $service)
+    {
+        $this->service = $service;
+    }
+
+    /**
+     * Fetch the given repository and hydrate it.
+     *
+     * @param  MetaCommand      $command
+     * @return PromiseInterface
+     */
+    public function handle(MetaCommand $command): PromiseInterface
+    {
+        return $this->service->fetch('meta', '', MetaInterface::HYDRATE_CLASS);
+    }
+}

src/Resource/Async/EmptyMeta.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types=1);
+
+namespace ApiClients\Client\Scrutinizer\Resource\Async;
+
+use ApiClients\Client\Scrutinizer\Resource\EmptyMeta as BaseEmptyMeta;
+
+class EmptyMeta extends BaseEmptyMeta
+{
+}