ISSUE-345: add validator

Author: tatevikg1

src/Controller/SubscriberController.php

@@ -4,16 +4,16 @@
 
 namespace PhpList\RestBundle\Controller;
 
+use PhpList\RestBundle\Entity\SubscriberRequest;
+use PhpList\RestBundle\Service\Manager\SubscriberManager;
+use PhpList\RestBundle\Validator\RequestValidator;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
-use PhpList\Core\Domain\Model\Subscription\Subscriber;
 use PhpList\Core\Domain\Repository\Subscription\SubscriberRepository;
 use PhpList\Core\Security\Authentication;
 use PhpList\RestBundle\Controller\Traits\AuthenticationTrait;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Exception\ConflictHttpException;
-use Symfony\Component\HttpKernel\Exception\UnprocessableEntityHttpException;
 use Symfony\Component\Routing\Attribute\Route;
 use Symfony\Component\Serializer\SerializerInterface;
 use OpenApi\Attributes as OA;
@@ -28,11 +28,16 @@ class SubscriberController extends AbstractController
     use AuthenticationTrait;
 
     private SubscriberRepository $subscriberRepository;
+    private SubscriberManager $subscriberManager;
 
-    public function __construct(Authentication $authentication, SubscriberRepository $repository)
-    {
+    public function __construct(
+        Authentication $authentication,
+        SubscriberRepository $repository,
+        SubscriberManager $subscriberManager,
+    ) {
         $this->authentication = $authentication;
         $this->subscriberRepository = $repository;
+        $this->subscriberManager = $subscriberManager;
     }
 
     #[Route('/subscribers', name: 'create_subscriber', methods: ['POST'])]
@@ -126,25 +131,16 @@ public function __construct(Authentication $authentication, SubscriberRepository
             )
         ]
     )]
-    public function postAction(Request $request, SerializerInterface $serializer): JsonResponse
-    {
+    public function postAction(
+        Request $request,
+        SerializerInterface $serializer,
+        RequestValidator $validator
+    ): JsonResponse {
         $this->requireAuthentication($request);
-        $data = $request->getPayload();
-        $this->validateSubscriber($request);
-
-        $email = $data->get('email');
-        if ($this->subscriberRepository->findOneByEmail($email) !== null) {
-            throw new ConflictHttpException('This resource already exists.', null, 1513439108);
-        }
-        $confirmed = (bool)$data->get('request_confirmation', true);
-        $subscriber = new Subscriber();
-        $subscriber->setEmail($email);
-        $subscriber->setConfirmed(!$confirmed);
-        $subscriber->setBlacklisted(false);
-        $subscriber->setHtmlEmail((bool)$data->get('html_email', true));
-        $subscriber->setDisabled(false);
 
-        $this->subscriberRepository->save($subscriber);
+        /** @var SubscriberRequest $subscriberRequest */
+        $subscriberRequest = $validator->validate($request, SubscriberRequest::class);
+        $subscriber = $this->subscriberManager->createSubscriber($subscriberRequest);
 
         return new JsonResponse(
             $serializer->serialize($subscriber, 'json'),
@@ -256,37 +252,4 @@ public function getAction(Request $request, int $subscriberId, SerializerInterfa
 
         return new JsonResponse($data, Response::HTTP_OK, [], true);
     }
-
-    /**
-     * @param Request $request
-     *
-     * @return void
-     *
-     * @throws UnprocessableEntityHttpException
-     */
-    private function validateSubscriber(Request $request): void
-    {
-        /** @var string[] $invalidFields */
-        $invalidFields = [];
-        if (filter_var($request->getPayload()->get('email'), FILTER_VALIDATE_EMAIL) === false) {
-            $invalidFields[] = 'email';
-        }
-
-        $booleanFields = ['request_confirmation', 'html_email'];
-        foreach ($booleanFields as $fieldKey) {
-            if ($request->getPayload()->get($fieldKey) !== null
-                && !is_bool($request->getPayload()->get($fieldKey))
-            ) {
-                $invalidFields[] = $fieldKey;
-            }
-        }
-
-        if (!empty($invalidFields)) {
-            throw new UnprocessableEntityHttpException(
-                'Some fields invalid:' . implode(', ', $invalidFields),
-                null,
-                1513446736
-            );
-        }
-    }
 }

src/Entity/SubscriberRequest.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Entity;
+
+use Symfony\Component\Validator\Constraints as Assert;
+use PhpList\RestBundle\Validator\UniqueEmail;
+
+class SubscriberRequest
+{
+    #[Assert\NotBlank]
+    #[Assert\Email]
+    #[UniqueEmail]
+    public string $email;
+
+    #[Assert\Type(type: 'bool')]
+    public ?bool $request_confirmation = null;
+
+    #[Assert\Type(type: 'bool')]
+    public ?bool $html_email = null;
+}

src/Service/Manager/SubscriberManager.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Service\Manager;
+
+use PhpList\Core\Domain\Model\Subscription\Subscriber;
+use PhpList\Core\Domain\Repository\Subscription\SubscriberRepository;
+use PhpList\RestBundle\Entity\SubscriberRequest;
+
+class SubscriberManager
+{
+    private SubscriberRepository $subscriberRepository;
+
+    public function __construct(SubscriberRepository $subscriberRepository)
+    {
+        $this->subscriberRepository = $subscriberRepository;
+    }
+
+    public function createSubscriber(SubscriberRequest $subscriberRequest): Subscriber
+    {
+        $subscriber = new Subscriber();
+        $subscriber->setEmail($subscriberRequest->email);
+        $confirmed = (bool)$subscriberRequest->request_confirmation;
+        $subscriber->setConfirmed(!$confirmed);
+        $subscriber->setBlacklisted(false);
+        $subscriber->setHtmlEmail((bool)$subscriberRequest->html_email);
+        $subscriber->setDisabled(false);
+
+        $this->subscriberRepository->save($subscriber);
+
+        return $subscriber;
+    }
+}

src/Validator/RequestValidator.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Validator;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Serializer\SerializerInterface;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+
+class RequestValidator
+{
+    public function __construct(
+        private readonly SerializerInterface $serializer,
+        private readonly ValidatorInterface $validator
+    ) {}
+
+    public function validate(Request $request, string $dtoClass): object
+    {
+        $dto = $this->serializer->deserialize($request->getContent(), $dtoClass, 'json');
+
+        $errors = $this->validator->validate($dto);
+
+        if (count($errors) > 0) {
+            throw new BadRequestHttpException((string) $errors);
+        }
+
+        return $dto;
+    }
+}

src/Validator/UniqueEmail.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Validator;
+
+use Symfony\Component\Validator\Constraint;
+
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::IS_REPEATABLE)]
+class UniqueEmail extends Constraint
+{
+    public string $message = 'The email "{{ value }}" is already in use.';
+}

src/Validator/UniqueEmailValidator.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Validator;
+
+use PhpList\Core\Domain\Repository\Subscription\SubscriberRepository;
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+
+class UniqueEmailValidator extends ConstraintValidator
+{
+    private SubscriberRepository $subscriberRepository;
+
+    public function __construct(SubscriberRepository $subscriberRepository)
+    {
+        $this->subscriberRepository = $subscriberRepository;
+    }
+
+    public function validate($value, Constraint $constraint)
+    {
+        /* @var $constraint UniqueEmail */
+
+        if (null === $value || '' === $value) {
+            return;
+        }
+
+        if ($this->subscriberRepository->findOneByEmail($value)) {
+            $this->context->buildViolation($constraint->message)
+                ->setParameter('{{ value }}', $value)
+                ->addViolation();
+        }
+    }
+}
+