ISSUE-345: create subscriber list endpoint

Author: tatevikg1

config/services.yml

@@ -21,7 +21,3 @@ services:
     PhpList\Core\Security\Authentication:
         autowire: true
         autoconfigure: true
-
-    PhpList\Core\Domain\Repository\Messaging\SubscriberListRepository:
-        autowire: true
-        autoconfigure: true

config/services/managers.yml

@@ -11,3 +11,7 @@ services:
   PhpList\RestBundle\Service\Manager\SessionManager:
     autowire: true
     autoconfigure: true
+
+  PhpList\RestBundle\Service\Manager\SubscriberListManager:
+    autowire: true
+    autoconfigure: true

config/services/normalizers.yml

@@ -18,3 +18,7 @@ services:
   PhpList\RestBundle\Serializer\AdministratorTokenNormalizer:
     tags: [ 'serializer.normalizer' ]
     autowire: true
+
+  PhpList\RestBundle\Serializer\SubscriberListNormalizer:
+    tags: [ 'serializer.normalizer' ]
+    autowire: true

src/Controller/ListController.php

@@ -4,11 +4,15 @@
 
 namespace PhpList\RestBundle\Controller;
 
-use PhpList\Core\Domain\Model\Messaging\SubscriberList;
+use PhpList\Core\Domain\Model\Subscription\SubscriberList;
 use PhpList\Core\Domain\Repository\Subscription\SubscriberRepository;
+use PhpList\RestBundle\Entity\CreateSubscriberListRequest;
+use PhpList\RestBundle\Serializer\SubscriberListNormalizer;
+use PhpList\RestBundle\Service\Manager\SubscriberListManager;
+use PhpList\RestBundle\Validator\RequestValidator;
 use Symfony\Bridge\Doctrine\Attribute\MapEntity;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
-use PhpList\Core\Domain\Repository\Messaging\SubscriberListRepository;
+use PhpList\Core\Domain\Repository\Subscription\SubscriberListRepository;
 use PhpList\Core\Security\Authentication;
 use PhpList\RestBundle\Controller\Traits\AuthenticationTrait;
 use Symfony\Component\HttpFoundation\JsonResponse;
@@ -34,17 +38,21 @@ class ListController extends AbstractController
     private SubscriberListRepository $subscriberListRepository;
     private SubscriberRepository $subscriberRepository;
     private SerializerInterface $serializer;
+    private SubscriberListManager $subscriberListManager;
+    private RequestValidator $validator;
 
     public function __construct(
         Authentication $authentication,
         SubscriberListRepository $repository,
         SubscriberRepository $subscriberRepository,
-        SerializerInterface $serializer
+        SerializerInterface $serializer,
+        RequestValidator $validator
     ) {
         $this->authentication = $authentication;
         $this->subscriberListRepository = $repository;
         $this->subscriberRepository = $subscriberRepository;
         $this->serializer = $serializer;
+        $this->validator = $validator;
     }
 
     #[Route('', name: 'get_lists', methods: ['GET'])]
@@ -340,4 +348,71 @@ public function getSubscribersCount(
 
         return new JsonResponse($json, Response::HTTP_OK, [], true);
     }
+
+    #[Route('', name: 'create_list', methods: ['POST'])]
+    #[OA\Post(
+        path: '/lists',
+        description: 'Returns created list.',
+        summary: 'Create a subscriber list.',
+        requestBody: new OA\RequestBody(
+            description: 'Pass parameters to create a new subscriber list.',
+            required: true,
+            content: new OA\JsonContent(
+                required: ['name'],
+                properties: [
+                    new OA\Property(property: 'name', type: 'string', format: 'string', example: 'News'),
+                    new OA\Property(property: 'description', type: 'string', example: 'News (and some fun stuff)'),
+                    new OA\Property(property: 'list_position', type: 'number', example: 12),
+                    new OA\Property(property: 'public', type: 'boolean', example: true),
+                    new OA\Property(property: 'owner', type: 'number', example: 12),
+                ]
+            )
+        ),
+        tags: ['lists'],
+        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: 201,
+                description: 'Success',
+                content: new OA\JsonContent(
+                    type: 'object',
+                    example: [
+                        'name' => 'News',
+                        'description' => 'News (and some fun stuff)',
+                        'creation_date' => '2016-06-22T15:01:17+00:00',
+                        'list_position' => 12,
+                        'subject_prefix' => 'phpList',
+                        'public' => true,
+                        'category' => 'news',
+                        'id' => 1
+                    ]
+                )
+            ),
+            new OA\Response(
+                response: 403,
+                description: 'Failure',
+                content: new OA\JsonContent(ref: '#/components/schemas/UnauthorizedResponse')
+            )
+        ]
+    )]
+    public function createList(Request $request, SubscriberListNormalizer $normalizer): JsonResponse
+    {
+        $this->requireAuthentication($request);
+
+        /** @var CreateSubscriberListRequest $subscriberListRequest */
+        $subscriberListRequest = $this->validator->validate($request, CreateSubscriberListRequest::class);
+        $data = $this->subscriberListManager->createSubscriberList($subscriberListRequest);
+
+        return new JsonResponse($normalizer->normalize($data), Response::HTTP_CREATED, [], true);
+    }
 }

src/Entity/CreateSubscriberListRequest.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Entity;
+
+use Symfony\Component\Validator\Constraints as Assert;
+
+class CreateSubscriberListRequest implements RequestInterface
+{
+    #[Assert\NotBlank]
+    #[Assert\NotNull]
+    public string $name;
+
+    #[Assert\NotBlank]
+    public bool $public;
+
+    #[Assert\NotBlank]
+    public int $listPosition;
+
+    #[Assert\NotBlank]
+    public int $owner;
+
+    #[Assert\NotBlank]
+    #[Assert\NotNull]
+    public string $description;
+}

src/Serializer/SubscriberListNormalizer.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Serializer;
+
+use PhpList\Core\Domain\Model\Subscription\SubscriberList;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+class SubscriberListNormalizer implements NormalizerInterface
+{
+    /**
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function normalize($object, string $format = null, array $context = []): array
+    {
+        if (!$object instanceof SubscriberList) {
+            return [];
+        }
+
+        return [
+            'id' => $object->getId(),
+            'name' => $object->getName(),
+            'creation_date' => $object->getCreationDate()->format('Y-m-d\TH:i:sP'),
+            'description' => $object->getDescription(),
+            'list_position' => $object->getListPosition(),
+            'subject_prefix' => $object->getSubjectPrefix(),
+            'public' => $object->isPublic(),
+            'category' => $object->getCategory(),
+        ];
+    }
+
+    /**
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function supportsNormalization($data, string $format = null): bool
+    {
+        return $data instanceof SubscriberList;
+    }
+}

src/Service/Manager/SubscriberListManager.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Service\Manager;
+
+use Doctrine\ORM\EntityManagerInterface;
+use PhpList\Core\Domain\Model\Subscription\SubscriberList;
+use PhpList\Core\Domain\Repository\Subscription\SubscriberListRepository;
+use PhpList\RestBundle\Entity\CreateSubscriberListRequest;
+
+class SubscriberListManager
+{
+    private SubscriberListRepository $subscriberListRepository;
+    private EntityManagerInterface $entityManager;
+
+    public function __construct(
+        SubscriberListRepository $subscriberListRepository,
+        EntityManagerInterface $entityManager
+    ) {
+        $this->subscriberListRepository = $subscriberListRepository;
+        $this->entityManager = $entityManager;
+    }
+
+    public function createSubscriberList(CreateSubscriberListRequest $subscriberListRequest): SubscriberList
+    {
+        $subscriberList = (new SubscriberList())
+            ->setName($subscriberListRequest->name)
+            ->setDescription($subscriberListRequest->description)
+            ->setListPosition($subscriberListRequest->listPosition)
+            ->setPublic($subscriberListRequest->public);
+
+        $this->subscriberListRepository->save($subscriberList);
+
+        return $subscriberList;
+    }
+}

tests/Integration/Controller/Fixtures/SubscriberListFixture.php

@@ -8,7 +8,7 @@
 use Doctrine\Bundle\FixturesBundle\Fixture;
 use Doctrine\Persistence\ObjectManager;
 use PhpList\Core\Domain\Model\Identity\Administrator;
-use PhpList\Core\Domain\Model\Messaging\SubscriberList;
+use PhpList\Core\Domain\Model\Subscription\SubscriberList;
 use PhpList\Core\TestingSupport\Traits\ModelTestTrait;
 use RuntimeException;
 

tests/Integration/Controller/Fixtures/SubscriptionFixture.php

@@ -7,7 +7,7 @@
 use DateTime;
 use Doctrine\Bundle\FixturesBundle\Fixture;
 use Doctrine\Persistence\ObjectManager;
-use PhpList\Core\Domain\Model\Messaging\SubscriberList;
+use PhpList\Core\Domain\Model\Subscription\SubscriberList;
 use PhpList\Core\Domain\Model\Subscription\Subscriber;
 use PhpList\Core\Domain\Model\Subscription\Subscription;
 use PhpList\Core\TestingSupport\Traits\ModelTestTrait;

tests/Integration/Controller/ListControllerTest.php

@@ -4,7 +4,7 @@
 
 namespace PhpList\RestBundle\Tests\Integration\Controller;
 
-use PhpList\Core\Domain\Repository\Messaging\SubscriberListRepository;
+use PhpList\Core\Domain\Repository\Subscription\SubscriberListRepository;
 use PhpList\RestBundle\Controller\ListController;
 use PhpList\RestBundle\Tests\Integration\Controller\Fixtures\AdministratorFixture;
 use PhpList\RestBundle\Tests\Integration\Controller\Fixtures\AdministratorTokenFixture;