Merge branch 'release/1.7.0'

Author: hirsch88

README.md

@@ -70,6 +70,13 @@ All script are defined in the package.json file, but the most important ones are
 ### Console
 * To run your own created cli script enter `npm run console <command-name>`
 
+## IoC
+Our IoC automatically looks through the `controllers`, `listeners` , `middlewares`, `services`,
+`repositories` and `models` for files to bind to our IoC - Container. So you have nothing to do.
+
+However it is very important to keep the naming, because otherwise our IoC will not find your
+created file.
+
 ## Using the debugger in VS Code
 Just set a breakpoint and hit `F5` in your Visual Studio Code.
 
@@ -92,15 +99,17 @@ The route prefix is by default `/api/v1`, but you can change this in the .env.ex
 | **src/**                      | Source-Files |
 | **src/api/controllers/**      | REST-API - Controllers |
 | **src/api/exceptions/**       | Exceptions like 404 NotFound |
+| **src/api/listeners/**        | Event-Listeners |
 | **src/api/middlewares/**      | Express Middlewares like populateUser |
 | **src/api/models/**           | Bookshelf Models |
 | **src/api/repositories/**     | Repository Layer |
 | **src/api/requests/**         | Request Bodys with Validations |
 | **src/api/services/**         | Service Layer |
 | **src/api/** swagger.json     | Swagger Documentation |
 | **src/console/**              | Command Line scripts |
+| **src/config/**               | Configurations like database or logger |
 | **src/constants/**            | Global Constants |
-| **src/core/**                 | All the libraries configurations and our small framework |
+| **src/core/**                 | Our small framework |
 | **src/database/factories/**   | Model Factories to generate database records |
 | **src/database/migrations/**  | Migrations scripts to build up our database schema |
 | **src/database/seeds/**       | Seed scripts to fake some data into our database |

package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-typescript-boilerplate",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "A delightful way to building a RESTful API with NodeJs & TypeScript",
   "main": "src/index.ts",
   "scripts": {
@@ -61,6 +61,7 @@
     "@types/dotenv": "^4.0.0",
     "@types/express": "^4.0.35",
     "@types/faker": "^4.1.0",
+    "@types/glob": "^5.0.30",
     "@types/helmet": "0.0.35",
     "@types/jest": "^19.2.3",
     "@types/jsonwebtoken": "^7.2.0",
@@ -85,6 +86,7 @@
     "express": "^4.15.3",
     "express-status-monitor": "^0.1.9",
     "faker": "^4.1.0",
+    "glob": "^7.1.2",
     "helmet": "^3.6.1",
     "inversify": "^4.1.1",
     "inversify-express-utils": "^3.5.1",
@@ -122,7 +124,8 @@
       "js",
       "json"
     ],
-    "testEnvironment": "node"
+    "testEnvironment": "node",
+    "setupTestFrameworkScriptFile": "./test/unit/lib/setup.ts"
   },
   "license": "MIT"
 }

src/api/controllers/UserController.ts

@@ -1,17 +1,27 @@
-import { injectable, inject, named } from 'inversify';
+/**
+ * UserController
+ * ----------------------------------------
+ *
+ * This controller is in charge of the user resource and should
+ * provide all crud actions.
+ */
+
+import { inject, named } from 'inversify';
 import { Controller, Get, Post, Put, Delete, RequestParam, RequestBody, Response, Request } from 'inversify-express-utils';
 import { my } from 'my-express';
-import { UserService } from '../services/UsersService';
+import { UserService } from '../services/UserService';
 import { Types } from '../../constants/Types';
-import { Service } from '../../constants/Targets';
-import { authenticate, populateUser } from '../middlewares';
+import { Service, Middleware } from '../../constants/Targets';
+import { AuthenticateMiddleware } from '../middlewares/AuthenticateMiddleware';
+import { PopulateUserMiddleware } from '../middlewares/PopulateUserMiddleware';
+import { ioc } from '../../core/IoC';
 
-/**
- * UserController is in charge of the user resource and should
- * provide all crud actions.
- */
-@injectable()
-@Controller('/user', authenticate)
+// Get middlewares
+const authenticate = ioc.Container.getNamed<AuthenticateMiddleware>(Types.Middleware, Middleware.AuthenticateMiddleware);
+const populateUser = ioc.Container.getNamed<PopulateUserMiddleware>(Types.Middleware, Middleware.PopulateUserMiddleware);
+
+
+@Controller('/user', authenticate.use)
 export class UserController {
 
     constructor( @inject(Types.Service) @named(Service.UserService) private userService: UserService) { }
@@ -28,7 +38,7 @@ export class UserController {
         return res.created(user.toJSON());
     }
 
-    @Get('/me', populateUser)
+    @Get('/me', populateUser.use)
     public async findMe( @Request() req: my.Request, @Response() res: my.Response): Promise<any> {
         return res.found(req.user);
     }

src/api/controllers/auth/AuthController.ts

@@ -0,0 +1,8 @@
+
+
+export namespace auth {
+
+    export class AuthController {
+
+    }
+}

src/api/listeners/UserAuthenticatedListener.ts

@@ -0,0 +1,23 @@
+import { inject, named } from 'inversify';
+import { Types } from '../../constants/Types';
+import { Core } from '../../constants/Targets';
+import { Log } from '../../core/log/';
+
+
+export class UserAuthenticatedListener {
+
+    static Event = Symbol('UserAuthenticatedListener');
+
+    public log: Log;
+
+    constructor(
+        @inject(Types.Core) @named(Core.Log) Logger: typeof Log
+    ) {
+        this.log = new Logger('api:listeners:UserAuthenticatedListener');
+    }
+
+    public async run(user: any): Promise<void> {
+        this.log.info('Receive event UserAuthenticatedListener', user);
+    }
+
+}

src/api/listeners/UserCreatedListener.ts

@@ -0,0 +1,26 @@
+import { inject, named } from 'inversify';
+import { Types } from '../../constants/Types';
+import { Core } from '../../constants/Targets';
+import { Log } from '../../core/log/';
+
+const log = new Log('api:listeners:UserCreated');
+
+
+export class UserCreatedListener {
+
+    static Event = Symbol('UserCreated');
+
+    public log: Log;
+
+    constructor(
+        @inject(Types.Core) @named(Core.Log) Logger: typeof Log
+    ) {
+        this.log = new Logger('api:listeners:UserCreatedListener');
+    }
+
+    public async run(user: any): Promise<void> {
+        log.info('Receive event UserCreated', user);
+    }
+
+}
+

src/api/middlewares/AuthenticateMiddleware.ts

@@ -0,0 +1,74 @@
+import { inject, named } from 'inversify';
+import * as Request from 'request';
+import { my } from 'my-express';
+import { Log } from '../../core/log';
+import { Types } from '../../constants/Types';
+import { Lib, Core } from '../../constants/Targets';
+import { events } from '../../core/api/events';
+import { UserAuthenticatedListener } from '../listeners/UserAuthenticatedListener';
+
+
+export class AuthenticateMiddleware {
+
+    public log: Log;
+
+    constructor(
+        @inject(Types.Core) @named(Core.Log) Logger: typeof Log,
+        @inject(Types.Lib) @named(Lib.Request) private request: typeof Request
+    ) {
+        this.log = new Logger('api:middleware:AuthenticateMiddleware');
+    }
+
+
+    public use = (req: my.Request, res: my.Response, next: my.NextFunction): void => {
+        const token = this.getToken(req);
+
+        if (token === null) {
+            this.log.warn('No token given');
+            return res.failed(403, 'You are not allowed to request this resource!');
+        }
+        this.log.debug('Token is provided');
+
+        // Request user info at auth0 with the provided token
+        this.request({
+            method: 'POST',
+            url: `${process.env.AUTH0_HOST}/tokeninfo`,
+            form: {
+                id_token: token
+            }
+        }, (error: any, response: Request.RequestResponse, body: any) => {
+            // Verify if the requests was successful and append user
+            // information to our extended express request object
+            if (!error && response.statusCode === 200) {
+                req.tokeninfo = JSON.parse(body);
+                this.log.info(`Retrieved user ${req.tokeninfo.email}`);
+                events.emit(UserAuthenticatedListener.Event, req.tokeninfo);
+                return next();
+            }
+
+            // Catch auth0 exception and return it as it is
+            this.log.warn(`Could not retrieve the user, because of`, body);
+            let statusCode = 401;
+            if (response && response.statusCode) {
+                statusCode = response.statusCode;
+            } else {
+                this.log.warn('It seems your oauth server is down!');
+            }
+            res.failed(statusCode, body);
+
+        });
+    }
+
+    private getToken(req: my.Request): string | null {
+        const authorization = req.headers.authorization;
+
+        // Retrieve the token form the Authorization header
+        if (authorization && authorization.split(' ')[0] === 'Bearer') {
+            return authorization.split(' ')[1];
+        }
+
+        // No token was provided by the client
+        return null;
+    }
+
+}

src/api/middlewares/PopulateUserMiddleware.ts

@@ -0,0 +1,39 @@
+import { inject, named } from 'inversify';
+import { my } from 'my-express';
+import { Log } from '../../core/log';
+import { UserService } from '../services/UserService';
+import { Types } from '../../constants/Types';
+import { Service, Core } from '../../constants/Targets';
+
+
+export class PopulateUserMiddleware {
+
+    public log: Log;
+
+    constructor(
+        @inject(Types.Core) @named(Core.Log) Logger: typeof Log,
+        @inject(Types.Service) @named(Service.UserService) private userService: UserService
+    ) {
+        this.log = new Logger('api:middleware:PopulateUserMiddleware');
+    }
+
+
+    public use = (req: my.Request, res: my.Response, next: my.NextFunction): void => {
+        // Check if the authenticate middleware was successful
+        if (!req.tokeninfo || !req.tokeninfo.user_id) {
+            return res.failed(400, 'Missing token information!');
+        }
+        // Find user from the token and store him in the request object
+        this.userService.findByUserId(req.tokeninfo.user_id)
+            .then((user) => {
+                req.user = user.toJSON();
+                this.log.debug(`populated user with the id=${req.user.id} to the request object`);
+                next();
+            })
+            .catch((error) => {
+                this.log.warn(`could not populate user to the request object`);
+                next(error);
+            });
+    }
+
+}