Initial commit

Author: jocodev1

.gitignore

@@ -0,0 +1,2 @@
+/node_modules
+/.idea

README.md

@@ -0,0 +1,22 @@
+## Currently In Progress...
+
+# Express JS REST API with JWT Authorization
+
+This is a basic implementation of a REST API using Express JS (NodeJS framework) including JWT authorization.
+
+### Pre-requisites
+
+You must have the following installed:
+* Node.JS
+* MongoDB
+* Postman (optional)
+
+### Getting Started
+
+After cloning / forking this repo, install all dependencies by running:
+
+```sh
+$ npm install
+```
+
+To be continued...

app.js

@@ -0,0 +1,30 @@
+"use strict"
+
+const express       = require('express')
+const bodyParser    = require('body-parser')
+const mongoose      = require('mongoose')
+const config        = require('./config/config')
+const middleware    = require('./src/middleware/_common/header')
+
+// DB Configuration
+mongoose.connect(config.database)
+
+// App Configuration
+const app = module.exports = express()
+
+const Routes        = new (require('./lib/build/routes'))(app)
+const RouteRegister = new (require('./lib/register/routeRegister.js'))()
+
+app.use(middleware.adjustHeaders)
+app.use(bodyParser.urlencoded({extended: true}))
+app.use(bodyParser.json())
+app.set('superSecret', config.secret)
+
+// register route files
+Routes.build(
+  RouteRegister.use('_auth/auth').concat(
+  RouteRegister.use('default')
+))
+
+// app.listen(process.env.PORT || 3000)
+app.listen(3000)

config/config.js

@@ -0,0 +1,25 @@
+module.exports = {
+    secret: 'secret',
+
+    /**
+     * Origins Header Information
+     *
+     * All clients accessing the API should have strict access. Be sure to
+     * explicitly list all client domains for the corresponding environment. 
+     * @type {Object}
+     */
+    prod: {
+      origins: [
+        // 'http://your-prod-domain.com',
+        '*' // NOT SECURE
+      ]
+    },
+    dev: {
+      origins: [
+        // 'http://your-local-domain.com',
+        '*' // NOT SECURE
+      ]
+    },
+    database: 'mongodb://localhost:27017/<mongo-db-name>',
+    version: 'v1.0'
+};

lib/build/routes.js

@@ -0,0 +1,23 @@
+"use strict"
+
+const app = require('../../app')
+
+class Routes {
+  /**
+   * Create new instance of RouteGroup class
+   */
+  constructor (app) {
+    this.app = app
+  }
+
+  /**
+   * Build routes list
+   */
+  build (routeGroups) {
+    routeGroups.forEach(function (routeGroup) {
+      this.app.use(routeGroup.getPrefix(), routeGroup.getExpressRouter())
+    }.bind(this))
+  }
+}
+
+module.exports = Routes

lib/class/routeGroup.js

@@ -0,0 +1,101 @@
+"use strict"
+
+const express = require('express')
+
+class RouteGroup {
+	/**
+	 * Create new instance of RouteGroup class
+	 */
+	constructor (options) {
+		this.expressRouter = express.Router()
+		this.options = Object.assign({
+			prefix: '/',
+			middleware: []
+		}, options ? options : {})
+
+		this.useMiddleware()
+		
+		return this
+	}
+
+	getExpressRouter () {
+		return this.expressRouter
+	}
+
+	useMiddleware () {
+		this.getMiddleware().forEach(function (middleware) {
+			this.expressRouter.use(middleware)
+		}.bind(this))
+	}
+
+	/**
+	 * Get an array of all middleware for route group
+	 */
+	getMiddleware () {
+		return this.options.middleware
+	}
+
+	/**
+	 * Get the prefix for route group
+	 */
+	getPrefix () {
+		return this.options.prefix
+	}
+
+	/**
+	 * Create route with method GET
+	 * @param  {String} route              		Route string
+	 * @param  {Function} controllerFunction 	Callback to be applied to route
+	 * @return {Route}                    		Self
+	 */
+	get (route, controllerFunction) {
+		this.expressRouter.get(route, controllerFunction)
+		return this
+	}
+
+	/**
+	 * Create route with method POST
+	 * @param  {String} route              		Route string
+	 * @param  {Function} controllerFunction 	Callback to be applied to route
+	 * @return {Route}                    		Self
+	 */
+	post (route, controllerFunction) {
+		this.expressRouter.post(route, controllerFunction)
+		return this
+	}
+
+	/**
+	 * Create route with method PUT
+	 * @param  {String} route              		Route string
+	 * @param  {Function} controllerFunction 	Callback to be applied to route
+	 * @return {Route}                    		Self
+	 */
+	put (route, controllerFunction) {
+		this.expressRouter.put(route, controllerFunction)
+		return this
+	}
+
+	/**
+	 * Create route with method PATCH
+	 * @param  {String} route              		Route string
+	 * @param  {Function} controllerFunction 	Callback to be applied to route
+	 * @return {Route}                    		Self
+	 */
+	patch (route, controllerFunction) {
+		this.expressRouter.patch(route, controllerFunction)
+		return this
+	}
+
+	/**
+	 * Create route with method DELETE
+	 * @param  {String} route              		Route string
+	 * @param  {Function} controllerFunction 	Callback to be applied to route
+	 * @return {Route}                    		Self
+	 */
+	delete (route, controllerFunction) {
+		this.expressRouter.delete(route, controllerFunction)
+		return this
+	}
+}
+
+module.exports = RouteGroup

lib/register/_register.js

@@ -0,0 +1,14 @@
+"use strict";
+
+module.exports = class Register {
+
+	default_path () {
+		return '../../src/';
+	}
+
+	use (file_path) {
+		return require(this.default_path() + file_path);
+	}
+
+}
+

lib/register/classRegister.js

@@ -0,0 +1,12 @@
+"use strict";
+
+const Register = require('./_register');
+
+module.exports = class ClassRegister extends Register {
+
+	default_path () {
+		return '../class/';
+	}
+
+}
+

lib/register/controllerRegister.js

@@ -0,0 +1,12 @@
+"use strict";
+
+const Register = require('./_register');
+
+module.exports = class ControllerRegister extends Register {
+
+	default_path () {
+		return '../../src/controllers/';
+	}
+
+}
+

lib/register/middlewareRegister.js

@@ -0,0 +1,12 @@
+"use strict";
+
+const Register = require('./_register');
+
+module.exports = class MiddlewareRegister extends Register {
+
+	default_path () {
+		return '../../src/middleware/';
+	}
+
+}
+

lib/register/modelRegister.js

@@ -0,0 +1,12 @@
+"use strict";
+
+const Register = require('./_register');
+
+module.exports = class ModelRegister extends Register {
+
+	default_path () {
+		return '../../src/models/';
+	}
+
+}
+

lib/register/routeRegister.js

@@ -0,0 +1,12 @@
+"use strict";
+
+const Register = require('./_register');
+
+module.exports = class RouteRegister extends Register {
+
+	default_path () {
+		return '../../src/routes/';
+	}
+
+}
+

package.json

@@ -0,0 +1,22 @@
+{
+  "name": "colls-api",
+  "version": "1.0.0",
+  "description": "A custom Node JS API framework built on top of Express JS.",
+  "main": "app.js",
+  "dependencies": {
+    "app-root-dir": "^1.0.2",
+    "body-parser": "^1.15.2",
+    "cors": "^2.8.1",
+    "express": "^4.14.0",
+    "jsonwebtoken": "^7.1.9",
+    "mongodb": "^2.2.10",
+    "mongoose": "^4.6.1",
+    "node-env-file": "^0.1.8"
+  },
+  "devDependencies": {},
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Collier Devlin",
+  "license": "MIT"
+}

src/controllers/_auth/loginController.js

@@ -0,0 +1,40 @@
+const app		= require('../../../app');
+const User 		= require('../../models/user');
+const jwt    	= require('jsonwebtoken');
+
+module.exports = {
+	/**
+	  * Login and authenicate user. Will return JWT token if user is authorized.
+	  */
+    store: function (req, res) {
+		User.findOne({
+		  username: req.body.username
+		}, function(err, user) {
+		  if (err) throw err;
+
+		  if (!user) {
+		    res.json({ success: false, message: 'Authentication failed. User not found.' });
+		  } else if (user) {
+
+		      if (user.password != req.body.password) {
+		        res.json({ success: false, message: 'Authentication failed. Wrong password.' });
+		      } else {
+
+		        var token = jwt.sign(user, app.get('superSecret'), {
+		          expiresIn: 1440 // expires in 24 hours
+		        });
+
+		        res.json({
+		          success: true,
+		          message: 'Enjoy your token!',
+		          token: token,
+		          user: {
+		            id: user._id,
+		            username: user.username
+		          }
+		        });
+		      }
+		  }
+		});
+    }
+};