updated packages

now using npm for typings
added integration test
updated project structure by adding services and config folders
removed gulp

.gitignore

@@ -37,5 +37,7 @@ node_modules
 coverage
 checkstyle-result.xml
 
-# generated js scripts from type-script
-dist
+app/**/*.js
+app/**/*.map
+test/**/*.js
+test/**/*.map

.vscode/launch.json

@@ -0,0 +1,46 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch",
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceRoot}/app/app.js",
+            "stopOnEntry": false,
+            "args": [],
+            "cwd": "${workspaceRoot}",
+            "preLaunchTask": null,
+            "runtimeExecutable": null,
+            "runtimeArgs": [
+                "--nolazy"
+            ],
+            "env": {
+                "NODE_ENV": "development"
+            },
+            "console": "internalConsole",
+            "sourceMaps": true,
+            "outFiles": []
+        },
+        {
+            "name": "Attach",
+            "type": "node",
+            "request": "attach",
+            "port": 5858,
+            "address": "localhost",
+            "restart": false,
+            "sourceMaps": true,
+            "outFiles": [],
+            "localRoot": "${workspaceRoot}",
+            "remoteRoot": null
+        },
+        {
+            "name": "Attach to Process",
+            "type": "node",
+            "request": "attach",
+            "processId": "${command.PickProcess}",
+            "port": 5858,
+            "sourceMaps": false,
+            "outFiles": []
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,15 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+    "explorer.openEditors.visible": 0,
+     "files.exclude": {
+        "**/.git": true,
+        "**/.svn": true,
+        "**/.hg": true,
+        "**/.DS_Store": true,
+        "app/**/*.js": true,
+        "app/**/*.map": true,
+        "test/**/*.js": true,
+        "test/**/*.map": true
+    },
+    "typescript.tsdk": "node_modules/typescript/lib"
+}

app/app.ts

@@ -1,9 +1,9 @@
-var fs = require('fs');
-import restify = require('restify');
-import {settings} from './config';
-import {logger} from './logger';
+import * as fs from 'fs';
+import * as restify from 'restify';
+import { settings } from './config/config';
+import { logger } from './services/logger';
 
-var api = restify.createServer({
+export let api = restify.createServer({
   name: settings.name
 });
 
@@ -17,13 +17,13 @@ api.use(restify.authorizationParser());
 api.use(restify.fullResponse());
 
 
-fs.readdirSync(__dirname + '/routes').forEach(function(routeConfig:string) {
+fs.readdirSync(__dirname + '/routes').forEach(function (routeConfig: string) {
   if (routeConfig.substr(-3) === '.js') {
-    var route = require(__dirname + '/routes/' + routeConfig);
+    let route = require(__dirname + '/routes/' + routeConfig);
     route.routes(api);
   }
 });
 
-api.listen(settings.port, function() {
-  console.log(`INFO: ${settings.name} is running at ${api.url}`);
-});
+api.listen(settings.port, function () {
+  logger.info(`INFO: ${settings.name} is running at ${api.url}`);
+});

app/config/config.ts

@@ -0,0 +1,15 @@
+import {Config} from '../types';
+
+let env = process.env.NODE_ENV || 'development';
+
+export let settings: Config = {
+  name: 'restify-typescript-seed',
+  version: '2.0.0',
+  port: 3000,
+  env: 'dev'
+};
+
+if (env === 'production') {
+  settings.env = 'prod';
+  // other production settings
+}

app/controllers/SampleRouteController.ts

@@ -1,8 +1,9 @@
-import restify = require('restify');
+import * as restify from 'restify';
+import { logger } from '../services/logger';
 
 export default class SampleRouteController {
-
-	get(req: restify.Request, res: restify.Response, next: restify.Next) {
+	public get(req: restify.Request, res: restify.Response, next: restify.Next) {
+		logger.info('accessing ping route');
 		res.json(200, 'pong');
 		return next();
 	}

app/routes/sampleRoute.ts

@@ -1,4 +1,4 @@
-import restify = require('restify');
+import * as restify from 'restify';
 import sampleRouteController from '../controllers/SampleRouteController'
 
 function sampleRoute(api:restify.Server) {

app/services/logger.ts

@@ -0,0 +1,25 @@
+import * as bunyan from 'bunyan';
+import * as stream from 'stream';
+
+let infoStream = new stream.Writable();
+infoStream.writable = true;
+
+infoStream.write = (info: any): boolean => {
+
+  console.log(JSON.parse(info).msg);
+  return true;
+};
+
+export let logger = bunyan.createLogger({
+  name: 'myapp',
+  streams: [
+    {
+      level: 'info',
+      stream: infoStream
+    },
+    {
+      level: 'error',
+      path: `error.log`
+    }
+  ]
+});

app/types.d.ts

@@ -0,0 +1,6 @@
+export interface Config {
+  name: string;
+  port: number;
+  env: string;
+  version: string;
+}

package.json

@@ -4,25 +4,31 @@
   "description": "a seed project for creating http service using restify written in typescript",
   "main": "app.js",
   "scripts": {
-    "test": "mocha dist/test/controllers/",
-    "compile": "tsc"
+    "test": "node_modules/.bin/_mocha test/unit/**/*.spec.js",
+    "compile": "node_modules/.bin/tsc",
+    "start": "node app/app.js"
   },
   "keywords": [
     "typescript",
     "restify"
   ],
   "author": "Sul.Aga",
   "license": "MIT",
-  "dependencies": {    
-    "restify": "^4.0.3"
+  "dependencies": {
+    "@types/chai": "^3.4.34",
+    "@types/mocha": "^2.2.32",
+    "@types/node": "^6.0.45",
+    "@types/restify": "^2.0.33",
+    "@types/sinon": "^1.16.31",
+    "@types/supertest": "^1.1.31",
+    "restify": "^4.1.1"
   },
   "devDependencies": {
-    "chai": "^3.4.1",
-    "gulp": "^3.9.0",
-    "gulp-sourcemaps": "^1.6.0",
-    "gulp-typescript": "^2.9.2",
-    "mocha": "^2.3.4",
-    "sinon": "^1.17.2",
-    "typescript": "^1.6.2"
+    "chai": "^3.5.0",
+    "mocha": "^3.1.2",
+    "sinon": "^1.17.6",
+    "supertest": "^2.0.0",
+    "tslint": "^3.15.1",
+    "typescript": "^2.0.3"
   }
 }

test/integration/controllers/SampleRouteController.spec.ts

@@ -0,0 +1,23 @@
+import chai = require('chai');
+import { api as server } from '../../../app/app';
+import * as supertest from 'supertest';
+
+let expect = chai.expect;
+
+describe('sample route controller', () => {
+
+    it('should return pong', (done) => {
+        supertest(server)
+            .get('/api/ping')
+            .end((err: any, response: supertest.Response) => {
+                if (err) {
+                    done(err);
+                }
+                else {
+                    expect(response.status).to.equal(200);
+                    expect(response.body).to.equal('pong');
+                    done();
+                }
+            });
+    });
+});