WIP: Feat/wdfGrantLetter

migrations/20220329140351-createDevelopmentFundGrantsTable.js

@@ -0,0 +1,55 @@
+'use strict';
+
+module.exports = {
+  up: (queryInterface, Sequelize) => {
+    return queryInterface.createTable(
+      'DevelopmentFundGrants',
+      {
+        AgreementID: {
+          type: Sequelize.STRING,
+          allowNull: false,
+          primaryKey: true,
+        },
+        EstablishmentID: {
+          type: Sequelize.INTEGER,
+          references: {
+            model: {
+              tableName: 'Establishment',
+              schema: 'cqc',
+            },
+            key: 'EstablishmentID',
+          },
+          unique: true,
+        },
+        SignStatus: {
+          type: Sequelize.STRING(36),
+          allowNull: false,
+        },
+        Receiver: {
+          type: Sequelize.STRING(100),
+          allowNull: false,
+        },
+        DateSent: {
+          type: Sequelize.DATE,
+          allowNull: false,
+          default: Sequelize.NOW,
+        },
+        DateCompleted: {
+          type: Sequelize.DATE,
+          allowNull: true,
+          default: null,
+        },
+      },
+      {
+        schema: 'cqc',
+      },
+    );
+  },
+
+  down: (queryInterface, Sequelize) => {
+    return queryInterface.dropTable({
+      tableName: 'DevelopmentFundGrants',
+      schema: 'cqc',
+    });
+  },
+};

server/config/config.js

@@ -158,20 +158,6 @@ const config = convict({
     },
   },
 
-  redis: {
-    url: {
-      doc: 'The URI to redirect users to the Redis',
-      format: String,
-      default: 'redis://localhost:6379',
-    },
-    serviceName: {
-      doc: 'Name of VCAP Service for Redis',
-      format: String,
-      default: 'Unknown',
-      env: 'REDIS_SERVICE_NAME',
-    },
-  },
-
   notify: {
     key: {
       doc: 'The gov.uk notify key',
@@ -629,6 +615,36 @@ const config = convict({
       env: 'REDIS_SERVICE_NAME',
     },
   },
+  adobeSign: {
+    apiBaseUrl: {
+      doc: 'The base URL for adobe sign API calls',
+      format: String,
+      default: 'https://api.eu2.adobesign.com:443',
+    },
+    directAccessDoc: {
+      doc: 'ID of direct access template',
+      format: String,
+      default:
+        {
+          production: 'prodDocIdHere',
+        }[this.env] || 'CBJCHBCAABAAWaloyEh2SuKJ7y-NFqAe7CwlouyqBFjj',
+    },
+    nationalOrgDoc: {
+      doc: 'ID of national organisation template',
+      format: String,
+      default:
+        {
+          production: 'prodDocIdHere',
+        }[this.env] || 'CBJCHBCAABAAHk5Czg1lz5LNbIlbRgvEnc7twleqy98A',
+    },
+    apiKey: {
+      doc: 'Adobe Sign API Key',
+      format: String,
+      default: '',
+      sensitive: true,
+      env: 'ADOBE_SIGN_KEY',
+    },
+  },
 });
 
 // Load environment dependent configuration

server/models/developmentFundGrants.js

@@ -0,0 +1,50 @@
+'use strict';
+
+module.exports = function (sequelize, DataTypes) {
+  const DevelopmentFundGrants = sequelize.define(
+    'DevelopmentFundGrants',
+    {
+      AgreementID: {
+        type: DataTypes.STRING,
+        allowNull: false,
+        primaryKey: true,
+      },
+      EstablishmentID: {
+        type: DataTypes.INTEGER,
+        references: {
+          model: {
+            tableName: 'Establishment',
+            schema: 'cqc',
+          },
+          key: 'EstablishmentID',
+        },
+        unique: true,
+      },
+      SignStatus: {
+        type: DataTypes.STRING(36),
+        allowNull: false,
+      },
+      Receiver: {
+        type: DataTypes.STRING(100),
+        allowNull: false,
+      },
+      DateSent: {
+        type: DataTypes.DATE,
+        allowNull: false,
+        default: sequelize.NOW,
+      },
+      DateCompleted: {
+        type: DataTypes.DATE,
+        allowNull: true,
+        default: null,
+      },
+    },
+    {
+      tableName: 'DevelopmentFundGrants',
+      createdAt: false,
+      updatedAt: false,
+    },
+  );
+
+  return DevelopmentFundGrants;
+};

server/models/establishment.js

@@ -1931,5 +1931,14 @@ module.exports = function (sequelize, DataTypes) {
     });
   };
 
+  Establishment.getWDFClaimData = async function (establishmentId) {
+    return await this.findOne({
+      attributes: ['NameValue', 'address1', 'town', 'county', 'postcode', 'IsNationalOrg'],
+      where: {
+        id: establishmentId,
+      },
+    });
+  };
+
   return Establishment;
 };

server/routes/wdf/developmentFundGrants/adobeSign/index.js

@@ -0,0 +1,86 @@
+const config = require('../../../../config/config');
+const axios = require('axios');
+
+const adobeSignBaseUrl = config.get('adobeSign.apiBaseUrl');
+const adobeApiKey = config.get('adobeSign.apiKey');
+
+module.exports.createAgreement = async (claimData) => {
+  const { name, email, address, town, county, postcode, organisation, isNationalOrg } = claimData;
+  const body = {
+    fileInfos: [
+      {
+        libraryDocumentId: config.get(`${isNationalOrg ? 'adobeSign.nationalOrgDoc' : 'adobeSign.directAccessDoc'}`),
+      },
+    ],
+    participantSetsInfo: [
+      {
+        role: 'SIGNER',
+        order: 1,
+        memberInfos: [
+          {
+            email,
+            name,
+          },
+        ],
+      },
+    ],
+    signatureType: 'ESIGN',
+    state: 'IN_PROCESS',
+    status: 'OUT_FOR_SIGNATURE',
+    name: 'Workplace Development Fund Grant Letter', // title of the agreement
+    mergeFieldInfo: [
+      {
+        defaultValue: name,
+        fieldName: 'full_name',
+      },
+      {
+        defaultValue: organisation,
+        fieldName: 'organisation',
+      },
+      {
+        defaultValue: address,
+        fieldName: 'address',
+      },
+      {
+        defaultValue: town,
+        fieldName: 'town',
+      },
+      {
+        defaultValue: county,
+        fieldName: 'county',
+      },
+      {
+        defaultValue: postcode,
+        fieldName: 'postcode',
+      },
+      {
+        defaultValue: 'contractNumber',
+        fieldName: 'contract_number',
+      },
+    ],
+  };
+
+  return axios
+    .post(`${adobeSignBaseUrl}/api/rest/v6/agreements`, body, {
+      headers: {
+        Authorization: `Bearer ${adobeApiKey}`,
+      },
+    })
+    .then(({ data }) => data)
+    .catch((err) => {
+      throw err;
+    });
+};
+
+module.exports.queryAgreementStatus = async (agreementId) => {
+  return axios
+    .get(`${adobeSignBaseUrl}/api/rest/v6/agreements/${agreementId}`, {
+      headers: {
+        Authorization: `Bearer ${adobeApiKey}`,
+      },
+    })
+    .then(({ data }) => data)
+    .catch((err) => {
+      throw err;
+    });
+};

server/routes/wdf/developmentFundGrants/generateDevelopmentFundGrantLetter.js

@@ -0,0 +1,29 @@
+const models = require('../../../models');
+const { createAgreement } = require('./adobeSign');
+
+const generateDevelopmentFundGrantLetter = async (req, res, next) => {
+  try {
+    const { establishmentId, name, email } = req.body;
+    const { NameValue, address1, town, county, postcode, IsNationalOrg } = await models.establishment.getWDFClaimData(
+      establishmentId,
+    );
+    // additional fields needed - funding_amount, grant_reference
+    const { id } = await createAgreement({
+      name,
+      email,
+      organisation: NameValue,
+      address: address1,
+      town,
+      county,
+      postcode,
+      isNationalOrg: IsNationalOrg,
+    });
+    // save to DB - success then continue, else cancel
+
+    return res.status(201).json({ id });
+  } catch (err) {
+    return next(Error('unable to create agreement'));
+  }
+};
+
+module.exports.generateDevelopmentFundGrantLetter = generateDevelopmentFundGrantLetter;

server/routes/wdf/developmentFundGrants/index.js

@@ -0,0 +1,19 @@
+const router = require('express').Router();
+const { queryAgreementStatus } = require('./adobeSign');
+
+router.post('/agreements', require('./generateDevelopmentFundGrantLetter'));
+
+router.get('/agreements/:agreementId', async (req, res, next) => {
+  const { agreementId } = req.params;
+  try {
+    const agreementStatus = await queryAgreementStatus(agreementId);
+
+    // store update status in db
+
+    return res.json(agreementStatus);
+  } catch (err) {
+    return next(Error(`unable to query agreement with ID ${agreementId}`));
+  }
+});
+
+module.exports = router;

server/routes/wdf/index.js

@@ -3,7 +3,9 @@ const express = require('express');
 const router = express.Router();
 
 const DisbursementFile = require('./disbursementFile');
+const DevelopmentFund = require('./developmentFundGrants');
 
 router.use('/disbursementFile', DisbursementFile);
+router.use('/developmentFund', DevelopmentFund);
 
 module.exports = router;