Merge pull request '5216-expeditionStateAdd' (!1717) from 5216-expeditionStateAdd into dev

Reviewed-on: #1717
Reviewed-by: Alex Moreno <alexm@verdnatura.es>

db/changes/233601/00-addExpeditionState.sql

@@ -0,0 +1,2 @@
+INSERT INTO `salix`.`ACL` (`model`,`property`,`accessType`,`permission`,`principalType`,`principalId`)
+    VALUES ('ExpeditionState','addExpeditionState','WRITE','ALLOW','ROLE','delivery');

modules/ticket/back/methods/expedition-state/addExpeditionState.js

@@ -0,0 +1,66 @@
+const UserError = require('vn-loopback/util/user-error');
+
+module.exports = Self => {
+    Self.remoteMethod('addExpeditionState', {
+        description: 'Update an expedition state',
+        accessType: 'WRITE',
+        accepts: [
+            {
+                arg: 'expeditions',
+                type: ['object'],
+                required: true,
+                description: 'Array of objects containing expeditionFk and stateCode'
+            }
+        ],
+        returns: {
+            type: 'boolean',
+            root: true
+        },
+        http: {
+            path: `/addExpeditionState`,
+            verb: 'post'
+        }
+    });
+
+    Self.addExpeditionState = async(expeditions, options) => {
+        const models = Self.app.models;
+        let tx;
+        const myOptions = {};
+        if (typeof options == 'object')
+            Object.assign(myOptions, options);
+
+        if (!myOptions.transaction) {
+            tx = await Self.beginTransaction({});
+            myOptions.transaction = tx;
+        }
+        let expeditionId;
+        try {
+            for (const expedition of expeditions) {
+                const expeditionStateType = await models.ExpeditionStateType.findOne(
+                    {
+                        fields: ['id'],
+                        where: {code: expedition.stateCode}
+                    }, myOptions
+                );
+                if (!expeditionStateType)
+                    throw new UserError(`Invalid state code: ${expedition.stateCode}.`);
+
+                const typeFk = expeditionStateType.id;
+                expeditionId = expedition.expeditionFk;
+
+                await models.ExpeditionState.create({
+                    expeditionFk: expedition.expeditionFk,
+                    typeFk,
+                }, myOptions);
+            }
+
+            if (tx) await tx.commit();
+        } catch (e) {
+            if (tx) await tx.rollback();
+            if (e instanceof UserError)
+                throw e;
+
+            throw new UserError(`Invalid expedition id: ${expeditionId}.`);
+        }
+    };
+};

modules/ticket/back/methods/expedition-state/specs/addExpeditionState.spec.js

@@ -0,0 +1,75 @@
+const models = require('vn-loopback/server/server').models;
+
+describe('expeditionState addExpeditionState()', () => {
+    it('should update the expedition states', async() => {
+        const tx = await models.ExpeditionState.beginTransaction({});
+
+        try {
+            const options = {transaction: tx};
+            const payload = [
+                {
+                    expeditionFk: 8,
+                    stateCode: 'ON DELIVERY'
+                },
+            ];
+
+            await models.ExpeditionState.addExpeditionState(payload, options);
+
+            const expeditionState = await models.ExpeditionState.findOne({
+                where: {id: 5}
+            });
+
+            expect(expeditionState.typeFk).toEqual(1);
+            await tx.rollback();
+        } catch (e) {
+            await tx.rollback();
+            throw e;
+        }
+    });
+
+    it('should throw an error an error when an stateCode does not exist', async() => {
+        const tx = await models.ExpeditionState.beginTransaction({});
+        let error;
+
+        try {
+            const options = {transaction: tx};
+            const payload = [
+                {
+                    expeditionFk: 2,
+                    stateCode: 'DUMMY'
+                }
+            ];
+            await models.ExpeditionState.addExpeditionState(payload, options);
+
+            await tx.rollback();
+        } catch (e) {
+            error = e;
+            await tx.rollback();
+        }
+
+        expect(error.message).toContain('Invalid state code: DUMMY.');
+    });
+
+    it('should throw an error when expeditionFk does not exist', async() => {
+        const tx = await models.ExpeditionState.beginTransaction({});
+        let error;
+        try {
+            const options = {transaction: tx};
+            const payload = [
+                {
+                    expeditionFk: 50,
+                    stateCode: 'LOST'
+                }
+            ];
+
+            await models.ExpeditionState.addExpeditionState(payload, options);
+
+            await tx.rollback();
+        } catch (e) {
+            error = e;
+            await tx.rollback();
+        }
+
+        expect(error.message).toContain('Invalid expedition id: 50.');
+    });
+});

modules/ticket/back/model-config.json

@@ -20,6 +20,9 @@
     "ExpeditionState": {
         "dataSource": "vn"
     },
+    "ExpeditionStateType": {
+        "dataSource": "vn"
+    },
     "Packaging": {
         "dataSource": "vn"
     },

modules/ticket/back/models/expedition-state-type.json

@@ -0,0 +1,22 @@
+{
+    "name": "ExpeditionStateType",
+    "base": "VnModel",
+    "options": {
+        "mysql": {
+        "table": "expeditionStateType"
+        }
+    },
+    "properties": {
+        "id": {
+            "id": true,
+            "type": "number",
+            "description": "Identifier"
+        },
+        "description": {
+            "type": "string"
+        },
+        "code": {
+            "type": "string"
+        }
+    }
+}

modules/ticket/back/models/expedition-state.js

@@ -1,3 +1,4 @@
 module.exports = function(Self) {
     require('../methods/expedition-state/filter')(Self);
+    require('../methods/expedition-state/addExpeditionState')(Self);
 };