playov2-js-utilities 0.3.69 → 0.3.73

package/lib/responseHandler/responseHandler.js

@@ -1,53 +1,53 @@
-const Logger = require("../logger");
-
-/**
- * Axios response handler
- * @param {Response} resp  
- * resp structure | 
- * on success {
- *      status: HTTP status code returned by the service
- *      data,
- *      config: request config    
- *  } 
- * on fail : {
- *      code: error code | http errorcode like ECONNREFUSED, ETIMEOUT etc
- *      message: error message | description of the error code
- *      config: request config
- *  }
- * @param {String} requestId 
- * @returns 
- */
-const responseHandler = (resp, requestId) => {
-    if (resp.isAxiosError) {
-        //if axios error is triggered then axios throws HTTP code for timeout or other forms of unsuccessful errors
-        const {
-            code = "UNCAUGHT_ERROR",
-            message = "encountered uncaught error",
-            config = { url: '' },
-            response = { data: { requestStatus: 0 } }
-        } = resp;
-        const { url } = config;
-        const { data = { requestStatus: 0, statusError: "POTENTIAL-BAD-GATEWAY" }} = response;
-        data["message"] = message;
-        Logger.prepareErrorLog(requestId, { code, message }, `Api call to url to ${url} failed`)
-        throw (data);
-    }
-
-    const { status, data, config = { url: '' } } = resp;
-    const { url = '' } = config;
-    if (status >= 200 && status < 400) {
-        const { requestStatus, message = 'success' } = data;
-        if (!requestStatus && requestStatus != 0) { //if the service does not provide request status 
-            data["requestStatus"] = 1;
-        }
-        Logger.prepareInfoLog(requestId, { status, requestStatus: data.requestStatus, message }, `Api call to url to ${url} succeeded with status ${status}`)
-        return data
-    }
-
-    else { // ideally this should not get triggered unless there is fault in calling lib itself
-        Logger.prepareErrorLog(requestId, { response: resp }, "axios error");
-        throw ({ requestStatus: 0, message: "Failed to handle response" })
-    }
-}
-
+const Logger = require("../logger");
+
+/**
+ * Axios response handler
+ * @param {Response} resp  
+ * resp structure | 
+ * on success {
+ *      status: HTTP status code returned by the service
+ *      data,
+ *      config: request config    
+ *  } 
+ * on fail : {
+ *      code: error code | http errorcode like ECONNREFUSED, ETIMEOUT etc
+ *      message: error message | description of the error code
+ *      config: request config
+ *  }
+ * @param {String} requestId 
+ * @returns 
+ */
+const responseHandler = (resp, requestId) => {
+    if (resp.isAxiosError) {
+        //if axios error is triggered then axios throws HTTP code for timeout or other forms of unsuccessful errors
+        const {
+            code = "UNCAUGHT_ERROR",
+            message = "encountered uncaught error",
+            config = { url: '' },
+            response = { data: { requestStatus: 0 } }
+        } = resp;
+        const { url } = config;
+        const { data = { requestStatus: 0, statusError: "POTENTIAL-BAD-GATEWAY" }} = response;
+        data["message"] = message;
+        Logger.prepareErrorLog(requestId, { code, message }, `Api call to url to ${url} failed`)
+        throw (data);
+    }
+
+    const { status, data, config = { url: '' } } = resp;
+    const { url = '' } = config;
+    if (status >= 200 && status < 400) {
+        const { requestStatus, message = 'success' } = data;
+        if (!requestStatus && requestStatus != 0) { //if the service does not provide request status 
+            data["requestStatus"] = 1;
+        }
+        Logger.prepareInfoLog(requestId, { status, requestStatus: data.requestStatus, message }, `Api call to url to ${url} succeeded with status ${status}`)
+        return data
+    }
+
+    else { // ideally this should not get triggered unless there is fault in calling lib itself
+        Logger.prepareErrorLog(requestId, { response: resp }, "axios error");
+        throw ({ requestStatus: 0, message: "Failed to handle response" })
+    }
+}
+
 module.exports = { responseHandler }

package/lib/util.js

@@ -1,152 +1,152 @@
-/**\
- * This module is not imported in PlayoLib directly as there are already many imports in individual repositories 
- * named util/utils and importing this alongside might cause unforeseen errors or poor readability
- * Ideally new repositories should import utils from here only. Todo- look for a workaround - named imports
- */
-
-const hbs = require('handlebars');
-
-/**
- * Finds rating given to a user for a sport by playpals <Assumes playpalDocs supplied are already filtered for a user>
- * @param {Array} playpalDocs 
- * @param {String} sportId 
- * @returns {Array<Number>}
- */
-const getRatingsFromPlaypalDocs = (playpalDocs = [], sport) => {
-    const ratings = [];
-
-    for (const playpalDoc of playpalDocs) {
-        if (playpalDoc.ratings && Array.isArray(playpalDoc.ratings)) {
-            for (const ratingData of playpalDoc.ratings) {
-                const { rating, sportId } = ratingData;
-                if (rating && sportId && sportId === sport) {
-                    ratings.push(rating);
-                    continue;
-                }
-            }
-        }
-    }
-    return ratings;
-};
-
-
-/**
- * Returns average of an array of numbers
- * @param {Array<Number>} arr 
- */
-const findAverage = (arr = []) => {
-
-    if (arr.length === 0) {
-        return 0;
-    }
-
-    let sum = 0;
-
-    for (const num of arr) {
-        if (typeof num === 'number') {
-            sum += num;
-        }
-    }
-
-    const avg = sum / (arr.length);
-
-    return avg;
-};
-
-/**
- * 
- * @param {Array<PostActivityDoc>} postActivityDocs - Assumes this is filtered for a particular sport
- * @return {
- *      palId: {
- *            rating: Number (Most recent),
- *            timestamp
- *          }
- *  }
- */
-const getRecentRatingDictOfPals = (postActivityDocs) => {
-
-    const palRatingDict = {};
-
-    postActivityDocs.forEach((postActivityDoc) => {
-
-        // pals array contains ratings object as per given by other playpals for a particular activity, check schema for further details
-        const { pals = [] } = postActivityDoc;
-
-        /**
-         * Description for code below we are try to get a dictionary of latest non-zero rating the user has received to be processed later
-         */
-        if (Array.isArray(pals)) {
-            pals.forEach((palRating) => {
-                const { palId = '', rating = 0, timestamp } = palRating;
-                if (!palRatingDict[palId] && rating > 0) { // only consider pals who have rated the user
-                    palRatingDict[palId] = {
-                        rating: rating,
-                        timestamp: timestamp
-                    }
-                } else if (palRatingDict[palId] && timestamp >= palRatingDict[palId]["timestamp"] && rating > 0) {
-                    // If user received any rating more recent then consider that instead 
-                    palRatingDict[palId]["rating"] = rating;
-                }
-            });
-        }
-    });
-
-    return palRatingDict;
-};
-
-/**
- * Returns categorical breakup of ratings the user received - data source - post activity docs
- * @param {*} palRatingDict 
- * @param {*} levelCategories 
- * @returns 
- */
-const getCategoricalBreakUpFromRecentUserRatings = (palRatingDict, levelCategories) => {
-    const categoricalBreakUp = {};
-
-    for (let pal in palRatingDict) {
-        const level = palRatingDict[pal].rating;
-
-        if (levelCategories[level]) {
-            if (!categoricalBreakUp[levelCategories[level]]) {
-                categoricalBreakUp[levelCategories[level]] = 1;
-            } else {
-                categoricalBreakUp[levelCategories[level]] += 1;
-            }
-        }
-    }
-
-    // Inject default zero rating for non-rated levels
-    for (level in levelCategories) {
-        if (!categoricalBreakUp[levelCategories[level]]) {
-            categoricalBreakUp[levelCategories[level]] = 0;
-        }
-    }
-
-    return categoricalBreakUp;
-};
-
-const noop = () => {
-    return undefined;
-};
-
-/**
- * 
- * @param {String} template  - Handlebars compatible template
- * @param {Object} data - Data points containing key value pairs of data required in template supplied
- * @returns {String}
- */
-const renderTemplate = (template, data) => {
-
-    const temp = hbs.compile(template);
-
-    return temp(data);
-};
-
-module.exports = {
-    getRatingsFromPlaypalDocs,
-    findAverage,
-    getRecentRatingDictOfPals,
-    getCategoricalBreakUpFromRecentUserRatings,
-    noop,
-    renderTemplate
+/**\
+ * This module is not imported in PlayoLib directly as there are already many imports in individual repositories 
+ * named util/utils and importing this alongside might cause unforeseen errors or poor readability
+ * Ideally new repositories should import utils from here only. Todo- look for a workaround - named imports
+ */
+
+const hbs = require('handlebars');
+
+/**
+ * Finds rating given to a user for a sport by playpals <Assumes playpalDocs supplied are already filtered for a user>
+ * @param {Array} playpalDocs 
+ * @param {String} sportId 
+ * @returns {Array<Number>}
+ */
+const getRatingsFromPlaypalDocs = (playpalDocs = [], sport) => {
+    const ratings = [];
+
+    for (const playpalDoc of playpalDocs) {
+        if (playpalDoc.ratings && Array.isArray(playpalDoc.ratings)) {
+            for (const ratingData of playpalDoc.ratings) {
+                const { rating, sportId } = ratingData;
+                if (rating && sportId && sportId === sport) {
+                    ratings.push(rating);
+                    continue;
+                }
+            }
+        }
+    }
+    return ratings;
+};
+
+
+/**
+ * Returns average of an array of numbers
+ * @param {Array<Number>} arr 
+ */
+const findAverage = (arr = []) => {
+
+    if (arr.length === 0) {
+        return 0;
+    }
+
+    let sum = 0;
+
+    for (const num of arr) {
+        if (typeof num === 'number') {
+            sum += num;
+        }
+    }
+
+    const avg = sum / (arr.length);
+
+    return avg;
+};
+
+/**
+ * 
+ * @param {Array<PostActivityDoc>} postActivityDocs - Assumes this is filtered for a particular sport
+ * @return {
+ *      palId: {
+ *            rating: Number (Most recent),
+ *            timestamp
+ *          }
+ *  }
+ */
+const getRecentRatingDictOfPals = (postActivityDocs) => {
+
+    const palRatingDict = {};
+
+    postActivityDocs.forEach((postActivityDoc) => {
+
+        // pals array contains ratings object as per given by other playpals for a particular activity, check schema for further details
+        const { pals = [] } = postActivityDoc;
+
+        /**
+         * Description for code below we are try to get a dictionary of latest non-zero rating the user has received to be processed later
+         */
+        if (Array.isArray(pals)) {
+            pals.forEach((palRating) => {
+                const { palId = '', rating = 0, timestamp } = palRating;
+                if (!palRatingDict[palId] && rating > 0) { // only consider pals who have rated the user
+                    palRatingDict[palId] = {
+                        rating: rating,
+                        timestamp: timestamp
+                    }
+                } else if (palRatingDict[palId] && timestamp >= palRatingDict[palId]["timestamp"] && rating > 0) {
+                    // If user received any rating more recent then consider that instead 
+                    palRatingDict[palId]["rating"] = rating;
+                }
+            });
+        }
+    });
+
+    return palRatingDict;
+};
+
+/**
+ * Returns categorical breakup of ratings the user received - data source - post activity docs
+ * @param {*} palRatingDict 
+ * @param {*} levelCategories 
+ * @returns 
+ */
+const getCategoricalBreakUpFromRecentUserRatings = (palRatingDict, levelCategories) => {
+    const categoricalBreakUp = {};
+
+    for (let pal in palRatingDict) {
+        const level = palRatingDict[pal].rating;
+
+        if (levelCategories[level]) {
+            if (!categoricalBreakUp[levelCategories[level]]) {
+                categoricalBreakUp[levelCategories[level]] = 1;
+            } else {
+                categoricalBreakUp[levelCategories[level]] += 1;
+            }
+        }
+    }
+
+    // Inject default zero rating for non-rated levels
+    for (level in levelCategories) {
+        if (!categoricalBreakUp[levelCategories[level]]) {
+            categoricalBreakUp[levelCategories[level]] = 0;
+        }
+    }
+
+    return categoricalBreakUp;
+};
+
+const noop = () => {
+    return undefined;
+};
+
+/**
+ * 
+ * @param {String} template  - Handlebars compatible template
+ * @param {Object} data - Data points containing key value pairs of data required in template supplied
+ * @returns {String}
+ */
+const renderTemplate = (template, data) => {
+
+    const temp = hbs.compile(template);
+
+    return temp(data);
+};
+
+module.exports = {
+    getRatingsFromPlaypalDocs,
+    findAverage,
+    getRecentRatingDictOfPals,
+    getCategoricalBreakUpFromRecentUserRatings,
+    noop,
+    renderTemplate
 };

package/package.json

@@ -1,36 +1,36 @@
-{
-  "name": "playov2-js-utilities",
-  "version": "0.3.69",
-  "description": "Private package for JS utility functions",
-  "main": "index.js",
-  "scripts": {
-    "test": "npm test"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@bitbucket.org/techmash/playov2-js-utilities.git"
-  },
-  "keywords": [
-    "Playo"
-  ],
-  "author": "Avish",
-  "license": "ISC",
-  "homepage": "https://bitbucket.org/techmash/playov2-js-utilities#readme",
-  "devDependencies": {
-    "@types/uuid": "^8.3.4",
-    "faker": "^5.5.3",
-    "jest": "^27.1.0"
-  },
-  "dependencies": {
-    "@google-cloud/tasks": "^2.5.0",
-    "@playo/logger": "^0.9.24",
-    "axios": "^0.24.0",
-    "bad-words": "^3.0.4",
-    "cron": "^1.8.2",
-    "googleapis": "^109.0.1",
-    "handlebars": "^4.7.7",
-    "moment": "^2.29.4",
-    "mongoose": "8.4.5",
-    "uuid": "^8.3.2"
-  }
-}
+{
+  "name": "playov2-js-utilities",
+  "version": "0.3.73",
+  "description": "Private package for JS utility functions",
+  "main": "index.js",
+  "scripts": {
+    "test": "npm test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@bitbucket.org/techmash/playov2-js-utilities.git"
+  },
+  "keywords": [
+    "Playo"
+  ],
+  "author": "Avish",
+  "license": "ISC",
+  "homepage": "https://bitbucket.org/techmash/playov2-js-utilities#readme",
+  "devDependencies": {
+    "@types/uuid": "^8.3.4",
+    "faker": "^5.5.3",
+    "jest": "^27.1.0"
+  },
+  "dependencies": {
+    "@google-cloud/tasks": "^2.5.0",
+    "@playo/logger": "^0.9.24",
+    "axios": "^0.24.0",
+    "bad-words": "^3.0.4",
+    "cron": "^1.8.2",
+    "googleapis": "^109.0.1",
+    "handlebars": "^4.7.7",
+    "moment": "^2.29.4",
+    "mongoose": "8.4.5",
+    "uuid": "^8.3.2"
+  }
+}