feat: make requests with a base url and a client builder

Author: andrepimpao

Diff for: .ddev/config.yaml

@@ -13,6 +13,7 @@ omit_containers: [db]
 use_dns_when_possible: true
 composer_version: "2"
 web_environment: []
+disable_upload_dirs_warning: true
 
 # Key features of DDEV's config.yaml:
 

Diff for: composer.json

@@ -12,24 +12,38 @@
         }
     ],
     "require": {
-        "php": ">=8.1"
+        "php": ">=8.1",
+        "php-http/client-common": "^2.7",
+        "php-http/discovery": "^1.19",
+        "programmatordev/yet-another-php-validator": "^0.6.0",
+        "psr/http-client": "^1.0",
+        "psr/http-factory": "^1.0"
     },
     "require-dev": {
+        "nyholm/psr7": "^1.8",
         "phpunit/phpunit": "^10.0",
+        "symfony/http-client": "^6.4",
         "symfony/var-dumper": "^6.4"
     },
+    "provide": {
+        "psr/http-client-implementation": "1.0",
+        "psr/http-factory-implementation": "1.0"
+    },
     "autoload": {
         "psr-4": {
-            "ProgrammatorDev\\PhpApiSdk\\": "src/"
+            "ProgrammatorDev\\Api\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "ProgrammatorDev\\PhpApiSdk\\Test\\": "tests/"
+            "ProgrammatorDev\\Api\\Test\\": "tests/"
         }
     },
     "config": {
         "optimize-autoloader": true,
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "php-http/discovery": true
+        }
     }
 }

Diff for: src/Api.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace ProgrammatorDev\Api;
+
+use Http\Client\Exception;
+use ProgrammatorDev\Api\Client\ClientBuilder;
+use ProgrammatorDev\Api\Exception\MissingConfigException;
+use ProgrammatorDev\Api\Helper\StringHelperTrait;
+use ProgrammatorDev\YetAnotherPhpValidator\Exception\ValidationException;
+use ProgrammatorDev\YetAnotherPhpValidator\Validator;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\StreamInterface;
+
+class Api
+{
+    use StringHelperTrait;
+
+    private ?string $baseUrl = null;
+
+    private ?ClientBuilder $clientBuilder = null;
+
+    public function __construct()
+    {
+        $this->clientBuilder ??= new ClientBuilder();
+    }
+
+    /**
+     * @throws MissingConfigException
+     * @throws Exception
+     */
+    public function request(
+        string $method,
+        string $path,
+        array $query = [],
+        array $headers = [],
+        string|StreamInterface $body = null
+    ): ResponseInterface
+    {
+        if (!$this->getBaseUrl()) {
+            throw new MissingConfigException('A base URL must be set');
+        }
+
+        return $this->clientBuilder->getClient()->send(
+            $method,
+            $this->createUri($path, $query),
+            $headers,
+            $body
+        );
+    }
+
+    protected function getBaseUrl(): ?string
+    {
+        return $this->baseUrl;
+    }
+
+    /**
+     * @throws ValidationException
+     */
+    protected function setBaseUrl(string $baseUrl): self
+    {
+        Validator::url()->assert($baseUrl);
+
+        $this->baseUrl = $baseUrl;
+
+        return $this;
+    }
+
+    protected function getClientBuilder(): ?ClientBuilder
+    {
+        return $this->clientBuilder;
+    }
+
+    protected function setClientBuilder(ClientBuilder $clientBuilder): self
+    {
+        $this->clientBuilder = $clientBuilder;
+
+        return $this;
+    }
+
+    private function createUri(string $path, array $query = []): string
+    {
+        $uri = $this->reduceDoubleSlashes($this->getBaseUrl() . $path);
+
+        if (!empty($query)) {
+            $uri = \sprintf('%s?%s', $uri, \http_build_query($query));
+        }
+
+        return $uri;
+    }
+}

Diff for: src/Client/ClientBuilder.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace ProgrammatorDev\Api\Client;
+
+use Http\Client\Common\HttpMethodsClient;
+use Http\Client\Common\Plugin;
+use Http\Client\Common\PluginClientFactory;
+use Http\Discovery\Psr17FactoryDiscovery;
+use Http\Discovery\Psr18ClientDiscovery;
+use Psr\Http\Client\ClientInterface;
+use Psr\Http\Message\RequestFactoryInterface;
+use Psr\Http\Message\StreamFactoryInterface;
+
+class ClientBuilder
+{
+    /** @var Plugin[] */
+    private array $plugins = [];
+
+    public function __construct(
+        private ?ClientInterface $client = null,
+        private ?RequestFactoryInterface $requestFactory = null,
+        private ?StreamFactoryInterface $streamFactory = null
+    )
+    {
+        $this->client ??= Psr18ClientDiscovery::find();
+        $this->requestFactory ??= Psr17FactoryDiscovery::findRequestFactory();
+        $this->streamFactory ??= Psr17FactoryDiscovery::findStreamFactory();
+    }
+
+    public function getClient(): HttpMethodsClient
+    {
+        $this->addPlugin(new Plugin\ContentTypePlugin());
+        $this->addPlugin(new Plugin\ContentLengthPlugin());
+
+        $pluginClientFactory = new PluginClientFactory();
+        $client = $pluginClientFactory->createClient($this->client, $this->plugins);
+
+        return new HttpMethodsClient(
+            $client,
+            $this->requestFactory,
+            $this->streamFactory
+        );
+    }
+
+    public function addPlugin(Plugin $plugin): void
+    {
+        $this->plugins[] = $plugin;
+    }
+}

Diff for: src/Exception/MissingConfigException.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace ProgrammatorDev\Api\Exception;
+
+class MissingConfigException extends \LogicException {}

Diff for: src/Helper/StringHelperTrait.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace ProgrammatorDev\Api\Helper;
+
+trait StringHelperTrait
+{
+    private function reduceDoubleSlashes(string $string): string
+    {
+        return \preg_replace('#(^|[^:])//+#', '\\1/', $string);
+    }
+}