[QRD-7899] feat(configuration-webhook): add affiliate config topic

CHANGELOG.md

@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
+# [v5.5.0](https://github.com/sequra/integration-core/tree/v5.5.0)
+## Added
+- Affiliate configuration support: the `AffiliateSettings` entity and `AffiliateSettingsService`, the `get-affiliate-settings` and `save-affiliate-settings` configuration webhook topics, and connect time provisioning that reads the `affiliate` block from the merchant `configuration_data` and persists it.
+
 # [v1.0.13](https://github.com/sequra/integration-core/tree/v1.0.13)
 ## Changed
 - Added compatibility with PHP8.2.

README.md

@@ -3171,6 +3171,8 @@ The Configuration WebhookAPI follows a **simplified Controller pattern** with **
     - **GetShopProductsHandler**: Handles `get-shop-products` webhook topic
     - **GetStoreInfoHandler**: Handles `get-store-info` webhook topic
     - **SaveWidgetSettingsHandler**: Handles `save-widget-settings` webhook topic
+    - **GetAffiliateSettingsHandler**: Handles `get-affiliate-settings` webhook topic
+    - **SaveAffiliateSettingsHandler**: Handles `save-affiliate-settings` webhook topic
 
 #### Webhook Processing Flow
 

src/BusinessLogic/BootstrapComponent.php

@@ -21,6 +21,8 @@
 use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Controller\ConfigurationWebhookController;
 use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\AdvancedSettings\GetAdvancedSettingsHandler;
 use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\AdvancedSettings\SaveAdvancedSettingsHandler;
+use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\Affiliate\GetAffiliateSettingsHandler;
+use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\Affiliate\SaveAffiliateSettingsHandler;
 use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\BannerSettings\GetBannerSettingsHandler;
 use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\BannerSettings\SaveBannerSettingsHandler;
 use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\Enums\Topics;
@@ -40,6 +42,8 @@
 use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\WidgetSettings\SaveWidgetSettingsHandler;
 use SeQura\Core\BusinessLogic\DataAccess\AdvancedSettings\Entities\AdvancedSettings;
 use SeQura\Core\BusinessLogic\DataAccess\AdvancedSettings\Repositories\AdvancedSettingsRepository;
+use SeQura\Core\BusinessLogic\DataAccess\Affiliate\Entities\AffiliateSettings;
+use SeQura\Core\BusinessLogic\DataAccess\Affiliate\Repositories\AffiliateSettingsRepository;
 use SeQura\Core\BusinessLogic\DataAccess\BannerSettings\Entities\BannerSettings;
 use SeQura\Core\BusinessLogic\DataAccess\BannerSettings\Repositories\BannerSettingsRepository;
 use SeQura\Core\BusinessLogic\DataAccess\ConnectionData\Entities\ConnectionData;
@@ -67,6 +71,8 @@
 use SeQura\Core\BusinessLogic\Domain\AdvancedSettings\RepositoryContracts\AdvancedSettingsRepositoryInterface;
 use SeQura\Core\BusinessLogic\Domain\AdvancedSettings\Services\AdvancedLoggerSettingsProvider;
 use SeQura\Core\BusinessLogic\Domain\AdvancedSettings\Services\AdvancedSettingsService;
+use SeQura\Core\BusinessLogic\Domain\Affiliate\RepositoryContracts\AffiliateSettingsRepositoryInterface;
+use SeQura\Core\BusinessLogic\Domain\Affiliate\Services\AffiliateSettingsService;
 use SeQura\Core\BusinessLogic\Domain\BannerSettings\RepositoryContracts\BannerSettingsRepositoryInterface;
 use SeQura\Core\BusinessLogic\Domain\BannerSettings\Services\BannerSettingsService;
 use SeQura\Core\BusinessLogic\Domain\Integration\Banner\BannerServiceInterface;
@@ -332,6 +338,16 @@ static function () {
                 );
             }
         );
+
+        ServiceRegister::registerService(
+            AffiliateSettingsRepositoryInterface::class,
+            static function () {
+                return new AffiliateSettingsRepository(
+                    RepositoryRegistry::getRepository(AffiliateSettings::getClassName()),
+                    ServiceRegister::getService(StoreContext::class)
+                );
+            }
+        );
     }
 
     /**
@@ -384,7 +400,8 @@ static function () {
                     ServiceRegister::getService(ConnectionProxyInterface::class),
                     ServiceRegister::getService(CredentialsRepositoryInterface::class),
                     ServiceRegister::getService(CountryConfigurationRepositoryInterface::class),
-                    ServiceRegister::getService(PaymentMethodRepositoryInterface::class)
+                    ServiceRegister::getService(PaymentMethodRepositoryInterface::class),
+                    ServiceRegister::getService(AffiliateSettingsService::class)
                 );
             }
         );
@@ -667,6 +684,15 @@ static function () {
             }
         );
 
+        ServiceRegister::registerService(
+            AffiliateSettingsService::class,
+            static function () {
+                return new AffiliateSettingsService(
+                    ServiceRegister::getService(AffiliateSettingsRepositoryInterface::class)
+                );
+            }
+        );
+
         ServiceRegister::registerService(
             LoggerSettingsProviderInterface::CLASS_NAME,
             static function () {
@@ -1056,6 +1082,16 @@ protected static function initTopicHandlers(): void
             SaveAdvancedSettingsHandler::class
         );
 
+        TopicHandlerRegistry::register(
+            Topics::GET_AFFILIATE_SETTINGS,
+            GetAffiliateSettingsHandler::class
+        );
+
+        TopicHandlerRegistry::register(
+            Topics::SAVE_AFFILIATE_SETTINGS,
+            SaveAffiliateSettingsHandler::class
+        );
+
         TopicHandlerRegistry::register(
             Topics::GET_BANNER_SETTINGS,
             GetBannerSettingsHandler::class
@@ -1189,6 +1225,24 @@ static function () {
             }
         );
 
+        ServiceRegister::registerService(
+            GetAffiliateSettingsHandler::class,
+            static function () {
+                return new GetAffiliateSettingsHandler(
+                    ServiceRegister::getService(AffiliateSettingsService::class)
+                );
+            }
+        );
+
+        ServiceRegister::registerService(
+            SaveAffiliateSettingsHandler::class,
+            static function () {
+                return new SaveAffiliateSettingsHandler(
+                    ServiceRegister::getService(AffiliateSettingsService::class)
+                );
+            }
+        );
+
         ServiceRegister::registerService(
             GetBannerSettingsHandler::class,
             static function () {

src/BusinessLogic/ConfigurationWebhookAPI/Handlers/Affiliate/GetAffiliateSettingsHandler.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\Affiliate;
+
+use SeQura\Core\BusinessLogic\AdminAPI\Response\Response;
+use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\TopicHandlerInterface;
+use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Responses\Affiliate\AffiliateSettingsResponse;
+use SeQura\Core\BusinessLogic\Domain\Affiliate\Services\AffiliateSettingsService;
+
+/**
+ * Class GetAffiliateSettingsHandler
+ *
+ * @package SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\Affiliate
+ */
+class GetAffiliateSettingsHandler implements TopicHandlerInterface
+{
+    /**
+     * @var AffiliateSettingsService
+     */
+    protected $affiliateSettingsService;
+
+    /**
+     * @param AffiliateSettingsService $affiliateSettingsService
+     */
+    public function __construct(AffiliateSettingsService $affiliateSettingsService)
+    {
+        $this->affiliateSettingsService = $affiliateSettingsService;
+    }
+
+    /**
+     * @param mixed[] $payload
+     *
+     * @return Response
+     */
+    public function handle(array $payload): Response
+    {
+        // GET is a boolean-state read: return only whether the feature is enabled, never echo the
+        // offer id or security token. The service always yields settings (disabled by default when
+        // none are stored), so the response is enabled=false when nothing is configured.
+        return new AffiliateSettingsResponse($this->affiliateSettingsService->getAffiliateSettings()->isEnabled());
+    }
+}

src/BusinessLogic/ConfigurationWebhookAPI/Handlers/Affiliate/SaveAffiliateSettingsHandler.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\Affiliate;
+
+use SeQura\Core\BusinessLogic\AdminAPI\Response\Response;
+use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\TopicHandlerInterface;
+use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Requests\Affiliate\SaveAffiliateSettingsRequest;
+use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Responses\SuccessResponse;
+use SeQura\Core\BusinessLogic\Domain\Affiliate\Services\AffiliateSettingsService;
+
+/**
+ * Class SaveAffiliateSettingsHandler
+ *
+ * @package SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Handlers\Affiliate
+ */
+class SaveAffiliateSettingsHandler implements TopicHandlerInterface
+{
+    /**
+     * @var AffiliateSettingsService
+     */
+    protected $affiliateSettingsService;
+
+    /**
+     * @param AffiliateSettingsService $affiliateSettingsService
+     */
+    public function __construct(AffiliateSettingsService $affiliateSettingsService)
+    {
+        $this->affiliateSettingsService = $affiliateSettingsService;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function handle(array $payload): Response
+    {
+        $request = SaveAffiliateSettingsRequest::fromPayload($payload);
+        $this->affiliateSettingsService->setAffiliateSettings($request->transformToDomainModel());
+
+        return new SuccessResponse();
+    }
+}

src/BusinessLogic/ConfigurationWebhookAPI/Handlers/Enums/Topics.php

@@ -77,6 +77,14 @@ interface Topics
      * @var string
      */
     public const GET_STORE_INFO = 'get-store-info';
+    /**
+     * @var string
+     */
+    public const GET_AFFILIATE_SETTINGS = 'get-affiliate-settings';
+    /**
+     * @var string
+     */
+    public const SAVE_AFFILIATE_SETTINGS = 'save-affiliate-settings';
     /**
      * @var string[]
      */
@@ -97,6 +105,8 @@ interface Topics
         self::GET_SHOP_CATEGORIES,
         self::GET_SHOP_PRODUCTS,
         self::GET_SELLING_COUNTRIES,
-        self::GET_STORE_INFO
+        self::GET_STORE_INFO,
+        self::GET_AFFILIATE_SETTINGS,
+        self::SAVE_AFFILIATE_SETTINGS
     ];
 }

src/BusinessLogic/ConfigurationWebhookAPI/Requests/Affiliate/SaveAffiliateSettingsRequest.php

@@ -0,0 +1,63 @@
+<?php
+
+namespace SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Requests\Affiliate;
+
+use SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Requests\ConfigurationWebhookRequest;
+use SeQura\Core\BusinessLogic\Domain\Affiliate\Models\AffiliateSettings;
+
+/**
+ * Class SaveAffiliateSettingsRequest.
+ *
+ * @package SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Requests\Affiliate
+ */
+class SaveAffiliateSettingsRequest extends ConfigurationWebhookRequest
+{
+    /**
+     * @var bool $isEnabled
+     */
+    private $isEnabled;
+
+    /**
+     * @var string $offerId
+     */
+    private $offerId;
+
+    /**
+     * @var string $securityToken
+     */
+    private $securityToken;
+
+    /**
+     * @param bool $isEnabled
+     * @param string $offerId
+     * @param string $securityToken
+     */
+    public function __construct(bool $isEnabled, string $offerId, string $securityToken)
+    {
+        $this->isEnabled = $isEnabled;
+        $this->offerId = $offerId;
+        $this->securityToken = $securityToken;
+    }
+
+    /**
+     * @param mixed[] $payload
+     *
+     * @return self
+     */
+    public static function fromPayload(array $payload): object
+    {
+        return new self(
+            $payload['isEnabled'] ?? false,
+            (string)($payload['offerId'] ?? ''),
+            (string)($payload['securityToken'] ?? '')
+        );
+    }
+
+    /**
+     * @return AffiliateSettings
+     */
+    public function transformToDomainModel(): AffiliateSettings
+    {
+        return new AffiliateSettings($this->isEnabled, $this->offerId, $this->securityToken);
+    }
+}

src/BusinessLogic/ConfigurationWebhookAPI/Responses/Affiliate/AffiliateSettingsResponse.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Responses\Affiliate;
+
+use SeQura\Core\BusinessLogic\AdminAPI\Response\Response;
+
+/**
+ * Class AffiliateSettingsResponse
+ *
+ * @package SeQura\Core\BusinessLogic\ConfigurationWebhookAPI\Responses\Affiliate
+ */
+class AffiliateSettingsResponse extends Response
+{
+    /**
+     * @var bool $isEnabled
+     */
+    protected $isEnabled;
+
+    /**
+     * @param bool $isEnabled
+     */
+    public function __construct(bool $isEnabled)
+    {
+        $this->isEnabled = $isEnabled;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function toArray(): array
+    {
+        return ['isEnabled' => $this->isEnabled];
+    }
+}