Built out API Functionality

package.json

@@ -5,6 +5,7 @@
   "main": "private/index.js",
   "scripts": {
     "serve": "webpack-serve --config ./webpack.config.js",
+    "watch": "nodemon --watch private private/index.js",
     "test": "jest"
   },
   "repository": {
@@ -54,6 +55,7 @@
     "webpack": "^4.14.0"
   },
   "devDependencies": {
+    "nodemon": "^1.17.5",
     "react-hot-loader": "^4.3.3",
     "webpack-dev-server": "^3.1.4"
   }

private/api/API.js

@@ -0,0 +1,91 @@
+// Copyright (c) 2018 Dominic Masters
+//
+// MIT License
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+const
+  path = require('path'),
+  fs = require('fs')
+;
+
+const API_BASE = '/api';
+
+class API {
+  constructor(server) {
+    this.server = server;
+    this.handlers = [];
+  }
+
+  getHandlers() {return this.handlers;}
+  getServer() {return this.server;}
+  getApp() {return this.server.getApp();}
+  getExpress() {return this.getServer().getExpress();}
+  getConfig() {return this.getApp().getConfig();}
+
+  addHandler(handler) {this.handlers.push(handler);}
+
+  registerHandlers() {
+    for(let i = 0; i < this.handlers.length; i++) {
+      let handler = this.handlers[i];
+
+      //Now we  need to register each of the paths to each of the methods!
+      for(let x = 0; x < handler.getMethods().length; x++) {
+        let method = handler.getMethods()[x].toLowerCase();
+        //For each method, there's perhaps multiple paths (e.g. post /test, get /test, post /ayy, get /ayy)
+        for(let y = 0; y < handler.getPaths().length; y++) {
+          let path = handler.getPaths()[y];
+          let url = API_BASE;
+          if(!path.startsWith('/')) url += '/';
+          url += path;
+
+          this.getExpress()[method](url, handler.onMethod.bind(handler));
+          console.log('Registering ' + url + '...');
+        }
+      }
+    }
+  }
+
+  loadHandlers() {
+    let dir = path.join(__dirname, 'methods');
+    this.loadHandlersInDirectory(dir);
+    this.registerHandlers();
+  }
+
+  loadHandlersInDirectory(dir) {
+    let assets = fs.readdirSync(dir);
+    for(let i = 0; i < assets.length; i++) {
+      let asset = assets[i];
+      let assetPath = path.join(dir, asset);
+      let stats = fs.statSync(assetPath);
+      if(stats.isDirectory()) {
+        this.loadHandlersInDirectory(assetPath  );
+        continue;
+      }
+
+      let method = require(assetPath);
+      let instance = new method(this);
+
+      this.addHandler(instance);
+    }
+  }
+}
+
+module.exports = API;

private/api/APIHandler.js

@@ -0,0 +1,53 @@
+// Copyright (c) 2018 Dominic Masters
+//
+// MIT License
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+const
+  API = require('./API'),
+  APIRequest = require('./APIRequest')
+;
+
+class APIHandler {
+  constructor(api, methods, paths) {
+    if(!(api instanceof API)) throw new Error('Invalid API Supplied!');
+    if(typeof methods === typeof undefined) methods = ['GET'];
+    if(typeof paths === typeof undefined) paths = [];
+    if(typeof methods === "string") methods = [ methods ];
+    if(typeof paths === "string") paths = [ paths ];
+    this.api = api;
+    this.methods = methods;
+    this.paths = paths;
+  }
+
+  getMethods() {return this.methods;}
+  getPaths() {return this.paths;}
+
+  onMethod(req, res) {
+    //Now that we have a request we need to create a nice wrapper for it, pass
+    //it to our method, and then expect a nice JSON object to send back to the
+    //client.
+    let request = new APIRequest(this, req, res);
+    request.process();
+  }
+}
+
+module.exports = APIHandler;

private/api/APIRequest.js

@@ -0,0 +1,227 @@
+// Copyright (c) 2018 Dominic Masters
+//
+// MIT License
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+class APIRequest {
+  constructor(handler, req, res) {
+    this.handler = handler;
+    this.req = req;
+    this.res = res;
+  }
+
+  getHandler() {return this.handler;}
+  getRequest() {return this.req;}
+  getResponse() {return this.res;}
+  getHandleFunction() {return this.getHandler().handle;}
+
+  //Some nice shorthands
+  getAPI() {return this.getHandler().getAPI();}
+  getConfig() {return this.getAPI().getConfig();}
+  getServer() {return this.getAPI().getServer();}
+  getExpress() {return this.getAPI().getExpress();}
+  getApp() {return this.getAPI().getApp();}
+
+  //Our process method
+  process() {
+    if(typeof this.processPromise !== typeof undefined) return;//Woops, already processing?
+    this.processPromise = this.processHandler();
+    this.processPromise.then(this.onResult.bind(this)).catch(this.onError.bind(this));
+  }
+
+  async processHandler() {
+    //Awesome, now we have a nice async function!
+    let response = { ok: false };
+    if(typeof this.getHandleFunction() === "function") {
+      try {
+        response = await this.getHandleFunction()(this);
+      } catch(e) {
+        response = { ok: false, data: ( e.message || "Unknown Error Occured" ) };
+      }
+    }
+
+    if(typeof response.data === typeof undefined || typeof response.ok === typeof undefined) {
+      throw new Error("Invalid response object.");
+    }
+
+    if(response.ok !== true) {
+      response.code = typeof response.ok === "number" ? response.ok : 500;
+    }
+
+    this.res.status(response.code || 200).json(response.data);
+  }
+
+  onResult(result) {
+  }
+
+  onError(error) {
+    this.res.status(500).json("An unexpected error occured");
+  }
+
+  //Some really nice API handlers
+  get(key) {
+    if(typeof this.req === typeof undefined) return null;
+    let data = this.req.body ||  {};
+    if(this.req.method == "GET") {
+      data = this.req.query || {};
+    }
+    if(typeof data === typeof undefined) return null;
+    if(typeof key === typeof undefined) return data;
+
+    return this.getRecursive(key.split("."), data);
+  }
+
+  getRecursive(key_array, data_obj) {
+    if(typeof data_obj === typeof undefined) return null;
+
+    let k = key_array[0];
+    let o = data_obj[k];
+    if(typeof o === typeof undefined) return null;
+
+    //Awesome
+    if(key_array.length > 1) {
+      if(typeof o !== typeof {}) return null;
+      key_array.shift();
+      return this.getRecursive(key_array, o);
+    }
+    return o;
+  }
+
+  getInteger(key) {
+    if(!this.hasInteger(key)) throw new Error("Invalid Data Type!");
+    return parseInt(this.get(key));
+  }
+
+  getDouble(key) {
+    if(!this.hasDouble(key)) throw new Error("Invalid Data Type!");
+    return parseFloat(this.get(key));
+  }
+
+  getBool(key) {
+    if(!this.hasBool(key)) throw new Error("Invalid Type");
+    let t = this.get(key);
+    if(t === true || t === "true" || t === 1 || t === "1") return true;
+    return false;
+  }
+
+  getString(key, maxLength, allowBlank) {
+    if(typeof allowBlank === typeof undefined) allowBlank = true;
+    if(!this.hasString(key, maxLength, allowBlank)) throw new Error("Missing Data");
+    return this.get(key)+"";
+  }
+
+  has(key) {
+    if(typeof this.req === typeof undefined) return false;
+    if(typeof this.req === typeof undefined) return false;
+    let data = this.req.body ||  {};
+    if(this.req.method == "GET") {
+      data = this.req.query || {};
+    }
+    if(typeof data === typeof undefined) return false;
+    if(typeof key === typeof undefined) return data;
+    return this.hasRecursive(key.split("."), data);
+  }
+
+  hasRecursive(key_array, data_obj) {
+    if(typeof data_obj === typeof undefined) return false;
+
+    let k = key_array[0];
+    let o = data_obj[k];
+    if(typeof o === typeof undefined) return false;
+    //Awesome
+    if(key_array.length > 1) {
+      if(typeof o !== typeof {}) return false;
+      key_array.shift();
+      return this.hasRecursive(key_array, o);
+    }
+    return true;
+  }
+
+  hasInteger(key) {
+    if(!this.has(key)) return false;
+    let t = parseInt(this.get(key));
+    if(typeof t !== "number" || isNaN(t) || !isFinite(t)) return false;
+    let tf = parseFloat(this.get(key));
+    if(tf !== t) return false;
+    return true;
+  }
+
+  hasDouble(key) {
+    if(!this.has(key)) return false;
+    let t = parseFloat(this.get(key));
+    return typeof t === typeof 1.00 && !isNaN(t) && isFinite(t);
+  }
+
+  hasBool(bool) {
+    if(!this.has(bool)) return false;
+    let t = this.get(bool);
+    return (
+      t === true || t === false ||
+      t === "true" || t === "false" ||
+      t === 1 || t === 0 ||
+      t === "1" || t === "0"
+    );
+  }
+
+  hasString(str, maxLength, allowBlank) {
+    if(typeof maxLength === typeof undefined) throw new Error("MaxLength check missing.");
+    if(typeof allowBlank === typeof undefined) allowBlank = false;
+    if(!this.has(str)) return false;
+    let t = this.get(str);
+    let v = typeof t === typeof "" && t.length <= maxLength;
+    if(!v) return false;
+    if(!allowBlank) {
+      t = t.replace(/\s/g, "");
+      if(!t.length) return false;
+    }
+    return typeof t === typeof "" && (t.length <= maxLength ? true : false);
+  }
+
+  //Files (if supported)
+  hasFiles() {
+    if(typeof this.req === typeof undefined) return false;
+    if(typeof this.req.files === typeof undefined) return false;
+    if(!this.req || !this.req.files) return false;
+    return Object.keys(this.req.files).length ? true : false;
+  }
+
+  hasFile(name) {
+    if(!this.hasFiles()) return false;
+    if(typeof this.req.files[name] === typeof undefined) return false;
+    return true;
+  }
+
+  getFile(name) {
+    if(!this.hasFile(name)) return false;
+    return this.req.files[name];
+  }
+
+  //Headers
+  hasHeader(header) {
+    return this.req && typeof this.req.get(header) !== typeof undefined
+  }
+
+  getHeader(header) {
+    return this.req.get(header);
+  }
+}
+
+module.exports = APIRequest;

private/api/methods/TestMethod.js

@@ -0,0 +1,39 @@
+// Copyright (c) 2018 Dominic Masters
+//
+// MIT License
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+const APIHandler = require('./../APIHandler');
+
+class TestMethod extends APIHandler {
+  constructor(api) {
+    super(api, 'GET', '/test');
+  }
+
+  handle(request) {
+    return {
+      ok: true,
+      data: "Hello World"
+    };
+  }
+}
+
+module.exports = TestMethod;

private/app/App.js

@@ -40,6 +40,8 @@ class App {
   getConfig()   { return this.config; }
   getDatabase() { return this.db; }
   getPublicDirectory() { return PUBLIC_PATH; }
+  getServer() { return this.server; }
+  getAPI() { return this.getServer().getAPI(); }
 
   //Primary Functions
   async start() {
@@ -81,9 +83,7 @@ class App {
   }
 
   //Database Specific
-  onDatabaseConnected(db) {
+  onDatabaseConnected(db) { }
-
-  }
 }
 
 module.exports = App;

private/index.js

@@ -1,3 +1,4 @@
+'use strict';
 // Copyright (c) 2018 Dominic Masters
 //
 // MIT License
@@ -22,7 +23,9 @@
 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 //Import
-const App = require('./app/App');
+const
+  App = require('./app/App')
+;
 
 //Create
 const app = new App();

private/server/Server.js

@@ -30,7 +30,8 @@ const
   fs = require('fs'),
   path = require('path'),
   webpack = require('webpack'),
-  CompilerOptions = require('./WebpackCompilerOptions')
+  CompilerOptions = require('./WebpackCompilerOptions'),
+  API = require('./../api/API')
 ;
 
 //Constants
@@ -59,8 +60,6 @@ class Server {
       process.env.PORT ||
       80
     ;
-    this.apiBase = app.getConfig().getValueOf("apiBase") || "/API/";
-    if(!this.apiBase.endsWith("/")) this.apiBase += "/";
 
     this.useHTTPS = app.getConfig().getValueOf("ssl") && app.getConfig().getValueOf("ssl.enable")
     if(this.useHTTPS) {
@@ -96,8 +95,14 @@ class Server {
     this.express.use(bodyParser.urlencoded({
       extended: true
     }));
+
+    //Serve Static Files
     this.express.use(express.static('./dist'));
 
+    //API Handler
+    this.api = new API(this);
+    this.api.loadHandlers();
+
     //Finally our catcher for all other enquiries
     this.express.get('*', this.onGetRequest.bind(this));
 
@@ -123,12 +128,13 @@ class Server {
   getConfig() {return this.config;}
   getIP() {return this.ip; }
   getPort() {return this.port;}
-  getAPIBase() {return this.apiBase;}
   isHTTPS() {return this.useHTTPS;}
   getHTTPSPort() {return this.portHTTPS;}
   getKey() {return this.key;}
   getCertificate() {return this.cert;}
   getLandingFile() {return path.join(this.app.getPublicDirectory(), LANDING_FILE);}
+  getExpress() {return this.express;}
+  getAPI() {return this.api;}
 
   isRunning() {
     if(typeof this.http !== typeof undefined) {