Merged master

src/Service/Connector/AbstractConnector.php

@@ -1,13 +0,0 @@
-<?php
-
-namespace App\Service\Connector;
-
-abstract class AbstractConnector implements ConnectorInterface
-{
-    protected array $authData;
-
-    public function authenticate(array $authData)
-    {
-        $this->authData = $authData;
-    }
-}

src/Service/Connector/AbstractProvider.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace App\Service\Connector;
+
+use App\Entity\Domain;
+use Psr\Cache\CacheItemInterface;
+use Psr\Cache\CacheItemPoolInterface;
+use Symfony\Contracts\HttpClient\HttpClientInterface;
+
+abstract class AbstractProvider
+{
+    protected array $authData;
+
+    public function __construct(
+        protected CacheItemPoolInterface $cacheItemPool
+    ) {
+    }
+
+    abstract public static function verifyAuthData(array $authData, HttpClientInterface $client): array;
+
+    abstract public function orderDomain(Domain $domain, bool $dryRun): void;
+
+    public function isSupported(Domain ...$domainList): bool
+    {
+        $item = $this->getCachedTldList();
+        if (!$item->isHit()) {
+            $supportedTldList = $this->getSupportedTldList();
+            $item
+                ->set($supportedTldList)
+                ->expiresAfter(new \DateInterval('PT1H'));
+            $this->cacheItemPool->saveDeferred($item);
+        } else {
+            $supportedTldList = $item->get();
+        }
+
+        $extensionList = [];
+        foreach ($domainList as $domain) {
+            // We want to check the support of TLDs and SLDs here.
+            // For example, it is not enough for the Connector to support .fr for it to support the domain name example.asso.fr.
+            // It must support .asso.fr.
+            $extension = explode('.', $domain->getLdhName(), 2)[1];
+            if (!in_array($extension, $extensionList)) {
+                $extensionList[] = $extension;
+            }
+        }
+
+        foreach ($extensionList as $extension) {
+            if (!in_array($extension, $supportedTldList)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    public function authenticate(array $authData): void
+    {
+        $this->authData = $authData;
+    }
+
+    abstract protected function getCachedTldList(): CacheItemInterface;
+
+    abstract protected function getSupportedTldList(): array;
+}

src/Service/Connector/ConnectorInterface.php

@@ -1,15 +0,0 @@
-<?php
-
-namespace App\Service\Connector;
-
-use App\Entity\Domain;
-use Symfony\Contracts\HttpClient\HttpClientInterface;
-
-interface ConnectorInterface
-{
-    public function authenticate(array $authData);
-
-    public function orderDomain(Domain $domain, bool $dryRun): void;
-
-    public static function verifyAuthData(array $authData, HttpClientInterface $client): array;
-}

src/Service/Connector/GandiProvider.php

@@ -3,18 +3,21 @@
 namespace App\Service\Connector;
 
 use App\Entity\Domain;
-use http\Exception\InvalidArgumentException;
+use Psr\Cache\CacheItemInterface;
 use Symfony\Component\HttpClient\HttpOptions;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\HttpKernel\Exception\HttpException;
+use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
 use Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface;
+use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface;
 use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
-class GandiConnector extends AbstractConnector
+class GandiProvider extends AbstractProvider
 {
-    private const BASE_URL = 'https://api.gandi.net/v5';
+    private const BASE_URL = 'https://api.gandi.net';
 
     public function __construct(private HttpClientInterface $client)
     {
@@ -30,12 +33,12 @@ class GandiConnector extends AbstractConnector
     public function orderDomain(Domain $domain, bool $dryRun = false): void
     {
         if (!$domain->getDeleted()) {
-            throw new InvalidArgumentException('The domain name still appears in the WHOIS database');
+            throw new \InvalidArgumentException('The domain name still appears in the WHOIS database');
         }
 
         $ldhName = $domain->getLdhName();
         if (!$ldhName) {
-            throw new InvalidArgumentException('Domain name cannot be null');
+            throw new \InvalidArgumentException('Domain name cannot be null');
         }
 
         $authData = self::verifyAuthData($this->authData, $this->client);
@@ -130,4 +133,32 @@ class GandiConnector extends AbstractConnector
 
         return $authDataReturned;
     }
+
+    /**
+     * @throws TransportExceptionInterface
+     * @throws ServerExceptionInterface
+     * @throws RedirectionExceptionInterface
+     * @throws DecodingExceptionInterface
+     * @throws ClientExceptionInterface
+     */
+    protected function getSupportedTldList(): array
+    {
+        $authData = self::verifyAuthData($this->authData, $this->client);
+
+        $response = $this->client->request('GET', '/v5/domain/tlds', (new HttpOptions())
+            ->setAuthBearer($authData['token'])
+            ->setHeader('Accept', 'application/json')
+            ->setBaseUri(self::BASE_URL)
+            ->toArray())->toArray();
+
+        return array_map(fn ($tld) => $tld['name'], $response);
+    }
+
+    /**
+     * @throws \Psr\Cache\InvalidArgumentException
+     */
+    protected function getCachedTldList(): CacheItemInterface
+    {
+        return $this->cacheItemPool->getItem('app.provider.ovh.supported-tld');
+    }
 }

src/Service/Connector/NamecheapConnector.php

@@ -3,11 +3,12 @@
 namespace App\Service\Connector;
 
 use App\Entity\Domain;
+use Psr\Cache\CacheItemInterface;
 use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 #[Autoconfigure(public: true)]
-class NamecheapConnector extends AbstractConnector
+class NamecheapConnector extends AbstractProvider
 {
     public const BASE_URL = 'https://api.namecheap.com/xml.response';
 
@@ -83,4 +84,14 @@ class NamecheapConnector extends AbstractConnector
     {
         return $authData;
     }
+
+    protected function getCachedTldList(): CacheItemInterface
+    {
+        // TODO: Implement getCachedTldList() method.
+    }
+
+    protected function getSupportedTldList(): array
+    {
+        // TODO: Implement getSupportedTldList() method.
+    }
 }

src/Service/Connector/OvhProvider.php

@@ -3,14 +3,22 @@
 namespace App\Service\Connector;
 
 use App\Entity\Domain;
+use GuzzleHttp\Exception\ClientException;
 use Ovh\Api;
+use Ovh\Exceptions\InvalidParameterException;
+use Psr\Cache\CacheItemInterface;
+use Psr\Cache\InvalidArgumentException;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
-class OvhConnector extends AbstractConnector
+class OvhProvider extends AbstractProvider
 {
     public const REQUIRED_ROUTES = [
+        [
+            'method' => 'GET',
+            'path' => '/domain/extensions',
+        ],
         [
             'method' => 'GET',
             'path' => '/order/cart',
@@ -45,12 +53,12 @@ class OvhConnector extends AbstractConnector
     public function orderDomain(Domain $domain, bool $dryRun = false): void
     {
         if (!$domain->getDeleted()) {
-            throw new \Exception('The domain name still appears in the WHOIS database');
+            throw new \InvalidArgumentException('The domain name still appears in the WHOIS database');
         }
 
         $ldhName = $domain->getLdhName();
         if (!$ldhName) {
-            throw new \Exception('Domain name cannot be null');
+            throw new \InvalidArgumentException('Domain name cannot be null');
         }
 
         $authData = self::verifyAuthData($this->authData, $this->client);
@@ -87,7 +95,7 @@ class OvhConnector extends AbstractConnector
         );
         if (empty($offer)) {
             $conn->delete("/order/cart/{$cartId}");
-            throw new \Exception('Cannot buy this domain name');
+            throw new \InvalidArgumentException('Cannot buy this domain name');
         }
 
         $item = $conn->post("/order/cart/{$cartId}/domain", [
@@ -163,14 +171,18 @@ class OvhConnector extends AbstractConnector
             $consumerKey
         );
 
-        $res = $conn->get('/auth/currentCredential');
-        if (null !== $res['expiration'] && new \DateTime($res['expiration']) < new \DateTime()) {
-            throw new \Exception('These credentials have expired');
-        }
+        try {
+            $res = $conn->get('/auth/currentCredential');
+            if (null !== $res['expiration'] && new \DateTime($res['expiration']) < new \DateTime()) {
+                throw new BadRequestHttpException('These credentials have expired');
+            }
 
-        $status = $res['status'];
-        if ('validated' !== $status) {
-            throw new \Exception("The status of these credentials is not valid ($status)");
+            $status = $res['status'];
+            if ('validated' !== $status) {
+                throw new BadRequestHttpException("The status of these credentials is not valid ($status)");
+            }
+        } catch (ClientException $exception) {
+            throw new BadRequestHttpException($exception->getMessage());
         }
 
         foreach (self::REQUIRED_ROUTES as $requiredRoute) {
@@ -186,7 +198,7 @@ class OvhConnector extends AbstractConnector
             }
 
             if (!$ok) {
-                throw new BadRequestHttpException('The credentials provided do not have enough permissions to purchase a domain name.');
+                throw new BadRequestHttpException('This Connector does not have enough permissions on the Provider API. Please recreate this Connector.');
             }
         }
 
@@ -202,4 +214,33 @@ class OvhConnector extends AbstractConnector
             'waiveRetractationPeriod' => $waiveRetractationPeriod,
         ];
     }
+
+    /**
+     * @throws InvalidParameterException
+     * @throws \JsonException
+     * @throws \Exception
+     */
+    protected function getSupportedTldList(): array
+    {
+        $authData = self::verifyAuthData($this->authData, $this->client);
+
+        $conn = new Api(
+            $authData['appKey'],
+            $authData['appSecret'],
+            $authData['apiEndpoint'],
+            $authData['consumerKey']
+        );
+
+        return $conn->get('/domain/extensions', [
+            'ovhSubsidiary' => $authData['ovhSubsidiary'],
+        ]);
+    }
+
+    /**
+     * @throws InvalidArgumentException
+     */
+    protected function getCachedTldList(): CacheItemInterface
+    {
+        return $this->cacheItemPool->getItem('app.provider.ovh.supported-tld');
+    }
 }