Minor changes to main, added BDD tests

README.md

@@ -93,6 +93,23 @@ hookshot()
 })
 ```
 
+### Spawn Event
+
+If hookshot was created with a shell command as the action, it will throw a spawn event with the child_process spawn instance.
+
+```javascript
+var server = hookshot('refs/head/master', 'git pull && make').listen(3000);
+
+server.on('spawn', function(spawn) {
+  // Bind on close to get exit code
+  spawn.on('close', function(code) {
+    if ( code !== 0 ) {
+      console.log('something went wrong');
+    }
+  });
+});
+```
+
 ### CLI Tool
 
 A companion CLI tool is provided for convenience. To use it, install **hookshot** via npm using the `-g` flag:

lib/index.js

@@ -30,7 +30,8 @@ module.exports = function (ref, action) {
     }
     hookshot.emit('hook', payload);
     hookshot.emit(payload.ref, payload);
-    res.send(202, 'Accepted\n');
+    res.status(202);
+    res.send('Accepted\n');
   });
 
   if (arguments.length == 1) {
@@ -51,13 +52,28 @@ module.exports = function (ref, action) {
     }
 
     hookshot.on(ref, function(payload) {
-      // shell command
-      spawn(shell, args, opts);
+      // Send emit spawn event w/ instance
+      hookshot.emit('spawn', spawn(shell, args, opts));
     });
   } else if (typeof action == 'function') {
     hookshot.on(ref, action);
   }
 
+  // Development Error middleware
+  if ( process.env.NODE_ENV === 'development' ) {
+    hookshot.use(function(err, req, res, next) {
+      console.log(err.stack);
+      next(err);
+    });
+  }
+
+  // Default Error middlware
+  hookshot.use(function(err, req, res, next) {
+    hookshot.emit('error', err);
+    res.status(500);
+    res.end(err.message);
+  });
+
   return hookshot;
 };
 

package.json

@@ -2,14 +2,25 @@
   "name": "hookshot",
   "author": "Marco Aurelio <thecoreh@gmail.com>",
   "version": "0.1.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/coreh/hookshot.git"
+  },
+  "scripts": {
+    "test": "node_modules/.bin/mocha"
+  },
   "dependencies": {
-    "express": "~4.9.0", 
+    "express": "~4.9.0",
     "commander": "~2.3.0",
     "lockfile": "~1.0.0",
     "body-parser": "~1.8.2"
   },
   "main": "lib",
   "bin": {
     "hookshot": "./bin/hookshot"
+  },
+  "devDependencies": {
+    "mocha": "^2.2.5",
+    "supertest": "^1.0.1"
   }
 }

test/test.js

@@ -0,0 +1,127 @@
+var assert    = require('assert'),
+    supertest = require('supertest'),
+    hookshot  = require('../lib');
+
+process.env.NODE_ENV = 'test';
+
+describe('hookshot server', function() {
+
+  var server, request;
+
+  beforeEach(function() {
+     server = hookshot('test', 'exit 1'),
+     request = supertest(server);
+  });
+
+  it('should throw an error on invalid payload', function(done) {
+    request
+      .post('/')
+      .set('Accept', 'application/json')
+      .send({})
+      .end(function(err) {
+        assert(err instanceof Error);
+        done();
+      });
+  });
+
+  it('should emit an error on invalid payload', function(done) {
+
+    server.on('error', function(err) {
+      assert(err instanceof Error);
+      done();
+    });
+
+    request
+      .post('/')
+      .set('Accept', 'application/json')
+      .send({})
+      .expect(500)
+      .end(function(err) {
+        assert(err instanceof Error);
+      });
+  });
+
+  it('should get a create event', function(done) {
+    server.on('create', function(payload) {
+      assert(payload);
+      done();
+    });
+
+    request
+      .post('/')
+      .set('Accept', 'application/json')
+      .send({ ref: 'test', created: true })
+      .expect(202)
+      .end(function(err, res) {
+        assert(!err);
+      });
+  });
+
+  it('should get a delete event', function(done) {
+    server.on('delete', function(payload) {
+      assert(payload);
+      done();
+    });
+
+    request
+      .post('/')
+      .set('Accept', 'application/json')
+      .send({ ref: 'test', deleted: true })
+      .expect(202)
+      .end(function(err, res) {
+        assert(!err);
+      });
+  });
+
+  it('should get a push event if created and deleted are falsy', function(done) {
+    server.on('push', function(payload) {
+      assert(payload);
+      done();
+    });
+
+    request
+      .post('/')
+      .set('Accept', 'application/json')
+      .send({ ref: 'test' })
+      .expect(202)
+      .end(function(err, res) {
+        assert(!err);
+      });
+  });
+
+  it('should get reference event with payload on hook', function(done) {
+    server.on('test', function(payload) {
+      done();
+    });
+
+    request
+      .post('/')
+      .set('Accept', 'application/json')
+      .send({ ref: 'test' })
+      .expect(202)
+      .end(function(err, res) {
+        assert(!err);
+      });
+
+  });
+
+  it('should run command `exit 1` when running receiving a hook for reference "test"', function(done) {
+
+    server.on('spawn', function(instance) {
+      instance.on('close', function(code) {
+        assert.equal(code, 1);
+        done();
+      });
+    });
+
+    request
+      .post('/')
+      .set('Accept', 'application/json')
+      .send({ ref: 'test' })
+      .expect(202)
+      .end(function(err, res) {
+        assert(!err);
+      });
+  });
+});
+