Merge pull request #20 from BitBagCommerce/adjustment/update-readme

Adjustment/update readme

Author: DominikWolos

README.md

@@ -47,8 +47,7 @@ We have a 70-person team of experts: business analysts and consultants, eCommerc
 ***
 
 * [Overview](#overview)
-* [Installation](#installation)
-* [Testing](#testing)
+* [Important documents](#important-documents)
 * [Functionalities](#functionalities)
 * [Demo](#demo)
 * [License](#license)
@@ -58,27 +57,13 @@ We have a 70-person team of experts: business analysts and consultants, eCommerc
 # Overview
 
 ----
-The **SyliusUserComPlugin** allows you to integrate your Sylius store with the User.com platform. User.com is a platform that allows you to automate your marketing, sales, and support processes. With this plugin, you can synchronize your Sylius store with User.com and use the data collected in your store to create personalized marketing campaigns, automate sales processes, and provide better customer support.
+The **SyliusUserComPlugin** is designed to seamlessly integrate User.com with any Sylius platform app, enabling businesses to monitor customer activity, synchronize agreements, and track orders effortlessly. This plugin acts as a bridge between Sylius and User.com, ensuring businesses gain valuable behavioral insights while enhancing user engagement and retention.
+# Important documents
 
+---
 
-# Installation
-----
-
-
-# Testing
-----
-
-```bash
-$ composer install
-$ cd tests/Application
-$ yarn install
-$ yarn build
-$ bin/console assets:install public -e test
-$ bin/console doctrine:schema:create -e test
-$ bin/console server:run 127.0.0.1:8080 -d public -e test
-$ open http://localhost:8080
-$ vendor/bin/behat
-```
+- [Installation](doc/installation.md)
+- [Adjustments](doc/adjustments.md)
 
 # Functionalities
 
@@ -89,7 +74,9 @@ All main functionalities of the plugin are described **[here.](https://github.co
 If you need some help with Sylius development, don't be hesitated to contact us directly. You can fill the form on [this site](https://bitbag.io/contact-us/?utm_source=github&utm_medium=referral&utm_campaign=plugins_productbundle) or send us an e-mail at hello@bitbag.io!
 
 ---
+
 # Demo
+
 ---
 We created a demo app with some useful use-cases of plugins! Visit http://demo.sylius.com/ to take a look at it.
 
@@ -99,6 +86,7 @@ We created a demo app with some useful use-cases of plugins! Visit http://demo.s
 
 
 # Additional resources for developers
+
 ---
 To learn more about our contribution workflow and more, we encourage you to use the following resources:
 * [Sylius Documentation](https://docs.sylius.com/en/latest/)
@@ -107,17 +95,20 @@ To learn more about our contribution workflow and more, we encourage you to use
 * [Sylius Product Bundle Plugin Blog](https://bitbag.io/blog/product-bundling-sylius)
 
 # License
+
 ---
 
 This plugin's source code is completely free and released under the terms of the MIT license.
 
 [//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen.)
 
 # Contact
+
 ---
 This open-source plugin was developed to help the Sylius community. If you have any additional questions, would like help with installing or configuring the plugin, or need any assistance with your Sylius project - let us know! **Contact us** or send us an **e-mail to hello@bitbag.io** with your question(s).
 
 # Community
+
 ---- 
 
 For online communication, we invite you to chat with us & other users on **[Sylius Slack](https://sylius-devs.slack.com/).**

config/packages/messenger.yaml

@@ -2,7 +2,7 @@ framework:
     messenger:
         transports:
             user_com_asynchronous: 
-                dsn: "%env(MESSENGER_USER_COM_ASYNCHRONOUS)%"
+                dsn: "%env(MESSENGER_USER_COM_ASYNCHRONOUS_DSN)%"
                 retry_strategy:
                     max_retries: 5
                     #1000 * 60 * 10

doc/functionalities.md

@@ -29,3 +29,6 @@ The **BitBagSyliusUserComPlugin** integrates **User.com** with Sylius-based stor
 ### 6. Tag Manager Script Injection
 - Allows users to **inject custom scripts** via **Tag Manager**.
 - Enables integration with **third-party tracking tools**.
+
+### 7. User information object 
+- you can use `user_com_customer_info` in browser console to check currently logged in customer data

doc/installation.md

@@ -9,7 +9,7 @@
         GOOGLE_ANALYTICS_TAG=""
         USER_COM_ENCRYPTION_KEY=your-32-character-long-key
         USER_COM_ENCRYPTION_IV=your-16-character-long-iv
-        MESSENGER_USER_COM_ASYNCHRONOUS=""
+        MESSENGER_USER_COM_ASYNCHRONOUS_DSN=""
     ```
 3. Add plugin dependencies to `config/bundles.php` file. Make sure that none of the bundles are duplicated.
     ```php
@@ -33,13 +33,13 @@
         ...
     ```
 
-4. Import routes in your `config/routes.yaml` file:
+5. 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` 
+6. Extend `Channel` entity `UserComApiAwareTrait` and implement `UserComApiAwareInterface` 
    ```php
     use BitBag\SyliusUserComPlugin\Trait\UserComApiAwareTrait;
     use BitBag\SyliusUserComPlugin\Trait\UserComApiAwareInterface;
@@ -50,22 +50,22 @@
     }
     ```
     
-    >`UserComApiAwareTrait` contains mapping for annotations and for attributes which are required by UserCom integration.
-    > If you're using xml mapping, you should add mapping for those properties in your `Channel.orm.xml` file.
+    >`UserComApiAwareTrait` contains mapping for annotations and for attributes which are required by UserCom integration. If you're using xml mapping, you should add mapping for those properties in your `Channel.orm.xml` file.
 
-6. Take advantage of channel based configuration of GoogleAnalyticsPlugin by adding :
+7. Take advantage of channel based configuration of GoogleAnalyticsPlugin by adding :
     ```yaml
     spinbits_sylius_google_analytics4:
       id: "%env(GOOGLE_ANALYTICS_TAG)%"
       enabled: true
     ```
-7. Add api credentials and GTM to your channel configuration in admin panel. If you decided to extend different object, please make sure that api credentials are set
-8. Run yarn install and yarn build to compile assets, or the alternative solution you use for your project
+8. Compile assets
 ```bash
   yarn install && yarn build
 ```
-9. Configure consumer to run in supervisor:
+9. Add API credentials and GTM to your channel configuration in admin panel. If you decided to extend different object, please make sure that API credentials are set.
+![Channel configuration](../doc/user_com_configuration.png)
+
+10. Configure consumer to run in supervisor:
 ```bash
    bin/console messenger:consume user_com_asynchronous
 ```
-10. While integrating with User.com via GTM, you can use `user_com_customer_info` in browser console to check currently logged in customer data.

doc/user_com_configuration.png

@@ -55,13 +55,9 @@ protected function request(
             }
 
             if ($status >= Response::HTTP_OK && $status < Response::HTTP_MULTIPLE_CHOICES) {
-                $this->logger->debug(sprintf(
-                    sprintf('%s User.com API request', $status),
-                ), [
+                $this->logger->debug('User.com - Successful API request', [
                     'path' => $path,
                     'method' => $method,
-                    'options' => $options,
-                    'response' => $response->getContent(false),
                 ]);
 
                 return $response->toArray();

src/Api/AbstractClient.php

@@ -28,7 +28,7 @@ public function assign(CustomerInterface $customer, array $agreements): void
                 'email_agreement' => $customer->setSubscribedToNewsletter($value),
                 default => $this->logger->error(
                     sprintf(
-                        'Agreement not found. Key = %s, Value = %s, CustomerId = %s',
+                        'User.com - Agreement not found. Key = %s, Value = %s, CustomerId = %s',
                         $key,
                         $value,
                         $customer->getId(),

src/Assigner/AgreementsAssigner.php

@@ -27,7 +27,7 @@ public function __construct(
     public function dispatch(OrderInterface $order): void
     {
         if (null === $order->getId()) {
-            $this->logger->error('Order ID cannot be null');
+            $this->logger->error('User.com - Order ID cannot be null');
 
             return;
         }

src/Dispatcher/OrderMessageDispatcher.php

@@ -91,15 +91,15 @@ private function createProductEvents(
         try {
             $eventType = self::PRODUCT_EVENT_MAP[$order->getState()] ?? null;
             if (null === $eventType) {
-                $this->logger->warning(sprintf('Order #%s state "%s" is not supported.', $order->getNumber(), $order->getState()));
+                $this->logger->warning(sprintf('User.com - Order #%s state "%s" is not supported.', $order->getNumber(), $order->getState()));
 
                 return;
             }
 
             foreach ($order->getItems() as $orderItem) {
                 $variant = $orderItem->getVariant();
                 if (null === $variant) {
-                    $this->logger->warning(sprintf('Order item #%s does not have a variant.', $orderItem->getId()));
+                    $this->logger->warning(sprintf('User.com - Order item #%s does not have a variant.', $orderItem->getId()));
 
                     continue;
                 }

src/Manager/OrderUpdateManager.php

@@ -37,5 +37,5 @@ USER_COM_FRONTEND_API_KEY=""
 GOOGLE_ANALYTICS_TAG=""
 USER_COM_ENCRYPTION_KEY=your-32-character-long-key
 USER_COM_ENCRYPTION_IV=your-16-character-long-
-MESSENGER_USER_COM_ASYNCHRONOUS="doctrine://default"
+MESSENGER_USER_COM_ASYNCHRONOUS_DSN="doctrine://default"
 ###< UserCom