Add TestingBot Storage functionality

Author: delabiejochen

README.md

@@ -115,6 +115,20 @@ Deletes a single build
 api.deleteBuild(buildId, function(error, success) {});
 ```
 
+### uploadFile
+Uploads a local file to TestingBot Storage
+
+```javascript
+api.uploadFile(localFilePath, function(error, appUrl) {});
+```
+
+### uploadRemoteFile
+Uploads a remote file to TestingBot Storage
+
+```javascript
+api.uploadFile(remoteFileUrl, function(error, appUrl) {});
+```
+
 ### 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)

lib/api.js

@@ -8,8 +8,8 @@ var crypto = require('crypto');
 
 function TestingBot(options) {
   this.options = options || {};
-  this.options.api_key = this.options.api_key || process.env.TESTINGBOT_KEY || null;
-  this.options.api_secret = this.options.api_secret || process.env.TESTINGBOT_SECRET || null;
+  this.options.api_key = this.options.api_key || process.env.TESTINGBOT_KEY || process.env.TB_KEY || null;
+  this.options.api_secret = this.options.api_secret || process.env.TESTINGBOT_SECRET || process.env.TB_SECRET || null;
 
   if (!this.options.api_key || !this.options.api_secret) {
     try {
@@ -176,6 +176,49 @@ TestingBot.prototype.deleteLabTest = function(testID, callback) {
   }, callback);
 };
 
+TestingBot.prototype.uploadFile = function(localFilePath, callback) {
+  var requestOptions = {
+    method: 'POST',
+    uri: 'https://api.testingbot.com/v1/storage',
+    auth: {
+      user: this.options.api_key,
+      pass: this.options.api_secret,
+      sendImmediately: true
+    },
+    formData: {
+      file: fs.createReadStream(localFilePath)
+    }
+  };
+
+  request(requestOptions, function(error, response) {
+    var responseBody = null;
+    if (response) {
+      if (response.body && typeof(response.body) === 'string') {
+        response.body = JSON.parse(response.body);
+      }
+      if (response.statusCode.toString().substring(0, 1) === '2') {
+        responseBody = response.body;
+      } else {
+        error = response.body;
+      }
+    }
+
+    if (callback) {
+      callback(error, responseBody);
+    }
+  });
+};
+
+TestingBot.prototype.uploadRemoteFile = function(remoteUrl, callback) {
+  this.request({
+    method: 'POST',
+    url: '/storage/',
+    data: {
+      url: remoteUrl
+    }
+  }, callback);
+};
+
 TestingBot.prototype.getAuthenticationHashForSharing = function(sessionId) {
   return crypto.createHash('md5').update(this.options.api_key + ':' + this.options.api_secret + ':' + sessionId).digest('hex');
 };
@@ -201,13 +244,15 @@ TestingBot.prototype.request = function(req_data, callback) {
 
   request(requestOptions, function(error, response) {
     var responseBody = null;
-    if (response.body && typeof(response.body) === 'string') {
-      response.body = JSON.parse(response.body);
-    }
-    if (response.statusCode.toString().substring(0, 1) === '2') {
-      responseBody = response.body;
-    } else {
-      error = response.body;
+    if (response) {
+      if (response.body && typeof(response.body) === 'string') {
+        response.body = JSON.parse(response.body);
+      }
+      if (response.statusCode.toString().substring(0, 1) === '2') {
+        responseBody = response.body;
+      } else {
+        error = response.body;
+      }
     }
     if (callback) {
       callback(error, responseBody);

package.json

@@ -2,9 +2,9 @@
   "author": "TestingBot <[email protected]> (testingbot.com)",
   "name": "testingbot-api",
   "description": "A wrapper around TestingBot's REST API",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "scripts": {
-    "lint": "eslint .",
+    "lint": "eslint lib/",
     "test": "make test"
   },
   "homepage": "https://github.com/testingbot/testingbot-api",
@@ -25,7 +25,7 @@
     "node": "*"
   },
   "dependencies": {
-    "qs": "^6.6.0",
+    "qs": "^6.7.0",
     "request": "^2.88.0"
   }
 }

test/api_test.js

@@ -1,6 +1,8 @@
 'use strict';
+
 var TbApi = require('../lib/api.js');
 var assert = require('assert');
+var path = require('path');
 
 describe('Api Tests', function() {
   beforeEach(function(done) {
@@ -17,7 +19,7 @@ describe('Api Tests', function() {
   });
 
   it('should detect wrong credentials', function(done) {
-    var api = new TbApi({api_key: 'bogus', api_secret: 'bogus'});
+    var api = new TbApi({ api_key: 'bogus', api_secret: 'bogus' });
     api.getUserInfo(function(err, response) {
       assert.equal(response, null);
       assert.notEqual(err, null);
@@ -46,16 +48,16 @@ describe('Api Tests', function() {
       assert.equal(response.data && response.data.length > 0, true);
       var singleTest = response.data[0];
       that.api.getTestDetails(singleTest.id, function(err, response) {
-        assert.notEqual(response, null);      
+        assert.notEqual(response, null);
         done();
       });
     });
   });
 
   it('should update a user object', function(done) {
     var that = this;
-    var newName = "name_" + Math.round(Math.random()*10000);
-    this.api.updateUserInfo({ user: { first_name : newName } }, function(err, response) {
+    var newName = 'name_' + Math.round(Math.random() * 10000);
+    this.api.updateUserInfo({ user: { first_name: newName } }, function(err, response) {
       assert.equal(err, null);
       that.api.getUserInfo(function(err, response) {
         assert.notEqual(response, null);
@@ -78,10 +80,10 @@ describe('Api Tests', function() {
       var singleTest = response.data[0];
       that.api.getTestDetails(singleTest.id, function(err, response) {
         assert.notEqual(response, null);
-        var payload = { "test[success]" : "1", "test[status_message]" : "test" };
+        var payload = { 'test[success]': '1', 'test[status_message]': 'test' };
         that.api.updateTest(payload, singleTest.id, function(err) {
           that.api.getTestDetails(singleTest.id, function(err, response) {
-            assert.equal(response.status_message, "test");
+            assert.equal(response.status_message, 'test');
             done();
           });
         });
@@ -96,10 +98,10 @@ describe('Api Tests', function() {
       var singleTest = response.data[0];
       that.api.getTestDetails(singleTest.id, function(err, response) {
         assert.notEqual(response, null);
-        var payload = { test: { success: 1, status_message: "test2" } };
+        var payload = { test: { success: 1, status_message: 'test2' } };
         that.api.updateTest(payload, singleTest.id, function(err) {
           that.api.getTestDetails(singleTest.id, function(err, response) {
-            assert.equal(response.status_message, "test2");
+            assert.equal(response.status_message, 'test2');
             done();
           });
         });
@@ -121,4 +123,19 @@ describe('Api Tests', function() {
       });
     });
   });
-});
+
+  it('should be possible to upload a local file', function(done) {
+    var testFilePath = path.resolve(__dirname, 'test.apk');
+    this.api.uploadFile(testFilePath, function(err, response) {
+      assert(response.app_url !== undefined);
+      done();
+    });
+  });
+
+  it('should be possible to upload a remote file', function(done) {
+    this.api.uploadRemoteFile('https://testingbot.com/appium/sample.apk', function(err, response) {
+      assert(response.app_url !== undefined);
+      done();
+    });
+  });
+});

test/test.apk

@@ -0,0 +1 @@
+ok