create new config area and update documentations

Author: hirsch88

src/api/controllers/UserController.ts

@@ -1,13 +1,11 @@
-import { injectable, inject } from 'inversify';
+import { injectable, inject, named } from 'inversify';
 import { Controller, Get, Post, Put, Delete, RequestParam, RequestBody, Response, Request } from 'inversify-express-utils';
 import { my } from 'my-express';
-import { Log } from '../../core/log';
 import { UserService } from '../services/UsersService';
 import { Types } from '../../constants/Types';
+import { Service } from '../../constants/Targets';
 import { authenticate, populateUser } from '../middlewares';
 
-const log = new Log('api:ctrl.UserController');
-
 /**
  * UserController is in charge of the user resource and should
  * provide all crud actions.
@@ -16,45 +14,39 @@ const log = new Log('api:ctrl.UserController');
 @Controller('/user', authenticate)
 export class UserController {
 
-    constructor( @inject(Types.UserService) private userService: UserService) { }
+    constructor( @inject(Types.Service) @named(Service.UserService) private userService: UserService) { }
 
     @Get('/')
     public async findAll( @Response() res: my.Response): Promise<any> {
-        log.debug('findAll');
         const users = await this.userService.findAll();
         return res.found(users.toJSON());
     }
 
     @Post('/')
     public async create( @Response() res: my.Response, @RequestBody() body: any): Promise<any> {
-        log.debug('create ', body);
         const user = await this.userService.create(body);
         return res.created(user.toJSON());
     }
 
     @Get('/me', populateUser)
     public async findMe( @Request() req: my.Request, @Response() res: my.Response): Promise<any> {
-        log.debug('findMe');
         return res.found(req.user);
     }
 
     @Get('/:id')
     public async findOne( @Response() res: my.Response, @RequestParam('id') id: string): Promise<any> {
-        log.debug('findOne ', id);
         const user = await this.userService.findOne(parseInt(id, 10));
         return res.found(user.toJSON());
     }
 
     @Put('/:id')
     public async update( @Response() res: my.Response, @RequestParam('id') id: string, @RequestBody() body: any): Promise<any> {
-        log.debug('update ', body);
         const user = await this.userService.update(parseInt(id, 10), body);
         return res.updated(user.toJSON());
     }
 
     @Delete('/:id')
     public async destroy( @Response() res: my.Response, @RequestParam('id') id: string): Promise<any> {
-        log.debug('destroy ', id);
         await this.userService.destroy(parseInt(id, 10));
         return res.destroyed();
     }

src/api/middlewares/authenticate.ts

@@ -2,8 +2,6 @@ import { RequestAPI, RequiredUriUrl, Options, Request, RequestResponse } from 'r
 import { my } from 'my-express';
 import { Log } from '../../core/log';
 
-// const log = new Log('api:middleware.authenticate');
-
 /**
  * authenticate middleware
  * -----------------------

src/api/middlewares/index.ts

@@ -1,19 +1,22 @@
+/**
+ * Middlewares
+ * ------------------------------------
+ * We build them up here so we can easily use them in the controllers and
+ * also be able to test the middlewares without any big effort.
+ */
+
 import * as request from 'request';
 import container from '../../container';
 import { Log } from '../../core/log';
 import { Types } from '../../constants/Types';
+import { Service } from '../../constants/Targets';
 import { UserService } from '../services/UsersService';
 
 import { authenticate as Authenticate } from './authenticate';
 import { populateUser as PopulateUser } from './populateUser';
 
+const logPrefix = 'api:middleware';
 
-/**
- * Middlewares
- * ------------------------------------
- * We build them up here so we can easily use them in the controllers and
- * also be able to test the middlewares without any big effort.
- */
-export const authenticate = Authenticate(request, new Log('api:middleware.authenticate'));
-export const populateUser = PopulateUser(() => container.get<UserService>(Types.UserService), new Log('api:middleware.populateUser'));
 
+export const authenticate = Authenticate(request, new Log(`${logPrefix}:authenticate`));
+export const populateUser = PopulateUser(() => container.getNamed<UserService>(Types.Service, Service.UserService), new Log(`${logPrefix}:populateUser`));

src/api/middlewares/populateUser.ts

@@ -4,8 +4,6 @@ import { my } from 'my-express';
 import { Log } from '../../core/log';
 import { UserService } from '../services/UsersService';
 
-// const log = new Log('api:middleware.populateUser');
-
 /**
  * populateUser middleware
  * -----------------------
@@ -18,11 +16,11 @@ import { UserService } from '../services/UsersService';
  */
 export const populateUser = (lazyUserService: () => UserService, log: Log) =>
     (req: my.Request, res: my.Response, next: my.NextFunction) => {
-
+        // 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
         const userService = lazyUserService();
         userService.findByUserId(req.tokeninfo.user_id)
             .then((user) => {

src/api/models/User.ts

@@ -1,4 +1,4 @@
-import { Bookshelf } from '../../core/Database';
+import { Bookshelf } from '../../config/Database';
 import { Tables } from '../../constants/Tables';
 
 /**
@@ -51,6 +51,9 @@ export class User extends Bookshelf.Model<User> {
     public get CreatedAt(): Date { return this.get('createdAt'); }
     public set CreatedAt(value: Date) { this.set('createdAt', value); }
 
+    /**
+     * Helper methods
+     */
     public fullName(): string {
         return this.FirstName + ' ' + this.LastName;
     }

src/api/requests/UserCreateRequest.ts

@@ -23,7 +23,6 @@ export class UserCreateRequest extends RequestBody {
     email: string;
 
     picture: string;
-
     auth0UserId: string;
 
 }

src/api/requests/UserUpdateRequest.ts

@@ -27,6 +27,10 @@ export class UserUpdateRequest extends RequestBody {
     @IsNotEmpty()
     auth0UserId: string;
 
+    /**
+     * We override the validate method so we can skip the missing
+     * properties.
+     */
     public async validate(): Promise<void> {
         return super.validate(true);
     }

src/api/services/UsersService.ts

@@ -26,7 +26,7 @@ const log = new Log('api:services:UserService');
 export class UserService {
 
     constructor(
-        @inject(Types.UserRepository) @named(Repository.UserRepository) public userRepo: typeof UserRepository
+        @inject(Types.Repository) @named(Repository.UserRepository) public userRepo: typeof UserRepository
     ) { }
 
     /**

src/app.ts

@@ -1,3 +1,11 @@
+/**
+ * APPLICATION CONFIGURATION
+ * ----------------------------------------
+ *
+ * This is the place to add any other express module and register
+ * all your custom middlewares and routes.
+ */
+
 import * as path from 'path';
 import * as cors from 'cors';
 import * as morgan from 'morgan';
@@ -11,14 +19,9 @@ import { Bootstrap } from './core/Bootstrap';
 import { Log } from './core/log';
 import container from './container';
 
-/**
- * APPLICATION CONFIGURATION
- * ----------------------------------------
- * This is the place to add any other express module and register
- * all your custom middlewares and routes
- */
+
 const app = Bootstrap.getApp()
-    // Report realtime server metrics for Express-based node servers
+    // Report real time server metrics for Express-based node servers
     .use(monitor())
 
     // Enabling the cors headers

src/core/Database.ts src/config/Database.tssrc/core/Database.ts renamed to src/config/Database.ts

@@ -1,6 +1,16 @@
+/**
+ * config.Database
+ * ------------------------------------
+ *
+ * Here we configure our database connection and
+ * our ORM 'bookshelf'.
+ *
+ * Here would be the place to add more bookshelf plugins.
+ */
+
 import * as knex from 'knex';
 import * as bookshelf from 'bookshelf';
-import { Environment } from './Environment';
+import { Environment } from '../core/Environment';
 
 
 export const Knex = (): knex => knex({