Subscriber history service

Author: tatevikg1

src/Domain/Subscription/Model/Filter/SubscriptionHistoryFilter.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Subscription\Model\Filter;
+
+use DateTimeImmutable;
+use PhpList\Core\Domain\Common\Model\Filter\FilterRequestInterface;
+use PhpList\Core\Domain\Subscription\Model\Subscriber;
+
+class SubscriptionHistoryFilter implements FilterRequestInterface
+{
+    private ?Subscriber $subscriber;
+    private ?string $ip;
+    private ?DateTimeImmutable $dateFrom;
+    private ?string $summery;
+
+    public function __construct(
+        ?Subscriber $subscriber = null,
+        ?string $ip = null,
+        ?DateTimeImmutable $dateFrom = null,
+        ?string $summery = null,
+    ) {
+        $this->subscriber = $subscriber;
+        $this->ip = $ip;
+        $this->dateFrom = $dateFrom;
+        $this->summery = $summery;
+    }
+
+    public function getSubscriber(): ?Subscriber
+    {
+        return $this->subscriber;
+    }
+
+    public function getIp(): ?string
+    {
+        return $this->ip;
+    }
+
+    public function getDateFrom(): ?DateTimeImmutable
+    {
+        return $this->dateFrom;
+    }
+
+    public function getSummery(): ?string
+    {
+        return $this->summery;
+    }
+}

src/Domain/Subscription/Repository/SubscriberHistoryRepository.php

@@ -4,11 +4,50 @@
 
 namespace PhpList\Core\Domain\Subscription\Repository;
 
+use InvalidArgumentException;
+use PhpList\Core\Domain\Common\Model\Filter\FilterRequestInterface;
 use PhpList\Core\Domain\Common\Repository\AbstractRepository;
 use PhpList\Core\Domain\Common\Repository\CursorPaginationTrait;
 use PhpList\Core\Domain\Common\Repository\Interfaces\PaginatableRepositoryInterface;
+use PhpList\Core\Domain\Subscription\Model\Filter\SubscriptionHistoryFilter;
+use PhpList\Core\Domain\Subscription\Model\SubscriberHistory;
 
 class SubscriberHistoryRepository extends AbstractRepository implements PaginatableRepositoryInterface
 {
     use CursorPaginationTrait;
+
+    /**
+     * @return SubscriberHistory[]
+     * @throws InvalidArgumentException
+     */
+    public function getFilteredAfterId(int $lastId, int $limit, ?FilterRequestInterface $filter = null): array
+    {
+        $queryBuilder = $this->createQueryBuilder('sh');
+
+        if (!$filter instanceof SubscriptionHistoryFilter) {
+            throw new InvalidArgumentException('Expected SubscriptionHistoryFilter.');
+        }
+
+        if ($filter->getSubscriber() !== null) {
+            $queryBuilder->andWhere('sh.subscriber = :subscriber')
+                ->setParameter('subscriber', $filter->getSubscriber());
+        }
+
+        if ($filter->getDateFrom() !== null) {
+            $queryBuilder->andWhere('sh.date >= :date')
+                ->setParameter('date', $filter->getDateFrom());
+        }
+
+        if ($filter->getIp() !== null) {
+            $queryBuilder->andWhere('sh.ip = :ip')
+                ->setParameter('ip', $filter->getIp());
+        }
+
+        if ($filter->getSummery() !== null) {
+            $queryBuilder->andWhere('sh.summery = :summery')
+                ->setParameter('summery', $filter->getSummery());
+        }
+
+        return $queryBuilder->getQuery()->getResult();
+    }
 }

src/Domain/Subscription/Service/SubscriptionHistoryService.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Subscription\Service;
+
+use PhpList\Core\Domain\Subscription\Model\Filter\SubscriptionHistoryFilter;
+use PhpList\Core\Domain\Subscription\Repository\SubscriberHistoryRepository;
+
+class SubscriptionHistoryService
+{
+    private SubscriberHistoryRepository $repository;
+
+    public function __construct(SubscriberHistoryRepository $repository)
+    {
+        $this->repository = $repository;
+    }
+
+    public function getHistory(int $lastId, int $limit, SubscriptionHistoryFilter $filter): array
+    {
+        return $this->repository->getFilteredAfterId($lastId, $limit, $filter);
+    }
+}

tests/Unit/Domain/Subscription/Service/SubscriptionHistoryServiceTest.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Tests\Unit\Domain\Subscription\Service;
+
+use PhpList\Core\Domain\Subscription\Model\Filter\SubscriptionHistoryFilter;
+use PhpList\Core\Domain\Subscription\Model\SubscriberHistory;
+use PhpList\Core\Domain\Subscription\Repository\SubscriberHistoryRepository;
+use PhpList\Core\Domain\Subscription\Service\SubscriptionHistoryService;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+class SubscriptionHistoryServiceTest extends TestCase
+{
+    private SubscriberHistoryRepository|MockObject $subscriberHistoryRepository;
+    private SubscriptionHistoryService $subscriptionHistoryService;
+
+    protected function setUp(): void
+    {
+        $this->subscriberHistoryRepository = $this->createMock(SubscriberHistoryRepository::class);
+        $this->subscriptionHistoryService = new SubscriptionHistoryService(
+            repository: $this->subscriberHistoryRepository
+        );
+    }
+
+    public function testGetHistoryCallsRepositoryWithCorrectParameters(): void
+    {
+        $lastId = 10;
+        $limit = 20;
+        $filter = $this->createMock(SubscriptionHistoryFilter::class);
+        $expectedResult = [$this->createMock(SubscriberHistory::class)];
+
+        $this->subscriberHistoryRepository
+            ->expects($this->once())
+            ->method('getFilteredAfterId')
+            ->with($lastId, $limit, $filter)
+            ->willReturn($expectedResult);
+
+        $result = $this->subscriptionHistoryService->getHistory($lastId, $limit, $filter);
+
+        $this->assertSame($expectedResult, $result);
+    }
+
+    public function testGetHistoryReturnsEmptyArrayWhenRepositoryReturnsEmptyArray(): void
+    {
+        $lastId = 10;
+        $limit = 20;
+        $filter = $this->createMock(SubscriptionHistoryFilter::class);
+        $expectedResult = [];
+
+        $this->subscriberHistoryRepository
+            ->expects($this->once())
+            ->method('getFilteredAfterId')
+            ->with($lastId, $limit, $filter)
+            ->willReturn($expectedResult);
+
+        $result = $this->subscriptionHistoryService->getHistory($lastId, $limit, $filter);
+
+        $this->assertSame($expectedResult, $result);
+        $this->assertEmpty($result);
+    }
+}