Merge pull request #139 from ibm-cloud-security/rebranding

Rebranding

Author: vitalymibm

.eslintrc

@@ -0,0 +1,148 @@
+{
+  "root": true,
+  "parserOptions": {
+    "ecmaVersion": 2017,
+    "sourceType": "module"
+  },
+  "env": {
+    "browser": false,
+    "node": true,
+    "es6": true
+  },
+
+  "plugins": [
+    "node"
+  ],
+  "extends": [
+    "airbnb-base",
+    "eslint:recommended",
+    "plugin:node/recommended"
+  ],
+  "rules": {
+    "max-len": [
+      2,
+      130,
+      4
+    ],
+    "curly": [
+      2,
+      "all"
+    ],
+    "operator-linebreak": [
+      2,
+      "after"
+    ],
+    "indent": [
+      0,
+      "tab",
+      {
+        "SwitchCase": 1
+      }
+    ],
+    "quotes": [
+      0,
+      "single"
+    ],
+    "no-mixed-spaces-and-tabs": 0,
+    "space-unary-ops": [
+      2,
+      {
+        "nonwords": false,
+        "overrides": {}
+      }
+    ],
+    "keyword-spacing": [
+      2,
+      {}
+    ],
+    "space-infix-ops": 0,
+    "space-before-blocks": [
+      2,
+      "always"
+    ],
+    "array-bracket-spacing": [
+      0,
+      "never",
+      {
+        "singleValue": true
+      }
+    ],
+    "space-in-parens": [
+      2,
+      "never"
+    ],
+    "no-multiple-empty-lines": 2,
+    "wrap-iife": 2,
+    "valid-jsdoc": 2,
+    "no-param-reassign": [
+      2,
+      {
+        "props": false
+      }
+    ],
+    "no-plusplus": 0,
+    "no-underscore-dangle": 0,
+    "prefer-rest-params": 0,
+    "comma-dangle": [
+      "error",
+      "never"
+    ],
+    "semi": 2,
+    "no-console": 2,
+    "no-irregular-whitespace": 1,
+    "no-sparse-arrays": 1,
+    "object-curly-spacing": "off",
+    "no-tabs": 0,
+    "no-unreachable": 1,
+    "valid-typeof": 1,
+    "no-shadow": 1,
+
+    "no-path-concat": 1,
+    "eqeqeq": [
+      2,
+      "smart"
+    ],
+    "no-use-before-define": 1,
+    "no-new-require": 1,
+    //   "no-undef": 2,
+
+
+    "no-mixed-requires": 0,
+    "no-multi-spaces": 0,
+    //   "no-unused-vars": [2, {"vars": "all", "args": "none"}],
+    "dot-notation": 0,
+    "new-cap": 0,
+    "one-var": 0,
+    "handle-callback-err": [
+      2,
+      "^.*(e|E)rr"
+    ],
+    "node/no-unsupported-features/es-syntax": [1, {//warn
+      "version": ">=8.11.0",
+      "ignores": []
+    }]
+  },
+  "globals": {
+    "__dirname": true,
+    "after": true,
+    "afterEach": true,
+    "assert": true,
+    "before": true,
+    "browser": true,
+    "Buffer": true,
+    "by": true,
+    "console": true,
+    "describe": true,
+    "element": true,
+    "emit": true,
+    "it": true,
+    "module": true,
+    "process": true,
+    "require": true,
+    "setTimeout": true,
+    "transclude": true,
+    "templateUrl": true,
+    "cwd": true,
+    "__base": true
+  }
+}

lib/self-service/self-service-manager.js

@@ -15,8 +15,8 @@ const log4js = require("log4js");
 let request = require("request");
 const Q = require("q");
 const _ = require("underscore");
-const logger = log4js.getLogger("self-service-manager");
 
+const logger = log4js.getLogger("self-service-manager");
 const VCAP_SERVICES = "VCAP_SERVICES";
 const VCAP_SERVICES_CREDENTIALS = "credentials";
 const VCAP_SERVICES_SERVICE_NAME1 = "AdvancedMobileAccess";
@@ -53,18 +53,18 @@ const PRODUCTION_IAM_TOKEN_URL = "https://iam.bluemix.net/oidc/token";
 const GENERAL_ERROR = "general_error";
 
 const initError = "Failed to initialize self-service-manager.";
-const initErrorMsg = "Ensure your node.js app is either bound to an App ID service instance or pass required parameter to the constructor";
+const initErrorMsg = "Ensure your node.js app is either bound to an App ID service " +
+	"instance or pass required parameter to the constructor";
 
 /**
  * The constructor function, options can include: iamApiKey, tenantId, oauthServerUrl and managementUrl.
  * if iamApiKey, tenantId or oauthServerUrl not specify it will be taken from the App ID service binding json.
  * if iamToken is not passed to the SelfServiceManager APIs, the iamApiKey will be use to get iam tokens before every request.
  * if managementUrl not specify it will be taken from  the App ID service binding json if exist or construct using the oauthServerUrl.
- * @param options
+ * @param {object} options - options for the constructor
+ * @return {undefined}
  */
-function SelfServiceManager(options) {
-	options = options || {};
-	
+function SelfServiceManager(options={}) {
 	const vcapServices = JSON.parse(process.env[VCAP_SERVICES] || "{}");
 	var vcapServiceCredentials = {};
 	// Find App ID service config
@@ -76,13 +76,13 @@ function SelfServiceManager(options) {
 		}
 	}
 	this.iamApiKey = options.iamApiKey || vcapServiceCredentials[API_KEY];
-	if(this.iamApiKey) {
+	if (this.iamApiKey) {
 		logger.info("using user IAM API key [NOT SHOWING]");
 	}
 	this.managementUrl = options[MGMT_URL] || vcapServiceCredentials[MGMT_URL];
 	let tenantId = options[TENANT_ID] || vcapServiceCredentials[TENANT_ID];
 	this.tenantId = tenantId;
-	
+
 	if (!this.managementUrl) {
 		if (!tenantId) {
 			logger.error(initError);
@@ -96,7 +96,7 @@ function SelfServiceManager(options) {
 			throw new Error(initError);
 		}
 		logger.info(OAUTH_SERVER_URL, oauthServerUrl);
-		
+
 		let serverUrl = oauthServerUrl.split(OAUTH_V3)[0];
 		let serverDomain = serverUrl.split(APPID_AUTH);
 		if (serverDomain[1]) {
@@ -106,9 +106,9 @@ function SelfServiceManager(options) {
 			logger.error(initErrorMsg);
 			throw new Error(initError);
 		}
-		this.managementUrl +=  MGMT_V4 + tenantId;
+		this.managementUrl += MGMT_V4 + tenantId;
 	}
-	
+
 	this.iamTokenUrl = options[IAM_TOKEN_URL] || PRODUCTION_IAM_TOKEN_URL;
 	logger.info(IAM_TOKEN_URL, this.iamTokenUrl);
 	logger.info(MGMT_URL, this.managementUrl);
@@ -121,7 +121,7 @@ function SelfServiceManager(options) {
  * @param {string=} iamToken, optional, if passed request to the server will use this token.
  * @return {Object} The created user SCIM.
  */
-SelfServiceManager.prototype.signUp = function (userData, language='en', iamToken) {
+SelfServiceManager.prototype.signUp = function (userData, language = 'en', iamToken) {
 	const deferred = Q.defer();
 	let url = this.managementUrl + MGMT_SIGN_UP_PATH;
 	_getIAMToken(iamToken, this.iamApiKey, this.iamTokenUrl).then(function (token) {
@@ -137,7 +137,7 @@ SelfServiceManager.prototype.signUp = function (userData, language='en', iamToke
  * @param {string} [language='en'] the user language code.
  * @return {Object} The user SCIM profile.
  */
-SelfServiceManager.prototype.forgotPassword = function (email, language='en', iamToken) {
+SelfServiceManager.prototype.forgotPassword = function (email, language = 'en', iamToken) {
 	const deferred = Q.defer();
 	let url = this.managementUrl + MGMT_FORGOT_PASSWORD_PATH;
 	_getIAMToken(iamToken, this.iamApiKey, this.iamTokenUrl).then(function (token) {
@@ -153,11 +153,11 @@ SelfServiceManager.prototype.forgotPassword = function (email, language='en', ia
  * @param {string=} iamToken, optional, if passed request to the server will use this token.
  * @return resolve if notification sent successfully, else reject with the error.
  */
-SelfServiceManager.prototype.resendNotification = function (uuid, templateName, language='en', iamToken) {
+SelfServiceManager.prototype.resendNotification = function (uuid, templateName, language = 'en', iamToken) {
 	const deferred = Q.defer();
 	let url = this.managementUrl + MGMT_RESEND_PATH + templateName;
 	_getIAMToken(iamToken, this.iamApiKey, this.iamTokenUrl).then(function (token) {
-		_handleRequest(token, POST, url, {uuid: uuid} , {language: language}, RESEND_NOTIFICATION, deferred);
+		_handleRequest(token, POST, url, {uuid: uuid}, {language: language}, RESEND_NOTIFICATION, deferred);
 	}).catch(deferred.reject);
 	return deferred.promise;
 };
@@ -172,7 +172,7 @@ SelfServiceManager.prototype.getSignUpConfirmationResult = function (context, ia
 	const deferred = Q.defer();
 	let url = this.managementUrl + MGMT_SIGN_UP_RESULT_PATH;
 	_getIAMToken(iamToken, this.iamApiKey, this.iamTokenUrl).then(function (token) {
-		_handleRequest(token, POST, url, {context: context} , {}, SIGN_UP_RESULT, deferred);
+		_handleRequest(token, POST, url, {context: context}, {}, SIGN_UP_RESULT, deferred);
 	}).catch(deferred.reject);
 	return deferred.promise;
 };
@@ -187,7 +187,7 @@ SelfServiceManager.prototype.getForgotPasswordConfirmationResult = function (con
 	const deferred = Q.defer();
 	let url = this.managementUrl + MGMT_FORGOT_PASSWORD_RESULT_PATH;
 	_getIAMToken(iamToken, this.iamApiKey, this.iamTokenUrl).then(function (token) {
-		_handleRequest(token, POST, url, {context: context} , {}, FORGOT_PASSWORD_RESULT, deferred);
+		_handleRequest(token, POST, url, {context: context}, {}, FORGOT_PASSWORD_RESULT, deferred);
 	}).catch(deferred.reject);
 	return deferred.promise;
 };
@@ -202,18 +202,18 @@ SelfServiceManager.prototype.getForgotPasswordConfirmationResult = function (con
  * @return {Object} The user SCIM profile.
  */
 
-SelfServiceManager.prototype.setUserNewPassword = function (uuid, newPassword, language='en', changedIpAddress=null, iamToken) {
+SelfServiceManager.prototype.setUserNewPassword = function (uuid, newPassword, language = 'en', changedIpAddress = null, iamToken) {
 	const deferred = Q.defer();
 	let url = this.managementUrl + MGMT_CHANGE_PASSWORD_PATH;
 	_getIAMToken(iamToken, this.iamApiKey, this.iamTokenUrl).then(function (token) {
-		let replacePasswordBody =  {
+		let replacePasswordBody = {
 			uuid: uuid,
 			newPassword: newPassword
 		};
 		if (changedIpAddress) {
 			replacePasswordBody.changedIpAddress = changedIpAddress;
 		}
-		_handleRequest(token, POST, url, replacePasswordBody , {language: language}, CHANGE_USER_PASSWORD, deferred);
+		_handleRequest(token, POST, url, replacePasswordBody, {language: language}, CHANGE_USER_PASSWORD, deferred);
 	}).catch(deferred.reject);
 	return deferred.promise;
 };
@@ -227,7 +227,7 @@ SelfServiceManager.prototype.getUserDetails = function (uuid, iamToken) {
 	const deferred = Q.defer();
 	let url = this.managementUrl + MGMT_USERS_PATH + uuid;
 	_getIAMToken(iamToken, this.iamApiKey, this.iamTokenUrl).then(function (token) {
-		_handleRequest(token, GET, url, {} , {}, GET_USER_DETAILS, deferred);
+		_handleRequest(token, GET, url, {}, {}, GET_USER_DETAILS, deferred);
 	}).catch(deferred.reject);
 	return deferred.promise;
 };
@@ -247,7 +247,7 @@ SelfServiceManager.prototype.updateUserDetails = function (uuid, userData, iamTo
 	return deferred.promise;
 };
 
-let _handleRequest = function(iamToken, method, url, body, queryObject , action, deferred) {
+let _handleRequest = function (iamToken, method, url, body, queryObject, action, deferred) {
 	let reqOptions = {
 		url: url,
 		method: method,
@@ -261,7 +261,7 @@ let _handleRequest = function(iamToken, method, url, body, queryObject , action,
 		reqOptions.json = body;
 	}
 	request(reqOptions, function (err, response, responseBody) {
-		if(!err && response.statusCode >= 200 && response.statusCode < 300) {
+		if (!err && response.statusCode >= 200 && response.statusCode < 300) {
 			logger.debug("request " + action + " success");
 			logger.debug("response body: " + JSON.stringify(responseBody));
 			deferred.resolve(responseBody);
@@ -284,26 +284,26 @@ let _handleRequest = function(iamToken, method, url, body, queryObject , action,
 	});
 };
 
-let _getIAMToken = function(iamToken, iamApiKey, iamTokenUrl) {
+let _getIAMToken = function (iamToken, iamApiKey, iamTokenUrl) {
 	if (iamToken && _.isString(iamToken)) {
 		return Promise.resolve(iamToken);
 	}
 	if (!iamApiKey) {
 		return Promise.reject("You must pass 'iamToken' to self-service-manager APIs or specify 'iamApiKey' in selfServiceManager init options.");
 	}
 	var reqOptions = {
-		url:  iamTokenUrl,
+		url: iamTokenUrl,
 		method: "POST",
 		headers: {
 			"Content-Type": "application/x-www-form-urlencoded",
 			"Accept": "application/json"
 		},
-		form : {
-			"grant_type":"urn:ibm:params:oauth:grant-type:apikey",
-			"apikey" : iamApiKey
+		form: {
+			"grant_type": "urn:ibm:params:oauth:grant-type:apikey",
+			"apikey": iamApiKey
 		}
 	};
-	return new Promise(function(resolve, reject) {
+	return new Promise(function (resolve, reject) {
 		request(reqOptions, function (error, response, body) {
 			if (error) {
 				logger.error("Obtained IAM token failure: " + error.message);

lib/strategies/api-strategy.js

@@ -40,10 +40,10 @@ function ApiStrategy(options) {
 ApiStrategy.STRATEGY_NAME = STRATEGY_NAME;
 ApiStrategy.DEFAULT_SCOPE = "appid_default";
 
-ApiStrategy.prototype.authenticate = function (req, options) {
+ApiStrategy.prototype.authenticate = function (req, options={}) {
 	var self = this;
 	logger.debug("authenticate");
-	options = options || {};
+
 	var requiredScope = ApiStrategy.DEFAULT_SCOPE;
 	if (options.scope) {
 		requiredScope += " " + options.scope;
@@ -93,7 +93,8 @@ ApiStrategy.prototype.authenticate = function (req, options) {
 				}
 			}
 			if (!found) {
-				logger.warn("access_token does not contain required scope. Expected ::", requiredScope, " Received ::", accessToken.scope);
+				logger.warn("access_token does not contain required scope. Expected ::", requiredScope, " Received ::",
+					accessToken.scope);
 				return self.fail(buildWwwAuthenticateHeader(requiredScope, ERROR.INSUFFICIENT_SCOPE), 401);
 			}
 		}
@@ -117,15 +118,15 @@ ApiStrategy.prototype.authenticate = function (req, options) {
 				}
 				logger.debug("authentication success");
 				return self.success(identityToken || null);
-			}).catch(function (err) {
+			}).catch(() => {
 				logger.debug("authentication failed due to invalid identity token");
 				return self.fail(buildWwwAuthenticateHeader(requiredScope, ERROR.INVALID_TOKEN), 401);
 			});
 		} else {
 			logger.debug("authentication success: identity_token not found. Proceeding with access_token only");
 			return self.success(identityToken || null);
 		}
-	}).catch(function (err) {
+	}).catch(function () {
 		logger.debug("authentication failed due to invalid access token");
 		return self.fail(buildWwwAuthenticateHeader(requiredScope, ERROR.INVALID_TOKEN), 401);
 	});