#1325: Bulk transfers and bulk quotes support

.gitignore

@@ -65,4 +65,7 @@ simulator.log
 # environments
 docker-compose.local.yml
 goldenpayerfsp
-goldenpayeefsp
+goldenpayeefsp
+
+#vscode configs
+.vscode/

src/audit-resolve.json

@@ -1,14 +1,32 @@
 {
-  "1300|nyc>istanbul-reports>handlebars": {
-    "fix": 1
+  "decisions": {
+    "1300|nyc>istanbul-reports>handlebars": {
+      "madeAt": 0,
+      "decision": "fix"
+    },
+    "1316|nyc>istanbul-reports>handlebars": {
+      "madeAt": 0,
+      "decision": "fix"
+    },
+    "1324|nyc>istanbul-reports>handlebars": {
+      "madeAt": 0,
+      "decision": "fix"
+    },
+    "1325|nyc>istanbul-reports>handlebars": {
+      "madeAt": 0,
+      "decision": "fix"
+    },
+    "1500|npm-audit-resolver>yargs-unparser>yargs>yargs-parser": {
+      "decision": "ignore",
+      "madeAt": 1591787086979,
+      "expiresAt": 1592391879076
+    },
+    "1500|npm-audit-resolver>audit-resolve-core>yargs-parser": {
+      "decision": "ignore",
+      "madeAt": 1591787090589,
+      "expiresAt": 1592391879076
+    }
   },
-  "1316|nyc>istanbul-reports>handlebars": {
-    "fix": 1
-  },
-  "1324|nyc>istanbul-reports>handlebars": {
-    "fix": 1
-  },
-  "1325|nyc>istanbul-reports>handlebars": {
-    "fix": 1
-  }
+  "rules": {},
+  "version": 1
 }

src/config.js

@@ -52,6 +52,11 @@ const config = {
             key: null,
         },
     },
+    ports: {
+        simulatorApi: 3000,
+        reportApi: 3002,
+        testApi: 3003,
+    },
 };
 
 
@@ -70,6 +75,9 @@ const setConfig = async (cfg) => {
             readFile(cfg.SERVER_KEY_PATH),
         ]);
     }
+    config.ports.simulatorApi = cfg.SIMULATOR_API_LISTEN_PORT || config.ports.simulatorApi;
+    config.ports.reportApi = cfg.REPORT_API_LISTEN_PORT || config.ports.reportApi;
+    config.ports.testApi = cfg.TEST_API_LISTEN_PORT || config.ports.testApi;
 };
 
 

src/index.js

@@ -19,6 +19,9 @@
 
  - Name Surname <name.surname@gatesfoundation.com>
  * Mowali
+
+ * ModusBox <https://modusbox.com>
+ - Steven Oderayi <steven.oderayi@modusbox.com>
  --------------
  ******/
 'use strict';
@@ -255,9 +258,9 @@ const testApi = new Koa();
     // If config specifies TLS, start an HTTPS server; otherwise HTTP
     let simServer;
     const conf = getConfig();
-    const simulatorPort = 3000;
-    const reportPort = 3002;
-    const testApiPort = 3003;
+    const simulatorPort = conf.ports.simulatorApi;
+    const reportPort = conf.ports.reportApi;
+    const testApiPort = conf.ports.testApi;
 
     if (conf.tls.mutualTLS.enabled || conf.tls.enabled) {
         if (!(conf.tls.creds.ca && conf.tls.creds.cert && conf.tls.creds.key)) {

src/models/bulkQuote.js

@@ -0,0 +1,123 @@
+/*****
+ License
+ --------------
+ Copyright © 2020 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+ * ModusBox <https://modusbox.com>
+ - Steven Oderayi <steven.oderayi@modusbox.com>
+ --------------
+ ******/
+'use strict';
+
+/**
+ * @file Simulator resources BulkQuote model
+ * @description Defines the bulk quote model structure and operations within the simulator.
+ */
+const { bulkQuoteTable } = require('./constants');
+
+// eslint-disable-next-line import/no-unresolved
+require('dotenv').config();
+
+/**
+ * @typedef {Object} BulkQuote
+ *
+ * Data model for bulk quotes.
+ */
+module.exports = class BulkQuote {
+    constructor(db) {
+        this.db = db;
+    }
+
+    /**
+   * Gets a BulkQuote with the provided bulkQuoteId
+   *
+   * @async
+   * @param {String} bulkQuoteId     The bulk quote Id.
+   * @returns {Promise<Object>}  BulkQuote object.
+   */
+    async get(bulkQuoteId) {
+        const res = await this.db.get(`SELECT * FROM ${bulkQuoteTable} WHERE id = ?`, [bulkQuoteId]);
+        return res;
+    }
+
+    /**
+   * Creates a bulk quote.
+   *
+   * @async
+   * @param {Object} bulkQuoteRequest     The bulk quote request object.
+   * @returns {Promise<Object>}       The BulkQuote response.
+   */
+    async create(bulkQuoteRequest) {
+        const { bulkQuoteId } = bulkQuoteRequest;
+        const individualQuoteResults = bulkQuoteRequest.individualQuotes.map((quote) => {
+            const fee = Math
+                .floor(Number(quote.amount) * Number(process.env.FEE_MULTIPLIER))
+                .toString();
+            return {
+                quoteId: quote.quoteId,
+                transactionId: quote.transactionId,
+                transferAmount: quote.amount,
+                transferAmountCurrency: quote.currency,
+                payeeFspFeeAmount: fee,
+                payeeFspFeeAmountCurrency: quote.currency,
+                payeeFspCommissionAmount: fee,
+                payeeFspCommissionAmountCurrency: quote.currency,
+            };
+        });
+        const response = {
+            bulkQuoteId,
+            individualQuoteResults,
+        };
+        const reqStr = JSON.stringify(bulkQuoteRequest);
+        const resStr = JSON.stringify(response);
+        const created = new Date().toISOString().slice(0, 19);
+
+        await this.db.get(`INSERT INTO ${bulkQuoteTable} (id, request, response, created) VALUES (?, ?, ?, ?)`,
+            [bulkQuoteId, reqStr, resStr, created]);
+
+        return response;
+    }
+
+    /**
+   * Updates a bulk quote
+   *
+   * @param {String} currentBulkOuoteId    The bulk quote id to update.
+   * @param {Object} newBulkQuoteRequest   The new BulkQuote object.
+   */
+    async update(currentBulkOuoteId, newBulkQuoteRequest) {
+        const response = newBulkQuoteRequest.individualQuotes.map(
+            (quote) => ({ transferAmount: quote.amount, transferAmountCurrency: quote.currency }),
+        );
+        const reqStr = JSON.stringify(newBulkQuoteRequest);
+        const resStr = JSON.stringify(response);
+
+        await this.db.run(`
+            UPDATE ${bulkQuoteTable}
+            SET id = ?, request = ?, response = ?
+            WHERE id = ?`, [newBulkQuoteRequest.bulkQuoteId, reqStr, resStr, currentBulkOuoteId]);
+    }
+
+    /**
+     * Deletes a BulkQuote.
+     *
+     * @async
+     * @param {String} bulkQuoteId The bulk quote id.
+     */
+    async delete(bulkQuoteId) {
+        await this.db.run(`DELETE FROM ${bulkQuoteTable} WHERE id = ?`, [bulkQuoteId]);
+    }
+};

src/models/bulkTransfer.js

@@ -0,0 +1,100 @@
+/*****
+ License
+ --------------
+ Copyright © 2020 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+ * ModusBox <https://modusbox.com>
+ - Steven Oderayi <steven.oderayi@modusbox.com>
+ --------------
+ ******/
+'use strict';
+
+/**
+ * @file Simulator resources BulkTransfer model
+ * @description Defines the bulk transfer model structure and operations within the simulator.
+ */
+const { bulkTransferTable } = require('./constants');
+require('dotenv').config();
+
+/**
+ * @typedef {Object} BulkTransfer
+ *
+ * Data model for bulk transfer.
+ */
+module.exports = class BulkTransfer {
+    constructor(db) {
+        this.db = db;
+    }
+
+    /**
+    * Retrieves a bulk transfer
+    *
+    * @async
+    * @param {String} bulkTransferId  The bulk transfer id.
+    * @returns {Promise<Object>}  BulkTransfer object.
+    */
+    async get(bulkTransferId) {
+        const res = await this.db.get(`SELECT * FROM ${bulkTransferTable} WHERE id = ?`, [bulkTransferId]);
+        return res;
+    }
+
+    /**
+    * Creates a bulk transfer.
+    *
+    * @async
+    * @param {Object} bulkTransferRequest  The bulk transfer request object.
+    * @returns {Promise<Object>}       BulkTransfer response.
+    */
+    async create(bulkTransferRequest) {
+        const { bulkTransferId } = bulkTransferRequest;
+        const response = { bulkTransferId };
+        const reqStr = JSON.stringify(bulkTransferRequest);
+        const resStr = JSON.stringify(response);
+
+        await this.db.get(`INSERT INTO ${bulkTransferTable} (id, request, response) VALUES (?, ?, ?)`, [bulkTransferId, reqStr, resStr]);
+
+        return response;
+    }
+
+    /**
+    * Updates a bulk transfer
+    *
+    * @param {String} bulkTransferId       The current bulk transfer id.
+    * @param {Object} BulkTansferRequest   The new BulkTransfer object.
+    */
+    async update(currentBulkTransferId, bulkTransferRequest) {
+        const { homeTransactionId: newBulkTransferId } = bulkTransferRequest;
+        const response = { newBulkTransferId };
+        const reqStr = JSON.stringify(bulkTransferRequest);
+        const resStr = JSON.stringify(response);
+
+        await this.db.run(`
+            UPDATE ${bulkTransferTable}
+            SET id = ?, request = ?, response = ?
+            WHERE id = ?`, [newBulkTransferId, reqStr, resStr, currentBulkTransferId]);
+    }
+
+    /**
+    * Deletes a bulk transfer.
+    *
+    * @async
+    * @param {String} bulkTransferId The bulk transfer id.
+    */
+    async delete(bulkTransferId) {
+        await this.db.run(`DELETE FROM ${bulkTransferTable} WHERE id = ?`, [bulkTransferId]);
+    }
+};

src/models/constants.js

@@ -26,6 +26,8 @@ const partyTable = 'party';
 const quoteTable = 'quote';
 const transactionRequestTable = 'transactionRequest';
 const transferTable = 'transfer';
+const bulkQuoteTable = 'bulkQuote';
+const bulkTransferTable = 'bulkTransfer';
 const partyExtensionTable = 'partyExtension';
 
 const createPartyTable = `
@@ -59,6 +61,16 @@ CREATE TABLE IF NOT EXISTS ${quoteTable} (
 )
 `;
 
+const createBulkQuoteTable = `
+CREATE TABLE IF NOT EXISTS ${bulkQuoteTable} (
+    id TEXT NOT NULL PRIMARY KEY,
+    request TEXT,
+    response TEXT,
+    created TIMESTAMP
+    CHECK(id <> '')
+)
+`;
+
 const createTransactionRequestTable = `
 CREATE TABLE IF NOT EXISTS ${transactionRequestTable} (
     id TEXT NOT NULL PRIMARY KEY,
@@ -78,15 +90,28 @@ CREATE TABLE IF NOT EXISTS ${transferTable} (
 )
 `;
 
+const createBulkTransferTable = `
+CREATE TABLE IF NOT EXISTS ${bulkTransferTable} (
+    id TEXT NOT NULL PRIMARY KEY,
+    request TEXT,
+    response TEXT,
+    CHECK(id <> '')
+)
+`;
+
 module.exports = {
     partyTable,
     quoteTable,
+    bulkQuoteTable,
+    transferTable,
+    bulkTransferTable,
     transactionRequestTable,
+    partyExtensionTable,
     createPartyTable,
     createQuoteTable,
-    createTransactionRequestTable,
+    createBulkQuoteTable,
+    createBulkTransferTable,
     createTransferTable,
-    transferTable,
-    partyExtensionTable,
+    createTransactionRequestTable,
     createPartyExtensionTable,
 };