@mhubcloud/tms_core 1.7.5 → 1.7.6

package/index.js

@@ -9,6 +9,7 @@ module.exports = {
         Facebook : require('./publishers/Facebook'),
         GoogleAnalytics4 : require('./publishers/GoogleAnalytics4'),
         CJ : require('./publishers/CJ'),
-        UniversalAnalytics : require('./publishers/UniversalAnalytics')
+        UniversalAnalytics : require('./publishers/UniversalAnalytics'),
+        AffiliatePort : require('./publishers/AffiliatePort')
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mhubcloud/tms_core",
-    "version": "1.7.5",
+    "version": "1.7.6",
     "description": "Core function for mHub Cloud TMS publishers",
     "homepage": "https://mhubcloud.com/",
     "license": "Apache 2.0",
@@ -16,7 +16,7 @@
         "conversion API"
     ],
     "scripts": {
-        "test": "mocha ./tests/*.js"
+        "test": "mocha ./tests/*.js  --timeout 10000 "
     },
     "dependencies": {
         "ajv": "^8.8.2",

package/publishers/AffiliatePort.js

@@ -0,0 +1,61 @@
+const fetch = require('node-fetch');
+const utils = require("../lib/utils");
+const SOURCE = "f_AffiliatePort";
+
+module.exports = {
+    /**
+     * Processed data comming from EventHub to data for further processing
+     * @param {Object} data The data comming from EventHub
+     * @returns {Object} Data for further processing
+     */
+    parse: function parse(data, context) {
+        //ConsumerBase.cs:ConsumeOneEventAsync
+        data.enqueuedAt = context.test ? 1600000000000 : Date.now();
+        return data;
+    },
+
+    /**
+     * Publishes data to AffiliatePort
+     * @param {{id: string, access_token: string}} config Publisher configuration
+     * @param {Object} data Data in publisher-friendly format to be published
+     * @param {string} event for which is it triggered
+     */
+     publish: async function publish(config, data, event) {
+        data = utils.removeUndefined(data);
+        const reqOpts = {
+            method: "get"
+        };
+
+        for(let product of data.products){  
+
+            //https://tracking.affiliateclub.cz/aff_lsr?offer_id=OFFER_ID&adv_sub=TID_SUB_ID&amount=AMOUNT&transaction_id=TRANSACTION_ID&adv_sub2=CATEGORY&adv_sub3=MASTER_TYPE
+            const url = "https://tracking.affiliateclub.cz/aff_lsr?offer_id=" + encodeURIComponent(config.offerId) + "&adv_sub=TID_" + data.orderId + "&amount=" + product.quantity * product.price + "&transaction_id=" + data.transactionID + "&adv_sub2=" + product.category + "&adv_sub3=" + product.masterType;
+            const resp = await fetch(url, reqOpts);
+    
+            if (process.env.PUBLISHER_TESTURL) {
+                try {
+                    utils.prepareTestRequestHeaders(reqOpts.headers, url, reqOpts, resp);
+                    await fetch(process.env.PUBLISHER_TESTURL + query, reqOpts);
+                } catch { }
+            }
+    
+            await utils.handleResponse(resp, event);
+
+            console.log(`AffiliatePort - ${event} - sent`);
+
+        }
+    },
+
+    /**
+    * Validates an object against given schema
+    * @param {Object} data An object to validate.
+    * @param {string} schema Name of the schema. That's name of a file with `.schema.json` extension in `customizable/schemas` subfolder of current publisher folder
+    * @returns {boolean} Validation result, true if successful, false if unsuccessfull (in which case more info is written to console)
+    */
+    validate: function validate(data, schema) {
+        if (!schema) throw new Error("Schema parameters not provided");
+        if (schema.indexOf("/") >= 0) throw new Error("Schema must be provided as schema name, not schema path");
+        //More validation done by utils.validate
+        return utils.validate(data, SOURCE, schema);
+    }
+};

package/tests/AffiliatePort.js

@@ -0,0 +1,116 @@
+const publisher = require("../index.js").publisher.AffiliatePort;
+const defaultPublisher = require("../index.js").DefaultPublisher;
+const utils = require("../index.js").utils;
+var assert = require('assert');
+
+describe('test AffiliatePort publisher', function () {
+  it('purchase', async function () {
+    var eventHubMessages = [
+      {
+        "event": {
+          "region": "smarty.cz",
+          "id": "825333270-1011.1659006863812",
+          "code": "purchase"
+        },
+        "user": {
+          "ts": "customer.HL",
+          "email": "jan.brzobohaty@crossmasters.com",
+          "id": "a2992fb8-40ac-4b88-9cf5-7fba02f1f611"
+        },
+        "session": {
+          "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/15.2 Safari/605.1.15",
+          "ip": "217.195.174.253"
+        },
+        "permissions": [],
+        "currencyCode": "CZK",
+        "publisher": {
+          "code": "www.smarty.cz",
+          "tm": "GTM-NVNTFG",
+          "tmv": "193"
+        },
+        "$schema": "https://schema.measurementhub.net/mhub/2021-12-27/purchase",
+        "id": "3511111111",
+        "revenue": 10,
+        "products": [
+          {
+            "id": "67137",
+            "price": 10,
+            "quantity": 1,
+            "category": "Playstation",
+            "masterType": "Konzole"
+          },{
+            "id": "67137",
+            "price": 20,
+            "quantity": 1,
+            "category": "Monitor",
+            "masterType": "Video"
+          }
+        ],
+        "location": "https://www.smarty.cz/checkoutSuccess",
+        "referrer": "https://www.smarty.cz/Order/AddReservation?productId=57873&shopAddressId=24798",
+        "enqueuedAt": 1659006864038,
+        "ads": [{"adPlatform":"affiliateport","adCodes":{"transaction_id":"816f5670dbf52c3dc27a7e849903c327d705ef643993fbab3"},"visitAt":1658392668000}],
+        "EventProcessedUtcTime": "2022-07-28T11:54:50.2528883Z",
+        "PartitionId": 0,
+        "EventEnqueuedUtcTime": "2022-07-28T11:14:24.1170000Z"
+      }
+    ];
+    await test(eventHubMessages);
+  });
+})
+
+
+/**
+ * Test function
+ * @param [object] object obsahující nastavení testovací parametry
+ */
+async function test(eventHubMessages) {
+    try{
+        await defaultPublisher(console, eventHubMessages, "AffiliatePort", publisher, trigger);
+    }catch(err){
+        console.log(err);
+    }
+}
+
+function trigger(data) {
+    const publishers = [];
+    let publisher;
+    
+    //Dummy config, replace with your own
+    const config = {
+        offerId: 123,
+    };
+
+    switch (data.event?.code) {
+        case "purchase":
+            publisher = AffiliatePortPurchasePublisher;
+            publisher.register(publishers, config);
+            break;
+    } 
+    return publishers;
+};
+
+/**
+ * Implements Purchase event publisher for Facebook
+ * @implements {EventPublisher<{id: string, access_token: string}>}
+ */
+class AffiliatePortPurchasePublisher extends utils.EventPublisherBase {
+    /**
+     * Maps `purchase` event data to AffiliatePort payload
+     * @param {Object} data `purchase` event data
+     * @returns {Object} Data mapped from incomming Event Hub message to platform payload
+     */
+    map(data) {
+        return {
+            orderId: data.id,
+            revenue: data.revenue, //should be without VAT and shipping, payment fees
+            products: data.products.map(pr => ({
+                quantity: pr.quantity, // e.g. 1
+                price: pr.price, // e.g. 109
+                category: pr.category.replace(/ /g, "-"), // e.g. Playstation
+                masterType: pr.masterType // e.g. Konzole
+            })),
+            transactionID: utils.extractAdCode(data, 'affiliateport', 'transaction_id')?.code // AffiliatePort identificator taken automatically from URL
+        };
+    }
+};