Merge pull request #7 from BitBagCommerce/feature/UC-13-ga4-plugin

Add GA-4 Plugin

Author: DominikWolos

composer.json

@@ -8,7 +8,8 @@
         "php": "^8.1",
         "bitbag/coding-standard": "^3.0",
         "sylius/sylius": "~1.13.0",
-        "symfony/webpack-encore-bundle": "^1.15"
+        "symfony/webpack-encore-bundle": "^1.15",
+        "bitbag/google-analytics-4-plugin": "^1.0"
     },
     "require-dev": {
         "behat/behat": "^3.6.1",

config/bundles.php

@@ -0,0 +1,5 @@
+<?php
+
+return [
+    Spinbits\SyliusGoogleAnalytics4Plugin\SpinbitsSyliusGoogleAnalytics4Plugin::class => ['all' => true],
+];

config/config.yml

@@ -1,2 +1,11 @@
+parameters:
+    user_com.frontend_api_key: '%env(USER_COM_FRONTEND_API_KEY)%'
+
+twig:
+    globals:
+        user_com_frontend_api_key: '%user_com.frontend_api_key%'
+
 imports: 
     - { resource: "state_machine/*" }
+    - { resource: "events.yaml" }
+

config/events.yaml

@@ -0,0 +1,12 @@
+sylius_ui:
+    events:
+        sylius.admin.channel.form.first_column_content:
+            blocks:
+                user_com_configuration:
+                    template: '@BitBagSyliusUserComPlugin/UserApiResource/_userComCredentials.html.twig'
+                    priority: 25
+        sylius.shop.layout.stylesheets:
+            blocks:
+                user_com:
+                    template: '@BitBagSyliusUserComPlugin/_userComScripts.html.twig'
+                    priority: 25

config/services/form.xml

@@ -9,5 +9,10 @@
             <argument type="service" id="sylius.context.customer"/>
             <tag name="form.type_extension" />
         </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"/>
+            <tag name="form.type_extension" extended-type="Sylius\Bundle\ChannelBundle\Form\Type\ChannelType" priority="200" />
+        </service>
     </services>
 </container>

doc/adjustments.md

@@ -0,0 +1,31 @@
+# Adjustments 
+### 1. Payloads for Customer, Product or Order
+To modify data sent for occurences related to one of resources, you can adjust classes responsible for payload building.
+These classes are located under `src/Builder/Payload` directory and have meaningful names corresponding to data that will be provided, e.g. `CustomerPayloadBuilder`or `OrderPayloadBuilder`.
+
+### 2. Requests from User.com on designated endpoint.
+Requests send on endpoint designed by User.com are handled by `\BitBag\SyliusUserComPlugin\Controller\UserComAgreementsController`.
+You can adjust this controller to handle requests in a way that suits your needs.
+There is designated validator to check if request payload contains required fields.
+If there will be any field added by User.com, you can adjust this validator to check if this field is present in request payload.
+Also, in `BitBag\SyliusUserComPlugin\Assigner\AgreementsAssigner` you can adjust existing logic to assign agreements to customer in a way that suits your needs.
+
+```php
+public function assign(CustomerInterface $customer, array $agreements): void
+    {
+        foreach ($agreements as $key => $value) {
+            match ($key) {
+                'email_agreement' => $customer->setSubscribedToNewsletter($value),
+                default => $this->logger->error(
+                    sprintf(
+                        'Agreement not found. Key = %s, Value = %s, CustomerId = %s',
+                        $key,
+                        $value,
+                        $customer->getId(),
+                    ),
+                ),
+            };
+        }
+    }
+}
+```

doc/installation.md

@@ -0,0 +1,59 @@
+# Installation
+1. Add package to your project via composer:
+    ```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],
+        ...
+    ];
+    ```
+4. Import required config in your `config/packages/_sylius.yaml` file:
+    ```yaml
+    imports:
+        ...
+        - { resource: "@BitBagSyliusUserComPlugin/config/config.yml" }
+        ...
+    ```
+5. Extend `Channel` entity `UserComApiAwareTrait` and implement `UserComApiAwareInterface` 
+    ```php
+    class Channel extends BaseChannel implements ChannelInterface
+    {
+        use UserComApiAwareTrait;
+    }
+    ```
+    
+    ```php
+    interface ChannelInterface extends BaseChannelInterface, UserComApiAwareInterface
+    {
+    }
+    ```
+    >`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 :
+    ```yaml
+    spinbits_sylius_google_analytics4:
+        id: "%env(TAG_MANAGER_ID)%"
+        channels_ids:
+            FASHION_WEB: "G-DF1P3RRJ8S"
+            OTHER_CHANNEL: "G-WX1RJ8SP3R"
+    ```

src/Trait/UserComApiAwareTrait.php

@@ -11,10 +11,16 @@
 
 namespace BitBag\SyliusUserComPlugin\Trait;
 
+use Doctrine\ORM\Mapping as ORM;
+
 trait UserComApiAwareTrait
 {
+    #[ORM\Column(name: 'user_com_url', type: 'string', nullable: true)]
+    /** @ORM\Column(name="user_com_url", type="string", nullable=true) */
     private ?string $userComUrl;
 
+    #[ORM\Column(name: 'user_com_api_key', type: 'string', nullable: true)]
+    /** @ORM\Column(name="user_com_api_key", type="string", nullable=true) */
     private ?string $userComApiKey;
 
     public function getUserComUrl(): ?string

symfony.lock

@@ -202,6 +202,9 @@
             "ref": "9c8a1e8ce2b1f215015ed16652c4ed18eb5867fd"
         }
     },
+    "spinbits/google-analytics-4-plugin": {
+        "version": "dev-test/bump-sylius-version"
+    },
     "squizlabs/php_codesniffer": {
         "version": "3.7",
         "recipe": {

templates/_userComScripts.html.twig

@@ -1,4 +1,5 @@
 {% set channel = sylius.channel %}
+
 {% if null != channel.userComApiKey and null != channel.userComUrl%}
     {% set customer = sylius.customer|default(null) %}
     {% set genderMap =  constant('BitBag\\SyliusUserComPlugin\\Builder\\Payload\\CustomerPayloadBuilderInterface::GENDER_MAP')%}