feat(network): add NetCom assignment and mail building and sending for Antenna Criteria fulfilment

lib/antenna_criteria.js

@@ -1,5 +1,6 @@
 const { AntennaCriterion } = require('../models');
 const errors = require('./errors');
+const mailer = require('./mailer');
 
 exports.listCriteria = async (req, res) => {
     if (!req.permissions.manage_antenna_criteria) {
@@ -40,3 +41,23 @@
         data: result[0]
     });
 };
+
+exports.sendFulfilmentMail = async (req, res) => {
+    if (!req.permissions.send_mails) {
+        return errors.makeForbiddenError(res, 'You are not allowed to send Antenna Criteria fulfilment mails.');
+    }
+
+    await mailer.sendMail({
+        from: req.body.from,
+        to: req.body.to,
+        cc: req.body.cc,
+        subject: req.body.subject,
+        template: req.body.template,
+        reply_to: req.body.reply_to
+    });
+
+    return res.json({
+        success: true,
+        message: 'Successfully sent Antenna Criteria fulfilment mail',
+    });
+};

lib/helpers.js

@@ -50,7 +50,9 @@ function getBodiesListFromPermissions(result) {
 exports.getPermissions = (user, corePermissions, managePermissions) => {
     const permissions = {
         view_board: hasPermission(corePermissions, 'view:board'),
-        manage_antenna_criteria: hasPermission(corePermissions, 'global:manage_network:antenna_criteria')
+        manage_antenna_criteria: hasPermission(corePermissions, 'global:manage_network:antenna_criteria'),
+        manage_netcom_assignment: hasPermission(corePermissions, 'global:manage_network:netcom_assignment'),
+        send_mails: hasPermission(corePermissions, 'global:manage_network:fulfilment_email')
     };
 
     permissions.manage_boards = {

lib/mail_component.js

@@ -0,0 +1,34 @@
+const { MailComponent } = require('../models');
+const errors = require('./errors');
+
+exports.listMailComponents = async (req, res) => {
+    if (!req.permissions.send_mails) {
+        return errors.makeForbiddenError(res, 'You are not allowed to list mail components.');
+    }
+
+    const components = await MailComponent.findAll({
+        where: { agora_id: Number(req.params.agora_id) }
+    });
+
+    return res.json({
+        success: true,
+        data: components
+    });
+};
+
+exports.setMailComponent = async (req, res) => {
+    if (!req.permissions.send_mails) {
+        return errors.makeForbiddenError(res, 'You are not allowed to set mail components.');
+    }
+
+    if (!['introduction', 'communication', 'board election', 'members list', 'membership fee', 'events', 'agora attendance', 'development plan', 'fulfilment report', 'closing'].includes(req.body.mail_component)) {
+        return errors.makeValidationError(res, 'This is not a valid mail component.');
+    }
+
+    const result = await MailComponent.upsert(req.body);
+
+    return res.json({
+        success: true,
+        data: result[0]
+    });
+};

lib/mailer.js

@@ -11,9 +11,11 @@ module.exports.sendMail = async (options) => {
         body: {
             from: options.from,
             to: options.to,
+            cc: options.cc,
             subject: options.subject,
             template: options.template,
-            parameters: options.parameters
+            parameters: options.parameters,
+            reply_to: options.reply_to
         }
     });
 

lib/netcom.js

@@ -0,0 +1,47 @@
+const { Netcom } = require('../models');
+const errors = require('./errors');
+
+exports.listNetcomAssignment = async (req, res) => {
+    if (!req.permissions.manage_netcom_assignment) {
+        return errors.makeForbiddenError(res, 'You are not allowed to list NetCom assignment.');
+    }
+
+    const netcom = await Netcom.findAll();
+
+    return res.json({
+        success: true,
+        data: netcom
+    });
+};
+
+exports.setNetcomAssignment = async (req, res) => {
+    if (!req.permissions.manage_netcom_assignment) {
+        return errors.makeForbiddenError(res, 'You are not allowed to set NetCom assignment.');
+    }
+
+    const result = await Netcom.upsert(req.body);
+
+    return res.json({
+        success: true,
+        data: result[0]
+    });
+};
+
+exports.removeNetcomAssignment = async (req, res) => {
+    if (!req.permissions.manage_netcom_assignment) {
+        return errors.makeForbiddenError(res, 'You are not allowed to remove NetCom assignment.');
+    }
+
+    const assignment = await Netcom.findOne({
+        where: {
+            body_id: req.params.body_id
+        }
+    });
+
+    await assignment.destroy();
+
+    return res.json({
+        success: true,
+        message: 'NetCom assignment was deleted.'
+    });
+};

lib/server.js

@@ -9,6 +9,8 @@ const morgan = require('./morgan');
 const middlewares = require('./middlewares');
 const boards = require('./boards');
 const antennaCriteria = require('./antenna_criteria');
+const netcom = require('./netcom');
+const mailComponent = require('./mail_component');
 const metrics = require('./metrics');
 const endpointsMetrics = require('./endpoints_metrics');
 const db = require('./sequelize');
@@ -44,6 +46,14 @@ GeneralRouter.delete('/bodies/:body_id/boards/:board_id', boards.findBoard, boar
 
 GeneralRouter.get('/antennaCriteria/:agora_id', antennaCriteria.listCriteria);
 GeneralRouter.put('/antennaCriteria', antennaCriteria.setCriterion);
+GeneralRouter.post('/antennaCriteria/sendFulfilmentMail', antennaCriteria.sendFulfilmentMail);
+
+GeneralRouter.get('/netcom', netcom.listNetcomAssignment);
+GeneralRouter.put('/netcom', netcom.setNetcomAssignment);
+GeneralRouter.delete('/netcom/:body_id', netcom.removeNetcomAssignment);
+
+GeneralRouter.get('/mailComponent/:agora_id', mailComponent.listMailComponents);
+GeneralRouter.put('/mailComponent', mailComponent.setMailComponent);
 
 server.use(endpointsMetrics.addEndpointMetrics);
 server.use('/', GeneralRouter);

migrations/20240923115900-create-netcom-assignment.js

@@ -0,0 +1,22 @@
+module.exports = {
+    up: (queryInterface, Sequelize) => queryInterface.createTable('netcom', {
+        body_id: {
+            allowNull: false,
+            type: Sequelize.INTEGER,
+            primaryKey: true
+        },
+        netcom_id: {
+            allowNull: false,
+            type: Sequelize.INTEGER
+        },
+        created_at: {
+            allowNull: false,
+            type: Sequelize.DATE
+        },
+        updated_at: {
+            allowNull: false,
+            type: Sequelize.DATE
+        }
+    }),
+    down: (queryInterface) => queryInterface.dropTable('netcom')
+};

migrations/20240924202000-create-mail-component.js

@@ -0,0 +1,27 @@
+module.exports = {
+    up: (queryInterface, Sequelize) => queryInterface.createTable('mailComponent', {
+        agora_id: {
+            allowNull: false,
+            type: Sequelize.INTEGER,
+            primaryKey: true
+        },
+        mail_component: {
+            allowNull: false,
+            type: Sequelize.ENUM('introduction', 'communication', 'board election', 'members list', 'membership fee', 'events', 'agora attendance', 'development plan', 'fulfilment report', 'closing'),
+            primaryKey: true
+        },
+        text: {
+            allowNull: false,
+            type: Sequelize.TEXT
+        },
+        created_at: {
+            allowNull: false,
+            type: Sequelize.DATE
+        },
+        updated_at: {
+            allowNull: false,
+            type: Sequelize.DATE
+        }
+    }),
+    down: (queryInterface) => queryInterface.dropTable('mailComponent')
+};

models/MailComponent.js

@@ -0,0 +1,36 @@
+const { Sequelize, sequelize } = require('../lib/sequelize');
+
+const MailComponent = sequelize.define('mailComponent', {
+    agora_id: {
+        allowNull: false,
+        primaryKey: true,
+        type: Sequelize.INTEGER,
+        validate: {
+            notEmpty: { msg: 'Agora should be set.' },
+            isInt: { msg: 'Agora ID should be a number.' }
+        }
+    },
+    mail_component: {
+        allowNull: false,
+        primaryKey: true,
+        type: Sequelize.ENUM('introduction', 'communication', 'board election', 'members list', 'membership fee', 'events', 'agora attendance', 'development plan', 'fulfilment report', 'closing'),
+        validate: {
+            isIn: {
+                args: [['introduction', 'communication', 'board election', 'members list', 'membership fee', 'events', 'agora attendance', 'development plan', 'fulfilment report', 'closing']],
+                msg: 'Message component must be one of these: "introduction", "communication", "board election", "members list", "membership fee", "events", "agora attendance", "development plan", "fulfilment report", "closing".'
+            }
+        }
+    },
+    text: {
+        allowNull: false,
+        type: Sequelize.TEXT
+    }
+}, {
+    underscored: true,
+    tableName: 'mailComponent',
+    createdAt: 'created_at',
+    updatedAt: 'updated_at',
+    primaryKey: ['agora_id', 'mail_component']
+});
+
+module.exports = MailComponent;

models/Netcom.js

@@ -0,0 +1,27 @@
+const { Sequelize, sequelize } = require('../lib/sequelize');
+
+const Netcom = sequelize.define('netcom', {
+    body_id: {
+        allowNull: false,
+        primaryKey: true,
+        type: Sequelize.INTEGER,
+        validate: {
+            notEmpty: { msg: 'Body should be set.' },
+            isInt: { msg: 'Body ID should be a number.' }
+        }
+    },
+    netcom_id: {
+        allowNull: false,
+        type: Sequelize.INTEGER,
+        validate: {
+            isInt: { msg: 'Netcom ID should be a number.' }
+        }
+    }
+}, {
+    underscored: true,
+    tableName: 'netcom',
+    createdAt: 'created_at',
+    updatedAt: 'updated_at'
+});
+
+module.exports = Netcom;

models/index.js

@@ -1,4 +1,6 @@
 const Board = require('./Board');
 const AntennaCriterion = require('./AntennaCriterion');
+const Netcom = require('./Netcom');
+const MailComponent = require('./MailComponent');
 
-module.exports = { Board, AntennaCriterion };
+module.exports = { Board, AntennaCriterion, Netcom, MailComponent };