Added Mocha as test framework and the exported check method can now return a Promise.

Author: axelrindle

lib/main.coffee

@@ -3,29 +3,40 @@ request = require 'request'
 semcmp = require 'semver-compare'
 chalk = require 'chalk'
 sprintf = require('sprintf-js').sprintf
+Promise = require 'promise'
 
 baseApiUrl = 'https://api.github.com/repos/%s/releases'
 
 module.exports = (options, callback) ->
+  if callback
+    check options, callback
+  else
+    return new Promise (resolve, reject) ->
+      check options, (release, error) ->
+        reject error if error
+        if release then resolve release
+        else resolve null
+
+check = (options, callback) ->
 
   # get options
   repo = options.repo
   currentVersion = options.currentVersion
 
   # check if required options are defined
-  error 'no repository specified' if repo is undefined
-  error 'no current version given' if currentVersion is undefined
+  callback(null, 'no repository specified') if repo is undefined
+  callback(null, 'no current version given') if currentVersion is undefined
 
   apiUrl = sprintf baseApiUrl, repo
 
   # request options
   reqOpts =
     url: apiUrl
     headers:
-      'User-Agent': options.useragent or 'github-version-checker'
+      'User-Agent': 'github-version-checker'
 
   request reqOpts, (error, response, body) ->
-    throw error if error
+    callback(null, error) if error
 
     # parse the response body into an object
     releases = JSON.parse body
@@ -39,11 +50,9 @@ module.exports = (options, callback) ->
       tag = release.tag_name.replace(/[^0-9$.,]/g, '')
       if semcmp(currentVersion, tag) is -1
         found = true
-        callback release
+        callback release, null
         break
 
-    callback null if not found
+    callback(null, null) if not found
 
-# error method
-error = (cause) ->
-  throw chalk.bgRed.bold('Error!') + ' ' + cause
+  return null

package.json

@@ -4,7 +4,7 @@
   "description": "Version checker working with GitHub releases.",
   "main": "index.js",
   "scripts": {
-    "test": "node test.js"
+    "test": "mocha"
   },
   "keywords": [
     "node",
@@ -15,14 +15,17 @@
   "license": "MIT",
   "dependencies": {
     "chalk": "^1.1.3",
-    "coffee-script": "^1.12.4",
+    "coffee-script": "^1.12.5",
     "gulp": "github:gulpjs/gulp#4.0",
+    "promise": "^7.1.1",
     "request": "^2.81.0",
     "semver-compare": "^1.0.0",
     "sprintf-js": "^1.0.3"
   },
   "devDependencies": {
     "gulp": "^3.9.1",
-    "gulp-coffeelint": "^0.6.0"
+    "gulp-coffeelint": "^0.6.0",
+    "mocha": "^3.2.0",
+    "mocha-logger": "^1.0.5"
   }
 }

test.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+'use strict';
+
+// register coffee-script
+require('coffee-script/register');
+
+// require modules
+const versionCheck = require('../lib/main.coffee');
+const assert = require('assert');
+
+const options = {
+  repo: 'axelrindle/github-version-checker',
+  currentVersion: "1.0.0"
+};
+
+describe('github-version-checker', function () {
+  describe('#versionCheck with one parameter and correct options', function () {
+    it('should resolve the Promise without errors', function () {
+      versionCheck(options).then(
+        function (update) {
+          assert.notEqual(update, undefined);
+        },
+        function (error) {
+          throw error;
+        }
+      );
+    });
+  });
+});

test/test-promise-handling.js

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+'use strict';
+
+// register coffee-script
+require('coffee-script/register');
+
+// require modules
+const versionCheck = require('../lib/main.coffee');
+const assert = require('assert');
+
+const options = {
+  repo: 'axelrindle/github-version-checker',
+  currentVersion: "1.0.0"
+};
+
+describe('github-version-checker', function () {
+  describe('#versionCheck with two parameters', function () {
+    it('should return null', function () {
+      assert.equal(versionCheck(options, function(update, error) {}), null);
+    });
+  });
+});
+
+describe('github-version-checker', function () {
+  describe('#versionCheck with only one options parameter', function () {
+    it('should return a Promise', function () {
+      assert.equal(typeof versionCheck(options).then, 'function');
+    });
+  });
+});