Create API client classes (#4)

- ControlD.php will make HTTP requests
- ControlDFactory.php creates the client class
- Bind the ControlD client class and build it with the factory in ControldServiceProvider.php. Used for dependency injection
- Add tests for the factory
- Use TestMiddleware.php to assert all methods
- Define API endpoint and secret bearer token in .env and config
- Installed guzzlehttp/guzzle to support the underlying Laravel HTTP client
- Set up test coverage in run-tests.yml
- Set minimum test coverage to 100 percent
- Fix unused autoload path in composer.json

.env.example

@@ -0,0 +1,2 @@
+CONTROL_D_API_URL=
+CONTROL_D_API_SECRET=

.github/workflows/run-tests.yml

@@ -32,7 +32,7 @@ jobs:
         with:
           php-version: ${{ matrix.php }}
           extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
-          coverage: none
+          coverage: xdebug
 
       - name: Setup problem matchers
         run: |
@@ -48,4 +48,4 @@ jobs:
         run: composer show -D
 
       - name: Execute tests
-        run: vendor/bin/pest --ci
+        run: XDEBUG_MODE=coverage php ./vendor/bin/pest --ci --coverage --min=100 --do-not-cache-result

.gitignore

@@ -9,3 +9,4 @@ phpstan.neon
 testbench.yaml
 vendor
 node_modules
+.env

composer.json

@@ -17,8 +17,9 @@
     ],
     "require": {
         "php": "^8.1",
-        "spatie/laravel-package-tools": "^1.14.0",
-        "illuminate/contracts": "^10.0"
+        "guzzlehttp/guzzle": "^7.7",
+        "illuminate/contracts": "^10.0",
+        "spatie/laravel-package-tools": "^1.14.0"
     },
     "require-dev": {
         "laravel/pint": "^1.0",
@@ -34,8 +35,7 @@
     },
     "autoload": {
         "psr-4": {
-            "Rapkis\\Controld\\": "src/",
-            "Rapkis\\Controld\\Database\\Factories\\": "database/factories/"
+            "Rapkis\\Controld\\": "src/"
         }
     },
     "autoload-dev": {
@@ -80,4 +80,4 @@
     },
     "minimum-stability": "dev",
     "prefer-stable": true
-}
+}

config/controld.php

@@ -2,5 +2,6 @@
 
 // config for Rapkis/Controld
 return [
-
+    'url' => env('CONTROL_D_API_URL'),
+    'secret' => env('CONTROL_D_API_SECRET'),
 ];

src/Api/ControlD.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rapkis\Controld\Api;
+
+use Illuminate\Http\Client\PendingRequest;
+
+class ControlD
+{
+    public function __construct(private PendingRequest $request)
+    {
+    }
+}

src/Api/ControlDFactory.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rapkis\Controld\Api;
+
+use Illuminate\Config\Repository;
+use Illuminate\Http\Client\PendingRequest;
+
+class ControlDFactory
+{
+    public function __construct(private PendingRequest $request, private Repository $config)
+    {
+    }
+
+    public function make(): ControlD
+    {
+        $this->request
+            ->asJson()
+            ->acceptJson()
+            ->baseUrl($this->config->get('controld.url'))
+            ->withToken($this->config->get('controld.secret'))
+            ->retry(3, 250, new RetryCallback());
+
+        foreach ($this->config->get('controld.middleware') ?? [] as $middleware) {
+            $this->request->withMiddleware(app($middleware));
+        }
+
+        return new ControlD($this->request);
+    }
+}

src/Api/RetryCallback.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rapkis\Controld\Api;
+
+use Illuminate\Http\Client\ConnectionException;
+use Throwable;
+
+class RetryCallback
+{
+    public function __invoke(Throwable $exception): bool
+    {
+        return $exception instanceof ConnectionException || $exception->getCode() >= 500;
+    }
+}

src/ControldServiceProvider.php

@@ -2,6 +2,9 @@
 
 namespace Rapkis\Controld;
 
+use Illuminate\Contracts\Foundation\Application;
+use Rapkis\Controld\Api\ControlD;
+use Rapkis\Controld\Api\ControlDFactory;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
@@ -18,4 +21,12 @@ public function configurePackage(Package $package): void
             ->name('laravel-controld')
             ->hasConfigFile();
     }
+
+    public function boot()
+    {
+        $this->app->bind(
+            ControlD::class,
+            fn (Application $app) => $app->make(ControlDFactory::class)->make(),
+        );
+    }
 }

tests/Api/ControlDFactoryTest.php

@@ -0,0 +1,37 @@
+<?php
+
+use Illuminate\Config\Repository;
+use Illuminate\Http\Client\PendingRequest;
+use Rapkis\Controld\Api\ControlDFactory;
+use Rapkis\Controld\Api\RetryCallback;
+use Rapkis\Controld\Tests\Api\TestMiddleware;
+
+it('creates an api client', function () {
+    $config = app(Repository::class);
+    $request = $this->createMock(PendingRequest::class);
+    $factory = new ControlDFactory($request, $config);
+    app()->bind(TestMiddleware::class, fn () => $this->createStub(TestMiddleware::class));
+
+    $config->set([
+        'controld' => [
+            'url' => 'example.com',
+            'secret' => 'bearer_token',
+            'middleware' => [TestMiddleware::class],
+        ],
+    ]);
+
+    $request->expects($this->once())->method('asJson')->willReturnSelf();
+    $request->expects($this->once())->method('acceptJson')->willReturnSelf();
+    $request->expects($this->once())->method('baseUrl')->with('example.com')->willReturnSelf();
+    $request->expects($this->once())->method('withToken')->with('bearer_token')->willReturnSelf();
+
+    $request->expects($this->once())->method('withMiddleware')
+        ->with($this->createStub(TestMiddleware::class))
+        ->willReturnSelf();
+
+    $request->expects($this->once())->method('retry')
+        ->with(3, 250, new RetryCallback())
+        ->willReturnSelf();
+
+    $factory->make();
+});

tests/Api/RetryCallbackTest.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+use Illuminate\Http\Client\ConnectionException;
+use Rapkis\Controld\Api\RetryCallback;
+
+it('will retry for exception', function (Throwable $exception, bool $willRetry) {
+    $retry = new RetryCallback();
+
+    expect($retry($exception))->toBe($willRetry);
+})->with([
+    [new Exception(), false],
+    [new Exception('', 500), true],
+    [new Exception('', 422), false],
+    [new ConnectionException(), true],
+]);

tests/Api/TestMiddleware.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Rapkis\Controld\Tests\Api;
+
+use Closure;
+use Psr\Http\Message\RequestInterface;
+
+class TestMiddleware
+{
+    public function __invoke(callable $handler): Closure
+    {
+        return function (RequestInterface $request, array $options = []) use ($handler) {
+            $request->withHeader('test', 'test');
+
+            return $handler($request, $options);
+        };
+    }
+}