Add: history to subscriber object

Author: tatevikg1

src/Subscription/Controller/SubscriberController.php

@@ -339,7 +339,7 @@ public function getSubscriber(Request $request, int $subscriberId): JsonResponse
     {
         $this->requireAuthentication($request);
 
-        $subscriber = $this->subscriberManager->getSubscriberById($subscriberId);
+        $subscriber = $this->subscriberManager->getSubscriberDetails($subscriberId);
         $subscriberData = $this->subscriberNormalizer->normalize($subscriber);
 
         return $this->json($subscriberData, Response::HTTP_OK);

src/Subscription/Serializer/SubscriberNormalizer.php

@@ -6,6 +6,7 @@
 
 use OpenApi\Attributes as OA;
 use PhpList\Core\Domain\Subscription\Model\Subscriber;
+use PhpList\Core\Domain\Subscription\Model\SubscriberHistory;
 use PhpList\Core\Domain\Subscription\Model\Subscription;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
@@ -20,6 +21,12 @@
             format: 'date-time',
             example: '2023-01-01T12:00:00Z',
         ),
+        new OA\Property(
+            property: 'updated_at',
+            type: 'string',
+            format: 'date-time',
+            example: '2026-01-01T12:00:00Z',
+        ),
         new OA\Property(property: 'confirmed', type: 'boolean', example: true),
         new OA\Property(property: 'blacklisted', type: 'boolean', example: false),
         new OA\Property(property: 'bounce_count', type: 'integer', example: 0),
@@ -31,13 +38,20 @@
             type: 'array',
             items: new OA\Items(ref: '#/components/schemas/SubscriberList')
         ),
+        new OA\Property(
+            property: 'history',
+            type: 'array',
+            items: new OA\Items(ref: '#/components/schemas/SubscriberHistory')
+        ),
     ],
     type: 'object'
 )]
 class SubscriberNormalizer implements NormalizerInterface
 {
-    public function __construct(private readonly SubscriberListNormalizer $subscriberListNormalizer)
-    {
+    public function __construct(
+        private readonly SubscriberListNormalizer $subscriberListNormalizer,
+        private readonly SubscriberHistoryNormalizer $subscriberHistoryNormalizer,
+    ) {
     }
 
     /**
@@ -53,6 +67,7 @@ public function normalize($object, string $format = null, array $context = []):
             'id' => $object->getId(),
             'email' => $object->getEmail(),
             'created_at' => $object->getCreatedAt()->format('Y-m-d\TH:i:sP'),
+            'updated_at' => $object->getUpdatedAt()->format('Y-m-d\TH:i:sP'),
             'confirmed' => $object->isConfirmed(),
             'blacklisted' => $object->isBlacklisted(),
             'bounce_count' => $object->getBounceCount(),
@@ -62,6 +77,9 @@ public function normalize($object, string $format = null, array $context = []):
             'subscribed_lists' => array_map(function (Subscription $subscription) {
                 return $this->subscriberListNormalizer->normalize($subscription->getSubscriberList());
             }, $object->getSubscriptions()->toArray()),
+            'history' => array_map(function (SubscriberHistory $history) {
+                return  $this->subscriberHistoryNormalizer->normalize($history);
+            }, $object->getHistory()),
         ];
     }
 

tests/Unit/Subscription/Serializer/SubscriberNormalizerTest.php

@@ -9,6 +9,7 @@
 use PhpList\Core\Domain\Subscription\Model\Subscriber;
 use PhpList\Core\Domain\Subscription\Model\SubscriberList;
 use PhpList\Core\Domain\Subscription\Model\Subscription;
+use PhpList\RestBundle\Subscription\Serializer\SubscriberHistoryNormalizer;
 use PhpList\RestBundle\Subscription\Serializer\SubscriberListNormalizer;
 use PhpList\RestBundle\Subscription\Serializer\SubscriberNormalizer;
 use PHPUnit\Framework\TestCase;
@@ -18,7 +19,7 @@ class SubscriberNormalizerTest extends TestCase
 {
     public function testSupportsNormalization(): void
     {
-        $normalizer = new SubscriberNormalizer(new SubscriberListNormalizer());
+        $normalizer = new SubscriberNormalizer(new SubscriberListNormalizer(), new SubscriberHistoryNormalizer());
         $subscriber = $this->createMock(Subscriber::class);
 
         $this->assertTrue($normalizer->supportsNormalization($subscriber));
@@ -50,12 +51,13 @@ public function testNormalize(): void
         $subscriber->method('isDisabled')->willReturn(false);
         $subscriber->method('getSubscriptions')->willReturn(new ArrayCollection([$subscription]));
 
-        $normalizer = new SubscriberNormalizer(new SubscriberListNormalizer());
+        $normalizer = new SubscriberNormalizer(new SubscriberListNormalizer(), new SubscriberHistoryNormalizer());
 
         $expected = [
             'id' => 101,
             'email' => 'test@example.com',
             'created_at' => '2024-12-31T12:00:00+00:00',
+            'updated_at' => '',
             'confirmed' => true,
             'blacklisted' => false,
             'bounce_count' => 0,
@@ -73,15 +75,16 @@ public function testNormalize(): void
                     'public' => true,
                     'category' => '',
                 ]
-            ]
+            ],
+            'history' => [],
         ];
 
         $this->assertSame($expected, $normalizer->normalize($subscriber));
     }
 
     public function testNormalizeWithInvalidObject(): void
     {
-        $normalizer = new SubscriberNormalizer(new SubscriberListNormalizer());
+        $normalizer = new SubscriberNormalizer(new SubscriberListNormalizer(), new SubscriberHistoryNormalizer());
         $this->assertSame([], $normalizer->normalize(new stdClass()));
     }
 }