@becollective/utils 1.0.4 → 1.2.0

package/bundle.js

@@ -10,9 +10,6 @@ var password = {
   hasNumeral: function hasNumeral(input) {
     return !!input.match(/[0-9]/);
   },
-  hasSpecialCharacter: function hasSpecialCharacter(input) {
-    return !!input.match(/[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/);
-  },
   validate: function validate(input) {
     if (typeof input !== 'string') {
       throw new Error('not-string');
@@ -24,7 +21,6 @@ var password = {
     if (password.hasUppercase(input)) rules++;
     if (password.hasLowerCase(input)) rules++;
     if (password.hasNumeral(input)) rules++;
-    if (password.hasSpecialCharacter(input)) rules++;
 
     if (rules < 3) {
       throw new Error('invalid-minimum-rules');
@@ -42,7 +38,55 @@ var password = {
   }
 };
 
+var moment = require('moment');
+/**
+ * Get current age based on the given birth date
+ * @param {string} dateOfBirth
+ * @param {string} unit the measurement of the the difference
+ *  The supported measurements are:
+ *  years, months, weeks, days, hours, minutes, and seconds. 
+ * @returns {number} age
+ */
+
+
+var getAge = function getAge(dateOfBirth) {
+  var unit = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'years';
+  var age = moment().diff(dateOfBirth, unit);
+
+  if (isNaN(age)) {
+    throw new Error('Invalid date');
+  }
+
+  return age;
+};
+/**
+ * Check if a user requires parent(guardian) consent
+ * i.e. Is under the age of 16 years, based on GDPR
+ * https://gdpr-info.eu/art-8-gdpr/
+ * @param {string} dateOfBirth moment.js compatible date time
+ * @returns {boolean}
+ * NOTE:
+ * We used to not allow child (under 16) to register,
+ * and birthdate is not a required field for ghost user
+ * So an existing user could have no birthdate, we assume these users are adults
+ * TODO:
+ * Remove above logic after we migrated all legacy
+ * data to have a consistent birthdate property.
+ * Then we should throw error if birthdate is not valid
+ */
+
+var isUnderSixteen = function isUnderSixteen(dateOfBirth) {
+  if (!dateOfBirth || !moment(dateOfBirth).isValid()) {
+    return false;
+  }
+
+  var age = getAge(dateOfBirth);
+  return isNaN(age) ? false : age < 16;
+};
+
 var util = {
-  password: password
+  password: password,
+  isUnderSixteen: isUnderSixteen,
+  getAge: getAge
 };
 module.exports = util;

package/date-time.js

@@ -0,0 +1,39 @@
+const moment = require('moment');
+
+/**
+ * Get current age based on the given birth date
+ * @param {string} dateOfBirth
+ * @param {string} unit the measurement of the the difference
+ *  The supported measurements are:
+ *  years, months, weeks, days, hours, minutes, and seconds. 
+ * @returns {number} age
+ */
+export const getAge = (dateOfBirth, unit='years') => {
+  const age = moment().diff(dateOfBirth, unit);
+  if (isNaN(age)) {
+    throw new Error('Invalid date');
+  }
+  return age;
+};
+/**
+ * Check if a user requires parent(guardian) consent
+ * i.e. Is under the age of 16 years, based on GDPR
+ * https://gdpr-info.eu/art-8-gdpr/
+ * @param {string} dateOfBirth moment.js compatible date time
+ * @returns {boolean}
+ * NOTE:
+ * We used to not allow child (under 16) to register,
+ * and birthdate is not a required field for ghost user
+ * So an existing user could have no birthdate, we assume these users are adults
+ * TODO:
+ * Remove above logic after we migrated all legacy
+ * data to have a consistent birthdate property.
+ * Then we should throw error if birthdate is not valid
+ */
+export const isUnderSixteen = dateOfBirth => {
+  if (!dateOfBirth || !moment(dateOfBirth).isValid()) {
+    return false;
+  }
+  const age = getAge(dateOfBirth);
+  return isNaN(age) ? false : age < 16;
+};

package/index.js

@@ -1,7 +1,10 @@
 import { password } from './password';
+import { isUnderSixteen, getAge } from './date-time';
 
 const util = {
   password,
+  isUnderSixteen,
+  getAge,
 };
 
 module.exports = util;

package/package.json

@@ -1,26 +1,24 @@
 {
   "name": "@becollective/utils",
-  "version": "1.0.4",
+  "version": "1.2.0",
   "description": "Common utilities",
   "main": "bundle.js",
   "scripts": {
-    "test": "NODE_ENV=localtest ./node_modules/.bin/jest tests/*",
-    "build": "./node_modules/.bin/rollup -c"
-  },
-  "husky": {
-    "hooks": {
-      "pre-push": "npm run build; npm test"
-    }
+    "test": "NODE_ENV=localtest npm run build && ./node_modules/.bin/jest tests/*",
+    "build": "./node_modules/.bin/rollup -c",
+    "prepublish": "npm run build; npm test"
   },
   "author": "",
   "license": "ISC",
   "devDependencies": {
     "@babel/core": "^7.1.6",
     "@babel/preset-env": "^7.1.6",
-    "husky": "^1.1.4",
     "jest": "^23.6.0",
     "rollup": "^0.67.1",
     "rollup-plugin-babel": "^4.0.3",
     "rollup-plugin-node-resolve": "^3.4.0"
+  },
+  "dependencies": {
+    "moment": "^2.24.0"
   }
 }

package/password.js

@@ -8,9 +8,6 @@ export const password = {
   hasNumeral: (input) => {
     return !!input.match(/[0-9]/);
   },
-  hasSpecialCharacter: (input) => {
-    return !!input.match(/[!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~]/);
-  },
   validate: (input) => {
     if(typeof input !== 'string') {
       throw new Error('not-string');
@@ -22,7 +19,6 @@ export const password = {
     if(password.hasUppercase(input)) rules++;
     if(password.hasLowerCase(input)) rules++;
     if(password.hasNumeral(input)) rules++;
-    if(password.hasSpecialCharacter(input)) rules++;
     if(rules < 3) {
       throw new Error('invalid-minimum-rules');
     }

package/tests/date-time.test.js

@@ -0,0 +1,56 @@
+const { isUnderSixteen, getAge } = require('../bundle.js');
+const moment = require('moment');
+
+describe('getAge', () => {
+  const refPoint = moment().subtract(16, 'years');
+
+  test('Returns the correct age', () => {
+    const dob = moment(refPoint);
+
+    expect(getAge(dob)).toBe(16);
+    expect(getAge(dob.subtract(1, 'year').utc().format())).toBe(17);
+    expect(getAge(dob.add(13, 'months').utc().format())).toBe(15);
+  });
+
+  test('Returns the age in specified measurement', () => {
+    const dob = moment().subtract(15, 'months');
+
+    expect(getAge(dob)).toBe(1);
+    expect(getAge(dob, 'years')).toBe(1);
+    expect(getAge(dob, 'months')).toBe(15);
+  });
+
+  test('Throws Error if dob is not a valid date-string', () => {
+    expect(() => getAge(notDefined)).toThrow(/not defined/);
+    expect(() => getAge(null)).toThrow(/Invalid date/);
+    expect(() => getAge('not-valid')).toThrow(/Invalid date/);
+  });
+});
+
+describe('isUnderSixteen', () => {
+  const refPoint = moment().subtract(16, 'years');
+  const obj = {};
+  test('Is not U16 if dob is 16 years ago', () => {
+    const dob = moment(refPoint);
+
+    expect(isUnderSixteen(dob.subtract(1, 'second').utc().format())).toBe(false);
+    expect(isUnderSixteen(dob.subtract(100, 'year').utc().format())).toBe(false);
+  });
+
+  test('Is U16 if dob is less than 16 years ago', () => {
+    const dob = moment(refPoint);
+
+    expect(isUnderSixteen(dob.add(1, 'second').utc().format())).toBe(true);
+    expect(isUnderSixteen(dob.add(100, 'year').utc().format())).toBe(true);
+  });
+
+  test('Undefined dob', () => {
+    expect(isUnderSixteen(obj.notDefined)).toBe(false);
+  });
+  test('Null dob', () => {
+    expect(isUnderSixteen(null)).toBe(false);
+  });
+  test('Invalid date string', () => {
+    expect(isUnderSixteen('not-valid')).toBe(false);
+  });
+});

package/tests/password.test.js

@@ -2,7 +2,7 @@ const util = require('../bundle.js');
 
 describe('password.valiate', () => {
   test('validate a valid password', async () => {
-    const password = 'eihe1soKah@c';
+    const password = 'Password123';
     let result;
     try {
       result = util.password.validate(password);
@@ -35,12 +35,6 @@ describe('password.valiate', () => {
       util.password.validate(password);
     }).not.toThrow('invalid-minimum-rules');
   }, 1000);
-  test('validate a four rule password', async () => {
-    const password = 'foobar123M@';
-    expect(() => {
-      util.password.validate(password);
-    }).not.toThrow('invalid-minimum-rules');
-  }, 1000);
   test('validate a missing password property', async () => {
     expect(() => {
       util.password.validate();