house cleaning

hirsch88 · hirsch88 · commit 9d7be1c47af5 · 2017-05-18T19:01:42.000+02:00
diff --git a/README.md b/README.md
@@ -51,9 +51,6 @@ The port will be displayed to you as `http://0.0.0.0:3000` (or if you prefer IPv
 * There is also a vscode task for this called build.
 * To start the builded app use `npm start`.
 
-### Docs
-* Run `npm run docs` to generate all doc files and serve it on `http://0.0.0.0:8080`
-
 ### Seed
 * Run `npm run db:seed` to seed some data into the database
 
diff --git a/gulpfile.js b/gulpfile.js
@@ -1,3 +1,4 @@
 'use strict';
+
 var requireDir = require('require-dir');
 var tasks = requireDir('./build/tasks');
diff --git a/package.json b/package.json
@@ -14,9 +14,6 @@
     "build": "./node_modules/.bin/gulp build",
     "clean": "./node_modules/.bin/gulp clean",
     "zip": "./node_modules/.bin/gulp zip",
-    "docs": "npm run docs:generate && npm run docs:server",
-    "docs:generate": "./node_modules/.bin/gulp docs",
-    "docs:server": "./node_modules/.bin/http-server ./docs --cors",
     "db:migrate": "./node_modules/.bin/knex migrate:latest",
     "db:migrate:rollback": "./node_modules/.bin/knex migrate:rollback",
     "db:seed": "./node_modules/.bin/knex seed:run",
@@ -116,7 +113,6 @@
     "ts-jest": "^19.0.11",
     "ts-node": "^2.0.0",
     "tslint": "^4.3.1",
-    "typedoc": "^0.5.5",
     "typescript": "^2.2.1",
     "typings": "^2.1.0",
     "winston": "^2.3.1"
diff --git a/src/api/controllers/UserController.ts b/src/api/controllers/UserController.ts
@@ -1,9 +1,9 @@
 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';
+import { Log } from '../../core/log';
 import { UserService } from '../services';
-import TYPES from '../../constants/types';
+import { Types } from '../../constants/Types';
 
 const log = new Log('api:ctrl.UserController');
 
@@ -17,7 +17,7 @@ const log = new Log('api:ctrl.UserController');
 @Controller('/v1/user')
 export class UserController {
 
-    constructor( @inject(TYPES.UserService) private userService: UserService) { }
+    constructor( @inject(Types.UserService) private userService: UserService) { }
 
     @Get('/')
     public async findAll( @Response() res: my.Response): Promise<any> {
diff --git a/src/api/middlewares/index.ts b/src/api/middlewares/index.ts
diff --git a/src/api/models/User.ts b/src/api/models/User.ts
@@ -1,8 +1,8 @@
-import * as core from '../../core';
-import { Tables } from '../../database/Tables';
+import { Bookshelf } from '../../core/Bookshelf';
+import { Tables } from '../../constants/Tables';
 
 
-export class User extends core.Bookshelf.Model<User> {
+export class User extends Bookshelf.Model<User> {
 
     public static async fetchById(id: number): Promise<User> {
         return await User.where<User>({ id: id }).fetch();
diff --git a/src/api/services/UsersService.ts b/src/api/services/UsersService.ts
@@ -1,15 +1,15 @@
-import { injectable, inject, named } from 'inversify';
 import * as Bookshelf from 'bookshelf';
-import * as core from '../../core';
-import * as models from '../models';
-import * as repo from '../repositories';
+import { injectable, inject, named } from 'inversify';
+import { Repository } from '../../constants/Targets';
+import { Types } from '../../constants/Types';
+import { Log } from '../../core/log';
 import { NotFoundException } from '../exceptions';
-import TYPES from '../../constants/types';
-import TAGS from '../../constants/tags';
 import { UserCreateRequest } from '../request/UserCreateRequest';
 import { UserUpdateRequest } from '../request/UserUpdateRequest';
+import { UserRepository } from '../repositories';
+import { User } from '../models';
 
-const log = new core.Log('api:services:UserService');
+const log = new Log('api:services:UserService');
 
 /**
  * UserService
@@ -21,15 +21,15 @@ const log = new core.Log('api:services:UserService');
 export class UserService {
 
     constructor(
-        @inject(TYPES.UserRepository) @named(TAGS.UserRepository) public userRepo: typeof repo.UserRepository
+        @inject(Types.UserRepository) @named(Repository.UserRepository) public userRepo: typeof UserRepository
     ) {
     }
 
-    public async findAll(): Promise<Bookshelf.Collection<models.User>> {
+    public async findAll(): Promise<Bookshelf.Collection<User>> {
         return this.userRepo.findAll();
     }
 
-    public async findOne(id: number): Promise<models.User> {
+    public async findOne(id: number): Promise<User> {
         let user = await this.userRepo.findOne(id);
         if (user === null) {
             log.warn(`User with the id=${id} was not found!`);
@@ -38,7 +38,7 @@ export class UserService {
         return user;
     }
 
-    public async create(data: any): Promise<models.User> {
+    public async create(data: any): Promise<User> {
         // Validate request payload
         const request = new UserCreateRequest(data);
         await request.validate();
@@ -48,7 +48,7 @@ export class UserService {
         return user;
     }
 
-    public async update(id: number, newUser: any): Promise<models.User> {
+    public async update(id: number, newUser: any): Promise<User> {
         const oldUserModel = await this.findOne(id);
         let oldUser = oldUserModel.toJSON();
         const request = new UserUpdateRequest(oldUser);
diff --git a/src/app.ts b/src/app.ts
@@ -6,7 +6,8 @@ import * as express from 'express';
 import * as favicon from 'serve-favicon';
 import * as bodyParser from 'body-parser';
 import * as compression from 'compression';
-import * as core from './core';
+import { Bootstrap } from './core/Bootstrap';
+import { Log } from './core/log';
 import container from './container';
 
 /**
@@ -15,34 +16,41 @@ import container from './container';
  * This is the place to add any other express module and register
  * all your custom middlewares and routes
  */
-const app = core.Bootstrap.getApp()
+const app = Bootstrap.getApp()
+
     // Enabling the cors headers
     .options('*', cors())
     .use(cors())
+
     // Helmet helps you secure your Express apps by setting various HTTP headers. It's not a silver bullet, but it can help!
     .use(helmet())
     .use(helmet.noCache())
     .use(helmet.hsts({
         maxAge: 31536000,
         includeSubdomains: true
     }))
+
     // Compress response bodies for all request that traverse through the middleware
     .use(compression())
+
     // Parse incoming request bodies in a middleware before your handlers, available under the req.body property.
     .use(bodyParser.json())
     .use(bodyParser.urlencoded({
         extended: true
     }))
+
     // Serve static filles like images from the public folder
     .use(express.static(`${__dirname}/public`))
+
     // A favicon is a visual cue that client software, like browsers, use to identify a site
     .use(favicon(path.join(__dirname, 'public', 'favicon.ico')))
+
     // HTTP request logger middleware for node.js
     .use(morgan('dev', {
         stream: {
-            write: core.Log.info
+            write: Log.info
         }
     }));
 
 
-export default core.Bootstrap.build(app, container);
+export default Bootstrap.build(app, container);
diff --git a/src/constants/Tables.ts b/src/constants/Tables.ts
@@ -0,0 +1,3 @@
+export const Tables = {
+    Users: 'users'
+};
diff --git a/src/constants/Targets.ts b/src/constants/Targets.ts
@@ -0,0 +1,8 @@
+export const Controller = {
+    HomeController: 'HomeController',
+    UserController: 'UserController'
+};
+
+export const Repository = {
+    UserRepository: 'UserRepository'
+};
diff --git a/src/constants/tags.ts b/src/constants/tags.ts
diff --git a/src/constants/types.ts b/src/constants/types.ts
@@ -1,6 +1,9 @@
-const TYPES = {
+import { TYPE } from 'inversify-express-utils';
+
+
+const myType = {
     UserService: Symbol('UserService'),
     UserRepository: Symbol('UserRepository')
 };
 
-export default TYPES;
+export const Types = Object.assign(TYPE, myType);
diff --git a/src/container.ts b/src/container.ts
@@ -1,9 +1,8 @@
-import { interfaces, TYPE } from 'inversify-express-utils';
+import { interfaces } from 'inversify-express-utils';
 import { Container } from 'inversify';
-import TYPES from './constants/types';
-import TAGS from './constants/tags';
-import { HomeController } from './api/controllers/HomeController';
-import { UserController } from './api/controllers';
+import { Types } from './constants/Types';
+import { Controller, Repository } from './constants/Targets';
+import { UserController, HomeController } from './api/controllers';
 import { UserService } from './api/services';
 import { UserRepository } from './api/repositories';
 
@@ -14,14 +13,17 @@ import { UserRepository } from './api/repositories';
  * Bind every controller and service to the ioc container. All controllers
  * will then be bonded to the express structure with their defined routes.
  */
-let container = new Container();
+const container = new Container();
 
-container.bind<interfaces.Controller>(TYPE.Controller).to(HomeController).whenTargetNamed(TAGS.HomeController);
-container.bind<interfaces.Controller>(TYPE.Controller).to(UserController).whenTargetNamed(TAGS.UserController);
+// Controllers
+container.bind<interfaces.Controller>(Types.Controller).to(HomeController).whenTargetNamed(Controller.HomeController);
+container.bind<interfaces.Controller>(Types.Controller).to(UserController).whenTargetNamed(Controller.UserController);
 
-container.bind<UserService>(TYPES.UserService).to(UserService);
+// Services
+container.bind<UserService>(Types.UserService).to(UserService);
 
-container.bind<UserRepository>(TYPES.UserRepository).toConstantValue(UserRepository).whenTargetNamed(TAGS.UserRepository);
+// Repositories
+container.bind<UserRepository>(Types.UserRepository).toConstantValue(UserRepository).whenTargetNamed(Repository.UserRepository);
 
 
 export default container;
diff --git a/src/core/Knex.ts b/src/core/Knex.ts
@@ -1,5 +1,5 @@
 import * as knex from 'knex';
-import { Environment } from './';
+import { Environment } from './Environment';
 
 
 export const Knex: knex = knex({
diff --git a/src/core/api/Exception.ts b/src/core/api/Exception.ts
@@ -1,5 +1,16 @@
 export const isException = Symbol();
 
+/**
+ * Exception
+ * -----------------
+ * We use this extend error for our custom errors, which we
+ * call exceptions. They have a code property for the http-status,
+ * global message and a body, which we will return as a json.
+ *
+ * @export
+ * @class Exception
+ * @extends {Error}
+ */
 export class Exception extends Error {
 
     public code = 500;
diff --git a/src/core/api/RequestBody.ts b/src/core/api/RequestBody.ts
@@ -1,9 +1,21 @@
 import { validate } from 'class-validator';
 import { ValidationException } from '../../api/exceptions/ValidationException';
 
-
+/**
+ * RequestBody
+ * --------------------------
+ * This Class is used to verify a valid payload an prepare
+ * it for further actions in the repository
+ *
+ * @export
+ * @class RequestBody
+ */
 export class RequestBody {
 
+    /**
+     * Creates an instance of RequestBody and if a input is given
+     * we store the values into the correct property
+     */
     constructor(input?: any) {
         if (input) {
             const keys = Object.keys(input);
@@ -13,6 +25,9 @@ export class RequestBody {
         }
     }
 
+    /**
+     * Validates the body on the basis of the validator-annotations
+     */
     public async validate(): Promise<void> {
         let errors = await validate(this);
         if (errors && errors.length > 0) {
@@ -21,6 +36,9 @@ export class RequestBody {
         return;
     }
 
+    /**
+     * Returns a new body object
+     */
     public toJSON(): any {
         let json = {};
         const keys = Object.keys(this);
@@ -32,10 +50,16 @@ export class RequestBody {
         return json;
     }
 
+    /**
+     * Sets the values direct into the body object
+     */
     protected set(key: string, value: any): void {
         this[key] = value;
     }
 
+    /**
+     * Updates the property only if the the value is given
+     */
     protected update(key: string, value: any): void {
         if (value !== undefined) {
             this[key] = value;
diff --git a/src/core/api/exceptionHandler.ts b/src/core/api/exceptionHandler.ts
@@ -3,18 +3,12 @@ import { Exception, isException } from '../api/Exception';
 
 
 /**
- * @name exceptionHandler
- * @description
+ * Exception Handler
+ * ---------------------------
  * This handler catches all thrown exceptions from the api. Afterwards it
  * send them to the client otherwise it moves to the next middleware or handler.
- *
- * @param {core.Exception} error
- * @param {express.Request} req
- * @param {express.Response} res
- * @param {express.NextFunction} next
  */
 export const exceptionHandler = (error: Exception | Error, req: my.Request, res: my.Response, next: my.NextFunction) => {
-    console.log('exceptionHandler', error.message, error['body']);
     if (error instanceof Exception || error[isException]) {
         res.failed(error['code'], error.message, error['body'] || null);
         next();
diff --git a/src/core/api/extendExpressResponse.ts b/src/core/api/extendExpressResponse.ts
@@ -1,8 +1,12 @@
 import * as express from 'express';
 import { my } from 'my-express';
 
-
-
+/**
+ * Extend Express Response
+ * --------------------------------
+ * We use this middleware to extend the express response object, so
+ * we can access the new functionality in our controllers
+ */
 export const extendExpressResponse = (req: my.Request, res: my.Response, next: express.NextFunction) => {
 
     /**
@@ -59,11 +63,6 @@ export const extendExpressResponse = (req: my.Request, res: my.Response, next: e
 
 /**
  * This body parser is used to show successful responses to the client
- *
- * @export
- * @param {*} data
- * @param {my.ResponseOptions} [options={}]
- * @returns {*}
  */
 export function bodySuccessful<T>(data: T, options: my.ResponseOptions = {}): any {
     return {
@@ -76,11 +75,6 @@ export function bodySuccessful<T>(data: T, options: my.ResponseOptions = {}): an
 
 /**
  * This body parse is used for error messages to the client
- *
- * @export
- * @param {*} data
- * @param {my.ResponseOptions} [options={}]
- * @returns {*}
  */
 export function bodyFailed(message: string, error: any): any {
     return {
diff --git a/src/core/index.ts b/src/core/index.ts
diff --git a/src/database/Tables.ts b/src/database/Tables.ts
diff --git a/src/database/factories/index.ts b/src/database/factories/index.ts
diff --git a/src/index.ts b/src/index.ts
diff --git a/test/unit/core/Bootstrap.test.ts b/test/unit/core/Bootstrap.test.ts
diff --git a/test/unit/core/Environment.test.ts b/test/unit/core/Environment.test.ts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export const Tables = {`
	`2`	`+ Users: 'users'`
	`3`	`+};`