Add: getPublicPage endpoint

Author: tatevikg1

src/Subscription/Controller/SubscribePageController.php

@@ -16,6 +16,7 @@
 use PhpList\RestBundle\Common\Validator\RequestValidator;
 use PhpList\RestBundle\Subscription\Request\SubscribePageRequest;
 use PhpList\RestBundle\Subscription\Serializer\SubscribePageNormalizer;
+use PhpList\RestBundle\Subscription\Serializer\SubscribePagePublicNormalizer;
 use Symfony\Bridge\Doctrine\Attribute\MapEntity;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
@@ -153,16 +154,58 @@ className: SubscribePage::class,
     )]
     public function getPage(Request $request): JsonResponse
     {
-        $admin = $this->authentication->authenticateByApiKey($request);
-        $page = $this->subscribePageManager->findPage(id: (int) $request->get('id'));
+        $admin = $this->requireAuthentication($request);
+        if (!$admin->getPrivileges()->has(PrivilegeFlag::Subscribers)) {
+            throw $this->createAccessDeniedException('You are not allowed to view subscribe pages.');
+        }
 
-        if (!$page || ($page->isActive() === false && $admin === null)) {
+        $page = $this->subscribePageManager->findPage(id: (int) $request->get('id'));
+        if (!$page) {
             throw $this->createNotFoundException('Subscribe page not found');
         }
 
         return $this->json($this->normalizer->normalize($page), Response::HTTP_OK);
     }
 
+    #[Route('/{id}/public', name: 'get_public', requirements: ['id' => '\\d+'], methods: ['GET'])]
+    #[OA\Get(
+        path: '/api/v2/subscribe-pages/{id}/public',
+        description: '🚧 **Status: Beta** – This method is under development. Avoid using in production.',
+        summary: 'Get public subscribe page (placeholders replaced with actual values)',
+        tags: ['subscriptions'],
+        parameters: [
+            new OA\Parameter(
+                name: 'id',
+                description: 'Subscribe page ID',
+                in: 'path',
+                required: true,
+                schema: new OA\Schema(type: 'integer')
+            )
+        ],
+        responses: [
+            new OA\Response(
+                response: 200,
+                description: 'Success',
+                content: new OA\JsonContent(ref: '#/components/schemas/SubscribePagePublic'),
+            ),
+            new OA\Response(
+                response: 404,
+                description: 'Not Found',
+                content: new OA\JsonContent(ref: '#/components/schemas/NotFoundErrorResponse')
+            ),
+        ]
+    )]
+    public function getPublicPage(Request $request, SubscribePagePublicNormalizer $normalizer): JsonResponse
+    {
+        $page = $this->subscribePageManager->findPublicPage(id: (int) $request->get('id'));
+
+        if (!$page || $page->isActive() === false) {
+            throw $this->createNotFoundException('Subscribe page not found');
+        }
+
+        return $this->json($normalizer->normalize($page), Response::HTTP_OK);
+    }
+
     #[Route('', name: 'create', methods: ['POST'])]
     #[OA\Post(
         path: '/api/v2/subscribe-pages',

src/Subscription/Serializer/SubscribePagePublicNormalizer.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Subscription\Serializer;
+
+use OpenApi\Attributes as OA;
+use PhpList\Core\Domain\Subscription\Model\SubscribePage;
+use PhpList\Core\Domain\Subscription\Model\SubscribePageData;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+#[OA\Schema(
+    schema: 'SubscribePagePublic',
+    properties: [
+        new OA\Property(property: 'id', type: 'integer', example: 1),
+        new OA\Property(property: 'title', type: 'string', example: 'Subscribe to our newsletter'),
+        new OA\Property(
+            property: 'data',
+            type: 'array',
+            items: new OA\Items(
+                type: 'object',
+                additionalProperties: new OA\AdditionalProperties(
+                    type: 'string'
+                )
+            )
+        ),
+    ],
+)]
+class SubscribePagePublicNormalizer implements NormalizerInterface
+{
+    /**
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function normalize($object, string $format = null, array $context = []): array
+    {
+        if (!$object instanceof SubscribePage) {
+            return [];
+        }
+
+        return [
+            'id' => $object->getId(),
+            'title' => $object->getTitle(),
+            'data' => array_reduce(
+                $object->getData(),
+                function (array $carry, SubscribePageData $data) {
+                    $carry[$data->getName()] = $data->getData();
+                    return $carry;
+                },
+                []
+            ),
+        ];
+    }
+
+    /**
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function supportsNormalization($data, string $format = null): bool
+    {
+        return $data instanceof SubscribePage;
+    }
+}

tests/Integration/Subscription/Controller/SubscribePageControllerTest.php

@@ -20,12 +20,12 @@ public function testControllerIsAvailableViaContainer(): void
         );
     }
 
-    public function testGetSubscribePageWithoutSessionReturnsPageIfItIsActive(): void
+    public function testGetSubscribePageWithoutSessionReturnsForbidden(): void
     {
         $this->loadFixtures([AdministratorFixture::class, SubscribePageFixture::class]);
 
         self::getClient()->request('GET', '/api/v2/subscribe-pages/1');
-        $this->assertHttpOkay();
+        $this->assertHttpForbidden();
     }
 
     public function testGetSubscribePageWithSessionReturnsPage(): void

tests/Unit/Subscription/Serializer/SubscribePagePublicNormalizerTest.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Tests\Unit\Subscription\Serializer;
+
+use PhpList\Core\Domain\Identity\Model\Administrator;
+use PhpList\Core\Domain\Subscription\Model\SubscribePage;
+use PhpList\RestBundle\Subscription\Serializer\SubscribePagePublicNormalizer;
+use PHPUnit\Framework\TestCase;
+use stdClass;
+
+class SubscribePagePublicNormalizerTest extends TestCase
+{
+    public function testSupportsNormalization(): void
+    {
+        $normalizer = new SubscribePagePublicNormalizer();
+
+        $page = $this->createMock(SubscribePage::class);
+
+        $this->assertTrue($normalizer->supportsNormalization($page));
+        $this->assertFalse($normalizer->supportsNormalization(new stdClass()));
+    }
+
+    public function testNormalizeReturnsExpectedArray(): void
+    {
+        $owner = $this->createMock(Administrator::class);
+
+        $page = $this->createMock(SubscribePage::class);
+        $page->method('getId')->willReturn(42);
+        $page->method('getTitle')->willReturn('welcome@example.org');
+        $page->method('isActive')->willReturn(true);
+        $page->method('getOwner')->willReturn($owner);
+
+        $normalizer = new SubscribePagePublicNormalizer();
+
+        $expected = [
+            'id' => 42,
+            'title' => 'welcome@example.org',
+            'data' => [],
+        ];
+
+        $this->assertSame($expected, $normalizer->normalize($page));
+    }
+
+    public function testNormalizeWithInvalidObjectReturnsEmptyArray(): void
+    {
+        $normalizer = new SubscribePagePublicNormalizer();
+        $this->assertSame([], $normalizer->normalize(new stdClass()));
+    }
+}