Update node modules and added v2 apis

Author: avsingh-systango

README.md

@@ -11,13 +11,14 @@ This project covers basic necessities of most APIs.
 * http/2 support for websites and apis
 * Doc generation with apidoc
 * linting using standard
+* Contains two versions of API
 
 Please note, if you are planning to use this boilerplate for creating a web application then the 'https' protocol should be used to access its pages.
 
 Visit `https://localhost:3000/` to access the root page.
 
 ## Requirements
-* node > v7.8.0
+* node > v8.9.4
 * MongoDB
 
 ## Installation
@@ -62,9 +63,18 @@ git clone https://github.com/SystangoTechnologies/Koach.git
 │   ├── index.js             # Config entrypoint
 │   └── passport.js          # Passportjs config of strategies
 ├── src                      # Source code
-│   ├── modules
-│   │   ├── controller.js    # Module-specific controllers
-│   │   └── router.js        # Router definitions for module
+│   ├── modules              # Module-specific controllers
+│   │    ├── common          # Contains common modules
+│   │    │   ├─── home              
+│   │    │   └─ index.js
+│   │    ├── v1              # Version 1 of APIs
+│   │    │   ├─ Auth
+│   │    │   ├─ User   
+│   │    │   └─ index.js            
+│   │    └─── v2             # Version 2 of APIs
+│   │         ├─ Auth
+│   │         ├─ User   
+│   │         └─ index.js
 │   ├── models               # Mongoose models
 │   └── middleware           # Custom middleware
 │       └── validators       # Validation middleware
@@ -88,7 +98,7 @@ Visit [https://localhost:3000/swagger](https://localhost:3000/swagger) to view S
 
 ## Performance Comparison
 The environment for the test caes are following-
-* Node Version: **7.9.0**
+* Node Version: **8.9.4**
 * Number of Users: **1500**
 * Ramp-up Period: **300 seconds**
 * Loop Count: **100**
@@ -98,6 +108,7 @@ The environment for the test caes are following-
 
 ## Contributors
 [Arpit Khandelwal](https://github.com/arpit-systango)
+[Anurag Vikram Singh](https://github.com/avsingh-systango)
 
 ## License
 MIT.

bin/server.js

@@ -51,8 +51,12 @@ app.use(passport.initialize())
 app.use(passport.session())
 
 // Using module wise routing
-const modules = require('../src/modules')
-modules(app)
+const modules1 = require('../src/modules/v1')
+const modules2 = require('../src/modules/v2')
+const common = require('../src/modules/common')
+modules1(app)
+modules2(app)
+common(app)
 
 // Show swagger only if the NODE_ENV is development
 if (!process.env.NODE_ENV || process.env.NODE_ENV === 'devlopment') {
@@ -61,7 +65,7 @@ if (!process.env.NODE_ENV || process.env.NODE_ENV === 'devlopment') {
 
 // Using http2 to work with http/2 instead of http/1.x
 http2
-  .createServer(options, app.callback())
+  .createSecureServer(options, app.callback())
   .listen(config.port, () => {
     console.log(`Server started on ${config.port}`)
   })

package.json

@@ -32,48 +32,48 @@
     "url": "https://github.com/SystangoTechnologies/Koach.git"
   },
   "dependencies": {
-    "apidoc": "^0.17.5",
-    "babel-core": "^6.5.1",
-    "babel-polyfill": "^6.5.0",
+    "apidoc": "^0.17.6",
+    "babel-core": "^6.26.0",
+    "babel-polyfill": "^6.26.0",
     "babel-preset-es2015-node5": "^1.2.0",
-    "babel-preset-stage-0": "^6.5.0",
-    "bcrypt": "^1.0.2",
-    "eslint-plugin-import": "^2.6.1",
-    "eslint-plugin-node": "^5.1.0",
-    "glob": "^7.0.0",
+    "babel-preset-stage-0": "^6.24.1",
+    "bcrypt": "^1.0.3",
+    "eslint-plugin-import": "^2.9.0",
+    "eslint-plugin-node": "^6.0.0",
+    "glob": "^7.1.2",
     "gulp": "^3.9.1",
-    "gulp-eslint": "^4.0.0",
-    "gulp-watch": "^4.3.11",
-    "http2": "^3.3.6",
-    "jsonwebtoken": "^7.1.9",
-    "koa": "^2.2.0",
+    "gulp-eslint": "^4.0.2",
+    "gulp-watch": "^5.0.0",
+    "http2": "^3.3.7",
+    "jsonwebtoken": "^8.1.1",
+    "koa": "^2.5.0",
     "koa-bodyparser": "^4.2.0",
     "koa-convert": "^1.2.0",
-    "koa-generic-session": "^1.10.1",
-    "koa-helmet": "^3.1.0",
-    "koa-logger": "^2.0.0",
+    "koa-generic-session": "^2.0.1",
+    "koa-helmet": "^3.3.0",
+    "koa-logger": "^3.1.0",
     "koa-mount": "^3.0.0",
-    "koa-passport": "^3.0.0",
-    "koa-router": "^7.0.1",
-    "koa-static": "^3.0.0",
-    "mongoose": "^4.4.3",
+    "koa-passport": "^4.0.1",
+    "koa-router": "^7.4.0",
+    "koa-static": "^4.0.2",
+    "mongoose": "^5.0.6",
     "passport-local": "^1.0.0",
-    "pm2": "^2.5.0",
-    "require-dir": "^0.3.2"
+    "pm2": "^2.10.1",
+    "require-dir": "^1.0.0"
   },
   "devDependencies": {
-    "babel-eslint": "^7.2.2",
-    "babel-register": "^6.5.1",
-    "chai": "^3.5.0",
-    "dotenv": "^4.0.0",
-    "eslint": "^3.4.0",
-    "eslint-config-standard": "^10.2.1",
-    "eslint-plugin-promise": "^3.5.0",
+    "babel-eslint": "^8.2.2",
+    "babel-register": "^6.26.0",
+    "chai": "^4.1.2",
+    "dotenv": "^5.0.0",
+    "eslint": "^4.18.1",
+    "eslint-config-standard": "^11.0.0",
+    "eslint-plugin-promise": "^3.6.0",
     "eslint-plugin-standard": "^3.0.1",
     "gulp-nodemon": "^2.2.1",
     "gulp-yaml": "^1.0.1",
-    "mocha": "^3.0.2",
-    "nodemon": "^1.8.1",
+    "mocha": "^5.0.1",
+    "nodemon": "^1.15.1",
     "supertest": "^3.0.0"
   }
 }

src/modules/home/controller.js renamed to src/modules/common/home/controller.js

@@ -6,6 +6,7 @@ exports = module.exports = function initModules (app) {
     if (err) { throw err }
 
     matches.forEach((mod) => {
+      console.log(`${mod}/router`)
       const router = require(`${mod}/router`)
 
       const routes = router.default
@@ -14,6 +15,7 @@ exports = module.exports = function initModules (app) {
 
       routes.forEach((config) => {
         const {
+
           method = '',
           route = '',
           handlers = []

src/modules/home/router.js renamed to src/modules/common/home/router.js

@@ -0,0 +1,71 @@
+import passport from 'koa-passport'
+
+/**
+ * @apiDefine TokenError
+ * @apiError Unauthorized Invalid JWT token
+ *
+ * @apiErrorExample {json} Unauthorized-Error:
+ *     HTTP/1.1 401 Unauthorized
+ *     {
+ *       "status": 401,
+ *       "error": "Unauthorized"
+ *     }
+ */
+
+/**
+ * @api {post} /v1/auth Authenticate user
+ * @apiVersion 1.0.0
+ * @apiName AuthUser
+ * @apiGroup Auth
+ *
+ * @apiParam {String} username  User username.
+ * @apiParam {String} password  User password.
+ *
+ * @apiExample Example usage:
+ * curl -H "Content-Type: application/json" -X POST -d '{ "username": "johndoe, "password": "foo" }' localhost:3000/v1/auth
+ *
+ * @apiSuccess {Object}   user           User object
+ * @apiSuccess {ObjectId} user._id       User id
+ * @apiSuccess {String}   user.name      User name
+ * @apiSuccess {String}   user.username  User username
+ * @apiSuccess {String}   token          Encoded JWT
+ *
+ * @apiSuccessExample {json} Success-Response:
+ *     HTTP/1.1 200 OK
+ *     {
+ *       "user": {
+ *          "_id": "56bd1da600a526986cf65c80"
+ *          "username": "johndoe"
+ *        },
+ *       "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ"
+ *     }
+ *
+ * @apiError Unauthorized Incorrect credentials
+ *
+ * @apiErrorExample {json} Error-Response:
+ *     HTTP/1.1 401 Unauthorized
+ *     {
+ *       "status": 401,
+ *       "error": "Unauthorized"
+ *     }
+ */
+
+export async function authUser (ctx, next) {
+  console.log("authUser")
+  return passport.authenticate('local', (err, user) => {
+    if (err || !user) {
+      ctx.throw(401)
+    }
+
+    const token = user.generateToken()
+
+    const response = user.toJSON()
+
+    delete response.password
+
+    ctx.body = {
+      token,
+      user: response
+    }
+  })(ctx, next)
+}

src/modules/index.js renamed to src/modules/common/index.js

@@ -0,0 +1,34 @@
+import glob from 'glob'
+import Router from 'koa-router'
+
+exports = module.exports = function initModules (app) {
+  glob(`${__dirname}/*`, { ignore: '**/index.js' }, (err, matches) => {
+    if (err) { throw err }
+
+    matches.forEach((mod) => {
+      const router = require(`${mod}/router`)
+
+      const routes = router.default
+      const baseUrl = router.baseUrl
+      const instance = new Router({ prefix: '/v1' + baseUrl })
+
+      routes.forEach((config) => {
+        const {
+          method = '',
+          route = '',
+          handlers = []
+        } = config
+
+        const lastHandler = handlers.pop()
+
+        instance[method.toLowerCase()](route, ...handlers, async function (ctx) {
+          await lastHandler(ctx)
+        })
+
+        app
+          .use(instance.routes())
+          .use(instance.allowedMethods())
+      })
+    })
+  })
+}

src/modules/v1/auth/controller.js

@@ -1,14 +1,14 @@
-import User from '../../models/users'
+import User from '../../../models/users'
 
 /**
- * @api {post} /users Create a new user
+ * @api {post} /v1/users Create a new user
  * @apiPermission
  * @apiVersion 1.0.0
  * @apiName CreateUser
  * @apiGroup Users
  *
  * @apiExample Example usage:
- * curl -H "Content-Type: application/json" -X POST -d '{ "user": { "username": "johndoe", "password": "secretpasas" } }' localhost:5000/users
+ * curl -H "Content-Type: application/json" -X POST -d '{ "user": { "username": "johndoe", "password": "secretpasas" } }' localhost:3000/v1/users
  *
  * @apiParam {Object} user          User object (required)
  * @apiParam {String} user.username Username.
@@ -58,14 +58,14 @@ export async function createUser (ctx) {
 }
 
 /**
- * @api {get} /users Get all users
+ * @api {get} /v1/users Get all users
  * @apiPermission user
  * @apiVersion 1.0.0
  * @apiName GetUsers
  * @apiGroup Users
  *
  * @apiExample Example usage:
- * curl -H "Content-Type: application/json" -X GET localhost:5000/users
+ * curl -H "Content-Type: application/json" -X GET localhost:3000/v1/users
  *
  * @apiSuccess {Object[]} users           Array of user objects
  * @apiSuccess {ObjectId} users._id       User id
@@ -90,14 +90,14 @@ export async function getUsers (ctx) {
 }
 
 /**
- * @api {get} /users/:id Get user by id
+ * @api {get} /v1/users/:id Get user by id
  * @apiPermission user
  * @apiVersion 1.0.0
  * @apiName GetUser
  * @apiGroup Users
  *
  * @apiExample Example usage:
- * curl -H "Content-Type: application/json" -X GET localhost:5000/users/56bd1da600a526986cf65c80
+ * curl -H "Content-Type: application/json" -X GET localhost:3000/v1/users/56bd1da600a526986cf65c80
  *
  * @apiSuccess {Object}   users           User object
  * @apiSuccess {ObjectId} users._id       User id
@@ -138,14 +138,14 @@ export async function getUser (ctx, next) {
 }
 
 /**
- * @api {put} /users/:id Update a user
+ * @api {put} /v1/users/:id Update a user
  * @apiPermission
  * @apiVersion 1.0.0
  * @apiName UpdateUser
  * @apiGroup Users
  *
  * @apiExample Example usage:
- * curl -H "Content-Type: application/json" -X PUT -d '{ "user": { "name": "Cool new Name" } }' localhost:5000/users/56bd1da600a526986cf65c80
+ * curl -H "Content-Type: application/json" -X PUT -d '{ "user": { "name": "Cool new Name" } }' localhost:3000/v1/users/56bd1da600a526986cf65c80
  *
  * @apiParam {Object} user          User object (required)
  * @apiParam {String} user.name     Name.
@@ -190,14 +190,14 @@ export async function updateUser (ctx) {
 }
 
 /**
- * @api {delete} /users/:id Delete a user
+ * @api {delete} /v1/users/:id Delete a user
  * @apiPermission
  * @apiVersion 1.0.0
  * @apiName DeleteUser
  * @apiGroup Users
  *
  * @apiExample Example usage:
- * curl -H "Content-Type: application/json" -X DELETE localhost:5000/users/56bd1da600a526986cf65c80
+ * curl -H "Content-Type: application/json" -X DELETE localhost:3000/v1/users/56bd1da600a526986cf65c80
  *
  * @apiSuccess {StatusCode} 200
  *