WIP: Feat/wdfGrantLetter

migrations/20220329140351-createDevelopmentFundGrantsTable.js

@@ -0,0 +1,78 @@
+'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',
+          },
+        },
+        SignStatus: {
+          type: Sequelize.ENUM,
+          allowNull: false,
+          values: [
+            'OUT_FOR_SIGNATURE',
+            'OUT_FOR_DELIVERY',
+            'OUT_FOR_ACCEPTANCE',
+            'OUT_FOR_FORM_FILLING',
+            'OUT_FOR_APPROVAL',
+            'AUTHORING',
+            'CANCELLED',
+            'SIGNED',
+            'APPROVED',
+            'DELIVERED',
+            'ACCEPTED',
+            'FORM_FILLED',
+            'EXPIRED',
+            'ARCHIVED',
+            'PREFILL',
+            'WIDGET_WAITING_FOR_VERIFICATION',
+            'DRAFT',
+            'DOCUMENTS_NOT_YET_PROCESSED',
+            'WAITING_FOR_FAXIN',
+            'WAITING_FOR_VERIFICATION',
+            'WAITING_FOR_NOTARIZATION',
+          ],
+        },
+        ReceiverEmail: {
+          type: Sequelize.STRING(320),
+          allowNull: false,
+        },
+        ReceiverName: {
+          type: Sequelize.STRING(100),
+          allowNull: false,
+        },
+        DateCreated: {
+          type: Sequelize.DATE,
+          allowNull: false,
+          default: Sequelize.NOW,
+        },
+      },
+      {
+        schema: 'cqc',
+      },
+    );
+  },
+
+  down: async (queryInterface, Sequelize) => {
+    await queryInterface.dropTable({
+      tableName: 'DevelopmentFundGrants',
+      schema: 'cqc',
+    });
+
+    return queryInterface.sequelize.query('DROP TYPE IF EXISTS cqc."enum_DevelopmentFundGrants_SignStatus";');
+  },
+};

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,105 @@
+'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',
+        },
+      },
+      SignStatus: {
+        type: DataTypes.ENUM,
+        allowNull: false,
+        values: [
+          'OUT_FOR_SIGNATURE',
+          'OUT_FOR_DELIVERY',
+          'OUT_FOR_ACCEPTANCE',
+          'OUT_FOR_FORM_FILLING',
+          'OUT_FOR_APPROVAL',
+          'AUTHORING',
+          'CANCELLED',
+          'SIGNED',
+          'APPROVED',
+          'DELIVERED',
+          'ACCEPTED',
+          'FORM_FILLED',
+          'EXPIRED',
+          'ARCHIVED',
+          'PREFILL',
+          'WIDGET_WAITING_FOR_VERIFICATION',
+          'DRAFT',
+          'DOCUMENTS_NOT_YET_PROCESSED',
+          'WAITING_FOR_FAXIN',
+          'WAITING_FOR_VERIFICATION',
+          'WAITING_FOR_NOTARIZATION',
+        ],
+      },
+      ReceiverEmail: {
+        type: DataTypes.STRING(320),
+        allowNull: false,
+      },
+      ReceiverName: {
+        type: DataTypes.STRING(100),
+        allowNull: false,
+      },
+      DateCreated: {
+        type: DataTypes.DATE,
+        allowNull: false,
+        default: sequelize.NOW,
+      },
+    },
+    {
+      tableName: 'DevelopmentFundGrants',
+      createdAt: false,
+      updatedAt: false,
+      schema: 'cqc',
+    },
+  );
+
+  DevelopmentFundGrants.saveWDFData = function (data) {
+    return this.create({
+      AgreementID: data.agreementId,
+      EstablishmentID: data.establishmentId,
+      ReceiverEmail: data.email,
+      ReceiverName: data.name,
+      SignStatus: data.signStatus,
+      DateCreated: data.createdDate,
+    });
+  };
+
+  DevelopmentFundGrants.getWDFClaimStatus = async function (establishmentId) {
+    return await this.findOne({
+      attributes: ['AgreementID', 'SignStatus'],
+      where: {
+        EstablishmentID: establishmentId,
+      },
+    });
+  };
+
+  DevelopmentFundGrants.updateStatus = async function (establishmentId, status) {
+    return await this.update(
+      {
+        SignStatus: status,
+      },
+      {
+        where: {
+          EstablishmentID: establishmentId,
+        },
+      },
+    );
+  };
+
+  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/establishments/wdfClaims/generateDevelopmentFundGrantLetter.js

@@ -0,0 +1,67 @@
+const express = require('express');
+const router = express.Router({ mergeParams: true });
+const models = require('../../../models');
+const { createAgreement, queryAgreementStatus } = require('../../../utils/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: agreementId } = await createAgreement({
+      name,
+      email,
+      organisation: NameValue,
+      address: address1,
+      town,
+      county,
+      postcode,
+      isNationalOrg: IsNationalOrg,
+    });
+    // save to DB
+    await models.DevelopmentFundGrants.saveWDFData({
+      agreementId,
+      establishmentId,
+      email,
+      name,
+      signStatus: data.status,
+      createdDate: data.createdDate,
+    });
+
+    return res.status(201).json({ agreementId });
+  } catch (err) {
+    return next(Error('unable to create agreement'));
+  }
+};
+
+const getDevelopmentFundGrantStatus = async (req, res, next) => {
+  try {
+    // get signStatus
+    const getWDFClaimStatus = await models.DevelopmentFundGrants.getWDFClaimStatus(req.body.establishmentId);
+    const data = await queryAgreementStatus(getWDFClaimStatus.AgreementID);
+
+    const signedStatus = getWDFClaimStatus.signStatus;
+    const echoSignStatus = data.status;
+    const returnStatus = signedStatus == 'SIGNED' ? signedStatus : echoSignStatus;
+
+    if (signedStatus != 'SIGNED') {
+      // update status to DB
+      if (signedStatus != echoSignStatus) {
+        await models.DevelopmentFundGrants.updateStatus(req.body.establishmentId, echoSignStatus);
+      }
+    }
+    return res.status(200).json({ Status: returnStatus });
+  } catch (err) {
+    console.error(err);
+    return next(Error('unable to get the status'));
+  }
+};
+
+router.route('/').get(getDevelopmentFundGrantStatus);
+router.route('/').post(generateDevelopmentFundGrantLetter);
+
+module.exports = router;
+module.exports.generateDevelopmentFundGrantLetter = generateDevelopmentFundGrantLetter;
+module.exports.getDevelopmentFundGrantStatus = getDevelopmentFundGrantStatus;

server/routes/establishments/wdfClaims/grantLetter.js

@@ -1,16 +1,13 @@
 const router = require('express').Router();
 const { hasPermission } = require('../../../utils/security/hasPermission');
+const {
+  generateDevelopmentFundGrantLetter,
+  getDevelopmentFundGrantStatus,
+} = require('./generateDevelopmentFundGrantLetter');
 
-const updateBUDataChanges = async (res) => {
-  try {
-    res.status(200).send();
-  } catch (error) {
-    console.log(error);
-    res.status(500).send();
-  }
-};
-
-router.route('/').post(hasPermission('canManageWdfClaims'), updateBUDataChanges);
+router.route('/').post(generateDevelopmentFundGrantLetter);
+router.route('/').get(getDevelopmentFundGrantStatus);
 
 module.exports = router;
-module.exports.updateBUDataChanges = updateBUDataChanges;
+module.exports.generateDevelopmentFundGrantLetter = generateDevelopmentFundGrantLetter;
+module.exports.getDevelopmentFundGrantStatus = getDevelopmentFundGrantStatus;

server/routes/establishments/wdfClaims/index.js

@@ -4,7 +4,7 @@ const { hasPermission } = require('../../../utils/security/hasPermission');
 
 const router = require('express').Router();
 
-router.use('/', hasPermission('canManageWdfClaims'));
+// router.use('/', hasPermission('canManageWdfClaims'));
 
 router.use('/grantLetter', require('./grantLetter.js'));