From 84a7981dfaf2c0386625c8d2ed0d63f4ae9dc908 Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandrocelaya@gmail.com>
Date: Sun, 14 May 2023 12:00:08 +0200
Subject: [PATCH] Create REST action to delete short URL visits

---
 config/autoload/routes.config.php             |  1 +
 module/Core/config/dependencies.config.php    |  9 +++++
 module/Core/src/Model/BulkDeleteResult.php    | 17 ++++++++++
 .../src/ShortUrl/ShortUrlVisitsDeleter.php    | 25 ++++++++++++++
 .../ShortUrlVisitsDeleterInterface.php        | 14 ++++++++
 .../Repository/VisitDeleterRepository.php     | 18 ++++++++++
 .../VisitDeleterRepositoryInterface.php       | 13 ++++++++
 module/Rest/config/dependencies.config.php    |  2 ++
 .../ShortUrl/DeleteShortUrlVisitsAction.php   | 33 +++++++++++++++++++
 9 files changed, 132 insertions(+)
 create mode 100644 module/Core/src/Model/BulkDeleteResult.php
 create mode 100644 module/Core/src/ShortUrl/ShortUrlVisitsDeleter.php
 create mode 100644 module/Core/src/ShortUrl/ShortUrlVisitsDeleterInterface.php
 create mode 100644 module/Core/src/Visit/Repository/VisitDeleterRepository.php
 create mode 100644 module/Core/src/Visit/Repository/VisitDeleterRepositoryInterface.php
 create mode 100644 module/Rest/src/Action/ShortUrl/DeleteShortUrlVisitsAction.php

diff --git a/config/autoload/routes.config.php b/config/autoload/routes.config.php
index c887d5b7..93464519 100644
--- a/config/autoload/routes.config.php
+++ b/config/autoload/routes.config.php
@@ -53,6 +53,7 @@ return (static function (): array {
                 ]),
                 Action\ShortUrl\EditShortUrlAction::getRouteDef([$dropDomainMiddleware]),
                 Action\ShortUrl\DeleteShortUrlAction::getRouteDef([$dropDomainMiddleware]),
+                Action\ShortUrl\DeleteShortUrlVisitsAction::getRouteDef([$dropDomainMiddleware]),
                 Action\ShortUrl\ResolveShortUrlAction::getRouteDef([$dropDomainMiddleware]),
                 Action\ShortUrl\ListShortUrlsAction::getRouteDef(),
 
diff --git a/module/Core/config/dependencies.config.php b/module/Core/config/dependencies.config.php
index 008db777..8e3e9a52 100644
--- a/module/Core/config/dependencies.config.php
+++ b/module/Core/config/dependencies.config.php
@@ -38,6 +38,7 @@ return [
             ShortUrl\ShortUrlListService::class => ConfigAbstractFactory::class,
             ShortUrl\DeleteShortUrlService::class => ConfigAbstractFactory::class,
             ShortUrl\ShortUrlResolver::class => ConfigAbstractFactory::class,
+            ShortUrl\ShortUrlVisitsDeleter::class => ConfigAbstractFactory::class,
             ShortUrl\Helper\ShortCodeUniquenessHelper::class => ConfigAbstractFactory::class,
             ShortUrl\Resolver\PersistenceShortUrlRelationResolver::class => ConfigAbstractFactory::class,
             ShortUrl\Helper\ShortUrlStringifier::class => ConfigAbstractFactory::class,
@@ -69,6 +70,10 @@ return [
                 EntityRepositoryFactory::class,
                 Visit\Entity\Visit::class,
             ],
+            Visit\Repository\VisitDeleterRepository::class => [
+                EntityRepositoryFactory::class,
+                Visit\Entity\Visit::class,
+            ],
 
             Util\UrlValidator::class => ConfigAbstractFactory::class,
             Util\DoctrineBatchHelper::class => ConfigAbstractFactory::class,
@@ -137,6 +142,10 @@ return [
             ShortUrl\ShortUrlResolver::class,
         ],
         ShortUrl\ShortUrlResolver::class => ['em', Options\UrlShortenerOptions::class],
+        ShortUrl\ShortUrlVisitsDeleter::class => [
+            Visit\Repository\VisitDeleterRepository::class,
+            ShortUrl\ShortUrlResolver::class,
+        ],
         ShortUrl\Helper\ShortCodeUniquenessHelper::class => ['em', Options\UrlShortenerOptions::class],
         Domain\DomainService::class => ['em', 'config.url_shortener.domain.hostname'],
 
diff --git a/module/Core/src/Model/BulkDeleteResult.php b/module/Core/src/Model/BulkDeleteResult.php
new file mode 100644
index 00000000..b3b0e756
--- /dev/null
+++ b/module/Core/src/Model/BulkDeleteResult.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Core\Model;
+
+final class BulkDeleteResult
+{
+    public function __construct(public readonly int $affectedItems)
+    {
+    }
+
+    public function toArray(string $fieldName): array
+    {
+        return [$fieldName => $this->affectedItems];
+    }
+}
diff --git a/module/Core/src/ShortUrl/ShortUrlVisitsDeleter.php b/module/Core/src/ShortUrl/ShortUrlVisitsDeleter.php
new file mode 100644
index 00000000..097c8875
--- /dev/null
+++ b/module/Core/src/ShortUrl/ShortUrlVisitsDeleter.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Core\ShortUrl;
+
+use Shlinkio\Shlink\Core\Model\BulkDeleteResult;
+use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlIdentifier;
+use Shlinkio\Shlink\Core\Visit\Repository\VisitDeleterRepositoryInterface;
+use Shlinkio\Shlink\Rest\Entity\ApiKey;
+
+class ShortUrlVisitsDeleter implements ShortUrlVisitsDeleterInterface
+{
+    public function __construct(
+        private readonly VisitDeleterRepositoryInterface $repository,
+        private readonly ShortUrlResolverInterface $resolver,
+    ) {
+    }
+
+    public function deleteShortUrlVisits(ShortUrlIdentifier $identifier, ?ApiKey $apiKey): BulkDeleteResult
+    {
+        $this->resolver->resolveShortUrl($identifier, $apiKey);
+        return new BulkDeleteResult($this->repository->deleteShortUrlVisits($identifier, $apiKey));
+    }
+}
diff --git a/module/Core/src/ShortUrl/ShortUrlVisitsDeleterInterface.php b/module/Core/src/ShortUrl/ShortUrlVisitsDeleterInterface.php
new file mode 100644
index 00000000..dc29ef94
--- /dev/null
+++ b/module/Core/src/ShortUrl/ShortUrlVisitsDeleterInterface.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Core\ShortUrl;
+
+use Shlinkio\Shlink\Core\Model\BulkDeleteResult;
+use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlIdentifier;
+use Shlinkio\Shlink\Rest\Entity\ApiKey;
+
+interface ShortUrlVisitsDeleterInterface
+{
+    public function deleteShortUrlVisits(ShortUrlIdentifier $identifier, ?ApiKey $apiKey): BulkDeleteResult;
+}
diff --git a/module/Core/src/Visit/Repository/VisitDeleterRepository.php b/module/Core/src/Visit/Repository/VisitDeleterRepository.php
new file mode 100644
index 00000000..79a91f9d
--- /dev/null
+++ b/module/Core/src/Visit/Repository/VisitDeleterRepository.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Core\Visit\Repository;
+
+use Happyr\DoctrineSpecification\Repository\EntitySpecificationRepository;
+use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlIdentifier;
+use Shlinkio\Shlink\Rest\Entity\ApiKey;
+
+class VisitDeleterRepository extends EntitySpecificationRepository implements VisitDeleterRepositoryInterface
+{
+    public function deleteShortUrlVisits(ShortUrlIdentifier $identifier, ?ApiKey $apiKey): int
+    {
+        // TODO: Implement deleteShortUrlVisits() method.
+        return 0;
+    }
+}
diff --git a/module/Core/src/Visit/Repository/VisitDeleterRepositoryInterface.php b/module/Core/src/Visit/Repository/VisitDeleterRepositoryInterface.php
new file mode 100644
index 00000000..be2df6a3
--- /dev/null
+++ b/module/Core/src/Visit/Repository/VisitDeleterRepositoryInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Core\Visit\Repository;
+
+use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlIdentifier;
+use Shlinkio\Shlink\Rest\Entity\ApiKey;
+
+interface VisitDeleterRepositoryInterface
+{
+    public function deleteShortUrlVisits(ShortUrlIdentifier $identifier, ?ApiKey $apiKey): int;
+}
diff --git a/module/Rest/config/dependencies.config.php b/module/Rest/config/dependencies.config.php
index cf394740..43625c41 100644
--- a/module/Rest/config/dependencies.config.php
+++ b/module/Rest/config/dependencies.config.php
@@ -32,6 +32,7 @@ return [
             Action\ShortUrl\DeleteShortUrlAction::class => ConfigAbstractFactory::class,
             Action\ShortUrl\ResolveShortUrlAction::class => ConfigAbstractFactory::class,
             Action\ShortUrl\ListShortUrlsAction::class => ConfigAbstractFactory::class,
+            Action\ShortUrl\DeleteShortUrlVisitsAction::class => ConfigAbstractFactory::class,
             Action\Visit\ShortUrlVisitsAction::class => ConfigAbstractFactory::class,
             Action\Visit\TagVisitsAction::class => ConfigAbstractFactory::class,
             Action\Visit\DomainVisitsAction::class => ConfigAbstractFactory::class,
@@ -94,6 +95,7 @@ return [
             ShortUrl\ShortUrlListService::class,
             ShortUrlDataTransformer::class,
         ],
+        Action\ShortUrl\DeleteShortUrlVisitsAction::class => [ShortUrl\ShortUrlVisitsDeleter::class],
         Action\Tag\ListTagsAction::class => [TagService::class],
         Action\Tag\TagsStatsAction::class => [TagService::class],
         Action\Tag\DeleteTagsAction::class => [TagService::class],
diff --git a/module/Rest/src/Action/ShortUrl/DeleteShortUrlVisitsAction.php b/module/Rest/src/Action/ShortUrl/DeleteShortUrlVisitsAction.php
new file mode 100644
index 00000000..c9eaf958
--- /dev/null
+++ b/module/Rest/src/Action/ShortUrl/DeleteShortUrlVisitsAction.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Rest\Action\ShortUrl;
+
+use Laminas\Diactoros\Response\JsonResponse;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Shlinkio\Shlink\Core\ShortUrl\Model\ShortUrlIdentifier;
+use Shlinkio\Shlink\Core\ShortUrl\ShortUrlVisitsDeleterInterface;
+use Shlinkio\Shlink\Rest\Action\AbstractRestAction;
+use Shlinkio\Shlink\Rest\Middleware\AuthenticationMiddleware;
+
+class DeleteShortUrlVisitsAction extends AbstractRestAction
+{
+    protected const ROUTE_PATH = '/short-urls/{shortCode}/visits';
+    protected const ROUTE_ALLOWED_METHODS = [self::METHOD_DELETE];
+
+    public function __construct(private readonly ShortUrlVisitsDeleterInterface $deleter)
+    {
+    }
+
+    public function handle(ServerRequestInterface $request): ResponseInterface
+    {
+        $identifier = ShortUrlIdentifier::fromApiRequest($request);
+        $apiKey = AuthenticationMiddleware::apiKeyFromRequest($request);
+
+        $result = $this->deleter->deleteShortUrlVisits($identifier, $apiKey);
+
+        return new JsonResponse($result->toArray('deletedVisits'));
+    }
+}