dial-once / node-phone-utils Goto Github PK

The module require a .env file to use it for hlr-lookup, but even if it's not an hlr-lookup the module still require the .env file, I've tried to add an empty .env, and it worked.

Add test coverage badge.

• Update this line var phoneNumberUtils = require('phone-number-utils').createInstance(); to var phoneNumberUtils = require('node-phone-utils').createInstance();
• Add section about .env file to add

Example:
https://github.com/dial-once/node-phone-utils/blob/master/lib/validators/phone_number_validator.js#L101

getInstance is always returning a new object, the function naming is misleading, we can either assign the function directly to module.exports or rename it to something like createInstance.

https://sonar.dialonce.io/dashboard/index/245

The project needs a global refresh to match our contributing guidelines : https://github.com/dial-once/contributing-guidelines/, starting with a refactoring in ES6.

The logger facade is clean but a bit complex.

Maybe a simpler facade would be cleaner, e.g

var winston;
try {
    winston = require('winston');
}
catch(e) {}

if (!process.env.DEBUG) {
  global.Logger = {
    log: function() {},
    info: function() {},
    error: function() {},
    warn: function() {},
  };
} else if (winston) {
  global.Logger = winston;
} else {
  global.Logger = console;
}

Example: https://github.com/dial-once/node-phone-utils/blob/master/lib/index.js#L64

In order to required env variables, we should provide a .env.tpl file.

Like we hava getCountryCode we need getRegionCode for a phone number

Coverage is much higher but not properly reported to sonar.

Investigate and fix.

The project needs a global refresh to match our contributing guidelines : https://github.com/dial-once/contributing-guidelines/ including replacing jshint by eslint.

I needed only HLR lookups provider, so I called getProviders() function to get one, but the thing is that it also initializes SmsApiProvider inside and hence requires some envs to configure that one.

So I needed to use random values as stubs to avoid assertion error when it tried to initialize SmsApiProvider, but this polluted the env file with some unused stubs.

I think providers should be initialized separately and the function should be split in two

UPD: for backward compatibility you can keep getProviders function that will call those 2 new functions after a separation of concerns