Merge branch 'release/1.2.0'

Author: hirsch88

.env.example

@@ -0,0 +1,43 @@
+#
+# APPLICATION
+#
+APP_NAME=express-typescript-boilerplate
+APP_ENV=local
+APP_HOST=http://localhost
+APP_PORT=3000
+
+#
+# LOGGING
+#
+DEBUG=app*,api*,core*
+LOG_LEVEL=debug
+LOG_ADAPTER=debug
+
+#
+# DATABASE
+#
+# MySql
+DB_CLIENT=mysql
+DB_CONNECTION=mysql://root@localhost:3306/my_database
+
+# PostGres
+#DB_CLIENT=pg
+#DB_CONNECTION=postgres://root:root@localhost:5432/my_database
+
+# Knex
+DB_POOL_MIN=0
+DB_POOL_MAX=7
+DB_MIGRATION_DIR=./src/database/migrations
+DB_MIGRATION_TABLE=version
+DB_SEEDS_DIR=./src/database/seeds
+
+#
+# Auth0
+#
+AUTH0_HOST=https://w3tecch.auth0.com
+AUTH0_OAUTH=/oauth
+AUTH0_API=/api/v2
+AUTH0_CLIENT_ID=auth0_client_id
+AUTH0_CLIENT_SECRET=auth0_client_secret
+AUTH0_AUDIENCE=https://my.auth0.com/api/v2/
+AUTH0_GRANT_TYPE=client_credentials

.gitignore

@@ -10,6 +10,7 @@ node_modules/
 bower_components/
 npm-debug.log
 yarn-error.log
+.env
 
 # OS generated files #
 .DS_Store

.vscode/settings.json

@@ -1,7 +1,7 @@
 {
     "typescript.tsdk": "./node_modules/typescript/lib",
     "files.exclude": {
-        "src/**/*.js": true,
+        "src/**/*.js": false,
         "test/**/*.js": true
     },
     "vsicons.presets.angular": false,

README.md

@@ -50,10 +50,6 @@ The port will be displayed to you as `http://0.0.0.0:3000` (or if you prefer IPv
 * Run `npm run build` to generated all JavaScript files from your TypeScript sources. After this step you can deploy the app on any server.
 * There is also a vscode task for this called build.
 * To start the builded app use `npm start`.
-* With `npm run zip` it will generate the JavaScript source and pack them into to a deployable zip file into the dist folder.
-
-### 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
@@ -67,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)

build/tasks/zip.js

@@ -1,3 +1,4 @@
 'use strict';
+
 var requireDir = require('require-dir');
 var tasks = requireDir('./build/tasks');

gulpfile.js

@@ -1,9 +1,13 @@
-import * as _ from 'lodash';
-
-const config = require('./src/config');
-
-let databaseConfig = {};
-
-_.forOwn(_.clone(config), (value, key) => databaseConfig[`${key}`] = value.database);
-
-module.exports = databaseConfig;
+require('dotenv').config();
+
+module.exports = {
+    client: process.env.DB_CLIENT,
+    connection: process.env.DB_CONNECTION,
+    migrations: {
+        directory: process.env.DB_MIGRATION_DIR,
+        tableName: process.env.DB_MIGRATION_TABLE
+    },
+    seeds: {
+        directory: process.env.DB_SEEDS_DIR
+    }
+};

knexfile.ts

@@ -1,6 +1,6 @@
 {
   "name": "express-typescript-boilerplate",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Boilerplate for an restful express-application written in TypeScript.",
   "main": "src/index.ts",
   "scripts": {
@@ -14,13 +14,9 @@
     "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",
-    "db:clean": "./node_modules/.bin/ts-node ./src/console/CleanDatabaseCommand.ts",
     "db:refresh": "npm run db:drop && npm run db:migrate",
     "start": "node src/index.js"
   },
@@ -57,11 +53,13 @@
     "@types/bookshelf": "^0.8.38",
     "@types/cors": "^2.8.1",
     "@types/debug": "0.0.29",
+    "@types/dotenv": "^4.0.0",
     "@types/express": "^4.0.35",
     "@types/faker": "^4.1.0",
     "@types/helmet": "0.0.34",
     "@types/inversify": "^2.0.33",
     "@types/inversify-express-utils": "^2.0.0",
+    "@types/jest": "^19.2.2",
     "@types/knex": "0.0.47",
     "@types/lodash": "^4.14.63",
     "@types/morgan": "^1.7.32",
@@ -72,25 +70,13 @@
     "body-parser": "^1.17.1",
     "bookshelf": "^0.10.3",
     "bookshelf-camelcase": "^1.1.4",
+    "class-validator": "^0.7.0",
     "compression": "^1.6.2",
     "cors": "^2.8.1",
     "debug": "^2.6.0",
+    "dotenv": "^4.0.0",
     "express": "^4.14.0",
     "faker": "^3.1.0",
-    "helmet": "^3.4.0",
-    "inversify": "^4.1.0",
-    "inversify-express-utils": "^3.5.1",
-    "knex": "^0.12.7",
-    "lodash": "^4.17.4",
-    "morgan": "^1.7.0",
-    "pg": "^6.1.5",
-    "reflect-metadata": "^0.1.10",
-    "request": "^2.81.0",
-    "serve-favicon": "^2.4.2",
-    "ts-node": "^2.0.0",
-    "typescript": "^2.3.2",
-    "winston": "^2.3.1",
-    "@types/jest": "^19.2.2",
     "gulp": "^3.9.1",
     "gulp-clean": "^0.3.2",
     "gulp-concat": "^2.6.1",
@@ -106,20 +92,30 @@
     "gulp-typedoc": "^2.0.2",
     "gulp-typescript": "^3.1.4",
     "gulp-zip": "^3.2.0",
+    "helmet": "^3.4.0",
     "http-server": "^0.9.0",
+    "inversify": "^4.1.0",
+    "inversify-express-utils": "^3.5.1",
     "jasmine-spec-reporter": "^4.0.0",
     "jest": "^19.0.2",
+    "knex": "^0.12.7",
+    "lodash": "^4.17.4",
+    "morgan": "^1.7.0",
     "nodemon": "^1.11.0",
     "path": "^0.12.7",
+    "pg": "^6.1.5",
+    "reflect-metadata": "^0.1.10",
     "request": "^2.79.0",
     "require-dir": "^0.3.1",
     "run-sequence": "^1.2.2",
+    "serve-favicon": "^2.4.2",
     "sqlite3": "^3.1.8",
     "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"
+    "typings": "^2.1.0",
+    "winston": "^2.3.1"
   },
   "jest": {
     "transform": {

package.json

@@ -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/HomeController.ts

@@ -1,35 +1,58 @@
 import { injectable, inject } from 'inversify';
-import { Controller, Get, RequestParam } from 'inversify-express-utils';
-import TYPES from '../../constants/types';
-import * as core from '../../core';
-import { UserService } from '../services';
+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/UsersService';
+import { Types } from '../../constants/Types';
 
-const log = new core.Log('api:ctrl.UserController');
+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
  */
 @injectable()
-@Controller('/users')
+@Controller('/v1/user')
 export class UserController {
 
-    constructor( @inject(TYPES.UserService) private userService: UserService) { }
+    constructor( @inject(Types.UserService) private userService: UserService) { }
 
     @Get('/')
-    public async findAll(): Promise<any> {
+    public async findAll( @Response() res: my.Response): Promise<any> {
         log.debug('findAll');
         const users = await this.userService.findAll();
-        return users.toJSON();
+        return res.found(users.toJSON());
     }
 
     @Get('/:id')
-    public async findOne( @RequestParam('id') id: string): Promise<any> {
+    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 user.toJSON();
+        return res.found(user.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());
+    }
+
+    @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();
     }
 
 }