External/domain-watchdog
1
0
Fork 0
mirror of https://github.com/maelgangloff/domain-watchdog.git synced 2025-12-29 16:15:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add GANDI provider

Browse Source
This commit is contained in:
Maël Gangloff
2024-08-06 03:38:00 +02:00
parent da1ae4cb8e
commit a603a2c7a0
10 changed files with 226 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
assets/components/tracking/ConnectorForm.tsx
View File

@@ -90,6 +90,29 @@ export function ConnectorForm({form, onCreate}: { form: FormInstance, onCreate:
>
<Select options={ovhPricingMode} optionFilterProp="label"/>
</Form.Item>
</>
}
{
provider === ConnectorProvider.GANDI && <>
<Form.Item
label={t`Personal Access Token (PAT)`}
name={['authData', 'token']}
rules={[{required: true, message: t`Required`}]}>
<Input autoComplete='off'/>
</Form.Item>
<Form.Item
label={t`Organization sharing ID`}
name={['authData', 'sharingId']}
help={<Typography.Text
type='secondary'>{t`It indicates the organization that will pay for the ordered product`}</Typography.Text>}
required={false}>
<Input autoComplete='off' placeholder='xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'/>
</Form.Item>
</>
}
{
provider !== undefined && <>
<Form.Item
valuePropName="checked"
label={t`API Terms of Service`}
@@ -124,7 +147,6 @@ export function ConnectorForm({form, onCreate}: { form: FormInstance, onCreate:
</>
}
<Form.Item style={{marginTop: 10}}>
<Space>
<Button type="primary" htmlType="submit">

3
assets/utils/api/connectors.ts
View File

@@ -1,7 +1,8 @@
import {request} from "./index";
export enum ConnectorProvider {
OVH = 'ovh'
OVH = 'ovh',
GANDI = 'gandi'
}
export type Connector = {

8
assets/utils/providers/index.tsx
View File

@@ -10,8 +10,14 @@ export const helpGetTokenLink = (provider?: string) => {
href="https://api.ovh.com/createToken/index.cgi?GET=/order/cart&GET=/order/cart/*&POST=/order/cart&POST=/order/cart/*&DELETE=/order/cart/*">
{t`Retrieve a set of tokens from your customer account on the Provider's website`}
</Typography.Link>
case ConnectorProvider.GANDI:
return <Typography.Link target='_blank' href="https://admin.gandi.net/organizations/account/pat">
{t`Retrieve a Personal Access Token from your customer account on the Provider's website`}
</Typography.Link>
default:
return <></>
}
}
@@ -19,6 +25,8 @@ export const tosHyperlink = (provider?: string) => {
switch (provider) {
case ConnectorProvider.OVH:
return 'https://www.ovhcloud.com/fr/terms-and-conditions/contracts/'
case ConnectorProvider.GANDI:
return 'https://www.gandi.net/en/contracts/terms-of-service'
default:
return ''
}

2
src/Config/Connector/ConnectorInterface.php
View File

@@ -6,7 +6,5 @@ use App\Entity\Domain;
interface ConnectorInterface
{
public static function verifyAuthData(array $authData): array;
public function orderDomain(Domain $domain, bool $dryRun): void;
}

135
src/Config/Connector/GandiConnector.php Normal file
View File

@@ -0,0 +1,135 @@
<?php
namespace App\Config\Connector;
use App\Entity\Domain;
use Symfony\Component\HttpClient\HttpOptions;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface;
use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
readonly class GandiConnector implements ConnectorInterface
{
private const BASE_URL = 'https://api.gandi.net/v5';
public function __construct(private array $authData, private HttpClientInterface $client)
{
}
/**
* Order a domain name with the Gandi API.
*
* @throws \Exception
* @throws TransportExceptionInterface
* @throws DecodingExceptionInterface
*/
public function orderDomain(Domain $domain, bool $dryRun = false): void
{
if (!$domain->getDeleted()) {
throw new \Exception('The domain name still appears in the WHOIS database');
}
$ldhName = $domain->getLdhName();
if (!$ldhName) {
throw new \Exception('Domain name cannot be null');
}
$authData = self::verifyAuthData($this->authData, $this->client);
$acceptConditions = $authData['acceptConditions'];
$ownerLegalAge = $authData['ownerLegalAge'];
$waiveRetractationPeriod = $authData['waiveRetractationPeriod'];
if (false === $acceptConditions || false === $ownerLegalAge || false === $waiveRetractationPeriod) {
throw new \Exception('It is not possible to order a domain name if the legal conditions are not met');
}
$user = $this->client->request('GET', '/v5/organization/user-info', (new HttpOptions())
->setAuthBearer($authData['token'])
->setHeader('Accept', 'application/json')
->setBaseUri(self::BASE_URL)
->toArray()
)->toArray();
$httpOptions = (new HttpOptions())
->setAuthBearer($authData['token'])
->setHeader('Accept', 'application/json')
->setBaseUri(self::BASE_URL)
->setHeader('Dry-Run', $dryRun ? '1' : '0')
->setJson([
'fqdn' => $ldhName,
'owner' => [
'email' => $user['email'],
'given' => $user['firstname'],
'family' => $user['lastname'],
'streetaddr' => $user['streetaddr'],
'zip' => $user['zip'],
'city' => $user['city'],
'state' => $user['state'],
'phone' => $user['phone'],
'country' => $user['country'],
'type' => 'individual',
],
'tld_period' => 'golive',
]);
if (array_key_exists('sharingId', $authData)) {
$httpOptions->setQuery([
'sharing_id' => $authData['sharingId'],
]);
}
$res = $this->client->request('POST', '/domain/domains', $httpOptions->toArray());
if (Response::HTTP_ACCEPTED !== $res->getStatusCode()) {
throw new \Exception($res->toArray()['message']);
}
}
/**
* @throws \Exception
* @throws TransportExceptionInterface
*/
public static function verifyAuthData(array $authData, HttpClientInterface $client): array
{
$token = $authData['token'];
$acceptConditions = $authData['acceptConditions'];
$ownerLegalAge = $authData['ownerLegalAge'];
$waiveRetractationPeriod = $authData['waiveRetractationPeriod'];
if (!is_string($token) || empty($token)
|| (array_key_exists('sharingId', $authData) && !is_string($authData['sharingId']))
|| true !== $acceptConditions
|| true !== $ownerLegalAge
|| true !== $waiveRetractationPeriod
) {
throw new \Exception('Bad authData schema');
}
$response = $client->request('GET', '/v5/organization/user-info', (new HttpOptions())
->setAuthBearer($token)
->setHeader('Accept', 'application/json')
->setBaseUri(self::BASE_URL)
->toArray()
);
if (Response::HTTP_OK !== $response->getStatusCode()) {
throw new \Exception('The status of these credentials is not valid');
}
$authDataReturned = [
'token' => $token,
'acceptConditions' => $acceptConditions,
'ownerLegalAge' => $ownerLegalAge,
'waiveRetractationPeriod' => $waiveRetractationPeriod,
];
if (array_key_exists('sharingId', $authData)) {
$authDataReturned['sharingId'] = $authData['sharingId'];
}
return $authDataReturned;
}
}

4
src/Config/Connector/OvhConnector.php
View File

@@ -38,8 +38,8 @@ readonly class OvhConnector implements ConnectorInterface
*
* @throws \Exception
*/
public function orderDomain(Domain $domain, bool $dryRun = false
): void {
public function orderDomain(Domain $domain, bool $dryRun = false): void
{
if (!$domain->getDeleted()) {
throw new \Exception('The domain name still appears in the WHOIS database');
}

1
src/Config/ConnectorProvider.php
View File

@@ -5,4 +5,5 @@ namespace App\Config;
enum ConnectorProvider: string
{
case OVH = 'ovh';
case GANDI = 'gandi';
}

20
src/Controller/ConnectorController.php
View File

@@ -2,6 +2,7 @@
namespace App\Controller;
use App\Config\Connector\GandiConnector;
use App\Config\Connector\OvhConnector;
use App\Config\ConnectorProvider;
use App\Entity\Connector;
@@ -13,6 +14,8 @@ use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Attribute\Route;
use Symfony\Component\Serializer\SerializerInterface;
use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
use Symfony\Contracts\HttpClient\HttpClientInterface;
class ConnectorController extends AbstractController
{
@@ -42,6 +45,7 @@ class ConnectorController extends AbstractController
/**
* @throws \Exception
* @throws TransportExceptionInterface
*/
#[Route(
path: '/api/connectors',
@@ -52,7 +56,7 @@ class ConnectorController extends AbstractController
],
methods: ['POST']
)]
public function createConnector(Request $request): Connector
public function createConnector(Request $request, HttpClientInterface $client): Connector
{
$connector = $this->serializer->deserialize($request->getContent(), Connector::class, 'json', ['groups' => 'connector:create']);
/** @var User $user */
@@ -68,15 +72,19 @@ class ConnectorController extends AbstractController
if (ConnectorProvider::OVH === $provider) {
$authData = OvhConnector::verifyAuthData($connector->getAuthData());
$connector->setAuthData($authData);
$this->logger->info('User {username} authentication data with the OVH provider has been validated.', [
'username' => $user->getUserIdentifier(),
]);
} elseif (ConnectorProvider::GANDI === $provider) {
$authData = GandiConnector::verifyAuthData($connector->getAuthData(), $client);
} else {
throw new \Exception('Unknown provider');
}
$connector->setAuthData($authData);
$this->logger->info('User {username} authentication data with the {provider} provider has been validated.', [
'username' => $user->getUserIdentifier(),
'provider' => $provider->value,
]);
$this->logger->info('The new API connector requested by {username} has been successfully registered.', [
'username' => $user->getUserIdentifier(),
]);

15
src/MessageHandler/ProcessDomainTriggerHandler.php
View File

@@ -2,6 +2,7 @@
namespace App\MessageHandler;
use App\Config\Connector\GandiConnector;
use App\Config\Connector\OvhConnector;
use App\Config\ConnectorProvider;
use App\Config\TriggerAction;
@@ -22,6 +23,7 @@ use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\Messenger\Attribute\AsMessageHandler;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Email;
use Symfony\Contracts\HttpClient\HttpClientInterface;
#[AsMessageHandler]
final readonly class ProcessDomainTriggerHandler
@@ -33,7 +35,8 @@ final readonly class ProcessDomainTriggerHandler
private WatchListRepository $watchListRepository,
private DomainRepository $domainRepository,
private KernelInterface $kernel,
private LoggerInterface $logger
private LoggerInterface $logger,
private HttpClientInterface $client
) {
}
@@ -57,15 +60,19 @@ final readonly class ProcessDomainTriggerHandler
'provider' => $connector->getProvider()->value,
]);
try {
$isDebug = $this->kernel->isDebug();
if (ConnectorProvider::OVH === $connector->getProvider()) {
$ovh = new OvhConnector($connector->getAuthData());
$isDebug = $this->kernel->isDebug();
$ovh->orderDomain($domain, $isDebug);
$this->sendEmailDomainOrdered($domain, $connector, $watchList->getUser());
} elseif (ConnectorProvider::GANDI === $connector->getProvider()) {
$gandi = new GandiConnector($connector->getAuthData(), $this->client);
$gandi->orderDomain($domain, $isDebug);
} else {
throw new \Exception('Unknown provider');
}
$this->sendEmailDomainOrdered($domain, $connector, $watchList->getUser());
} catch (\Throwable) {
$this->logger->warning('Unable to complete purchase. An error message is sent to user {username}.', [
'username' => $watchList->getUser()->getUserIdentifier(),

41
translations/translations.pot
View File

@@ -23,9 +23,10 @@ msgstr ""
#: assets/components/tracking/ConnectorForm.tsx:74
#: assets/components/tracking/ConnectorForm.tsx:81
#: assets/components/tracking/ConnectorForm.tsx:89
#: assets/components/tracking/ConnectorForm.tsx:97
#: assets/components/tracking/ConnectorForm.tsx:110
#: assets/components/tracking/ConnectorForm.tsx:119
#: assets/components/tracking/ConnectorForm.tsx:100
#: assets/components/tracking/ConnectorForm.tsx:120
#: assets/components/tracking/ConnectorForm.tsx:133
#: assets/components/tracking/ConnectorForm.tsx:142
#: assets/components/tracking/WatchlistForm.tsx:103
msgid "Required"
msgstr ""
@@ -185,12 +186,12 @@ msgid ""
"that may be available soon."
msgstr ""
#: assets/components/tracking/ConnectorForm.tsx:131
#: assets/components/tracking/ConnectorForm.tsx:153
#: assets/components/tracking/WatchlistForm.tsx:186
msgid "Create"
msgstr ""
#: assets/components/tracking/ConnectorForm.tsx:134
#: assets/components/tracking/ConnectorForm.tsx:156
#: assets/components/tracking/WatchlistForm.tsx:189
msgid "Reset"
msgstr ""
@@ -215,31 +216,43 @@ msgstr ""
msgid "OVH pricing mode"
msgstr ""
#: assets/components/tracking/ConnectorForm.tsx:95
#: assets/components/tracking/ConnectorForm.tsx:98
msgid "Personal Access Token (PAT)"
msgstr ""
#: assets/components/tracking/ConnectorForm.tsx:104
msgid "Organization sharing ID"
msgstr ""
#: assets/components/tracking/ConnectorForm.tsx:107
msgid "It indicates the organization that will pay for the ordered product"
msgstr ""
#: assets/components/tracking/ConnectorForm.tsx:118
msgid "API Terms of Service"
msgstr ""
#: assets/components/tracking/ConnectorForm.tsx:102
#: assets/components/tracking/ConnectorForm.tsx:125
msgid ""
"I certify that I have read and accepted the conditions of use of the "
"Provider API, accessible from this hyperlink"
msgstr ""
#: assets/components/tracking/ConnectorForm.tsx:108
#: assets/components/tracking/ConnectorForm.tsx:131
msgid "Legal age"
msgstr ""
#: assets/components/tracking/ConnectorForm.tsx:113
#: assets/components/tracking/ConnectorForm.tsx:136
msgid ""
"I certify on my honor that I am of the minimum age required to consent to "
"these conditions"
msgstr ""
#: assets/components/tracking/ConnectorForm.tsx:117
#: assets/components/tracking/ConnectorForm.tsx:140
msgid "Withdrawal period"
msgstr ""
#: assets/components/tracking/ConnectorForm.tsx:122
#: assets/components/tracking/ConnectorForm.tsx:145
msgid ""
"I expressly waive my right of withdrawal regarding the purchase of domain "
"names via the Provider's API"
@@ -503,6 +516,12 @@ msgid ""
"website"
msgstr ""
#: assets/utils/providers/index.tsx:16
msgid ""
"Retrieve a Personal Access Token from your customer account on the "
"Provider's website"
msgstr ""
#: assets/utils/providers/ovh.tsx:5
msgid "Application key"
msgstr ""