@mojaloop/sdk-scheme-adapter 11.18.8

package/lib/model/index.js

@@ -0,0 +1,43 @@
+/**************************************************************************
+ *  (C) Copyright ModusBox Inc. 2019 - All rights reserved.               *
+ *                                                                        *
+ *  This file is made available under the terms of the license agreement  *
+ *  specified in the corresponding source code repository.                *
+ *                                                                        *
+ *  ORIGINAL AUTHOR:                                                      *
+ *       James Bush - james.bush@modusbox.com                             *
+ **************************************************************************/
+
+'use strict';
+
+
+const InboundTransfersModel = require('./InboundTransfersModel.js');
+const OutboundTransfersModel = require('./OutboundTransfersModel.js');
+const OutboundBulkQuotesModel = require('./OutboundBulkQuotesModel');
+const OutboundBulkTransfersModel = require('./OutboundBulkTransfersModel.js');
+const OutboundRequestToPayTransferModel = require('./OutboundRequestToPayTransferModel.js');
+const AccountsModel = require('./AccountsModel');
+const ProxyModel = require('./ProxyModel');
+const OutboundRequestToPayModel = require('./OutboundRequestToPayModel');
+const { BackendError, PersistentStateMachine } = require('./common');
+const PartiesModel = require('./PartiesModel');
+const QuotesModel = require('./QuotesModel');
+const TransfersModel = require('./TransfersModel');
+const AuthorizationsModel = require('./AuthorizationsModel');
+
+module.exports = {
+    AccountsModel,
+    BackendError,
+    OutboundBulkQuotesModel,
+    OutboundBulkTransfersModel,
+    OutboundRequestToPayTransferModel,
+    OutboundRequestToPayModel,
+    InboundTransfersModel,
+    OutboundTransfersModel,
+    ProxyModel,
+    PersistentStateMachine,
+    PartiesModel,
+    QuotesModel,
+    TransfersModel,
+    AuthorizationsModel
+};

package/lib/model/lib/deferredJob.js

@@ -0,0 +1,113 @@
+/**************************************************************************
+ *  (C) Copyright ModusBox Inc. 2020 - All rights reserved.               *
+ *                                                                        *
+ *  This file is made available under the terms of the license agreement  *
+ *  specified in the corresponding source code repository.                *
+ *                                                                        *
+ *  ORIGINAL AUTHOR:                                                      *
+ *       Paweł Marzec - pawel.marzec@modusbox.com                         *
+ **************************************************************************/
+
+'use strict';
+const pr = require('promise-timeout');
+
+class InitAndJobRequiredByWait extends Error {
+    constructor(channel) {
+        super(`'init' & 'job' methods of ObservedJob(cache, channel:'${channel}') should be called before 'wait' method`);
+        this.channel = channel;
+    }
+}
+
+class DeferredJob {
+
+    constructor(cache, channel, defaultTimeoutInMs) {
+        this.cache = cache;
+        this.channel = channel;
+        this.defaultTimeoutInMs = defaultTimeoutInMs || deferredJob.defaultTimeoutInMs;
+        this.sid = this.tailInit = this.listenerJob = null;
+    }
+
+    init(tailInit) {
+        this.tailInit = tailInit;
+        return this;
+    }
+
+    job(job) {
+        this.listenerJob = job;
+        return this;
+    }
+
+    async wait(timeout) {
+        // mvp validation
+        if (!(this.tailInit || this.listenerJob)) {
+            throw new InitAndJobRequiredByWait(this.channel);
+        }
+
+        // eslint-disable-next-line no-async-promise-executor
+        const promise = new Promise(async (resolve, reject) => {
+            try {
+                // subscribe to the channel to execute the jobCb when the message arrive
+                this.sid = await this.cache.subscribe(this.channel, async (channel, message) => {
+                    // consume message
+                    try {
+                        // unsubscribe first to be sure the jobCb will be executed only once
+                        // and system resources are preserved
+                        this.unsubscribe();
+                        
+                        // messages comes as stringified JSON
+                        // and we don't want to bother listener about de-serialization
+                        const parsed = JSON.parse(message);
+
+                        // invoke deferred job
+                        this.listenerJob(parsed);
+                    } catch (err) {
+                        return reject(err);
+                    }
+
+                    // done
+                    resolve();
+                });
+
+                // invoke the async task which should effects in the future
+                // by publishing the message to channel via trigger method
+                // so the jobCb will be invoked
+                await this.tailInit(this.channel, this.sid);
+            } catch (err) {
+                this.unsubscribe();
+                reject(err);
+            }
+        });
+    
+        // ensure the whole process will finish in specified timeout
+        // throws error if timeout happens
+        return pr.timeout(promise, timeout || this.defaultTimeoutInMs)
+            .catch(async (err) => {
+                await this.unsubscribe();
+                throw err;
+            });
+    }
+
+    async unsubscribe() {
+        if (this.sid && this.cache && this.channel) {
+            await this.cache.unsubscribe(this.channel, this.sid);
+            this.sid = null;
+        }
+    }
+    
+    // trigger the deferred job
+    async trigger(message) {
+        // message must be stringified before passing via channel
+        const stringified = JSON.stringify(message);
+        return this.cache.publish(this.channel, stringified);
+    }
+
+
+}
+
+function deferredJob(cache, channel, defaultTimeoutInMs) {
+    return new DeferredJob(cache, channel, defaultTimeoutInMs);
+}
+
+deferredJob.defaultTimeoutInMs = 2000;
+
+module.exports = deferredJob;

package/lib/model/lib/index.js

@@ -0,0 +1,9 @@
+const deferredJob = require('./deferredJob');
+const request = require('./requests');
+const shared = require('./shared');
+
+module.exports = {
+    deferredJob,
+    request,
+    shared,
+};

package/lib/model/lib/requests/backendRequests.js

@@ -0,0 +1,227 @@
+/**************************************************************************
+ *  (C) Copyright ModusBox Inc. 2019 - All rights reserved.               *
+ *                                                                        *
+ *  This file is made available under the terms of the license agreement  *
+ *  specified in the corresponding source code repository.                *
+ *                                                                        *
+ *  ORIGINAL AUTHOR:                                                      *
+ *       James Bush - james.bush@modusbox.com                             *
+ **************************************************************************/
+
+'use strict';
+
+const http = require('http');
+const { request } = require('@mojaloop/sdk-standard-components');
+const { buildUrl, throwOrJson, HTTPResponseError } = require('./common');
+
+
+/**
+ * A class for making requests to DFSP backend API
+ */
+class BackendRequests {
+    constructor(config) {
+        this.config = config;
+        this.logger = config.logger;
+
+        // FSPID of THIS DFSP
+        this.dfspId = config.dfspId;
+
+        // make sure we keep alive connections to the backend
+        this.agent = new http.Agent({
+            keepAlive: true
+        });
+
+        this.transportScheme = 'http';
+
+        // Switch or peer DFSP endpoint
+        this.backendEndpoint = `${this.transportScheme}://${config.backendEndpoint}`;
+    }
+
+    /**
+     * Executes a GET /otp request for the specified transaction request id
+     *
+     * @returns {object} - JSON response body if one was received
+     */
+    async getOTP(transactionRequestId) {
+        const url = `otp/${transactionRequestId}`;
+        return this._get(url);
+    }
+
+
+    /**
+     * Executes a GET /parties request for the specified identifier type and identifier
+     *
+     * @returns {object} - JSON response body if one was received
+     */
+    async getParties(idType, idValue, idSubValue) {
+        const url = `parties/${idType}/${idValue}`
+          + (idSubValue ? `/${idSubValue}` : '');
+        return this._get(url);
+    }
+
+    /**
+     * Executes a GET /transfers request for the specified transfer ID
+     *
+     * @returns {object} - JSON response body if one was received
+     */
+    async getTransfers(transferId) {
+        const url = `transfers/${transferId}`;
+        return this._get(url);
+    }
+
+
+    /**
+     * Executes a POST /quotes request for the specified quote request
+     *
+     * @returns {object} - JSON response body if one was received
+     */
+    async postQuoteRequests(quoteRequest) {
+        return this._post('quoterequests', quoteRequest);
+    }
+
+
+    /**
+     * Executes a POST /transfers request for the specified transfer prepare
+     *
+     * @returns {object} - JSON response body if one was received
+     */
+    async postTransfers(prepare) {
+        return this._post('transfers', prepare);
+    }
+
+    /**
+     * Executes a POST /transactionRequests request for the specified transaction request
+     *
+     * @returns {object} - JSON response body if one was received
+     */
+    async postTransactionRequests(transactionRequest) {
+        return this._post('transactionrequests', transactionRequest);
+    }
+
+    /**
+     * Executes a POST /bulkQuotes request for the specified bulk quotes request
+     *
+     * @returns {object} - JSON response body if one was received
+     */
+    async postBulkQuotes(bulkQuotesRequest) {
+        return this._post('bulkQuotes', bulkQuotesRequest);
+    }
+
+    /**
+     * Executes a GET /bulkQuotes/{ID} request for the specified bulk quote ID
+     *
+     * @returns {object} - JSON response body if one was received
+     */
+    async getBulkQuotes(bulkQuoteId) {
+        const url = `bulkQuotes/${bulkQuoteId}`;
+        return this._get(url);
+    }
+
+    /**
+     * Executes a POST /bulkTransfers request for the specified bulk transfer prepare
+     *
+     * @returns {object} - JSON response body if one was received
+     */
+    async postBulkTransfers(prepare) {
+        return this._post('bulkTransfers', prepare);
+    }
+
+    /**
+     * Executes a GET /bulkTransfers/{ID} request for the specified bulk transfer ID
+     *
+     * @returns {object} - JSON response body if one was received
+     */
+    async getBulkTransfers(bulkTransferId) {
+        const url = `bulkTransfers/${bulkTransferId}`;
+        return this._get(url);
+    }
+
+    /**
+     * Executes a PUT /transfers/{ID} request to forward notification for success
+     *
+     * @returns {object} - JSON response body if one was received
+     */
+
+    async putTransfersNotification(notifcation, transferId) {
+        const url = `transfers/${transferId}`;
+        return this._put(url, notifcation);
+    }
+
+    /**
+     * Utility function for building outgoing request headers as required by the mojaloop api spec
+     *
+     * @returns {object} - headers object for use in requests to mojaloop api endpoints
+     */
+    _buildHeaders () {
+        const headers = {
+            'Content-Type': 'application/json',
+            'Accept': 'application/json',
+            'Date': new Date().toUTCString()
+        };
+
+        return headers;
+    }
+
+    _get(url) {
+        const reqOpts = {
+            method: 'GET',
+            uri: buildUrl(this.backendEndpoint, url),
+            headers: this._buildHeaders(),
+        };
+
+        // Note we do not JWS sign requests with no body i.e. GET requests
+
+        try {
+            this.logger.push({ reqOpts }).log('Executing HTTP GET');
+            return request({...reqOpts, agent: this.agent}).then(throwOrJson);
+        }
+        catch (e) {
+            this.logger.push({ e }).log('Error attempting HTTP GET');
+            throw e;
+        }
+    }
+
+
+    _put(url, body) {
+        const reqOpts = {
+            method: 'PUT',
+            uri: buildUrl(this.backendEndpoint, url),
+            headers: this._buildHeaders(),
+            body: JSON.stringify(body)
+        };
+
+        try {
+            this.logger.push({ reqOpts }).log('Executing HTTP PUT');
+            return request({...reqOpts, agent: this.agent}).then(throwOrJson);
+        }
+        catch (e) {
+            this.logger.push({ e }).log('Error attempting HTTP PUT');
+            throw e;
+        }
+    }
+
+
+    _post(url, body) {
+        const reqOpts = {
+            method: 'POST',
+            uri: buildUrl(this.backendEndpoint, url),
+            headers: this._buildHeaders(),
+            body: JSON.stringify(body),
+        };
+
+        try {
+            this.logger.push({ reqOpts }).log('Executing HTTP POST');
+            return request({...reqOpts, agent: this.agent}).then(throwOrJson);
+        }
+        catch (e) {
+            this.logger.push({ e }).log('Error attempting POST.');
+            throw e;
+        }
+    }
+}
+
+
+module.exports = {
+    BackendRequests,
+    HTTPResponseError,
+};

package/lib/model/lib/requests/common.js

@@ -0,0 +1,76 @@
+/**************************************************************************
+ *  (C) Copyright ModusBox Inc. 2019 - All rights reserved.               *
+ *                                                                        *
+ *  This file is made available under the terms of the license agreement  *
+ *  specified in the corresponding source code repository.                *
+ *                                                                        *
+ *  ORIGINAL AUTHOR:                                                      *
+ *       James Bush - james.bush@modusbox.com                             *
+ **************************************************************************/
+
+'use strict';
+
+
+const util = require('util');
+const respErrSym = Symbol('ResponseErrorDataSym');
+
+
+/**
+ * An HTTPResponseError class
+ */
+class HTTPResponseError extends Error {
+    constructor(params) {
+        super(params.msg);
+        this[respErrSym] = params;
+    }
+
+    getData() {
+        return this[respErrSym];
+    }
+
+    toString() {
+        return util.inspect(this[respErrSym]);
+    }
+
+    toJSON() {
+        return JSON.stringify(this[respErrSym]);
+    }
+}
+
+
+// Strip all beginning and end forward-slashes from each of the arguments, then join all the
+// stripped strings with a forward-slash between them. If the last string ended with a
+// forward-slash, append that to the result.
+const buildUrl = (...args) => {
+    return args
+        .filter(e => e !== undefined)
+        .map(s => s.replace(/(^\/*|\/*$)/g, '')) /* This comment works around a problem with editor syntax highglighting */
+        .join('/')
+        + ((args[args.length - 1].slice(-1) === '/') ? '/' : '');
+};
+
+
+const throwOrJson = async (res) => {
+    // TODO: will a 503 or 500 with content-length zero generate an error?
+    // or a 404 for that matter?!
+
+    if (res.headers['content-length'] === '0' || res.statusCode === 204) {
+        // success but no content, return null
+        return null;
+    }
+    if(res.statusCode < 200 || res.statusCode >= 300) {
+        // not a successful request
+        throw new HTTPResponseError({ msg: `Request returned non-success status code ${res.statusCode}`,
+            res
+        });
+    }
+
+    return res.data;
+};
+
+
+module.exports = {
+    HTTPResponseError,
+    buildUrl,
+    throwOrJson,
+};