UserBlacklistNormalizer

Author: tatevikg1

config/services/normalizers.yml

@@ -93,3 +93,7 @@ services:
   PhpList\RestBundle\Statistics\Serializer\TopLocalPartsNormalizer:
     tags: [ 'serializer.normalizer' ]
     autowire: true
+
+  PhpList\RestBundle\Subscription\Serializer\UserBlacklistNormalizer:
+    tags: [ 'serializer.normalizer' ]
+    autowire: true

src/Subscription/Controller/BlacklistController.php

@@ -11,6 +11,7 @@
 use PhpList\RestBundle\Common\Controller\BaseController;
 use PhpList\RestBundle\Common\Validator\RequestValidator;
 use PhpList\RestBundle\Subscription\Request\AddToBlacklistRequest;
+use PhpList\RestBundle\Subscription\Serializer\UserBlacklistNormalizer;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -23,15 +24,18 @@
 class BlacklistController extends BaseController
 {
     private SubscriberBlacklistManager $blacklistManager;
+    private UserBlacklistNormalizer $normalizer;
 
     public function __construct(
         Authentication $authentication,
         RequestValidator $validator,
         SubscriberBlacklistManager $blacklistManager,
+        UserBlacklistNormalizer $normalizer,
     ) {
         parent::__construct($authentication, $validator);
         $this->authentication = $authentication;
         $this->blacklistManager = $blacklistManager;
+        $this->normalizer = $normalizer;
     }
 
     #[Route('/check/{email}', name: 'check', methods: ['GET'])]

src/Subscription/Serializer/UserBlacklistNormalizer.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Subscription\Serializer;
+
+use PhpList\Core\Domain\Subscription\Model\UserBlacklist;
+use PhpList\Core\Domain\Subscription\Service\Manager\SubscriberBlacklistManager;
+use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+
+class UserBlacklistNormalizer implements NormalizerInterface
+{
+    public function __construct(private readonly SubscriberBlacklistManager $blacklistManager)
+    {
+    }
+
+    /**
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function normalize($object, string $format = null, array $context = []): array
+    {
+        if (!$object instanceof UserBlacklist) {
+            return [];
+        }
+
+        $reason = $this->blacklistManager->getBlacklistReason($object->getEmail());
+
+        return [
+            'email' => $object->getEmail(),
+            'added' => $object->getAdded()?->format('Y-m-d\TH:i:sP'),
+            'reason' => $reason,
+        ];
+    }
+
+    /**
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function supportsNormalization($data, string $format = null): bool
+    {
+        return $data instanceof UserBlacklist;
+    }
+}

tests/Unit/Subscription/Serializer/UserBlacklistNormalizerTest.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\RestBundle\Tests\Unit\Subscription\Serializer;
+
+use DateTime;
+use PhpList\Core\Domain\Subscription\Model\UserBlacklist;
+use PhpList\Core\Domain\Subscription\Service\Manager\SubscriberBlacklistManager;
+use PhpList\RestBundle\Subscription\Serializer\UserBlacklistNormalizer;
+use PHPUnit\Framework\TestCase;
+use stdClass;
+
+class UserBlacklistNormalizerTest extends TestCase
+{
+    public function testSupportsNormalization(): void
+    {
+        $blacklistManager = $this->createMock(SubscriberBlacklistManager::class);
+        $normalizer = new UserBlacklistNormalizer($blacklistManager);
+        $userBlacklist = $this->createMock(UserBlacklist::class);
+
+        $this->assertTrue($normalizer->supportsNormalization($userBlacklist));
+        $this->assertFalse($normalizer->supportsNormalization(new stdClass()));
+    }
+
+    public function testNormalize(): void
+    {
+        $email = '[email protected]';
+        $added = new DateTime('2025-08-08T12:00:00+00:00');
+        $reason = 'Unsubscribed by user';
+
+        $userBlacklist = $this->createMock(UserBlacklist::class);
+        $userBlacklist->method('getEmail')->willReturn($email);
+        $userBlacklist->method('getAdded')->willReturn($added);
+
+        $blacklistManager = $this->createMock(SubscriberBlacklistManager::class);
+        $blacklistManager->method('getBlacklistReason')->with($email)->willReturn($reason);
+
+        $normalizer = new UserBlacklistNormalizer($blacklistManager);
+
+        $expected = [
+            'email' => $email,
+            'added' => '2025-08-08T12:00:00+00:00',
+            'reason' => $reason,
+        ];
+
+        $this->assertSame($expected, $normalizer->normalize($userBlacklist));
+    }
+
+    public function testNormalizeWithInvalidObject(): void
+    {
+        $blacklistManager = $this->createMock(SubscriberBlacklistManager::class);
+        $normalizer = new UserBlacklistNormalizer($blacklistManager);
+        
+        $this->assertSame([], $normalizer->normalize(new stdClass()));
+    }
+}