Add feed plugin & update readme & encrypt token

DominikWolos · DominikWolos · commit 71adf282dc4b · 2025-02-12T12:32:12.000+01:00
diff --git a/composer.json b/composer.json
@@ -7,9 +7,12 @@
     "require": {
         "php": "^8.1",
         "bitbag/coding-standard": "^3.0",
+        "bitbag/google-analytics-4-plugin": "^1.0",
         "sylius/sylius": "~1.13.0",
+        "symfony/messenger": "^5.4 || ^6.4",
         "symfony/webpack-encore-bundle": "^1.15",
-        "bitbag/google-analytics-4-plugin": "^1.0"
+        "ext-openssl": "*",
+        "bitbag/sylius-feed-plugin": "~0.2"
     },
     "require-dev": {
         "behat/behat": "^3.6.1",
@@ -34,6 +37,7 @@
         "phpunit/phpunit": "^10.5",
         "polishsymfonycommunity/symfony-mocker-container": "^1.0",
         "robertfausk/behat-panther-extension": "^1.1",
+        "setono/sylius-feed-plugin": "dev-master",
         "sylius-labs/coding-standard": "^4.2",
         "sylius-labs/suite-tags-extension": "^0.2",
         "symfony/browser-kit": "^5.4 || ^6.4",
diff --git a/config/admin_routing.yml b/config/admin_routing.yml
diff --git a/config/bundles.php b/config/bundles.php
@@ -1,5 +1,9 @@
 <?php
 
 return [
+    League\FlysystemBundle\FlysystemBundle::class => ['all' => true],
+    Setono\SyliusFeedPlugin\SetonoSyliusFeedPlugin::class => ['all' => true],
+    Setono\DoctrineORMBatcherBundle\SetonoDoctrineORMBatcherBundle::class => ['all' => true],
     Spinbits\SyliusGoogleAnalytics4Plugin\SpinbitsSyliusGoogleAnalytics4Plugin::class => ['all' => true],
+    Sylius\Bundle\GridBundle\SyliusGridBundle::class => ['all' => true],
 ];
diff --git a/config/config.yml b/config/config.yml
@@ -1,5 +1,7 @@
 parameters:
     user_com.frontend_api_key: '%env(USER_COM_FRONTEND_API_KEY)%'
+    user_com.encryption_key: '%env(USER_COM_ENCRYPTION_KEY)%'
+    user_com.encryption_iv: '%env(USER_COM_ENCRYPTION_IV)%'
 
 twig:
     globals:
@@ -9,4 +11,6 @@ imports:
     - { resource: "state_machine/*" }
     - { resource: "events.yaml" }
     - { resource: "monolog.yaml" }
+    - { resource: "packages/*" }
 
+    - { resource: "@SetonoSyliusFeedPlugin/Resources/config/app/config.yaml" }
diff --git a/config/packages/uid.yaml b/config/packages/uid.yaml
@@ -0,0 +1,4 @@
+framework:
+    uid:
+        default_uuid_version: 7
+        time_based_uuid_version: 7
diff --git a/config/routes.yaml b/config/routes.yaml
@@ -1,4 +1,6 @@
-# Delete these routes and define your own shop routes here
+setono_sylius_feed:
+    resource: "@SetonoSyliusFeedPlugin/Resources/config/routing.yaml"
+
 bitbag_user_com_customer_agreements_endpoint:
     path: /user-com/customer-agreements
     controller: bit_bag.sylius_user_com_plugin.controller.user_com_agreements_controller
diff --git a/config/services/api.xml b/config/services/api.xml
@@ -6,17 +6,20 @@
         <service id="bit_bag.sylius_user_com_plugin.api.user_api" class="BitBag\SyliusUserComPlugin\Api\UserApi">
             <argument type="service" id="http_client"/>
             <argument type="service" id="monolog.logger.user_com"/>
+            <argument type="service" id="bit_bag.sylius_user_com_plugin.manager.user_com_api_token_manager"/>
         </service>
 
         <service id="bit_bag.sylius_user_com_plugin.api.deal_api" class="BitBag\SyliusUserComPlugin\Api\DealApi">
             <argument type="service" id="http_client"/>
             <argument type="service" id="monolog.logger.user_com"/>
+            <argument type="service" id="bit_bag.sylius_user_com_plugin.manager.user_com_api_token_manager"/>
             <argument type="service" id="bit_bag.sylius_user_com_plugin.api.user_api"/>
         </service>
 
         <service id="bit_bag.sylius_user_com_plugin.api.product_api" class="BitBag\SyliusUserComPlugin\Api\ProductApi">
             <argument type="service" id="http_client"/>
             <argument type="service" id="monolog.logger.user_com"/>
+            <argument type="service" id="bit_bag.sylius_user_com_plugin.manager.user_com_api_token_manager"/>
         </service>
     </services>
 </container>
diff --git a/config/services/form.xml b/config/services/form.xml
@@ -11,7 +11,7 @@
         </service>
 
         <service id="bit_bag.sylius_user_com_plugin.form.extension.user_com_api_aware_type_extension" class="BitBag\SyliusUserComPlugin\Form\Extension\UserComApiAwareTypeExtension">
-            <argument type="service" id="bit_bag.sylius_user_com_plugin.provider.user_com_api_aware_resource_provider"/>
+            <argument type="service" id="bit_bag.sylius_user_com_plugin.manager.user_com_api_token_manager"/>
             <tag name="form.type_extension" extended-type="Sylius\Bundle\ChannelBundle\Form\Type\ChannelType" priority="200" />
         </service>
     </services>
diff --git a/config/services/manager.xml b/config/services/manager.xml
@@ -19,5 +19,13 @@
             <argument type="service" id="bit_bag.sylius_user_com_plugin.updater.customer_without_key_updater"/>
             <argument type="service" id="monolog.logger.user_com"/>
         </service>
+
+        <service
+            id="bit_bag.sylius_user_com_plugin.manager.user_com_api_token_manager"
+            class="BitBag\SyliusUserComPlugin\Manager\UserComApiTokenManager"
+        >
+            <argument type="string">%user_com.encryption_key%</argument>
+            <argument type="string">%user_com.encryption_iv%</argument>
+        </service>
     </services>
 </container>
diff --git a/doc/functionalities.md b/doc/functionalities.md
@@ -0,0 +1,31 @@
+# Functionalities 
+
+## Overview
+The **BitBagSyliusUserComPlugin** integrates **User.com** with Sylius-based stores, enabling customer data synchronization, automated event tracking, and marketing automation capabilities.
+
+## Features
+
+### 1. User.com API Integration
+- Facilitates communication with the **User.com API** for seamless data synchronization.
+
+### 2. Customer Data Synchronization
+- **Triggers requests to User.com** upon critical customer actions:
+    - Providing **billing information** during checkout.
+    - **Editing profile** from the customer account.
+    - **Editing profile** from the admin panel.
+    - **Customer registration**.
+
+### 3. Order Tracking & Synchronization
+- Sends **order details** to User.com upon every state change of the **main order status**.
+- Ensures **real-time order tracking** and **customer behavior insights**.
+
+### 4. Event-Driven System
+- Each customer interaction generates an **event**, which is stored and sent to **User.com** for automation and reporting.
+
+### 5. Product Persistence & Feed Generation
+- **Persists products** within the system for accurate data reporting.
+- Generates a **product feed** that can be used for marketing and analytics purposes.
+
+### 6. Tag Manager Script Injection
+- Allows users to **inject custom scripts** via **Tag Manager**.
+- Enables integration with **third-party tracking tools**.
diff --git a/doc/installation.md b/doc/installation.md
@@ -3,36 +3,41 @@
     ```bash
     composer require bitbag/user-com-plugin
     ```
-   >If `bitbag/user-com-plugin` is not found by composer, try adding repository to your `composer.json` file:
-   > ```json
-   > "repositories": [
-   >    {
-   >       "type": "vcs",
-   >      "url": "https://github.com/BitBagCommerce/SyliusUserComPlugin.git"
-   >    },
-   > ],
-   > ```
-2. Add required environment variables to your `.env` file:
-    ```dotenv
-    USER_COM_FRONTEND_API_KEY=""
-    TAG_MANAGER_ID=""
-    ```
-3. Add plugin dependencies to config/bundles.php file:
-    ```php
-    return [
-        ...
-        BitBag\SyliusUserComPlugin\BitBagSyliusUserComPlugin::class => ['all' => true],
-        Spinbits\SyliusGoogleAnalytics4Plugin\SpinbitsSyliusGoogleAnalytics4Plugin::class => ['all' => true],
-        ...
-    ];
-    ```
+   2. Add required environment variables to your `.env` file:
+       ```dotenv
+           USER_COM_FRONTEND_API_KEY=""
+           TAG_MANAGER_ID=""
+           USER_COM_ENCRYPTION_KEY=your-32-character-long-key
+           USER_COM_ENCRYPTION_IV=your-16-character-long-iv
+       ```
+      3. Add plugin dependencies to config/bundles.php file:
+          ```php
+          return [
+              ...
+                  BitBag\SyliusUserComPlugin\BitBagSyliusUserComPlugin::class => ['all' => true],
+                  Spinbits\SyliusGoogleAnalytics4Plugin\SpinbitsSyliusGoogleAnalytics4Plugin::class => ['all' => true],
+                  League\FlysystemBundle\FlysystemBundle::class => ['all' => true],
+                  Setono\SyliusFeedPlugin\SetonoSyliusFeedPlugin::class => ['all' => true],
+                  Setono\DoctrineORMBatcherBundle\SetonoDoctrineORMBatcherBundle::class => ['all' => true],
+                 //Sylius grid bundle should be under Setono\SyliusFeedPlugin\SetonoSyliusFeedPlugin
+                  Sylius\Bundle\GridBundle\SyliusGridBundle::class => ['all' => true],
+              ...
+          ];
+          ```
 4. Import required config in your `config/packages/_sylius.yaml` file:
     ```yaml
     imports:
         ...
         - { resource: "@BitBagSyliusUserComPlugin/config/config.yml" }
         ...
     ```
+
+   4. Import routes in your `config/routes.yaml` file:
+       ```yaml
+           bitbag_sylius_user_com_plugin:
+               resource: "@BitBagSyliusUserComPlugin/config/routes.yaml"
+       ```
+
 5. Extend `Channel` entity `UserComApiAwareTrait` and implement `UserComApiAwareInterface` 
     ```php
     class Channel extends BaseChannel implements ChannelInterface
diff --git a/src/Api/AbstractClient.php b/src/Api/AbstractClient.php
@@ -11,6 +11,7 @@
 
 namespace BitBag\SyliusUserComPlugin\Api;
 
+use BitBag\SyliusUserComPlugin\Manager\UserComApiTokenManagerInterface;
 use BitBag\SyliusUserComPlugin\Trait\UserComApiAwareInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpFoundation\Response;
@@ -26,6 +27,7 @@ abstract class AbstractClient
     public function __construct(
         private readonly HttpClientInterface $client,
         private readonly LoggerInterface $logger,
+        private readonly UserComApiTokenManagerInterface $apiTokenManager,
     ) {
     }
 
@@ -131,9 +133,8 @@ protected function authorizeRequest(
             throw new \InvalidArgumentException('User.com API key is missing.');
         }
 
-        return sprintf(
-            'Token %s',
-            $resource->getUserComApiKey(),
-        );
+        $decryptedToken = $this->apiTokenManager->decrypt($resource->getUserComApiKey());
+
+        return sprintf('Token %s', $decryptedToken, );
     }
 }
diff --git a/src/Api/DealApi.php b/src/Api/DealApi.php
@@ -11,6 +11,7 @@
 
 namespace BitBag\SyliusUserComPlugin\Api;
 
+use BitBag\SyliusUserComPlugin\Manager\UserComApiTokenManagerInterface;
 use BitBag\SyliusUserComPlugin\Trait\UserComApiAwareInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpFoundation\Request;
@@ -21,9 +22,10 @@ final class DealApi extends AbstractClient implements DealApiInterface
     public function __construct(
         HttpClientInterface $client,
         LoggerInterface $logger,
+        UserComApiTokenManagerInterface $apiTokenManager,
         private readonly UserApiInterface $userApi,
     ) {
-        parent::__construct($client, $logger);
+        parent::__construct($client, $logger, $apiTokenManager);
     }
 
     public function updateDealByCustomId(UserComApiAwareInterface $resource, string $customId, array $data): ?array
diff --git a/src/Api/ProductApi.php b/src/Api/ProductApi.php
@@ -12,19 +12,10 @@
 namespace BitBag\SyliusUserComPlugin\Api;
 
 use BitBag\SyliusUserComPlugin\Trait\UserComApiAwareInterface;
-use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 final class ProductApi extends AbstractClient implements ProductApiInterface
 {
-    public function __construct(
-        HttpClientInterface $client,
-        LoggerInterface $logger,
-    ) {
-        parent::__construct($client, $logger);
-    }
-
     public function createProductEventByCustomId(
         UserComApiAwareInterface $resource,
         int $productId,
diff --git a/src/EventSubscriber/CustomerProfileUpdatedSubscriber.php b/src/EventSubscriber/CustomerProfileUpdatedSubscriber.php
@@ -55,10 +55,13 @@ public function postCustomerProfileUpdated(FormEvent $event): void
             if (null !== $customer && !$customer instanceof CustomerInterface) {
                 throw new \RuntimeException('Customer is not set or is not an instance of CustomerInterface');
             }
+
+            $address = $customer?->getDefaultAddress() ?? $subject->getBillingAddress();
+
             $this->customerUpdateManager->manageChange(
                 $eventName,
                 $customer,
-                $subject->getShippingAddress(),
+                $address,
                 strtolower($customer?->getEmail() ?? ''),
             );
         }
diff --git a/src/Form/Extension/UserComApiAwareTypeExtension.php b/src/Form/Extension/UserComApiAwareTypeExtension.php
@@ -11,6 +11,7 @@
 
 namespace BitBag\SyliusUserComPlugin\Form\Extension;
 
+use BitBag\SyliusUserComPlugin\Manager\UserComApiTokenManagerInterface;
 use BitBag\SyliusUserComPlugin\Trait\UserComApiAwareInterface;
 use Sylius\Bundle\ChannelBundle\Form\Type\ChannelType;
 use Symfony\Component\Form\AbstractTypeExtension;
@@ -24,6 +25,11 @@
 
 final class UserComApiAwareTypeExtension extends AbstractTypeExtension
 {
+    public function __construct(
+        private readonly UserComApiTokenManagerInterface $apiTokenManager,
+    ) {
+    }
+
     private const USER_COM_API_KEY_PROPERTY = 'userComApiKey';
 
     public function buildForm(FormBuilderInterface $builder, array $options): void
@@ -54,14 +60,15 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 $data = $event->getData();
                 $form = $event->getForm();
 
-                $newPassword = $form->get(self::USER_COM_API_KEY_PROPERTY)->getData();
+                $apiToken = $form->get(self::USER_COM_API_KEY_PROPERTY)->getData();
 
                 if (
-                    null !== $newPassword &&
-                    is_string($newPassword) &&
+                    null !== $apiToken &&
+                    is_string($apiToken) &&
                     $data instanceof UserComApiAwareInterface
                 ) {
-                    $data->setUserComApiKey($newPassword);
+                    $encryptedToken = $this->apiTokenManager->encrypt($apiToken);
+                    $data->setUserComApiKey($encryptedToken);
                 }
             });
     }
diff --git a/src/Manager/UserComApiTokenManager.php b/src/Manager/UserComApiTokenManager.php
@@ -0,0 +1,55 @@
+<?php
+
+/*
+ * This file has been created by developers from BitBag.
+ * Feel free to contact us once you face any issues or want to start
+ * You can find more information about us on https://bitbag.io and write us
+ * an email on hello@bitbag.io.
+ */
+
+declare(strict_types=1);
+
+namespace BitBag\SyliusUserComPlugin\Manager;
+
+final class UserComApiTokenManager implements UserComApiTokenManagerInterface
+{
+    public function __construct(
+        private readonly string $encryptionKey,
+        private readonly string $encryptionIv,
+    ) {
+    }
+
+    public function encrypt(string $token): string
+    {
+        $value = openssl_encrypt(
+            $token,
+            'aes-256-cbc',
+            $this->encryptionKey,
+            0,
+            $this->encryptionIv,
+        );
+
+        if (false === $value) {
+            throw new \RuntimeException('Could not encrypt the token');
+        }
+
+        return $value;
+    }
+
+    public function decrypt(string $encryptedToken): string
+    {
+        $value = openssl_decrypt(
+            $encryptedToken,
+            'aes-256-cbc',
+            $this->encryptionKey,
+            0,
+            $this->encryptionIv,
+        );
+
+        if (false === $value) {
+            throw new \RuntimeException('Could not decrypt the token');
+        }
+
+        return $value;
+    }
+}
diff --git a/src/Manager/UserComApiTokenManagerInterface.php b/src/Manager/UserComApiTokenManagerInterface.php
diff --git a/symfony.lock b/symfony.lock
diff --git a/tests/Application/.env b/tests/Application/.env
diff --git a/tests/Application/config/bundles.php b/tests/Application/config/bundles.php
diff --git a/tests/Application/config/routes.yaml b/tests/Application/config/routes.yaml
diff --git a/translations/messages.pl.yaml b/translations/messages.pl.yaml
