House cleaning

Author: hirsch88

README.md

@@ -63,8 +63,13 @@ The port will be displayed to you as `http://0.0.0.0:3000` (or if you prefer IPv
 * [aurelia-typescript-boilerplate](https://github.com/w3tecch/aurelia-typescript-boilerplate) - An Aurelia starter kit with TypeScript
 
 ## Documentations
-* [Auth0 API Documentation](https://auth0.com/docs/api/management/v2#!/Users/get_users)
+* [Express](https://expressjs.com/)
+* [Knex](http://knexjs.org/)
+* [Bookshelf](http://bookshelfjs.org/)
 * [Bookshelf Cheatsheet](http://ricostacruz.com/cheatsheets/bookshelf.html)
+* [Inversify](http://inversify.io/)
+* [Inversify Express Utils](https://github.com/inversify/inversify-express-utils)
+* [Auth0 API Documentation](https://auth0.com/docs/api/management/v2#!/Users/get_users)
 
 ## License
  [MIT](/LICENSE)

src/api/controllers/HomeController.ts

@@ -2,12 +2,19 @@ import * as express from 'express';
 import { Controller, Get, Response } from 'inversify-express-utils';
 import { injectable } from 'inversify';
 
+/**
+ * HomeController is a public controller to give some
+ * information about this api
+ *
+ * @export
+ * @class HomeController
+ */
 @injectable()
 @Controller('/')
 export class HomeController {
 
     @Get('/')
-    public get(@Response() res: express.Response): any {
+    public get( @Response() res: express.Response): any {
         const pkg = require('../../../package.json');
         return res.json({
             name: pkg.name,

src/api/controllers/UserController.ts

@@ -2,13 +2,14 @@ import { injectable, inject } from 'inversify';
 import { Controller, Get, Post, Put, Delete, RequestParam, RequestBody, Response } from 'inversify-express-utils';
 import { my } from 'my-express';
 import { Log } from '../../core/log';
-import { UserService } from '../services';
+import { UserService } from '../services/UsersService';
 import { Types } from '../../constants/Types';
 
 const log = new Log('api:ctrl.UserController');
 
 /**
- * UserController
+ * UserController is in charge of the user resource and should
+ * provide all crud actions.
  *
  * @export
  * @class UserController

src/api/controllers/index.ts

@@ -1,6 +1,13 @@
 import { Exception } from '../../core/api/Exception';
 
-
+/**
+ * DatabaseException should be used for repository errors like
+ * entity with this id already exists and stuff like that.
+ *
+ * @export
+ * @class DatabaseException
+ * @extends {Exception}
+ */
 export class DatabaseException extends Exception {
     constructor(text: string, error: any) {
         let value: string = error.stack.split('\n')[0];

src/api/exceptions/DatabaseException.ts

@@ -1,6 +1,14 @@
 import { Exception } from '../../core/api/Exception';
 
-
+/**
+ * NotFoundException should be used if a someone requests a
+ * entity with a id, but there is no entity with this id in the
+ * database, then we throw this exception.
+ *
+ * @export
+ * @class NotFoundException
+ * @extends {Exception}
+ */
 export class NotFoundException extends Exception {
     constructor(id?: number | string) {
         super(404, `Entity with identifier ${id} does not exist`);

src/api/exceptions/NotFoundException.ts

@@ -1,6 +1,13 @@
 import { Exception } from '../../core/api/Exception';
 
-
+/**
+ * ValidationException should be used when we validate
+ * the request payload, so we can response with a 400 (Bad Request)
+ *
+ * @export
+ * @class ValidationException
+ * @extends {Exception}
+ */
 export class ValidationException extends Exception {
     constructor(text: string, errors: any) {
         const info = errors.map((e) => ({

src/api/exceptions/ValidationException.ts

@@ -1,7 +1,13 @@
 import { Bookshelf } from '../../core/Bookshelf';
 import { Tables } from '../../constants/Tables';
 
-
+/**
+ * User Model
+ *
+ * @export
+ * @class User
+ * @extends {Bookshelf.Model<User>}
+ */
 export class User extends Bookshelf.Model<User> {
 
     public static async fetchById(id: number): Promise<User> {