From 037531c67a84d2d6bd5af94dc0bffee74f3da1bb Mon Sep 17 00:00:00 2001
From: Renato <renatobylyk@gmail.com>
Date: Thu, 28 Feb 2019 15:03:45 +0200
Subject: [PATCH] Update integration script (#14)

* Update integration script to match the new guidelines
* Push metadata separately using new functions
---
 CHANGELOG-1.0.md                  |  2 ++
 esatisfaction.php                 | 19 +------------------
 views/templates/hook/checkout.tpl | 28 ++++++++++------------------
 views/templates/hook/footer.tpl   | 18 ------------------
 views/templates/hook/header.tpl   | 22 +++++++++++++++++++---
 5 files changed, 32 insertions(+), 57 deletions(-)
 delete mode 100644 views/templates/hook/footer.tpl

diff --git a/CHANGELOG-1.0.md b/CHANGELOG-1.0.md
index 2d2bda5..0d3d80a 100644
--- a/CHANGELOG-1.0.md
+++ b/CHANGELOG-1.0.md
@@ -7,6 +7,8 @@ in all versions (major and minor)
 To get the diff for a specific change, go to https://github.com/esatisfaction/esat-prestashop/commit/XXX where
 XXX is the change hash
 
+* 1.0.3 (future-release)
+  * Update the integration script to match the latest (25th February, 2019) e-satisfaction integration guidelines.
 * 1.0.2 (2019-01-17)
   * Include send_time as variable on api calls, if necessary
 * 1.0.1 (2018-09-13)
diff --git a/esatisfaction.php b/esatisfaction.php
index 78b30c3..35ff9ef 100644
--- a/esatisfaction.php
+++ b/esatisfaction.php
@@ -51,8 +51,7 @@ public function __construct()
 
     /**
      * Install module and register it for hooks displayOrderConfirmation,
-     * actionOrderStatusPostUpdate, displayHeader,
-     * displayBackOfficeHeader, displayBeforeBodyClosingTag
+     * actionOrderStatusPostUpdate, displayHeader, displayBackOfficeHeader
      *
      * @author        e-satisfaction SA
      * @copyright (c) 2018, e-satisfaction SA
@@ -69,7 +68,6 @@ public function install()
         return parent::install() &&
             $this->registerHook('displayOrderConfirmation') &&
             $this->registerHook('actionOrderStatusPostUpdate') &&
-            $this->registerHook('displayBeforeBodyClosingTag') &&
             $this->registerHook('displayBackOfficeHeader') &&
             $this->registerHook('displayHeader');
     }
@@ -478,21 +476,6 @@ public function hookDisplayOrderConfirmation($params)
         return $this->display(__FILE__, 'checkout.tpl');
     }
 
-    /**
-     * Display footer
-     *
-     * @author        e-satisfaction SA
-     * @copyright (c) 2018, e-satisfaction SA
-     *
-     * @param array $params
-     *
-     * @return string
-     */
-    public function hookDisplayBeforeBodyClosingTag($params)
-    {
-        return $this->display(__FILE__, 'footer.tpl');
-    }
-
     /**
      * Add script in header
      *
diff --git a/views/templates/hook/checkout.tpl b/views/templates/hook/checkout.tpl
index 3bf16ad..59b9ee9 100644
--- a/views/templates/hook/checkout.tpl
+++ b/views/templates/hook/checkout.tpl
@@ -14,25 +14,17 @@
 <!-- E-sat order confirmation code -->
 {literal}
 <script>
-window.esat_config = {
-     application_id: "{/literal}{$app_id}{literal}",
-     collection: { 
-        "{/literal}{$checkout_quest_id}{literal}": {
-            'questionnaire_id': "{/literal}{$checkout_quest_id}{literal}",
-             'metadata' : {
-                  'responder' : {
-                    'email': "{/literal}{$customer_email}{literal}",
-                    'phone_number': "{/literal}{$customer_phone}{literal}"
-                  },
-                  'questionnaire' : {
-                    'transaction_id': "{/literal}{$order_id}{literal}",
-                    'transaction_date': "{/literal}{$order_date}{literal}",
-                    'store_pickup': {/literal}{$is_store_pickup}{literal}
-                  }
-             }
+    Esat.updateMetadata("{/literal}{$checkout_quest_id}{literal}", {
+        responder: {
+            "email": "{/literal}{$customer_email}{literal}",
+            "phone_number": "{/literal}{$customer_phone}{literal}"
+        },
+        questionnaire: {
+            "transaction_id": "{/literal}{$order_id}{literal}",
+            "transaction_date": "{/literal}{$order_date}{literal}",
+            "store_pickup": {/literal}{$is_store_pickup}{literal}
         }
-     }
-};
+    });
 </script>
 {/literal}
 <div id="esat-checkout-questionnaire-container"></div>
diff --git a/views/templates/hook/footer.tpl b/views/templates/hook/footer.tpl
deleted file mode 100644
index 49facd3..0000000
--- a/views/templates/hook/footer.tpl
+++ /dev/null
@@ -1,18 +0,0 @@
-{*
- * NOTICE OF LICENSE
- *
- * This file is licenced under the Software License Agreement.
- * With the purchase or the installation of the software in your application
- * you accept the licence agreement.
- *
- * You must not modify, adapt or create derivative works of this source code
- *
- *  @author    e-satisfaction SA
- *  @copyright 2018 e-satisfaction SA
- *  @license   https://opensource.org/licenses
- *}
-<!-- E-sat footer code -->
-
-<script src="https://collection.e-satisfaction.com/dist/js/integration.min.js"></script>
-
-<!-- /E-sat footer code -->
\ No newline at end of file
diff --git a/views/templates/hook/header.tpl b/views/templates/hook/header.tpl
index 04996a0..723ce44 100644
--- a/views/templates/hook/header.tpl
+++ b/views/templates/hook/header.tpl
@@ -14,9 +14,25 @@
 <!-- E-sat header code -->
 {literal}
 <script>
-    window.esat_config = {
-        application_id: "{/literal}{$app_id}{literal}"
-    };
+    (function (win, doc, application_id, jq, collection) {
+        // Define e-satisfaction collection configuration
+        win.esat_config = {application_id: application_id, collection: collection || {}};
+
+        // Update metadata
+        win.Esat = win.Esat || {};
+        win.Esat.updateMetadata = function (questionnaireId, metadata) {
+            win.esat_config.collection[questionnaireId] = win.esat_config.collection[questionnaireId] || {};
+            win.esat_config.collection[questionnaireId].metadata = metadata;
+        };
+
+        // Setup script
+        doc.addEventListener('DOMContentLoaded', function () {
+            var body = doc.getElementsByTagName('body')[0], script = doc.createElement('script');
+            script.async = true;
+            script.src = 'https://collection.e-satisfaction.com/dist/js/integration' + (!!jq ? '' : '.jq') + '.min.js';
+            body.appendChild(script);
+        });
+    })(window, document, "{/literal}{$app_id}{literal}", false, {});
 </script>
 {/literal}
 <!-- /E-sat header code -->
\ No newline at end of file