Access token middleware for authentication

Author: WyriHaximus

src/Middleware/AccessTokenMiddleware.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiClients\Client\Scrutinizer\Middleware;
+
+use ApiClients\Foundation\Middleware\ErrorTrait;
+use ApiClients\Foundation\Middleware\MiddlewareInterface;
+use ApiClients\Foundation\Middleware\PostTrait;
+use Psr\Http\Message\RequestInterface;
+use React\Promise\CancellablePromiseInterface;
+use function React\Promise\resolve;
+use function RingCentral\Psr7\build_query;
+use function RingCentral\Psr7\parse_query;
+
+final class AccessTokenMiddleware implements MiddlewareInterface
+{
+    const OPTION_ACCESS_TOKEN = 'ACCESS_TOKEN';
+
+    use PostTrait;
+    use ErrorTrait;
+
+    public function pre(
+        RequestInterface $request,
+        string $transactionId,
+        array $options = []
+    ): CancellablePromiseInterface {
+        if (!isset($options[self::class][self::OPTION_ACCESS_TOKEN])) {
+            return resolve($request);
+        }
+
+        $query = parse_query($request->getUri()->getQuery());
+        $query['access_token'] = $options[self::class][self::OPTION_ACCESS_TOKEN];
+        $request = $request->withUri($request->getUri()->withQuery(build_query($query)));
+        return resolve($request);
+    }
+}

tests/Middleware/AccessTokenMiddlewareTest.php

@@ -0,0 +1,61 @@
+<?php declare(strict_types=1);
+
+namespace ApiClients\Tests\Client\Scrutinizer;
+
+use ApiClients\Client\Scrutinizer\Middleware\AccessTokenMiddleware;
+use ApiClients\Tools\TestUtilities\TestCase;
+use React\EventLoop\Factory;
+use RingCentral\Psr7\Request;
+
+final class AccessTokenMiddlewareTest extends TestCase
+{
+    public function testNoOption()
+    {
+        $request = new Request('GET', 'https://example.com/');
+
+        $middleware = new AccessTokenMiddleware();
+        $returnedRequest = $this->await($middleware->pre($request, 'abc'), Factory::create());
+
+        self::assertSame($request, $returnedRequest);
+    }
+
+    public function testAddedTokenFirst()
+    {
+        $request = new Request('GET', 'https://example.com/');
+
+        $middleware = new AccessTokenMiddleware();
+        $promise = $middleware->pre(
+            $request,
+            'abc',
+            [
+                AccessTokenMiddleware::class => [
+                    AccessTokenMiddleware::OPTION_ACCESS_TOKEN => 'token',
+                ],
+            ]
+        );
+        $returnedRequest = $this->await($promise, Factory::create());
+
+        self::assertNotSame($request, $returnedRequest);
+        self::assertSame('https://example.com/?access_token=token', (string)$returnedRequest->getUri());
+    }
+
+    public function testAddedTokenSecond()
+    {
+        $request = new Request('GET', 'https://example.com/?first=value');
+
+        $middleware = new AccessTokenMiddleware();
+        $promise = $middleware->pre(
+            $request,
+            'abc',
+            [
+                AccessTokenMiddleware::class => [
+                    AccessTokenMiddleware::OPTION_ACCESS_TOKEN => 'token',
+                ],
+            ]
+        );
+        $returnedRequest = $this->await($promise, Factory::create());
+
+        self::assertNotSame($request, $returnedRequest);
+        self::assertSame('https://example.com/?first=value&access_token=token', (string)$returnedRequest->getUri());
+    }
+}