groupcore-utils 1.3.3 → 2.0.0

package/.eslintrc

@@ -0,0 +1,26 @@
+{
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es2021": true
+  },
+  "extends": ["eslint:recommended", "airbnb", "prettier", "plugin:jest/all"],
+  "parserOptions": {
+    "ecmaVersion": 12
+  },
+  "rules": {
+    "no-underscore-dangle": "off",
+    "class-methods-use-this": "off",
+    "no-console": "off",
+    "jest/no-hooks": "off",
+    "jest/no-test-return-statement": "off",
+    "jest/prefer-strict-equal": "off",
+    "consistent-return": "off",
+    "array-callback-return": "off",
+    "no-param-reassign": "off",
+    "no-restricted-syntax": "off",
+    "prefer-destructuring": "off",
+    "no-case-declarations": "off",
+    "jest/require-hook": "off"
+  }
+}

package/README.md

@@ -86,6 +86,244 @@ These are the methods you can call with this package. This list will continually
    */
 ```
 
+### Communication
+#### Email
+Send mail to a specified recipient.
+```
+  require('groupcore-utils/communication/email')
+    
+  /**
+   * @description constructor
+   * @param {string} hostname - hostname of the mail service provider
+   * @param port {number} - smtp port of the mail service provider
+   * @param username {string} - smtp username
+   * @param password {password} - smtp password
+   */
+
+  /**
+   * @method send()
+   * @description send email to a specified recipient
+   * @param email {string} - the recipient's email address
+   * @param subject {string} - subject of the email
+   * @param message {string} - mail message
+   * @param attachment {string} - url of attached file
+   * @param from {string} - sender email address
+   * @returns {Promise<*>}
+   */
+```
+
+### SQL Database
+#### Initialization
+Initialize db with this and pass the object to the CRUD class constructor
+```
+  require('groupcore-utils/database/init')
+  
+   /**
+   * @description constructor
+   * @param {string} host - sql db hostname
+   * @param {string} user - db user username
+   * @param {string} password - db user password
+   * @param {string} db - db name
+   * @param {string} socket - path to a unix domain socket to connect to. when used host and port are ignored
+   */
+```
+
+#### CRUD Methods
+```
+   require('groupcore-utils/database/crud')
+
+  /**
+   * @description constructor
+   * @param {string} dbTable - name of the table
+   * @param {object} db - the initialised db instance
+   */
+  
+  /**
+   * @method create()
+   * @description Insert values into db
+   * @param {Object} data - the key value pair of the data to be inserted into the db
+   * @param {Boolean} unique - if set to true, ensure no duplication of data during creation
+   * @param {Array} ignore - fields to ignore when checking for unique values
+   * @returns {Promise | string | Object} - resolves if successfully and rejects if there's an error
+   */
+   
+  /**
+   * @method read()
+   * @description get data from table
+   * @param {null, Object} where - if no where, all the data will be returned from db table without any 'where' clause.  shape {field, value}
+   * @param {null | Array} orderBy - explicitly specify the order, either asc or desc
+   * @returns {Promise}
+   */
+   
+  /**
+   * @method update
+   * @description update db table by id
+   * @param {Object} data - fields to update
+   * @param {number} id - id in where clause
+   * @returns {Promise}
+   */  
+   
+  /**
+   * @method delete()
+   * @description delete data from db by id
+   * @param {number} id - id of data to deleted
+   * @returns {Promise}
+   */
+   
+  /**
+   * @method query()
+   * @description make a custom db query
+   * @param {string} queryStatement - SQL query
+   * @returns {Promise}
+   */
+```
+
+### REST
+```
+  require('groupcore-utils/rbac')
+
+  /**
+   * @method get()
+   * @description send a GET request
+   * @param {string} url - api url
+   * @param {object} headers - headers to be added to request
+   * @returns {AxiosPromise<any>}
+   */
+   
+  /**
+   * @method post()
+   * @description send a POST request
+   * @param {string} url - api url
+   * @param {object} data - payload
+   * @param {object} headers - headers to be added to request 
+   * @returns {AxiosPromise<any>}
+   */
+   
+  /**
+   * @method put()
+   * @description send PUT request
+   * @param {string} url - api url
+   * @param {object} data - payload
+   * @param {object} headers - headers to be added to request
+   * @returns {AxiosPromise<any>}
+   */
+   
+  /**
+   * @method patch()
+   * @description send PATCH request
+   * @param {string} url - api url
+   * @param {object} data - payload
+   * @param {object} headers - headers to be added to request
+   * @returns {AxiosPromise<any>}
+   */
+   
+  /**
+   * @method delete()
+   * @description send DELETE request
+   * @param {string} urls - api url
+   * @param {object} headers - headers to be added to request
+   * @returns {AxiosPromise<any>}
+   */
+```
+
+### Encryption
+```
+  require('groupcore-utils/security/encryption')
+  /**
+   * @method hash()
+   * @description create a hash of a text
+   * @param {string} text - text to be hashed
+   * @returns {*}
+   */
+   
+  /**
+   * @method verify()
+   * @description verify a text by its hash
+   * @param {string} hash - the hashed text
+   * @param {string} text - the text to be compared with the hash
+   * @returns {*}
+   */  
+```
+
+### JWT
+```
+  require('groupcore-utils/security/encryption')
+
+  /**
+   * @description constructor
+   * @param {string} jwtKey - jwt key
+   */
+
+  /**
+   * @method jwtSign()
+   * @description create a JWT token 
+   * @param {object} payload - payload to be tokenized
+   * @returns {*}
+   */
+
+  /**
+   * @method jwtDecode()
+   * @description decode a JWT token
+   * @param {string} token - JWT token to be decoded
+   * @returns {{payload: any, signature: *, header: *}|*|SourceMapPayload|TokenPayload}
+   */      
+   
+  /**
+   * @method jwtVerify()
+   * @description verify a JWT token
+   * @param {string} token - token to be verified
+   * @returns {*}
+   */         
+```
+
+### Date and Time
+```
+  require('groupcore-utils/timestamp')
+
+  /**
+   * @method now()
+   * @description returns the present unix timestamp
+   * @returns {number}
+   */
+   
+  /**
+   * @method unixToDate()
+   * @description convert a unix timestamp to specific date format
+   * @param {number} unix - the unix timestamp to be converted
+   * @param {string} format - the format to use, default is 'MMMM DD, YYYY'
+   * @returns {string}
+   */
+   
+  /**
+   * @method dateToUnix()
+   * @description convert a unix date to unix
+   * @param {number} date - the date to be converted
+   * @param {string} format - the format of the date
+   * @returns {number}
+   */   
+   
+  /**
+   * @method unixToStartOfDay()
+   * @description take whatever date is given to 12:00:00 AM of that day
+   * @param {string} unix - unix timestamp
+   * @returns {number}
+   */   
+   
+  /**
+   * @method unixToEndOfDay()
+   * @description take whatever date is given to 11:59:59 PM of the day
+   * @param {string} unix - unix timestamp
+   * @returns {number}
+   */   
+   
+  /**
+   * @method toSeconds()
+   * @description convert time (HH:MM) to seconds
+   * @param {string} time - time to be converted
+   * @returns {number}
+   */   
+```
+
 ### Testing
 ```
 npm run test

package/communication/mail.js

@@ -0,0 +1,54 @@
+const nodemailer = require("nodemailer");
+
+module.exports = class {
+  /**
+   * @description constructor
+   * @param {string} hostname - hostname of the mail service provider
+   * @param port {number} - smtp port of the mail service provider
+   * @param username {string} - smtp username
+   * @param password {password} - smtp password
+   */
+  constructor({ hostname, port, username, password }) {
+    this.hostname = hostname;
+    this.port = port;
+    this.username = username;
+    this.password = password;
+  }
+
+  async _init() {
+    this.transporter = nodemailer.createTransport({
+      host: this.hostname,
+      port: this.port,
+      secure: false,
+      auth: {
+        user: this.username,
+        pass: this.password,
+      },
+      tls: {
+        rejectUnauthorized: false,
+      },
+    });
+  }
+
+  /**
+   * @method send()
+   * @description send email to a specified recipient
+   * @param email {string} - the recipient's email address
+   * @param subject {string} - subject of the email
+   * @param message {string} - mail message
+   * @param attachment {string} - url of attached file
+   * @param from {string} - sender email address
+   * @returns {Promise<*>}
+   */
+  async send({ email, subject, message, attachment = null, from }) {
+    await this._init();
+
+    return this.transporter.sendMail({
+      subject,
+      from,
+      to: email,
+      html: message,
+      attachments: attachment,
+    });
+  }
+};

package/database/crud.js

@@ -0,0 +1,124 @@
+const escapeQuotes = require('escape-quotes');
+const _ = require('lodash');
+
+module.exports = class {
+  /**
+   * @description constructor
+   * @param {string} dbTable - name of the table
+   * @param {object} db - the initialised db instance
+   */
+  constructor({ dbTable, db }) {
+    this.dbTable = dbTable;
+    this.db = db;
+  }
+
+  /**
+   * @method create()
+   * @description Insert values into db
+   * @param {Object} data - the key value pair of the data to be inserted into the db
+   * @param {Boolean} unique - if set to true, ensure no duplication of data during creation
+   * @param {Array} ignore - fields to ignore when checking for unique values
+   * @returns {Promise | string | Object} - resolves if successfully and rejects if there's an error
+   */
+
+  async create({ data }) {
+    const fields = Object.keys(data).join(',');
+
+    const rawValues = [];
+    Object.values(data).map((value) => {
+      rawValues.push(`'${escapeQuotes(value)}'`);
+      return true;
+    });
+    const values = rawValues.join(',');
+
+    const query = `insert into ${this.dbTable} (${fields}) values (${values})`;
+
+    return this.db.query(query);
+  }
+
+  /**
+   * @method read()
+   * @description get data from table
+   * @param {Object} where - if no where, all the data will be returned from db table without any 'where' clause.  shape {field, value}
+   * @param {Array} orderBy - explicitly specify the order, either asc or desc
+   * @returns {Promise}
+   */
+  read({ where, orderBy }) {
+    let query;
+
+    if (orderBy) {
+      if (where) {
+        query = `select * from ${this.dbTable} where ${where.field} = '${where.value}' order by ${orderBy}`;
+      } else {
+        query = `select * from ${this.dbTable} order by ${orderBy}`;
+      }
+    } else if (where) {
+      query = `select * from ${this.dbTable} where ${where.field} = '${where.value}'`;
+    } else {
+      query = `select * from ${this.dbTable}`;
+    }
+
+    return this.db.query(query);
+  }
+
+  // with orderby
+  // readOrderBy(where = null) {
+  //   let query;
+  //
+  //   if (where) {
+  //     query = `select * from ${this.dbTable} where ${where.field} = '${where.value}'`;
+  //   } else {
+  //     query = `select * from ${this.dbTable}`;
+  //   }
+  //
+  //   return new Db().query(query);
+  // }
+
+  /**
+   * @method update
+   * @description update db table by id
+   * @param {Object} data - fields to update
+   * @param {number} id - id in where clause
+   * @returns {Promise}
+   */
+  update({ data, id }) {
+    // variable to hold the dynamic part of the update sql query
+    let updateQuery = '';
+
+    // set this to be used inside the map function to check when we get to the last index key so that we dont add the comma to the last key in the generated sql query
+    const count = Object.keys(data).length;
+    Object.keys(data).map((key, i) => {
+      if (count - i === 1) {
+        updateQuery += `${key} = '${escapeQuotes(data[key])}'`;
+      } else {
+        updateQuery += `${key} = '${escapeQuotes(data[key])}', `;
+      }
+      return true;
+    });
+
+    const query = `update ${this.dbTable} set ${updateQuery} where id = '${id}'`;
+
+    return this.db.query(query);
+  }
+
+  /**
+   * @method delete()
+   * @description delete data from db by id
+   * @param {number} id - id of data to deleted
+   * @returns {Promise}
+   */
+  delete({ id }) {
+    return this.db.query(`delete from ${this.dbTable} where id = '${id}'`);
+  }
+
+  /**
+   * @method query()
+   * @description make a custom db query
+   * @param {string} statement - SQL query
+   * @returns {Promise}
+   */
+  // eslint-disable-next-line class-methods-use-this
+  query({ statement }) {
+    return this.db.query(statement);
+  }
+};

package/database/init.js

@@ -0,0 +1,47 @@
+const mysql = require("mysql");
+
+module.exports = class {
+  /**
+   * @description constructor
+   * @param {string} host - sql db hostname
+   * @param {string} user - db user username
+   * @param {string} password - db user password
+   * @param {string} db - db name
+   * @param {string} socket - path to a unix domain socket to connect to. when used host and port are ignored
+   */
+  constructor({ host, user, password, db, socket }) {
+    this.host = host;
+    this.user = user;
+    this.password = password;
+    this.db = db;
+    this.socket = socket;
+  }
+
+  /**
+   * @method query()
+   * @description send a db query
+   * @param {string} statement sql statement
+   * @returns {Promise<unknown>}
+   */
+  query(statement) {
+    const db = mysql.createConnection({
+      host: this.host,
+      user: this.user,
+      password: this.password,
+      database: this.db,
+      multipleStatements: true,
+      socketPath: this.socket,
+    });
+
+    return new Promise((resolve, reject) => {
+      db.query(statement, (err, result) => {
+        if (err) {
+          reject(Error(`DB Error: ${err}, Statement: ${statement}`));
+        }
+
+        resolve(result);
+        db.end();
+      });
+    });
+  }
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "groupcore-utils",
-  "version": "1.3.3",
-  "description": "Utilities for working with some Core features",
+  "version": "2.0.0",
+  "description": "Utilities for working with some core features",
   "main": "Utils.js",
   "scripts": {
     "test": "jest --coverage"
@@ -17,11 +17,23 @@
   },
   "homepage": "https://bitbucket.org/thegroupc/groupcore-utils/src/master",
   "dependencies": {
-    "axios": "^0.23.0",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "axios": "^0.26.1",
+    "bcrypt": "^5.0.1",
+    "easy-rbac": "^3.2.0",
+    "escape-quotes": "^1.0.2",
+    "jsonwebtoken": "^8.5.1",
+    "moment": "^2.29.2",
+    "nodemailer": "^6.7.3",
+    "random-number": "^0.0.9"
   },
   "devDependencies": {
-    "jest": "^27.2.5",
-    "prettier": "^2.4.1"
+    "eslint": "^8.24.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-jest": "^27.1.0",
+    "jest": "^27.5.1",
+    "prettier": "^2.7.1"
   }
 }

package/rest/index.js

@@ -0,0 +1,109 @@
+const axios = require('axios');
+
+module.exports = {
+  /**
+   * @method get()
+   * @description send a GET request
+   * @param {string} url - api url
+   * @param {object} headers - headers to be added to request
+   * @returns {AxiosPromise<any>}
+   */
+  async get({ url, headers }) {
+    try {
+      return axios({
+        url,
+        headers,
+        method: 'get',
+      });
+    } catch (err) {
+      console.log('Axios GET Error:', err.message);
+      throw err;
+    }
+  },
+
+  /**
+   * @method post()
+   * @description send a POST request
+   * @param {string} url - api url
+   * @param {object} data - payload
+   * @param {object} headers - headers to be added to request
+   * @returns {AxiosPromise<any>}
+   */
+  async post({ url, data, headers }) {
+    try {
+      return axios({
+        url,
+        data,
+        headers,
+        method: 'post',
+      });
+    } catch (err) {
+      console.log('Axios POST Error:', err.message);
+      throw err;
+    }
+  },
+
+  /**
+   * @method put()
+   * @description send PUT request
+   * @param {string} url - api url
+   * @param {object} data - payload
+   * @param {object} headers - headers to be added to request
+   * @returns {AxiosPromise<any>}
+   */
+  async put({ url, data, headers }) {
+    try {
+      return axios({
+        url,
+        data,
+        headers,
+        method: 'put',
+      });
+    } catch (err) {
+      console.log('Axios PUT Error:', err.message);
+      throw err;
+    }
+  },
+
+  /**
+   * @method patch()
+   * @description send PATCH request
+   * @param {string} url - api url
+   * @param {object} data - payload
+   * @param {object} headers - headers to be added to request
+   * @returns {AxiosPromise<any>}
+   */
+  async patch({ url, data, headers }) {
+    try {
+      return axios({
+        url,
+        data,
+        headers,
+        method: 'patch',
+      });
+    } catch (err) {
+      console.log('Axios PUT Error:', err.message);
+      throw err;
+    }
+  },
+
+  /**
+   * @method delete()
+   * @description send DELETE request
+   * @param {string} urls - api url
+   * @param {object} headers - headers to be added to request
+   * @returns {AxiosPromise<any>}
+   */
+  async delete({ url, headers }) {
+    try {
+      return axios({
+        url,
+        headers,
+        method: 'delete',
+      });
+    } catch (err) {
+      console.log('Axios DELETE Error:', err.message);
+      throw err;
+    }
+  },
+};

package/schemas/delete.js

@@ -0,0 +1,29 @@
+const headers = require("./headers");
+
+const schema = {
+  headers,
+  querystring: {
+    type: "object",
+    maxProperties: 1,
+    properties: {
+      id: { type: "number" },
+      email: { type: "string" },
+    },
+    oneOf: [
+      {
+        required: ["id"],
+      },
+      {
+        required: ["email"],
+      },
+    ],
+  },
+
+  response: {
+    204: {
+      type: "null",
+    },
+  },
+};
+
+module.exports = schema;

package/schemas/headers.js

@@ -0,0 +1,11 @@
+const headers = {
+  type: "object",
+  properties: {
+    token: {
+      type: "string",
+    },
+  },
+  required: ["token"],
+};
+
+module.exports = headers;

package/security/encryption.js

@@ -0,0 +1,31 @@
+const bcrypt = require('bcrypt');
+
+module.exports = class {
+  /**
+   * @description constructor
+   */
+  constructor() {
+    this.saltRounds = 10;
+  }
+
+  /**
+   * @method hash()
+   * @description create a hash of a text
+   * @param {string} text - text to be hashed
+   * @returns {*}
+   */
+  hash({ text }) {
+    return bcrypt.hashSync(text, bcrypt.genSaltSync(this.saltRounds));
+  }
+
+  /**
+   * @method verify()
+   * @description verify a text by its hash
+   * @param {string} hash - the hashed text
+   * @param {string} text - the text to be compared with the hash
+   * @returns {*}
+   */
+  verify({ hash, text }) {
+    return bcrypt.compareSync(text, hash);
+  }
+};

package/security/jwt.js

@@ -0,0 +1,41 @@
+const jwt = require('jsonwebtoken');
+
+module.exports = class {
+  /**
+   * @description constructor
+   * @param {string} jwtKey - jwt key
+   */
+  constructor({ jwtKey }) {
+    this.jwtKey = jwtKey;
+  }
+
+  /**
+   * @method jwtSign()
+   * @description create a JWT token
+   * @param {object} payload - payload to be tokenized
+   * @returns {*}
+   */
+  jwtSign({ payload }) {
+    return jwt.sign(payload, this.jwtKey);
+  }
+
+  /**
+   * @method jwtDecode()
+   * @description decode a JWT token
+   * @param {string} token - JWT token to be decoded
+   * @returns {{payload: any, signature: *, header: *}|*|SourceMapPayload|TokenPayload}
+   */
+  jwtDecode({ token }) {
+    return jwt.decode(token);
+  }
+
+  /**
+   * @method jwtVerify()
+   * @description verify a JWT token
+   * @param {string} token - token to be verified
+   * @returns {*}
+   */
+  jwtVerify({ token }) {
+    return jwt.verify(token, this.jwtKey);
+  }
+};

package/test-utils/mocks/request.js

@@ -0,0 +1,17 @@
+module.exports = class {
+  setQuery(query) {
+    this.query = query;
+  }
+
+  setBody(body) {
+    this.body = body;
+  }
+
+  setHeaders(headers) {
+    this.headers = headers;
+  }
+
+  setToken(token) {
+    this.token = token;
+  }
+};

package/test-utils/mocks/response.js

@@ -0,0 +1,14 @@
+module.exports = class {
+  constructor() {
+    jest.spyOn(this, "send").mockImplementation((body) => body);
+    jest.spyOn(this, "status").mockImplementation(() => this);
+  }
+
+  send() {
+    return true;
+  }
+
+  status() {
+    return true;
+  }
+};

package/timestamp/index.js

@@ -0,0 +1,65 @@
+const moment = require('moment');
+
+module.exports = class {
+  /**
+   * @method now()
+   * @description returns the present unix timestamp
+   * @returns {number}
+   */
+  now() {
+    return moment().unix();
+  }
+
+  /**
+   * @method unixToDate()
+   * @description convert a unix timestamp to specific date format
+   * @param {number} unix - the unix timestamp to be converted
+   * @param {string} format - the format to use, default is 'MMMM DD, YYYY'
+   * @returns {string}
+   */
+  unixToDate({ unix, format = 'MMMM DD, YYYY' }) {
+    return moment.unix(unix).format(format);
+  }
+
+  /**
+   * @method dateToUnix()
+   * @description convert a unix date to unix
+   * @param {number} date - the date to be converted
+   * @param {string} format - the format of the date
+   * @returns {number}
+   */
+  dateToUnix({ date, format }) {
+    return moment(date, format).valueOf() / 1000;
+  }
+
+  /**
+   * @method unixToStartOfDay()
+   * @description take whatever date is given to 12:00:00 AM of that day
+   * @param {string} unix - unix timestamp
+   * @returns {number}
+   */
+  unixToStartOfDay(unix) {
+    return new Date(unix * 1000).setHours(0, 0, 0, 0) / 1000;
+  }
+
+  /**
+   * @method unixToEndOfDay()
+   * @description take whatever date is given to 11:59:59 PM of the day
+   * @param {string} unix - unix timestamp
+   * @returns {number}
+   */
+  unixToEndOfDay(unix) {
+    return new Date(unix * 1000).setHours(23, 59, 59, 999) / 1000;
+  }
+
+  /**
+   * @method toSeconds()
+   * @description convert time (HH:MM) to seconds
+   * @param {string} time - time to be converted
+   * @returns {number}
+   */
+  toSeconds(time) {
+    time = time.split(':');
+    return time[0] * 3600 + time[1] * 60;
+  }
+};