Swagger interface added

microservices/flutterwave-transfer-micro/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:boron
+FROM node:erbium
 
 # Create app directory
 RUN mkdir -p /usr/src/app

microservices/flutterwave-transfer-micro/README.md

@@ -7,17 +7,37 @@ A microservice to handle flitterware payment services
 * Build the docker image by `docker build -t flutterwave-transfer-micro .`
 
 # Run
-* Set environment variables like `MONGO_URL` and `RABBITMQ_URL`. Full list in the wiki.
-* `docker run -p <BINDING> -e PORT=<app_port> -e POSTGRE_URL=<postgre_url> -i -t flutterwave-transfer-micro`
+* Set environment variables like `PORT` and `POSTGRE_URL`. Full list in the wiki.
+* `docker run -p <BINDING> -e PORT=<app_port> -e POSTGRE_URL=<postgre_url> -e FLUTTERWAVE_API=<flutterwave_config> -i -t flutterwave-transfer-micro`
 
 ## Example configurations
 * binding: 127.0.0.1:3000:3000/tcp
 * app_port: 3000
 * postgre_url: postgresql://wrenchboard:wrenchboard@10.10.10.23:5432/wrenchboard
+* flutterwave_config: eyJCYXNlQXBpVXJsIjoiaHR0cHM6Ly9hcGkuZmx1dHRlcndhdmUuY29tIiwiUHVibGljS2V5IjoiRkxXUFVCS19URVNULTU0YzkwMTQxYjAyODc4OWQ2NzEwNjdiZDcyZjc4MWE5LVgiLCJTZWNyZXRLZXkiOiJGTFdTRUNLX1RFU1QtYzdiYmM4NmQ3ZTcxMDAyNTRjNWU1YmJmMTYyYmYyYjItWCIsIkVuY3J5cHRpb25LZXkiOiJGTFdTRUNLX1RFU1RlOTQ3NGQ0ZTJjZTYifQ==
 
 ## Example command
 
-docker run -p 127.0.0.1:3000:3000/tcp -e PORT=3000 -e POSTGRE_URL='postgresql://wrenchboard:wrenchboard@10.10.10.23:5432/wrenchboard' -i -t flutterwave-transfer-micro
+```
+docker run -p 127.0.0.1:3000:3000/tcp \
+ -e PORT=3000 \
+ -e POSTGRE_URL='postgresql://wrenchboard:wrenchboard@10.10.10.23:5432/wrenchboard' \
+ -e FLUTTERWAVE_API='eyJCYXNlQXBpVXJsIjoiaHR0cHM6Ly9hcGkuZmx1dHRlcndhdmUuY29tIiwiUHVibGljS2V5IjoiRkxXUFVCS19URVNULTU0YzkwMTQxYjAyODc4OWQ2NzEwNjdiZDcyZjc4MWE5LVgiLCJTZWNyZXRLZXkiOiJGTFdTRUNLX1RFU1QtYzdiYmM4NmQ3ZTcxMDAyNTRjNWU1YmJmMTYyYmYyYjItWCIsIkVuY3J5cHRpb25LZXkiOiJGTFdTRUNLX1RFU1RlOTQ3NGQ0ZTJjZTYifQ==' \
+ -i -t flutterwave-transfer-micro
+```
+
+## Flutterwave config
+
+Either use a converniece script base64encoder.js or base64 CLI to encode the config:
+
+```
+echo '{
+  "BaseApiUrl":"https://api.flutterwave.com",
+  "PublicKey":"FLWPUBK_TEST-54c90141b028789d671067bd72f781a9-X",
+  "SecretKey":"FLWSECK_TEST-c7bbc86d7e7100254c5e5bbf162bf2b2-X",
+  "EncryptionKey":"FLWSECK_TESTe9474d4e2ce6"
+}' | base64
+```
 
 # Test
 `npm test`

microservices/flutterwave-transfer-micro/api/controller.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const properties = require('../package.json')
-const distance = require('../service/distance');
+const transfer = require('../service/transfer');
 
 var controllers = {
    about: function(req, res) {
@@ -11,13 +11,22 @@ var controllers = {
        }
        res.json(aboutInfo);
    },
-   getDistance: function(req, res) {
-           distance.find(req, res, function(err, dist) {
-               if (err)
-                   res.send(err);
-               res.json(dist);
-           });
-       },
+   postTransfer: function(req, res) {
+       transfer.create(req, res, function(err, dist) {
+           if (err) {
+               res.send(err);
+           }
+           res.json(dist);
+       });
+   },
+   getStatus: function(req, res) {
+       transfer.get(req, res, function(err, dist) {
+           if (err) {
+               res.send(err);
+           }
+           res.json(dist);
+       });
+   },
 };
 
 module.exports = controllers;

microservices/flutterwave-transfer-micro/api/routes.js

@@ -5,6 +5,8 @@ const controller = require('./controller');
 module.exports = function(app) {
    app.route('/about')
        .get(controller.about);
-   app.route('/distance/:zipcode1/:zipcode2')
-       .get(controller.getDistance);
+   app.route('/create')
+       .post(controller.postTransfer);
+   app.route('/status/:id')
+       .get(controller.getStatus);
 };

microservices/flutterwave-transfer-micro/base64decoder.js

@@ -0,0 +1,9 @@
+'use strict';
+
+let data = 'eyJQdWJsaWNLZXkiOiJGTFdQVUJLX1RFU1QtNTRjOTAxNDFiMDI4Nzg5ZDY3MTA2N2JkNzJmNzgxYTktWCIsIlNlY3JldEtleSI6IkZMV1NFQ0tfVEVTVC1jN2JiYzg2ZDdlNzEwMDI1NGM1ZTViYmYxNjJiZjJiMi1YIiwiRW5jcnlwdGlvbktleSI6IkZMV1NFQ0tfVEVTVGU5NDc0ZDRlMmNlNiJ9';
+let buff = new Buffer(data, 'base64');
+let text = buff.toString('ascii');
+let json = JSON.parse(text);
+
+console.log('"' + data + '" converted from Base64 to ASCII is "' + text + '"');
+console.log(json);

microservices/flutterwave-transfer-micro/base64encoder.js

@@ -0,0 +1,13 @@
+'use strict';
+
+let json = {
+  "BaseApiUrl":"https://api.flutterwave.com",
+  "PublicKey":"FLWPUBK_TEST-54c90141b028789d671067bd72f781a9-X",
+  "SecretKey":"FLWSECK_TEST-c7bbc86d7e7100254c5e5bbf162bf2b2-X",
+  "EncryptionKey":"FLWSECK_TESTe9474d4e2ce6"
+};
+let data = JSON.stringify(json);
+let buff = new Buffer(data);
+let base64data = buff.toString('base64');
+
+console.log('"' + data + '" converted to Base64 is "' + base64data + '"');

microservices/flutterwave-transfer-micro/package.json

@@ -1,10 +1,10 @@
 {
   "name": "flutterwave-transfer-micro",
-  "version": "0.0.1",
-  "description": "A microservice to handle flitterware payment services",
+  "version": "0.0.4",
+  "description": "A microservice to handle flutterware payment services",
   "main": "server.js",
   "scripts": {
-    "generate-docs": "jsdoc ./api/*.js ./api/**/*.js ./service/*.js ./services/**/*.js -d docs",
+    "generate-docs": "jsdoc ./api/*.js ./api/**/*.js ./app/*.js ./app/**/*.js ./service/*.js ./service/**/*.js -d docs",
     "lint": "eslint ./ --ext .js",
     "start": "node server.js",
     "start:dev": "nodemon server.js",
@@ -12,9 +12,15 @@
   },
   "author": "Anatolii Okhotnikov <acidumirae@gmail.com>",
   "dependencies": {
-    "pg": "8.7.1",
+    "axios": "^0.24.0",
+    "body-parser": "^1.19.0",
     "express": "^4.17.1",
+    "openapi-types": "^10.0.0",
+    "pg": "8.7.1",
     "request": "^2.88.2",
+    "swagger-autogen": "^2.17.2",
+    "swagger-jsdoc": "^6.1.0",
+    "swagger-ui-express": "^4.3.0",
     "underscore": "^1.8.3",
     "winston": "^2.3.1",
     "winston-papertrail": "^1.0.4"

microservices/flutterwave-transfer-micro/server.js

@@ -1,10 +1,151 @@
-const express = require('express')
+const express = require('express');
 const logger = require('./app/logger');
-const app = express();
+const swaggerUI = require('swagger-ui-express');
+const swaggerJSDocs = require('swagger-jsdoc');
+
 const port = process.env.PORT || 3000;
 
+const definition = {
+  "swagger": "2.0",
+  "info": {
+    "version": "0.0.4",
+    "title": "flutterwave-transfer-micro",
+    "description": "A microservice to handle flitterware payment services"
+  },
+  "host": "localhost:3000",
+  "basePath": "/",
+  "tags": [],
+  "schemes": [
+    "http"
+  ],
+  "consumes": ['application/json'],
+  "produces": ['application/json'],
+  "paths": {
+    "/about": {
+      "get": {
+        "tags": [],
+        "description": "About the microservice (service status)",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/create": {
+      "post": {
+        "tags": [],
+        "description": "Create new transfer",
+        "produces": [
+          "application/json"
+        ],
+	"parameters": [{
+	  "name":"transfer",
+	  "in": "body",
+	  "description": "Transfer to create",
+	  "required": true,
+	  "type":"object",
+	  "schema": {
+              "$ref": "#/definitions/NewTransfer"
+          },
+	  "example": {
+            "account_bank": "044",
+            "account_number": "0690000040",
+            "amount": 5500,
+	    "narration": "Akhlm Pstmn Trnsfr xx007",
+            "currency": "NGN",
+            "reference": "akhlm-pstmnpyt-rfxx007_PMCKDU_1",
+            "debit_currency": "NGN"
+	  }
+	}],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/status/{id}": {
+      "get": {
+        "tags": [],
+        "description": "Get transfer status",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "NewTransfer": {
+      "type": "object",
+      "required": [
+        "account_bank",
+	"account_number",
+	"amount",
+	"narration",
+	"currency",
+	"reference",
+	"debit_currency"
+      ],
+      "properties": {
+        "account_bank": {
+          "type": "string"
+        },
+        "account_number": {
+          "type": "string"
+        },
+	"amount": {
+          "type": "integer"
+        },
+        "narration": {
+          "type": "string"
+        },
+	"currency": {
+          "type": "string"
+        },
+        "reference": {
+          "type": "string"
+        },
+        "debit_currency": {
+          "type": "string"
+        }
+      }
+    },
+  }
+};
+
+const options = {
+  definition,
+  apis: ['./server.js'],
+};
+
+const swaggerSpec = swaggerJSDocs(options);
+
+const app = express();
+
+app.get('/swagger.json', (req, res) => {
+  res.setHeader('Content-Type', 'application/json');
+  res.send(swaggerSpec);
+});
+app.use('/api-docs', swaggerUI.serve, swaggerUI.setup(swaggerSpec));
+
+app.use(express.json());
+app.use(express.urlencoded());
+
 const routes = require('./api/routes');
 routes(app);
-app.listen(port, function() {
+
+app.listen(port, "0.0.0.0", function() {
    logger.info('***** Server started on port: ' + port + ' *****');
 });

microservices/flutterwave-transfer-micro/service/distance.js

@@ -1,36 +0,0 @@
-const request = require('request');
-const db = require('../app/db')
-const logger = require('../app/logger');
-
-const apiKey = process.env.ZIPCODE_API_KEY || "x4hw36qerDOdewjz5HIx4IR7XO5wsWVb7jFZTJ9jvCYYIHNhvK4aIpMExKb5gEoW";
-const zipCodeURL = 'https://www.zipcodeapi.com/rest/';
-
-var distance = {
-   find: function(req, res, next) {
-       var url = zipCodeURL + apiKey 
-               + '/distance.json/' + req.params.zipcode1 + '/' 
-               + req.params.zipcode2 + '/mile';
-       logger.info(url);
-       process.env["NODE_TLS_REJECT_UNAUTHORIZED"] = 0;
-       request(url,
-       function (error, response, body) {
-           if (!error && response.statusCode == 200) {
-               response = JSON.parse(body);
-               res.send(response);
-           } else {
-               logger.info(error);
-               res.send({distance: -1});
-           }
-       });
-       // Sample DB call
-       db.query('SELECT NOW()', (err, res) => {
-         if (err) {
-           throw err;
-         }
-         logger.info('time:', res.rows[0])
-       });
-   }
-};
-
-module.exports = distance;
-

microservices/flutterwave-transfer-micro/service/transfer.js

@@ -0,0 +1,98 @@
+'use strict';
+
+const axios = require('axios');
+const request = require('request');
+const db = require('../app/db')
+const logger = require('../app/logger');
+
+// https://developer.flutterwave.com/reference/create-a-transfer
+const flutterwaveConfigBuffer = new Buffer(process.env.FLUTTERWAVE_API, 'base64');
+const flutterwaveConfig = JSON.parse(flutterwaveConfigBuffer.toString('ascii'));
+
+var transfer = {
+   create: function(req, res, next) {
+       var url = flutterwaveConfig.BaseApiUrl + '/v3/transfers';
+       var headersOpt = {  
+           "Content-Type": "application/json",
+           "Authorization": "Bearer " + flutterwaveConfig.SecretKey,
+       };
+       var data = {
+                   "account_bank": req.body.account_bank,
+                   "account_number": req.body.account_number,
+                   "amount": req.body.amount,
+                   "narration": req.body.narration,
+                   "currency": req.body.currency,
+                   "reference": req.body.reference,
+                   "debit_currency": req.body.debit_currency
+       };
+       var options = {
+           headers: headersOpt
+       };
+       logger.info(url);
+       logger.info(options);
+       logger.info(data);
+       // https://blog.logrocket.com/5-ways-to-make-http-requests-in-node-js/
+       // https://stackoverflow.com/questions/53846709/how-do-i-use-axios-within-expressjs
+       axios.post(url, data, options)
+           .then(data => {
+               res.json(data);
+           })
+           .catch(err => {
+               logger.error(err.message);
+               //logger.error(err.stack);
+               logger.error(err.response.data);
+               //logger.error(err.response.headers);
+               res.send({
+                   status: "failure", 
+                   message: "Invalid response", 
+                   details: err.message,
+                   code: err.response.status,
+                   data: err.response.data
+               });
+           });
+       // TODO: Do we save the response in the DB? I assume: YES
+       db.query('SELECT NOW()', (err, res) => {
+         if (err) {
+           throw err;
+         }
+         logger.info('time:', res.rows[0])
+       });
+   },
+   get: function(req, res, next) {
+       var url = flutterwaveConfig.BaseApiUrl + '/v3/transfers/' + req.params.id;
+       var headersOpt = {
+           "Authorization": "Bearer " + flutterwaveConfig.SecretKey,
+       };
+       var options = {
+           headers: headersOpt
+       };
+       logger.info(url);
+       axios.get(url, options)
+           .then(data => {
+               res.json(data);
+           })
+           .catch(err => {
+               logger.error(err.message);
+               //logger.error(err.stack);
+               logger.error(err.response.data);
+               //logger.error(err.response.headers);
+               res.send({
+                   status: "failure", 
+                   message: "Invalid response", 
+                   details: err.message,
+                   code: err.response.status,
+                   data: err.response.data
+               });
+           });
+       // TODO: Do we save the response in the DB? I assume: YES
+       db.query('SELECT NOW()', (err, res) => {
+         if (err) {
+           throw err;
+         }
+         logger.info('time:', res.rows[0])
+       });
+   }
+};
+
+module.exports = transfer;
+

microservices/flutterwave-transfer-micro/swagger.js

@@ -0,0 +1,8 @@
+const swaggerAutogen = require('swagger-autogen')();
+
+const outputFile = './swagger.json';
+const endpointsFiles = ['./api/routes.js']
+
+swaggerAutogen(outputFile, endpointsFiles).then(() => {
+    require('./server.js')
+})