@getjones/test-infra 1.0.14 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getjones/test-infra",
-  "version": "1.0.14",
+  "version": "1.1.0",
   "description": "Providing internal and openapi interface",
   "main": "src/index.js",
   "scripts": {

package/src/{exceptions → common/exceptions}/notFoundError.js

@@ -2,7 +2,8 @@ const { StatusCodes } = require('http-status-code');
 
 class NotFoundError extends Error {
     constructor(message) {
-        super(message, StatusCodes.NOT_FOUND);
+        const { NOT_FOUND } = StatusCodes;
+        super(message, NOT_FOUND);
     }
 }
 

package/src/env.js

@@ -1,5 +1,6 @@
 let privateMembers = {
     backendUrl: null,
+    openapiUrl: null,
     credentials: null,
     environment: null,
     accountCreationSecret: null,
@@ -7,7 +8,11 @@ let privateMembers = {
 
 const init = conf => {
     privateMembers = Object.assign(privateMembers, conf);
-    requiredValidation({ backendUrl: privateMembers.backendUrl, environment: privateMembers.environment });
+    requiredValidation({
+        backendUrl: privateMembers.backendUrl,
+        openapiUrl: privateMembers.openapiUrl,
+        environment: privateMembers.environment
+    });
 };
 
 const requiredValidation = object => {

package/src/index.js

@@ -2,26 +2,21 @@ const env = require('./env');
 
 const init = conf => {
     env.init(conf);
+    const internalAPI = getInternalAPI();
+    const openAPI = getOpenAPI();
+    return { internalAPI, openAPI };
+};
 
-    const auth = require('./internal-api/auth/auth.setup');
+const getInternalAPI = () => {
 
-    const accountsCore = require('./internal-api/accounts/core/accounts.core.setup');
-    const accountsSettings = require('./internal-api/accounts/settings/settings.setup');
-    const accountsOpenAPI = require('./internal-api/accounts/openapi/accounts.openapi.setup');
+    const auth = require('./saas/internal-api/auth');
+    const accounts = require('./saas/internal-api/accounts');
 
-    const projects = require('./internal-api/projects/projects.setup');
-    const tabs = require('./internal-api/tabs/tabs.setup');
-    const requirements = require('./internal-api/requirements');
-    const contractors = require('./internal-api/contractors');
+    const projects = require('./saas/internal-api/projects');
+    const tabs = require('./saas/internal-api/tabs');
 
-    const accounts = {
-        core: accountsCore,
-        settings: accountsSettings,
-        openAPI: accountsOpenAPI,
-        accountsCore,
-        accountsSettings,
-        accountsOpenAPI
-    };
+    const requirements = require('./saas/internal-api/requirements');
+    const contractors = require('./saas/internal-api/contractors');
 
     const internalAPI = {
         auth,
@@ -31,7 +26,14 @@ const init = conf => {
         requirements,
         contractors
     };
-    return { internalAPI };
+    return internalAPI;
+};
+
+const getOpenAPI = () => {
+    const tabs = require('./saas/openapi/tabs/tabs.setup');
+    const openAPI = { tabs };
+    return openAPI;
+
 };
 
 module.exports = init;

package/src/{internal-api/accounts → saas/internal-api/accounts/api}/core/accounts.core.api.js

@@ -1,5 +1,5 @@
-const requests = require('../../common/requests');
-const { backendUrl } = require('../../../env').getEnv();
+const requests = require('../../../common/requests');
+const { backendUrl } = require('../../../../../env').getEnv();
 
 const Endpoints = {
     getAccount: `${backendUrl}/saas/accounts`,

package/src/{internal-api/accounts → saas/internal-api/accounts/api}/core/accounts.core.setup.js

@@ -1,28 +1,20 @@
-const env = require('../../../env');
+const env = require('../../../../../env');
 const accountsAPI = require('./accounts.core.api');
+const CreateAccountModel = require('../../models/core/create.account.model');
+const { validateType } = require('../../../../../common/validations/typeValidations');
 
-const { credentials, accountCreationSecret } = env.getEnv();
-const { NotFoundError } = require('../../../exceptions/notFoundError');
-const PROPERTY_TYPE = 'Property Management';
+const { accountCreationSecret } = env.getEnv();
+const { NotFoundError } = require('../../../../../common/exceptions/notFoundError');
+
+const createAccount = async (createAccountModel, context) => {
+    validateType(createAccountModel, CreateAccountModel);
 
-const createAccount = async (email, accountName, context,
-    password = credentials.strongPassword,
-    propertyType = PROPERTY_TYPE) => {
     env.requiredValidation({
         accountCreationSecret: accountCreationSecret,
-        'credentials.strongPassword': password
+        'credentials.strongPassword': createAccountModel.password
     });
 
-    const newAccount = {
-        companyName: accountName,
-        email: email,
-        password: password,
-        verifyPassword: password,
-        secret: accountCreationSecret,
-        userType: propertyType
-    };
-
-    return await accountsAPI.create(newAccount, context);
+    return await accountsAPI.create(createAccountModel, context);
 };
 
 const getAccount = async (accountName, context) => {
@@ -39,14 +31,15 @@ const getAccount = async (accountName, context) => {
     return existingAccounts[0];
 };
 
-const getOrCreateAccount = async (email, accountName, context, password = credentials.strongPassword) => {
-    const existingAccount = await getAccount(accountName, context);
+const getOrCreateAccount = async (createAccountModel, context) => {
+    validateType(createAccountModel, CreateAccountModel);
+    const existingAccount = await getAccount(createAccountModel.companyName, context);
 
     if (existingAccount) {
         return existingAccount;
     }
 
-    return await createAccount(email, accountName, context, password);
+    return await createAccount(createAccountModel, context);
 };
 
 const getAccountId = async (accountName, context) => {

package/src/{internal-api/accounts → saas/internal-api/accounts/api}/openapi/accounts.openapi.api.js

@@ -1,5 +1,5 @@
-const requests = require('../../common/requests');
-const { backendUrl } = require('../../../env').getEnv();
+const requests = require('../../../common/requests');
+const { backendUrl } = require('../../../../../env').getEnv();
 
 const Endpoints = {
     createApiKey: `${backendUrl}/saas/api-keys`,

package/src/{internal-api/accounts → saas/internal-api/accounts/api}/settings/settings.api.js

@@ -1,5 +1,5 @@
-const requests = require('../../common/requests');
-const { backendUrl } = require('../../../env').getEnv();
+const requests = require('../../../common/requests');
+const { backendUrl } = require('../../../../../env').getEnv();
 
 const Endpoints = {
     get: accountId => `${backendUrl}/saas/account/${accountId}/settings`,
@@ -10,8 +10,9 @@ const getAccountSettings = async (accountId, context) => {
     return requests.getRequestHandler(Endpoints.get(accountId), {}, context);
 };
 
-const updateAccountSettings = async (accountId, settings, context) => {
-    return requests.putRequestHandler(Endpoints.edit(accountId), { accountId, ...settings }, context);
+const updateAccountSettings = async (updateAccountSettingsModel, context) => {
+    const { accountId } = updateAccountSettingsModel;
+    return requests.putRequestHandler(Endpoints.edit(accountId), updateAccountSettingsModel, context);
 };
 
 module.exports = {

package/src/saas/internal-api/accounts/api/settings/settings.setup.js

@@ -0,0 +1,23 @@
+const accountsAPI = require('./settings.api');
+const { validateType } = require('../../../../../common/validations/typeValidations');
+const UpdateAccountSettings = require('../../models/settings/update.settings.model');
+
+const getAccountSettings = async (accountId, context) => {
+    return accountsAPI.getAccountSettings(accountId, context).then(res => res.data);
+};
+
+const updateAccountSettings = async (updateAccountSettingsModel, context) => {
+    validateType(updateAccountSettingsModel, UpdateAccountSettings);
+    return accountsAPI.updateAccountSettings(updateAccountSettingsModel, context);
+};
+
+const restoreAccountSettings = async (accountId, context) => {
+    const updateAccountSettingsModel = new UpdateAccountSettings(accountId, false, false);
+    return accountsAPI.updateAccountSettings(updateAccountSettingsModel, context);
+};
+
+module.exports = {
+    getAccountSettings,
+    updateAccountSettings,
+    restoreAccountSettings
+};

package/src/saas/internal-api/accounts/index.js

@@ -0,0 +1,19 @@
+const CreateAccountModel = require('./models/core/create.account.model');
+const coreModels = { CreateAccountModel };
+
+const UpdateAccountSettings = require('./models/settings/update.settings.model');
+const settingsModels = { UpdateAccountSettings };
+
+const models = { core: coreModels, settings: settingsModels };
+
+const coreService = require('./api/core/accounts.core.setup');
+const openApiServices = require('./api/openapi/accounts.openapi.setup');
+const settingsServices = require('./api/settings/settings.setup');
+
+const services = {
+    core: coreService,
+    openApi: openApiServices,
+    settings: settingsServices
+};
+
+module.exports = { services, models };

package/src/saas/internal-api/accounts/models/core/create.account.model.js

@@ -0,0 +1,16 @@
+const env = require('../../../../../env');
+const { credentials, accountCreationSecret } = env.getEnv();
+const PROPERTY_TYPE = 'Property Management';
+
+function CreateAccountModel(accountName, email, password = credentials.strongPassword,
+    secret = accountCreationSecret, propertyType = PROPERTY_TYPE) {
+
+    this.companyName = accountName;
+    this.email = email;
+    this.password = password;
+    this.verifyPassword = password;
+    this.secret = secret;
+    this.userType = propertyType;
+}
+
+module.exports = CreateAccountModel;

package/src/saas/internal-api/accounts/models/settings/update.settings.model.js

@@ -0,0 +1,8 @@
+function UpdateAccountSettings(accountId, isMultiPropertyTenants, isHighPriority) {
+    this.accountId = accountId;
+    this.isMultiPropertyTenants = isMultiPropertyTenants;
+    this.isHighPriority = isHighPriority;
+}
+
+module.exports = UpdateAccountSettings;
+

package/src/{internal-api/auth → saas/internal-api/auth/api}/auth.api.js

@@ -1,5 +1,5 @@
-const requests = require('../common/requests');
-const { backendUrl } = require('../../env').getEnv();
+const requests = require('../../common/requests');
+const { backendUrl } = require('../../../../env').getEnv();
 
 const Endpoints = {
     login: `${backendUrl}/logincontroller`

package/src/{internal-api/auth → saas/internal-api/auth/api}/auth.setup.js

@@ -1,4 +1,4 @@
-const { getEnv, requiredValidation } = require('../../env');
+const { getEnv, requiredValidation } = require('../../../../env');
 const { credentials } = getEnv();
 const authApi = require('./auth.api');
 
@@ -21,11 +21,6 @@ const getIcsCookie = async () => {
     return await getAuthCookie(credentials.superUser, credentials.superUserPassword);
 };
 
-const auth = {
-    getAuthCookie,
-    getIcsCookie
-};
-
 module.exports = {
     getAuthCookie,
     getIcsCookie

package/src/saas/internal-api/auth/index.js

@@ -0,0 +1,3 @@
+const services = require('./api/auth.setup');
+
+module.exports = { services };

package/src/{internal-api → saas/internal-api}/contractors/api/contractors.api.js

@@ -1,5 +1,5 @@
 const requests = require('../../common/requests');
-const { backendUrl } = require('../../../env').getEnv();
+const { backendUrl } = require('../../../../env').getEnv();
 
 const Endpoints = {
     create: `${backendUrl}/saas/contractors/invite`,

package/src/{internal-api → saas/internal-api}/contractors/api/contractors.setup.js

@@ -1,6 +1,6 @@
 const contractorsAPI = require('./contractors.api');
 const { CreateContractorModel } = require('../models/create.contractor.model');
-const { validateType } = require('../../common/validations');
+const { validateType } = require('../../../../common/validations/typeValidations');
 
 const createContractors = async (createContractorsModel, context) => {
     validateType(createContractorsModel, CreateContractorModel);

package/src/{internal-api → saas/internal-api}/contractors/index.js

@@ -1,6 +1,6 @@
 const createModel = require('./models/create.contractor.model');
-const api = require('./api/contractors.setup');
+const services = require('./api/contractors.setup');
 
 const models = { create: createModel };
 
-module.exports = { api, models };
+module.exports = { services, models };

package/src/{internal-api → saas/internal-api}/contractors/models/create.contractor.model.js

@@ -1,4 +1,4 @@
-const { validateType } = require('../../common/validations');
+const { validateType } = require('../../../../common/validations/typeValidations');
 
 function CreateContractorModel(requirementId, inviterEmail, vendorsInfo) {
     this.reqId = requirementId;

package/src/{internal-api/projects → saas/internal-api/projects/api}/projects.api.js

@@ -1,5 +1,5 @@
-const requests = require('../common/requests');
-const { backendUrl } = require('../../env').getEnv();
+const requests = require('../../common/requests');
+const { backendUrl } = require('../../../../env').getEnv();
 
 const Endpoints = {
     create: `${backendUrl}/saas/project`,

package/src/{internal-api/projects → saas/internal-api/projects/api}/projects.setup.js

@@ -1,5 +1,7 @@
 const projectsApi = require('./projects.api');
-const accounts = require('../accounts/core/accounts.core.setup');
+const accounts = require('../../accounts/api/core/accounts.core.setup');
+const { validateType } = require('../../../../common/validations/typeValidations');
+const CreateProjectModel = require('../models/create.project.model');
 
 const getProjectsByAccountName = async (accountName, context) => {
     const accountId = accounts.getAccountId(accountName, context);
@@ -18,13 +20,12 @@ const getProjectsByName = async (accountId, projectName, context) => {
 
 const deleteProjectByName = async (accountId, projectName, context) => {
     const projects = await getProjectsByName(accountId, projectName, context);
-    projects.map(async project => await projectsApi.deleteProjectById(project.projectId, context)
-    );
+    projects.map(async project => await projectsApi.deleteProjectById(project.projectId, context));
 };
 
-const createProject = async (project, accountName, context) => {
-    const accountId = await accounts.getAccountId(accountName, context);
-    return await projectsApi.create({ ...project, userId: accountId }, context);
+const createProject = async (createProjectModel, context) => {
+    validateType(createProjectModel, CreateProjectModel);
+    return projectsApi.create(createProjectModel, context);
 };
 
 module.exports = {

package/src/saas/internal-api/projects/index.js

@@ -0,0 +1,6 @@
+const services = require('./api/projects.setup');
+const CreateProjectModel = require('./models/create.project.model');
+
+const models = { CreateProjectModel };
+
+module.exports = { models, services };

package/src/saas/internal-api/projects/models/create.project.model.js

@@ -0,0 +1,26 @@
+function CreateProjectModel(accountId, name, description, address, number, startDate, endDate,
+    city, state, zipCode, companyNameForProject, certificateHolder = '', additionalInsured = '',
+    tenantSolutionEnabled = 0, onboardingEnabled = 0, automaticRenewalEnabled = 0) {
+    this.projectName = name;
+    this.userId = accountId;
+    this.projectDescription = description;
+
+    this.address = address;
+    this.projectNumber = number;
+    this.projectStartDate = startDate;
+    this.projectEndDate = endDate;
+
+    this.city = city;
+    this.state = state;
+    this.zipCode = zipCode;
+    this.companyNameForProject = companyNameForProject;
+
+    this.certificateHolder = certificateHolder;
+    this.additionalInsured = additionalInsured;
+
+    this.tenantSolutionEnabled = tenantSolutionEnabled;
+    this.onboardingEnabled = onboardingEnabled;
+    this.automaticRenewalEnabled = automaticRenewalEnabled;
+}
+
+module.exports = CreateProjectModel;

package/src/{internal-api → saas/internal-api}/requirements/api/requirements.api.js

@@ -1,5 +1,5 @@
 const requests = require('../../common/requests');
-const { backendUrl } = require('../../../env').getEnv();
+const { backendUrl } = require('../../../../env').getEnv();
 
 const Endpoints = {
     create: `${backendUrl}/saas/requirement`,

package/src/{internal-api → saas/internal-api}/requirements/api/requirements.setup.js

@@ -1,6 +1,6 @@
 const requirementsAPI = require('./requirements.api');
 const { CreateRequirementModel } = require('../models/create.requirement.model');
-const { validateType } = require('../../common/validations');
+const { validateType } = require('../../../../common/validations/typeValidations');
 
 const createRequirement = async (createRequirementModel, context) => {
     validateType(createRequirementModel, CreateRequirementModel);

package/src/{internal-api → saas/internal-api}/requirements/index.js

@@ -1,6 +1,6 @@
 const createModel = require('./models/create.requirement.model');
-const api = require('./api/requirements.setup');
+const services = require('./api/requirements.setup');
 
 const models = { create: createModel };
 
-module.exports = { api, models };
+module.exports = { services, models };

package/src/{internal-api → saas/internal-api}/requirements/models/create.requirement.model.js

@@ -1,5 +1,5 @@
 const Enum = require('enum');
-const { validateType } = require('../../common/validations');
+const { validateType } = require('../../../../common/validations/typeValidations');
 
 const DEFAULT_REQUIREMENT_TYPE = 'REQUIREMENT';
 

package/src/{internal-api/tabs → saas/internal-api/tabs/api}/tabs.api.js

@@ -1,5 +1,5 @@
-const requests = require('../common/requests');
-const { backendUrl } = require('../../env').getEnv();
+const requests = require('../../common/requests');
+const { backendUrl } = require('../../../../env').getEnv();
 
 const Endpoints = {
     getTabsByProjectId: `${backendUrl}/saas/vendortab`,

package/src/saas/internal-api/tabs/api/tabs.setup.js

@@ -0,0 +1,39 @@
+const tabsAPI = require('./tabs.api');
+
+const createTab = async (projectId, tabName, tabType, context) => {
+    const tabModel = { projectId, tabName, type: tabType };
+    return tabsAPI.createTab(tabModel, context);
+};
+
+const getTabsByProjectId = async (projectId, context) => {
+    return tabsAPI.getTabsByProjectId(projectId, context);
+};
+
+const getTabsByName = async (projectId, tabName, context) => {
+    const tabs = await tabsAPI.getTabsByProjectId(projectId, context);
+    const requestedTab = tabs.find(tab => tab.tabName === tabName);
+    return requestedTab;
+};
+
+const deleteTabById = async (tabId, context) => {
+    return tabsAPI.deleteTab(tabId, context);
+};
+
+const getOrCreateTab = async (projectId, tabName, tabType, context) => {
+    const tabs = await getTabsByProjectId(projectId, context);
+    const existingTab = tabs.find(tab => tab.tabName === tabName && tab.type === tabType);
+
+    if (existingTab) {
+        return existingTab;
+    }
+
+    return createTab(projectId, tabName, tabType, context);
+};
+
+module.exports = {
+    getTabsByProjectId,
+    createTab,
+    deleteTabById,
+    getOrCreateTab,
+    getTabsByName
+};

package/src/saas/internal-api/tabs/index.js

@@ -0,0 +1,3 @@
+const services = require('./api/tabs.setup');
+
+module.exports = { services };

package/src/saas/openapi/common/requests.js

@@ -0,0 +1,55 @@
+const axios = require('axios');
+
+const getRequestHandler = async (url, apiKey, params = {}, headers = {}) => {
+    enrichApiKey(headers, apiKey);
+    try {
+        const response = await axios.get(url, { params, headers });
+        return response;
+    } catch (error) {
+        const message = error.response.data && JSON.stringify(error.response.data) || error.message;
+        throw Error(message);
+    }
+
+};
+
+const postRequestHandler = async (url, apiKey, body, headers = {}) => {
+    enrichApiKey(headers, apiKey);
+    try {
+        const response = await axios.post(url, body, { headers });
+        return response;
+    } catch (error) {
+        const message = error.response.data && JSON.stringify(error.response.data) || error.message;
+        throw Error(message);
+    }
+
+};
+
+const putRequestHandler = async (url, apiKey, body, headers = {}) => {
+    enrichApiKey(headers, apiKey);
+    try {
+        const response = await axios.put(url, body, { headers });
+        return response;
+    } catch (error) {
+        const message = error.response.data && JSON.stringify(error.response.data) || error.message;
+        throw Error(message);
+    }
+
+};
+
+const deleteRequestHandler = async (url, apiKey, headers = {}, params = {}, data = {}) => {
+    enrichApiKey(headers, apiKey);
+    try {
+        const response = await axios.delete(url, { params, headers, data });
+        return response;
+    } catch (error) {
+        const message = error.response.data && JSON.stringify(error.response.data) || error.message;
+        throw Error(message);
+    }
+
+};
+
+const enrichApiKey = (headers, apiKey) => {
+    headers['x-api-key'] = apiKey;
+};
+
+module.exports = { getRequestHandler, postRequestHandler, putRequestHandler, deleteRequestHandler };

package/src/saas/openapi/tabs/tabs.api.js

@@ -0,0 +1,13 @@
+const requests = require('../common/requests');
+const { openapiUrl, backendUrl } = require('../../../env').getEnv();
+
+const Endpoints = {
+    delete: tabId => `${openapiUrl}/tabs/${tabId}`,
+    get: tabId => `${backendUrl}/tabs/${tabId}`
+};
+
+const deleteTabById = async (tabId, apiKey) => {
+    return requests.deleteRequestHandler(Endpoints.delete(tabId), apiKey);
+};
+
+module.exports = { deleteTabById };

package/src/saas/openapi/tabs/tabs.setup.js

@@ -0,0 +1,7 @@
+const tabsApi = require('./tabs.api');
+
+const deleteTabById = async (tabId, apiKey) => {
+    return tabsApi.deleteTabById(tabId, apiKey);
+};
+
+module.exports = { deleteTabById };

package/tests/env.test.js

@@ -5,19 +5,9 @@ const { expect } = chai;
 const env = require('../src/env');
 
 describe('Env | Test Core Logic', async function() {
-    const expectedSanityAssignVariables = {
-        'backendUrl': 'Test',
-        'credentials': {
-            'superUser': 'TestSuperUser',
-            'superUserPassword': 'TestSuperUserPassword'
-        },
-        'environment': 'dev',
-        'accountCreationSecret': null
-    };
-
-    const expectedValidationError = 'Missing required configuration on your environment variables. The missing env-vars are "backendUrl,environment".';
-
     it('Missing Configuration', async function() {
+        const expectedValidationError = 'Missing required configuration on your environment variables. The missing env-vars are "backendUrl,openapiUrl,environment".';
+
         const badInput = {
             credentials: { superUser: 'TestSuperUser', superUserPassword: 'TestSuperUserPassword' }
         };
@@ -26,8 +16,20 @@ describe('Env | Test Core Logic', async function() {
     });
 
     it('Assign Configuration', async function() {
+        const expectedSanityAssignVariables = {
+            'backendUrl': 'Test',
+            'openapiUrl': 'openapi',
+            'credentials': {
+                'superUser': 'TestSuperUser',
+                'superUserPassword': 'TestSuperUserPassword'
+            },
+            'environment': 'dev',
+            'accountCreationSecret': null
+        };
+
         env.init({
             backendUrl: 'Test',
+            openapiUrl: 'openapi',
             environment: 'dev',
             credentials: { superUser: 'TestSuperUser', superUserPassword: 'TestSuperUserPassword' }
         });

package/src/internal-api/accounts/settings/settings.setup.js

@@ -1,22 +0,0 @@
-const accountsAPI = require('./settings.api');
-
-const getAccountSettings = async (accountId, context) => {
-    return accountsAPI.getAccountSettings(accountId, context).then(res => res.data);
-};
-
-const updateAccountSettings = async (accountId, { isMultiPropertyTenants, isHighPriority }, context) => {
-    return accountsAPI.updateAccountSettings(accountId, { isMultiPropertyTenants, isHighPriority }, context);
-};
-
-const restoreAccountSettings = async (accountId, context) => {
-    return accountsAPI.updateAccountSettings(accountId, {
-        isMultiPropertyTenants: false,
-        isHighPriority: false
-    }, context);
-};
-
-module.exports = {
-    getAccountSettings,
-    updateAccountSettings,
-    restoreAccountSettings
-};

package/src/internal-api/tabs/tabs.setup.js

@@ -1,16 +0,0 @@
-const tabsAPI = require('./tabs.api');
-
-const createTab = async (projectId, tabName, tabType, context) => {
-    const tabModel = { projectId, tabName, type: tabType };
-    return tabsAPI.createTab(tabModel, context);
-};
-
-const getTabsByProjectId = async (projectId, context) => {
-    return tabsAPI.getTabsByProjectId(projectId, context);
-};
-
-const deleteTabById = async (tabId, context) => {
-    return tabsAPI.deleteTab(tabId, context);
-};
-
-module.exports = { getTabsByProjectId, createTab, deleteTabById };