feat: MailJet list handling with DOI, webhook receiver and API endpoint

addresses #869cut134

src/Controller/Api/NewsletterSubscriptionController.php

@@ -0,0 +1,114 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Controller\Api;
+
+use App\Exception\NewsletterListNotAllowedException;
+use App\Exception\NewsletterProviderException;
+use App\Model\NewsletterSubscriptionRequest;
+use App\Model\NewsletterSubscriptionRequestResult;
+use App\Service\NewsletterManager;
+use Psr\Log\LoggerInterface;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Attribute\MapRequestPayload;
+use Symfony\Component\Routing\Attribute\Route;
+use Symfony\Component\Security\Http\Attribute\IsGranted;
+
+#[Route('/api')]
+#[IsGranted('ROLE_OAUTH2_API')]
+class NewsletterSubscriptionController extends AbstractController
+{
+    /**
+     * @param array<int, string> $mailjetLists
+     */
+    public function __construct(
+        private readonly NewsletterManager $newsletterManager,
+        private readonly LoggerInterface $logger,
+        private readonly array $mailjetLists = [],
+    ) {
+    }
+
+    #[Route('/newsletters', name: 'api_newsletters_all', methods: ['GET'])]
+    public function index():JsonResponse
+    {
+        return $this->json($this->newsletterManager->createListIdMapping(array_keys($this->mailjetLists)));
+    }
+
+    #[Route('/newsletter-subscriptions', name: 'api_newsletters_subscriptions', methods: ['POST'])]
+    public function subscribe(
+        #[MapRequestPayload(validationFailedStatusCode: Response::HTTP_BAD_REQUEST)]
+        NewsletterSubscriptionRequest $request,
+    ): JsonResponse {
+        try {
+            $result = $this
+                ->newsletterManager
+                ->requestApiSubscription(
+                    (string) $request->email,
+                    $request->listIds,
+                    array_keys($this->mailjetLists),
+                    $request->firstName,
+                    $request->lastName,
+                )
+            ;
+        } catch (NewsletterListNotAllowedException $exception) {
+            return $this->badRequest($exception->getMessage(), [
+                'listIds' => $exception->getListIds(),
+                'unknownListIds' => $exception->getUnknownListIds(),
+            ]);
+        } catch (\InvalidArgumentException $exception) {
+            return $this->badRequest($exception->getMessage(), [
+                'listIds' => $request->listIds,
+            ]);
+        } catch (NewsletterProviderException $exception) {
+            $this->logger->warning('Newsletter subscription request failed', [
+                'email' => $request->email,
+                'list_ids' => $request->listIds,
+                'error' => $exception->getMessage(),
+            ]);
+
+            return new JsonResponse([
+                'success' => false,
+                'email' => $request->email,
+                'listIds' => $request->listIds,
+                'message' => 'Newsletter subscription request could not be processed.',
+            ], Response::HTTP_SERVICE_UNAVAILABLE);
+        }
+
+        return new JsonResponse(
+            $this->responsePayload($result),
+            NewsletterSubscriptionRequestResult::STATE_CONFIRMATION_REQUESTED === $result->state
+                ? Response::HTTP_ACCEPTED
+                : Response::HTTP_OK,
+        );
+    }
+
+    /**
+     * @param array<string, mixed> $extra
+     */
+    private function badRequest(string $message, array $extra = []): JsonResponse
+    {
+        return new JsonResponse(array_merge([
+            'success' => false,
+            'message' => $message,
+        ], $extra), Response::HTTP_BAD_REQUEST);
+    }
+
+    private function responsePayload(NewsletterSubscriptionRequestResult $result): array
+    {
+        return [
+            'success' => true,
+            'email' => $result->email,
+            'lists' => array_map(
+                fn (array $list): array => array_merge($list, [
+                    'state' => $result->stateForList((int) $list['id']),
+                ]),
+                $this->newsletterManager->createListIdMapping($result->listIds),
+            ),
+            'state' => $result->state,
+            'confirmationRequested' => $result->confirmationRequested,
+        ];
+    }
+}

src/Controller/Api/PickupController.php

@@ -19,7 +19,7 @@ use Symfony\Component\Security\Http\Attribute\IsGranted;
 #[IsGranted('ROLE_OAUTH2_API')]
 class PickupController extends AbstractController
 {
-    private const PLANNING_FILE = 'pickup_planning.json';
+    private const string PLANNING_FILE = 'pickup_planning.json';
 
     public function __construct(
         private readonly PickupLoader $xmlLoader,