groupcore-utils 1.0.0

package/.eslintrc.json

@@ -0,0 +1,25 @@
+{
+  "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"
+  }
+}

package/.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "printWidth":200
+}

package/Utils.js

@@ -0,0 +1,85 @@
+const axios = require('axios');
+const _isEmpty = require('lodash').isEmpty;
+
+class Utils {
+  constructor({ projectId, apiToken, apiUrl }) {
+    this.project = projectId;
+    this.token = apiToken;
+    this.apiUrl = apiUrl;
+  }
+
+  submitForm({ formData, formId, email, leadId = 0 }) {
+    if (_isEmpty(formData) || _isEmpty(String(formId)) || _isEmpty(email)) {
+      console.log('got here');
+      return { error: 'Missing some required params' };
+    }
+
+    return axios({
+      method: 'POST',
+      url: `${this.apiUrl}/com/submissions`,
+      data: {
+        formData,
+        formId,
+        email,
+        leadId,
+      },
+      headers: {
+        token: this.token,
+      },
+    });
+  }
+
+  sendMail({ recipientEmail, subject, htmlBody, hasAttachment = false, attachmentFilename, attachmentUrl }) {
+    if (hasAttachment) {
+      if (_isEmpty(attachmentFilename) || _isEmpty(attachmentUrl)) {
+        return { error: 'Some missing params. If hasAttachment is true, both attachmentFilename and attachmentUrl are required' };
+      }
+    }
+
+    if (!hasAttachment && (attachmentFilename || attachmentUrl)) {
+      return { error: 'If hasAttachment is false, both attachmentFilename and attachmentUrl cannot be accepted' };
+    }
+
+    if (_isEmpty(recipientEmail) || _isEmpty(subject) || _isEmpty(htmlBody)) {
+      return { error: 'Missing some required params' };
+    }
+
+    return axios({
+      method: 'POST',
+      url: `${this.apiUrl}/mail`,
+      data: {
+        project: this.project,
+        email: recipientEmail,
+        message: htmlBody,
+        subject,
+        attachments: hasAttachment ? [{ filename: attachmentFilename, path: attachmentUrl }] : null,
+      },
+      headers: {
+        token: this.token,
+      },
+    });
+  }
+
+  addLead({ firstname, lastname, phone = null, email }) {
+    if (_isEmpty(firstname) || _isEmpty(lastname) || _isEmpty(email)) {
+      return { error: 'Missing some required params' };
+    }
+
+    return axios({
+      method: 'POST',
+      url: `${this.apiUrl}/com/leads`,
+      data: {
+        project: this.project,
+        firstname,
+        lastname,
+        email,
+        phone,
+      },
+      headers: {
+        token: this.token,
+      },
+    });
+  }
+}
+
+module.exports = Utils;

package/Utils.spec.js

@@ -0,0 +1,91 @@
+const Utils = require('./Utils');
+const util = new Utils({ projectId: 10, apiToken: 'sampletoken', apiUrl: 'https://' });
+const axios = require('axios');
+
+jest.mock('axios');
+
+describe('Testing Utils.submitForm()', () => {
+  test('It should get a status 204 as response', async () => {
+    axios.mockResolvedValue({ status: 200 });
+    const response = await util.submitForm({ formData: { name: 'test' }, formId: 300, email: 'test@email.com' });
+    expect(response.status).toEqual(200);
+  });
+
+  test('It should return error if missing params', async () => {
+    const response = await util.submitForm({ formId: 10, email: 'test@email.com', leadId: 10 });
+    const error = { error: 'Missing some required params' };
+    expect(response).toEqual(error);
+  });
+});
+
+describe('Testing Utils.sendMail()', () => {
+  test('It should return right response', async () => {
+    axios.mockResolvedValue({ status: 204 });
+    const response = await util.sendMail({
+      recipientEmail: 'test@email.com',
+      subject: 'Test subject',
+      htmlBody: '<p>Html body</p>',
+    });
+    expect(response.status).toEqual(204);
+  });
+
+  test('It should return right response with attachment', async () => {
+    axios.mockResolvedValue({ status: 204 });
+    const response = await util.sendMail({
+      recipientEmail: 'test@email.com',
+      subject: 'Test subject',
+      htmlBody: '<p>Html body</p>',
+      hasAttachment: true,
+      attachmentFilename: 'file',
+      attachmentUrl: 'url',
+    });
+    expect(response.status).toEqual(204);
+  });
+
+  test('Should require attachmentFilename and attachmentUrl if hasAttachment is true', async () => {
+    const response = await util.sendMail({
+      recipientEmail: 'test@email.com',
+      subject: 'Test subject',
+      htmlBody: '<p>Html body</p>',
+      hasAttachment: true,
+      attachmentFilename: 'testfilename',
+    });
+    const error = { error: 'Some missing params. If hasAttachment is true, both attachmentFilename and attachmentUrl are required' };
+    expect(response).toEqual(error);
+  });
+
+  test('Should return error if hasAttachment is false or undefined but attachmentUrl or attachmentFilename are not empty', async () => {
+    const response = await util.sendMail({
+      recipientEmail: 'test@email.com',
+      subject: 'Test subject',
+      htmlBody: '<p>Html body</p>',
+      attachmentFilename: 'testfilename',
+    });
+    const error = { error: 'If hasAttachment is false, both attachmentFilename and attachmentUrl cannot be accepted' };
+    expect(response).toEqual(error);
+  });
+
+  test('Should return error if missing required params', async () => {
+    const response = await util.sendMail({
+      recipientEmail: 'test@email.com',
+    });
+    const error = { error: 'Missing some required params' };
+    expect(response).toEqual(error);
+  });
+});
+
+describe('Testing Utils.addLead()', () => {
+  test('It should return right response', async () => {
+    axios.mockResolvedValue({ data: { insertId: 3 } });
+    const response = await util.addLead({ firstname: 'test', lastname: 'test', email: 'test@email.com', phone: '123456' });
+    expect(response.data.insertId).toEqual(3);
+  });
+
+  test('Should return error if missing required params', async () => {
+    const response = await util.addLead({
+      firstname: 'test@email.com',
+    });
+    const error = { error: 'Missing some required params' };
+    expect(response).toEqual(error);
+  });
+});

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "groupcore-utils",
+  "version": "1.0.0",
+  "description": "Utilities for working with some Core features",
+  "main": "Utils.js",
+  "scripts": {
+    "test": "jest --coverage"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TheGroupC/groupcore-utils.git"
+  },
+  "author": "Ken Sawyerr",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/TheGroupC/groupcore-utils/issues"
+  },
+  "homepage": "https://github.com/TheGroupC/groupcore-utils#readme",
+  "dependencies": {
+    "axios": "^0.23.0",
+    "lodash": "^4.17.21",
+    "prettier": "^2.4.1"
+  },
+  "devDependencies": {
+    "jest": "^27.2.5"
+  }
+}