Add RPC Client API (#44)

Author: evanugarte

.gitignore

@@ -1,4 +1,5 @@
 .vscode/
 __pycache__/
 modules/
-node_modules/
+node_modules
+config.js

.travis.yml

@@ -2,6 +2,8 @@ language: node_js
 node_js:
   - "stable"
 install:
+  - cp client/config/config.example.js client/config/config.js
   - npm install
 script:
  - npm run lint
+ - npm run test

client/api/2DPrinting.js

@@ -0,0 +1,22 @@
+const express = require('express');
+const router = express.Router();
+const { healthCheck, updateSignText } = require('../ledsign/led_sign_client');
+const { sendPrintRequest } = require('../printing/print_client');
+const { send3dPrintRequest } = require('../printing_3d/print_3d_client');
+const {
+  OK, BAD_REQUEST, NOT_FOUND, LED_SIGN_IP
+} = require('../config/config');
+const { addSignLog } = require('../util/logging-helpers');
+
+router.post('/Printer/sendPrintRequest', (req, res) => {
+  const { raw, copies, sides, pageRanges, destination } = req.body;
+  sendPrintRequest(raw, copies, sides, pageRanges, destination)
+    .then(response => {
+      return res.status(OK).send({ ...response });
+    })
+    .catch(error => {
+      return res.status(BAD_REQUEST).send({ ...error });
+    });
+});
+
+module.exports = router;

client/api/3DPrinting.js

@@ -0,0 +1,22 @@
+const express = require('express');
+const router = express.Router();
+const { healthCheck, updateSignText } = require('../ledsign/led_sign_client');
+const { sendPrintRequest } = require('../printing/print_client');
+const { send3dPrintRequest } = require('../printing_3d/print_3d_client');
+const {
+  OK, BAD_REQUEST, NOT_FOUND, LED_SIGN_IP
+} = require('../config/config');
+const { addSignLog } = require('../util/logging-helpers');
+
+router.post('/3dPrinter/print3dModel', (req, res) => {
+  const { raw, memberName, volume, copies } = req.body;
+  send3dPrintRequest(raw, memberName, volume, copies)
+    .then(response => {
+      return res.status(OK).send({ ...response });
+    })
+    .catch(error => {
+      return res.status(BAD_REQUEST).send({ ...error });
+    });
+});
+
+module.exports = router;

client/api/LedSign.js

@@ -0,0 +1,43 @@
+const express = require('express');
+const router = express.Router();
+const { healthCheck, updateSignText } = require('../ledsign/led_sign_client');
+const { sendPrintRequest } = require('../printing/print_client');
+const { send3dPrintRequest } = require('../printing_3d/print_3d_client');
+const {
+  OK, BAD_REQUEST, NOT_FOUND, LED_SIGN_IP
+} = require('../config/config');
+const { addSignLog } = require('../util/logging-helpers');
+
+router.post('/LedSign/healthCheck', (req, res) => {
+  const { officerName } = req.body;
+  healthCheck(officerName, LED_SIGN_IP)
+    .then(response => {
+      const { message } = response;
+      return res.status(OK).send({
+        text: message.getText(),
+        brightness: message.getBrightness(),
+        scrollSpeed: message.getScrollSpeed(),
+        backgroundColor: message.getBackgroundColor(),
+        textColor: message.getTextColor(),
+        borderColor: message.getBorderColor()
+      });
+    })
+    .catch(error => {
+      return res.status(NOT_FOUND).send({ ...error });
+    });
+});
+
+router.post('/LedSign/updateSignText', async (req, res) => {
+  if (!await addSignLog(req.body)) {
+    return res.sendStatus(BAD_REQUEST);
+  }
+  updateSignText(req.body, LED_SIGN_IP)
+    .then(response => {
+      return res.status(OK).send({ ...response });
+    })
+    .catch(error => {
+      return res.status(NOT_FOUND).send({ ...error });
+    });
+});
+
+module.exports = router;

client/api/SceRpcApiServer.js

@@ -0,0 +1,105 @@
+const express = require('express');
+const bodyParser = require('body-parser');
+const cors = require('cors');
+const http = require('http');
+
+/**
+ * Class responsible for resolving paths of API endpoints and combining them
+ * them into an express server.
+ */
+class SceRpcApiServer {
+  /**
+   * Store port information, create express server object and configure
+   * BodyParser options.
+   * @param {(String|Array<String>)} pathToEndpoints The path to a single
+   * server file, directory or array of directories/files;
+   * @param {Number} port The port for the server to listen on.
+   * @param {String} prefix The prefix of the api endpoints to send requests
+   * to, e.g. /api/Event/addEvent, with /api/ being the prefix.
+   */
+  constructor(pathToEndpoints, port, prefix = '/api/') {
+    this.runningInProduction = process.env.NODE_ENV === 'production';
+    this.port = port;
+    this.pathToEndpoints = pathToEndpoints;
+    this.prefix = prefix;
+    this.app = express();
+
+    this.app.use(cors());
+    this.app.use(
+      bodyParser.json({
+        // support JSON-encoded request bodies
+        limit: '50mb',
+        strict: true
+      })
+    );
+    this.app.use(
+      bodyParser.urlencoded({
+        // support URL-encoded request bodies
+        limit: '50mb',
+        extended: true
+      })
+    );
+  }
+
+  /**
+   * This function is responsible for taking the pathToEndpoints instance
+   * variable and resolving API endpoints from it.
+   */
+  async initializeEndpoints() {
+    // Because this.pathToEndpoints can either be an array or
+    // string, we need to check before initializing the endpoints.
+    if (Array.isArray(this.pathToEndpoints)) {
+      this.pathToEndpoints.map((apiPath) => {
+        this.app.use(this.prefix, require(apiPath));
+      });
+    } else {
+      this.app.use(this.prefix, require(this.pathToEndpoints));
+    }
+  }
+
+  /**
+   * Create the http server and start listening on
+   * the supplied port.
+   */
+  openConnection() {
+    this.server = http.createServer(this.app);
+    const { port } = this;
+    this.server.listen(port, function() {
+      console.debug(`Now listening on port ${port}`);
+    });
+  }
+
+  /**
+   * Return the current instance of the HTTP server. This function is useful
+   * for making chai HTTP requests in our API testing files.
+   * @returns {http.Server} The current instance of the HTTP server.
+   */
+  getServerInstance() {
+    return this.server;
+  }
+
+  /**
+   * Stop the server.
+   */
+  closeConnection() {
+    this.server.close();
+  }
+}
+
+// This if statement checks if the module was require()'d or if it was run
+// by node server.js. If we are not requiring it and are running it from the
+// command line, we create a server instance and start listening for requests.
+if (typeof module !== 'undefined' && !module.parent) {
+  const apiRoutes = [
+    __dirname + '2DPrinting.js',
+    __dirname + '3DPrinting.js',
+    __dirname + 'LedSign.js'
+  ];
+  const server = new SceRpcApiServer(
+    apiRoutes, 8083, '/SceRpcApi/');
+  server.initializeEndpoints().then(() => {
+    server.openConnection();
+  });
+}
+
+module.exports = { SceRpcApiServer };

client/config/config.example.js

@@ -0,0 +1,7 @@
+module.exports = {
+  LED_SIGN_IP: 'localhost',
+  LOGGING_API_URL: 'http://localhost:8081',
+  OK: 200,
+  BAD_REQUEST: 400,
+  NOT_FOUND: 404
+};

client/util/logging-helpers.js

@@ -0,0 +1,41 @@
+const { LOGGING_API_URL } = require('../config/config');
+const axios = require('axios');
+
+/**
+ * Add a new error by calling on the ErrorLog API.
+ * @param {Object} newError - The error that is to be added
+ * @param {(string|undefined)} errorToAdd.userEmail - The email of the user
+ *                                                  who has sent this error
+ * @param {(string|undefined)} errorToAdd.errorTime- The time the error occured
+ * @param {string} errorToAdd.apiEndpoint - The location of the error
+ * @param {string} errorToAdd.errordescription - The description of the error
+ */
+async function addErrorLog(errorToAdd) {
+  let errorSaved = true;
+  await axios.post(LOGGING_API_URL + '/api/ErrorLog/addErrorLog',
+    { ...errorToAdd })
+    .catch(err => {
+      errorSaved = false;
+    });
+  return errorSaved;
+}
+
+/**
+ * Add a log to the SignLog MongoDB collection
+ * @param {Object} signRequest An object containing information about the
+ * request some of the sign.
+ * @returns {boolean} If the save was successful or not.
+ */
+async function addSignLog(signRequest) {
+  let saveSuccessful = true;
+  await axios.post(LOGGING_API_URL + '/api/SignLog/addSignLog', {
+    signText: signRequest.text,
+    firstName: signRequest.firstName,
+    email: signRequest.email
+  }).catch(err => {
+    saveSuccessful = false;
+  });
+  return saveSuccessful;
+}
+
+module.exports = { addErrorLog, addSignLog };