various updates

Author: delabiejochen

.gitignore

@@ -0,0 +1 @@
+node_modules/

Makefile

@@ -9,4 +9,4 @@ clean:
 lint:
 		eslint lib/
 test: clean lint
-	mocha -t 6000 --reporter spec test/ $(MOCHAFLAGS)
+	mocha -t 6000 --reporter spec test/ $(MOCHAFLAGS)

README.md

@@ -14,6 +14,10 @@ Wrapper around the TestingBot REST API for [Node.js](http://nodejs.org/).
 npm install testingbot-api
 ```
 
+## Credentials
+You can use environment variables `TESTINGBOT_KEY` and `TESTINGBOT_SECRET` to pass your TestingBot key and secret to the API client.
+The key and secret can be obtained from [TestingBot](https://testingbot.com/members/user/edit) .
+
 ## Using the wrapper
 
 ```javascript
@@ -23,10 +27,100 @@ var tb = new TestingBot({
   api_key: "your-tb-key",
   api_secret: "your-tb-secret"
 });
+```
 
-tb.getUserInfo(function(err, data) {
-	console.log(data);
-});
+### getBrowsers
+Gets a list of browsers you can test on
+
+```javascript
+api.getBrowsers(function(error, browsers) {});
+```
+
+
+### getUserInfo
+Gets your user information
+
+```javascript
+api.getUserInfo(function(error, userInfo) {});
+```
+
+### getTests
+Gets list of your latest tests
+
+```javascript
+api.getTests(function(error, tests) {}, offset, limit);
+```
+
+### getTestDetails
+Gets details for a single test, pass the WebDriver's SessionID
+
+```javascript
+api.getTestDetails(sessionId, function(error, testDetails) {});
+```
+
+### updateTest
+Updates a single test. For example, update the `passed` state of a test (whether it was successful or not).
+
+```javascript
+var testData = { "test[success]" : "1", "test[status_message]" : "test" };
+api.updateTest(testData, sessionId, function(error, testDetails) {});
+```
+
+### deleteTest
+Deletes a single test, pass the WebDriver's SessionID
+
+```javascript
+api.deleteTest(sessionId, function(error, success) {});
+```
+
+### stopTest
+Stops a single test, pass the WebDriver's SessionID
+
+```javascript
+api.stopTest(sessionId, function(error, success) {});
+```
+
+### getTunnelList
+Gets list of active tunnels
+
+```javascript
+api.getTunnelList(function(error, tunnelList) {});
+```
+
+### deleteTunnel
+Deletes a single Tunnel
+
+```javascript
+api.deleteTunnel(tunnelId, function(error, success) {});
+```
+
+### getBuilds
+Retrieves the latest builds
+
+```javascript
+api.getBuilds(function(error, builds) {}, offset, limit);
+```
+
+### getTestsForBuild
+Retrieves the tests for a single build
+
+```javascript
+api.getTestsForBuild(buildId, function(error, tests) {});
+```
+
+### deleteBuild
+Deletes a single build
+
+```javascript
+api.deleteBuild(buildId, function(error, success) {});
+```
+
+### getAuthenticationHashForSharing
+Calculates the authentication hash for sharing, pass the WebDriver's SessionID.
+This is used to [share a test's detail page on TestingBot](https://testingbot.com/support/other/sharing)
+
+```javascript
+api.getAuthenticationHashForSharing(sessionId);
 ```
 
 ## Tests
@@ -41,7 +135,7 @@ Check out the [TestingBot REST API](https://testingbot.com/support/api) for more
 
 The MIT License (MIT)
 
-Copyright (c) 2017 TestingBot.com
+Copyright (c) TestingBot.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

lib/api.js

@@ -4,6 +4,7 @@ var querystring = require('qs');
 var fs = require('fs');
 var path = require('path');
 var request = require('request');
+var crypto = require('crypto');
 
 function TestingBot(options) {
   this.options = options || {};
@@ -27,13 +28,6 @@ function TestingBot(options) {
   }
 }
 
-TestingBot.prototype.getTestDetails = function(testID, callback) {
-  this.request({
-    method: 'GET',
-    url: '/tests/' + testID
-  }, callback);
-};
-
 TestingBot.prototype.getBrowsers = function(callback, type) {
   var data = {};
   if (type) {
@@ -46,24 +40,18 @@ TestingBot.prototype.getBrowsers = function(callback, type) {
   }, callback);
 };
 
-TestingBot.prototype.getLabTestDetails = function(testID, callback) {
-  this.request({
-    method: 'GET',
-    url: '/lab/' + testID
-  }, callback);
-};
-
-TestingBot.prototype.getTunnel = function(callback) {
+TestingBot.prototype.getUserInfo = function(callback) {
   this.request({
     method: 'GET',
-    url: '/tunnel'
+    url: '/user'
   }, callback);
 };
 
-TestingBot.prototype.getUserInfo = function(callback) {
+TestingBot.prototype.updateUserInfo = function(data, callback) {
   this.request({
-    method: 'GET',
-    url: '/user'
+    method: 'PUT',
+    url: '/user',
+    data: data
   }, callback);
 };
 
@@ -81,6 +69,56 @@ TestingBot.prototype.getTests = function(callback, offset, limit) {
   }, callback);
 };
 
+TestingBot.prototype.getTestDetails = function(testID, callback) {
+  this.request({
+    method: 'GET',
+    url: '/tests/' + testID
+  }, callback);
+};
+
+TestingBot.prototype.updateTest = function(data, testID, callback) {
+  this.request({
+    method: 'PUT',
+    url: '/tests/' + testID,
+    data: data
+  }, callback);
+};
+
+TestingBot.prototype.deleteTest = function(testID, callback) {
+  this.request({
+    method: 'DELETE',
+    url: '/tests/' + testID
+  }, callback);
+};
+
+TestingBot.prototype.stopTest = function(testID, callback) {
+  this.request({
+    method: 'PUT',
+    url: '/tests/' + testID + '/stop'
+  }, callback);
+};
+
+TestingBot.prototype.getTunnel = function(callback) {
+  this.request({
+    method: 'GET',
+    url: '/tunnel'
+  }, callback);
+};
+
+TestingBot.prototype.getTunnelList = function(callback) {
+  this.request({
+    method: 'GET',
+    url: '/tunnel/list'
+  }, callback);
+};
+
+TestingBot.prototype.deleteTunnel = function(tunnelId, callback) {
+  this.request({
+    method: 'DELETE',
+    url: '/tunnel/' + tunnelId
+  }, callback);
+};
+
 TestingBot.prototype.getLabTests = function(callback, offset, limit) {
   if (!offset) {
     offset = 0;
@@ -95,34 +133,39 @@ TestingBot.prototype.getLabTests = function(callback, offset, limit) {
   }, callback);
 };
 
-TestingBot.prototype.updateUserInfo = function(data, callback) {
+TestingBot.prototype.updateLabTest = function(data, testID, callback) {
   this.request({
     method: 'PUT',
-    url: '/user',
+    url: '/lab/' + testID,
     data: data
   }, callback);
 };
 
-TestingBot.prototype.updateTest = function(data, testID, callback) {
+TestingBot.prototype.getBuilds = function(callback, offset, limit) {
+  if (!offset) {
+    offset = 0;
+  }
+  if (!limit) {
+    limit = 10;
+  }
+
   this.request({
-    method: 'PUT',
-    url: '/tests/' + testID,
-    data: data
+    method: 'GET',
+    url: '/builds?offset=' + offset + '&limit=' + limit
   }, callback);
 };
 
-TestingBot.prototype.updateLabTest = function(data, testID, callback) {
+TestingBot.prototype.getTestsForBuild = function(buildId, callback) {
   this.request({
-    method: 'PUT',
-    url: '/lab/' + testID,
-    data: data
+    method: 'GET',
+    url: '/builds/' + buildId
   }, callback);
 };
 
-TestingBot.prototype.deleteTest = function(testID, callback) {
+TestingBot.prototype.deleteBuild = function(buildId, callback) {
   this.request({
     method: 'DELETE',
-    url: '/tests/' + testID
+    url: '/builds/' + buildId
   }, callback);
 };
 
@@ -133,6 +176,10 @@ TestingBot.prototype.deleteLabTest = function(testID, callback) {
   }, callback);
 };
 
+TestingBot.prototype.getAuthenticationHashForSharing = function(sessionId) {
+  return crypto.createHash('md5').update(this.options.api_key + ':' + this.options.api_secret + ':' + sessionId).digest('hex');
+};
+
 TestingBot.prototype.request = function(req_data, callback) {
   var requestPath = '/v1' + req_data.url;
   if (req_data.method === 'GET' && req_data.data) {
@@ -154,7 +201,7 @@ TestingBot.prototype.request = function(req_data, callback) {
 
   request(requestOptions, function(error, response) {
     var responseBody = null;
-    if (typeof(response.body) === 'string') {
+    if (response.body && typeof(response.body) === 'string') {
       response.body = JSON.parse(response.body);
     }
     if (response.statusCode.toString().substring(0, 1) === '2') {

package.json

@@ -2,7 +2,7 @@
   "author": "TestingBot <[email protected]> (testingbot.com)",
   "name": "testingbot-api",
   "description": "A wrapper around TestingBot's REST API",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "scripts": {
     "lint": "eslint .",
     "test": "make test"
@@ -13,19 +13,19 @@
     "url": "git://github.com/testingbot/testingbot-api.git"
   },
   "devDependencies": {
-    "eslint": "^3.15.0",
-    "eslint-config-airbnb-base": "^11.1.0",
-    "eslint-config-standard": "^10.2.1",
-    "eslint-plugin-import": "^2.2.0",
-    "eslint-plugin-promise": "^3.4.1",
-    "eslint-plugin-standard": "^3.0.1",
-    "mocha": "^3.1.2"
+    "eslint": "^5.12.1",
+    "eslint-config-airbnb-base": "^13.1.0",
+    "eslint-config-standard": "^12.0.0",
+    "eslint-plugin-import": "^2.16.0",
+    "eslint-plugin-promise": "^4.0.1",
+    "eslint-plugin-standard": "^4.0.0",
+    "mocha": "^5.2.0"
   },
   "engines": {
     "node": "*"
   },
   "dependencies": {
-    "qs": "^6.3.1",
-    "request": "^2.79.0"
+    "qs": "^6.6.0",
+    "request": "^2.88.0"
   }
 }

test/api_test.js

@@ -66,6 +66,11 @@ describe('Api Tests', function() {
     });
   });
 
+  it('should share a test', function(done) {
+    assert.equal(this.api.getAuthenticationHashForSharing('sampleSessionId'), '7af1007a329eeeef3c69577517ca827c');
+    done();
+  });
+
   it('should update a test by specifying legacy data', function(done) {
     var that = this;
     this.api.getTests(function(err, response) {