@mhubcloud/tms_core 2.0.0-beta.0 → 2.0.0-beta.2

package/js/publishers/Facebook.js

@@ -1,64 +0,0 @@
-const fetch = require('node-fetch');
-const utils = require("../lib/utils");
-const SOURCE = "f_Facebook";
-
-module.exports = {
-    /**
-     * Processed data comming from EventHub to data for further processing
-     * @param {Object} data The data comming from EventHub
-     * @param {FunctionContext} test Azure Function context.test
-     * @returns {Object} Data for further processing
-     */
-    parse: function parse(data, test) {
-        //ConsumerBase.cs:ConsumeOneEventAsync
-        data.enqueuedAt = test ? 1600000000000 : Date.now();
-        return data;
-    },
-
-    /**
-     * Publishes data to Facebook
-     * @param {FunctionContext} log Azure Function context.log.warn
-     * @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(log, config, data, event) {
-        data = utils.removeUndefined(data);
-        const reqOpts = {
-            method: "post",
-            body: JSON.stringify({ data: [data] }),
-            headers: {
-                'Content-Type': 'application/json'
-            }
-        };
-        //https://graph.facebook.com/v11.0/<id>/events
-        const baseUrl = "https://graph.facebook.com/v11.0/" + encodeURIComponent(config.id) + "/events";
-        const query = "?access_token=" + encodeURI(config.access_token);
-        const url = baseUrl + query;
-        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);
-
-        log(`Facebook - ${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/js/publishers/GoogleAnalytics4.js

@@ -1,76 +0,0 @@
-const fetch = require('node-fetch');
-const utils = require("../lib/utils");
-const SOURCE = "f_GoogleAnalytics4";
-
-//https://cloud.google.com/appengine/docs/standard/php7/integrating-with-analytics#server-side_analytics_collection 
-
-module.exports = {
-    /**
-     * Processed data comming from EventHub to data for further processing
-     * @param {Object} data The data comming from EventHub
-     * @param {FunctionContext} test Azure Function context.test
-     * @returns {Object} Data for further processing
-     */
-    parse: function parse(data, test) {
-        //ConsumerBase.cs:ConsumeOneEventAsync
-        data.enqueuedAt = test ? 1600000000000 : Date.now();
-        return data;
-    },
-
-    /**
-     * Publishes data to Google Analytics
-     * @param {FunctionContext} log Azure Function context.log.warn
-     * @param {{tid: string}} config Publisher configuration
-     * @param {{action: string, ti: string, [key:string]: string|number|boolean}} data Data in publisher-friendly format to be published
-     */
-    publish: async function publish(log, config, data, event) {
-        data = utils.removeUndefined(data);
-        data.v = 2;
-        data.seg = 1;
-        data.gcs = 111;
-        data.tid = config.trackingId;
-        
-        let payload = "";
-
-        for (const prp in data) {
-            if (data.hasOwnProperty(prp)) {
-                if (payload) payload += "&";
-                payload += encodeURI(prp) + "=" + encodeURI(data[prp]);
-            }
-        }
-
-        var reqOpts = {
-            hostname: 'www.google-analytics.com',
-            port: 443,
-            path: '/g/collect?' + payload,
-            method: 'POST'
-        };
-        
-        await utils.httpRequest(reqOpts);
-
-        if (process.env.PUBLISHER_TESTURL) {
-            try {
-                reqOpts.headers = {};
-                utils.prepareTestRequestHeaders(reqOpts.headers, reqOpts.hostname + reqOpts.path , reqOpts);
-                await fetch(process.env.PUBLISHER_TESTURL, reqOpts);
-            } catch(exception) { 
-                warn(exception);
-            }
-        }
-        
-        log(`GoogleAnalytics4 - ${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/js/publishers/HttpPublisher.js

@@ -1,64 +0,0 @@
-const fetch = require('node-fetch');
-const utils = require("../lib/utils");
-const SOURCE = "f_HttpPublisher";
-
-module.exports = {
-    /**
-     * Processed data comming from EventHub to data for further processing
-     * @param {Object} data The data comming from EventHub
-     * @param {FunctionContext} test Azure Function context.test
-     * @returns {Object} Data for further processing
-     */
-    parse: function parse(data, test) {
-        //ConsumerBase.cs:ConsumeOneEventAsync
-        data.enqueuedAt = test ? 1600000000000 : Date.now();
-        return data;
-    },
-
-    /**
-     * Publishes data to provided URL
-     * @param {FunctionContext} log Azure Function context.log.warn
-     * @param {string} event Required: event for which is it triggered
-     * @param {string} url Required: Request URL with query parameters
-     * @param {string} platform Required: Name of the plaform to which request is sent
-     * @param {string} method Required: Request method - GET|POST|PUT...
-     * @param {Object} headers Optional: Object of request headers
-     * @param {Object} body Optional: Non-strigifed request body object 
-     * 
-     */
-     publish: async function publish(log, event, platform, url, method, headers = {}, body = {}) {
-        const reqOpts = {
-            method: method,
-            headers: headers
-        };
-        if(method == "POST"){
-            reqOpts.body = JSON.stringify(body);
-        }
-
-        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, reqOpts);
-            } catch { }
-        }
-
-        await utils.handleResponse(resp, event);
-
-        log(`${platform} - ${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/js/publishers/Piano.js

@@ -1,68 +0,0 @@
-const utils = require("../lib/utils");
-const fetch = require('node-fetch');
-const SOURCE = "f_Piano";
-
-module.exports = {
-    /**
-     * Processed data comming from EventHub to data for further processing
-     * @param {Object} data The data comming from EventHub
-     * @param {FunctionContext} test Azure Function context.test
-     * @returns {Object} Data for further processing
-     */
-    parse: function parse(data, test) {
-        //ConsumerBase.cs:ConsumeOneEventAsync
-        data.enqueuedAt = test ? 1600000000000 : Date.now();
-        return data;
-    },
-
-    /**
-     * Publishes data to Piano
-     * @param {FunctionContext} log Azure Function context.log.warn
-     * @param {{collectionDomain: string, siteId: string|number}} config Publisher configuration
-     * @param {{pianoData: {events: {name: string, data: {[key: string]: any}}[]}, aux: {visitorId: string, ref: string, userAgent?: string, referer?: string, forwardedFor?: string}}} data Data in publisher-friendly format to be published
-     * @returns {*} Data returned by platform, if possible JSON-deserialized (otherwise as string)
-     * @param {string} event for which is it triggered
-     */
-    publish: async function publish(log, config, data, event) {
-        data = utils.removeUndefined(data);
-        let dt = "";
-        //https://developers.atinternet-solutions.com/piano-analytics-tagging-en/event-tagging-piano-analytics-en/events-pattern-en/#post-request_5
-        //https://<collection-domain>/<path>?s=<site-id>&idclient=<visitor-id>&ref=<previous-url>
-        dt = "?s=" + encodeURI(config.siteId);
-        dt += "&idclient=" + encodeURI(data.aux.visitorId);
-        dt += "&ref=" + encodeURI(data.aux.ref);
-
-        const reqOpts = { method: "post", headers: {} /*Needed by test call*/, body: JSON.stringify(data.pianoData) };
-        if (data.aux.userAgent)
-            reqOpts.headers["User-Agent"] = data.aux.userAgent;
-        if (data.aux.referer)
-            reqOpts.headers["Referer"] = data.aux.referer;
-        if (data.aux.forwardedFor)
-            reqOpts.headers["X-Forwarded-For"] = data.aux.forwardedFor;
-        const resp = await fetch("https://" + config.collectionDomain + "/" + dt, reqOpts);
-
-        if (process.env.PUBLISHER_TESTURL) {
-            try {
-                utils.prepareTestRequestHeaders(reqOpts.headers, config.collectionDomain + dt, reqOpts, resp);
-                await fetch(process.env.PUBLISHER_TESTURL + dt, reqOpts);
-            } catch { }
-        }
-
-        await utils.handleResponse(resp, event);
-
-        log(`Piano Analytics - ${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/js/publishers/UniversalAnalytics.js

@@ -1,75 +0,0 @@
-const fetch = require('node-fetch');
-const utils = require("../lib/utils");
-const SOURCE = "f_UniversalAnalytics";
-
-//https://cloud.google.com/appengine/docs/standard/php7/integrating-with-analytics#server-side_analytics_collection 
-
-module.exports = {
-    /**
-     * Processed data comming from EventHub to data for further processing
-     * @param {Object} data The data comming from EventHub
-     * @param {FunctionContext} test Azure Function context.test
-     * @returns {Object} Data for further processing
-     */
-    parse: function parse(data, test) {
-        //ConsumerBase.cs:ConsumeOneEventAsync
-        data.enqueuedAt = test ? 1600000000000 : Date.now();
-        return data;
-    },
-
-    /**
-     * Publishes data to Google Analytics
-     * @param {FunctionContext} log Azure Function context.log.warn
-     * @param {{tid: string}} config Publisher configuration
-     * @param {{action: string, ti: string, [key:string]: string|number|boolean}} data Data in publisher-friendly format to be published
-     */
-    publish: async function publish(log, config, data, event) {
-        data = utils.removeUndefined(data);
-        //https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#event
-        const url = "https://www.google-analytics.com/collect";
-        data.v = 1;
-        data.tid = config.trackingId;
-        let payload = "";
-
-        for (const prp in data) {
-            if (data.hasOwnProperty(prp)) {
-                if (payload) payload += "&";
-                payload += encodeURI(prp) + "=" + encodeURI(data[prp]);
-            }
-        }
-
-        const reqOpts = {
-            method: "post",
-            body: payload,
-            headers: {
-                'Content-Type': 'application/x-www-form-urlencoded'
-            }
-        };
-
-        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, reqOpts);
-            } catch { }
-        }
-
-        await utils.handleResponse(resp);
-
-        log(`Universal Analytics - ${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/testUtils.js

@@ -1,7 +0,0 @@
-const context = {}
-context.log = function log(str) { console.log(str) }
-context.log.warn = function warn(str) {console.warn(str) }
-
-module.exports = {
-  context: context
-}