ISSUE-345: delete subscription endpoint

Author: tatevikg1

config/services/normalizers.yml

@@ -2,6 +2,7 @@ services:
   _defaults:
     autowire: true
     autoconfigure: true
+    public: false
 
   Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter: ~
 

config/services/validators.yml

@@ -2,6 +2,7 @@ services:
   PhpList\RestBundle\Validator\RequestValidator:
     autowire: true
     autoconfigure: true
+    public: false
 
   PhpList\RestBundle\Validator\UniqueEmailValidator:
     autowire: true

src/Controller/SubscriptionController.php

@@ -7,7 +7,8 @@
 use OpenApi\Attributes as OA;
 use PhpList\Core\Security\Authentication;
 use PhpList\RestBundle\Controller\Traits\AuthenticationTrait;
-use PhpList\RestBundle\Entity\Request\CreateSubscriptionRequest;
+use PhpList\RestBundle\Entity\Request\SubscriptionRequest;
+use PhpList\RestBundle\Entity\Request\DeleteSubscriptionRequest;
 use PhpList\RestBundle\Serializer\SubscriptionNormalizer;
 use PhpList\RestBundle\Service\Manager\SubscriptionManager;
 use PhpList\RestBundle\Validator\RequestValidator;
@@ -98,13 +99,68 @@ public function createSubscription(Request $request, SubscriptionNormalizer $ser
     {
         $this->requireAuthentication($request);
 
-        /** @var CreateSubscriptionRequest $subscriptionRequest */
-        $subscriptionRequest = $this->validator->validate($request, CreateSubscriptionRequest::class);
+        /** @var SubscriptionRequest $subscriptionRequest */
+        $subscriptionRequest = $this->validator->validate($request, SubscriptionRequest::class);
         $subscription = $this->subscriptionManager->createSubscription(
             $subscriptionRequest->email,
             $subscriptionRequest->listId
         );
 
         return new JsonResponse($serializer->normalize($subscription, 'json'), Response::HTTP_CREATED);
     }
+
+    #[Route('', name: 'delete_subscription', methods: ['DELETE'])]
+    #[OA\Delete(
+        path: '/subscriptions',
+        description: 'Delete subscription.',
+        summary: 'Delete subscription',
+        requestBody: new OA\RequestBody(
+            description: 'Pass session credentials',
+            required: true,
+            content: new OA\JsonContent(
+                required: ['email', 'list_id'],
+                properties: [
+                    new OA\Property(property: 'email', type: 'string', example: '[email protected]'),
+                    new OA\Property(property: 'list_id', type: 'integer', example: 2),
+                ]
+            )
+        ),
+        tags: ['subscriptions'],
+        parameters: [
+            new OA\Parameter(
+                name: 'session',
+                description: 'Session ID obtained from authentication',
+                in: 'header',
+                required: true,
+                schema: new OA\Schema(type: 'string')
+            ),
+        ],
+        responses: [
+            new OA\Response(
+                response: 204,
+                description: 'Success',
+            ),
+            new OA\Response(
+                response: 403,
+                description: 'Failure',
+                content: new OA\JsonContent(ref: '#/components/schemas/UnauthorizedResponse')
+            ),
+            new OA\Response(
+                response: 404,
+                description: 'Not Found',
+            )
+        ]
+    )]
+    public function deleteSubscriber(
+        Request $request,
+    ): JsonResponse {
+        $this->requireAuthentication($request);
+
+        /** @var SubscriptionRequest $subscriptionRequest */
+        $subscriptionRequest = $this->validator->validate($request, SubscriptionRequest::class);
+
+        $this->subscriptionManager->deleteSubscription($subscriptionRequest->email, $subscriptionRequest->listId);
+
+        return new JsonResponse(null, Response::HTTP_NO_CONTENT);
+    }
 }

src/Entity/Request/CreateSubscriptionRequest.php renamed to src/Entity/Request/SubscriptionRequest.php

@@ -7,7 +7,7 @@
 use PhpList\RestBundle\Validator as CustomAssert;
 use Symfony\Component\Validator\Constraints as Assert;
 
-class CreateSubscriptionRequest implements RequestInterface
+class SubscriptionRequest implements RequestInterface
 {
     #[Assert\NotBlank]
     #[Assert\Email]

src/EventListener/ExceptionListener.php

@@ -5,6 +5,7 @@
 namespace PhpList\RestBundle\EventListener;
 
 use Exception;
+use PhpList\RestBundle\Exception\SubscriptionCreationException;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpKernel\Event\ExceptionEvent;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
@@ -27,6 +28,11 @@ public function onKernelException(ExceptionEvent $event): void
                 'message' => $exception->getMessage(),
             ], $exception->getStatusCode());
 
+            $event->setResponse($response);
+        } elseif ($exception instanceof SubscriptionCreationException) {
+            $response = new JsonResponse([
+                'message' => $exception->getMessage(),
+            ], $exception->getStatusCode());
             $event->setResponse($response);
         } elseif ($exception instanceof Exception) {
             $response = new JsonResponse([

src/Exception/SubscriptionCreationException.php

@@ -8,4 +8,16 @@
 
 class SubscriptionCreationException extends RuntimeException
 {
+    private int $statusCode;
+
+    public function __construct(string $message, int $statusCode)
+    {
+        parent::__construct($message);
+        $this->statusCode = $statusCode;
+    }
+
+    public function getStatusCode(): int
+    {
+        return $this->statusCode;
+    }
 }

src/Service/Manager/SubscriptionManager.php

@@ -32,14 +32,14 @@ public function createSubscription(string $email, int $listId): Subscription
         $subscriberList = $this->subscriberListRepository->find($listId);
 
         if (!$subscriber || !$subscriberList) {
-            throw new SubscriptionCreationException('Subscriber or list does not exists.');
+            throw new SubscriptionCreationException('Subscriber or list does not exists.', 404);
         }
 
         $existingSubscription = $this->subscriptionRepository
             ->findOneBySubscriberListAndSubscriber($subscriberList, $subscriber);
 
         if ($existingSubscription) {
-            throw new SubscriptionCreationException('Subscriber is already subscribed to this list.');
+            throw new SubscriptionCreationException('Subscriber is already subscribed to this list.', 409);
         }
         $subscription = new Subscription();
         $subscription->setSubscriber($subscriber);
@@ -49,4 +49,15 @@ public function createSubscription(string $email, int $listId): Subscription
 
         return $subscription;
     }
+
+    public function deleteSubscription(string $email, int $listId): void
+    {
+        $subscription = $this->subscriptionRepository->findOneBySubscriberEmailAndListId($listId, $email);
+
+        if (!$subscription) {
+            throw new SubscriptionCreationException('Subscription not found for this subscriber and list.', 404);
+        }
+
+        $this->subscriptionRepository->remove($subscription);
+    }
 }