Merge pull request #148 from abdulsuhail/issue-147-fix

added getTestBalance function

Author: tkadlec

README.md

@@ -56,6 +56,7 @@ $ webpagetest --help
 * **locations** _[options]_: list locations and the number of pending tests
 * **testers** _[options]_: list testers status and details
 * **test** _[options] \<url_or_script\>_: run test, _\<url_or_script\>_ can also be a path to a script file
+* **testBalance** _[options]_: get remaining tests for the account
 * **restart** _\<id\>_: restart test
 * **cancel** _\<id\>_: cancel running/pending test
 * **har** _\<id\>_: get the HTTP Archive (HAR) from test
@@ -159,7 +160,7 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
 * **--timeout** _\<seconds\>_: timeout for polling and waiting results [no timeout]
 * **--lighthouse**: perform lighthouse test (Chrome only, Linux agent only)
 
-#### API Key (works for **test**, **restart**,**locations** and **cancel** commands)
+#### API Key (works for **test**, **restart**,**locations**, **testBalance** and **cancel** commands)
 * **-k, --key** _\<api_key\>_:API key (if assigned). Contact the WebPageTest server administrator for a key if required or request an API key for limited testing at [webpagetest.org/getkey.php](https://www.webpagetest.org/getkey.php)
 
 #### Request (works for **status**, **results**, **locations**, **testers** and **test** commands)
@@ -351,6 +352,18 @@ $ webpagetest waterfall 121025_PT_N8K --thumbnail --cached --uri
 }
 ```
 
+#### 7. Get remaining tests count for the account
+```bash
+$ webpagetest testBalance --key 1F2A3K4E5
+```
+```javascript
+{
+    "data": {
+        "remaining": 1175
+    }
+}
+```
+
 #### Run test on https://docs.webpagetest.org/api/integrations/ and poll results every 5 seconds timing out in 60 seconds
 ```bash
 $ webpagetest test https://docs.webpagetest.org/api/integrations/ --poll 5 --timeout 60
@@ -390,6 +403,7 @@ Methods and options (including the one letter shorthands) are the same when usin
 * `getTestResults(id, options, callback)`
 * `getLocations(options, callback)`
 * `getTesters(options, callback)`
+* `getTestBalance(options, callback)`
 * `runTest(url_or_script, options, callback)`
 * `restartTest(id, options, callback)`
 * `cancelTest(id, options, callback)`

lib/mapping.js

@@ -782,6 +782,11 @@ var commands = {
     options: [options.request,options.apikey],
     info: 'list locations and the number of pending tests'
   },
+  'testBalance': {
+    name: 'getTestBalance',
+    options: [options.apikey],
+    info: 'get remaining tests for the account'
+  },
   'testers': {
     name: 'getTesters',
     options: [options.request],

lib/webpagetest.js

@@ -24,6 +24,7 @@ var paths = {
   testResults: 'jsonResult.php',
   locations: 'getLocations.php',
   testers: 'getTesters.php',
+  testBalance: 'testBalance.php',
   test: 'runtest.php',
   gzip: 'getgzip.php',
   har: 'export.php',
@@ -315,6 +316,17 @@ function getTesters(options, callback) {
   return api.call(this, paths.testers, callback, query, options);
 }
 
+function getTestBalance(options, callback) {
+  callback = callback || options;
+  options = options === callback ? undefined : options;
+
+  var query = helper.setQuery(mapping.commands.testBalance, options);
+  if (!query.k && this.config.key) {
+    query.k = this.config.key;
+  }
+  return api.call(this, paths.testBalance, callback, query, options);
+}
+
 function runTest(what, options, callback) {
   var query = {};
 
@@ -778,6 +790,7 @@ WebPageTest.prototype = {
   restartTest: restartTest,
   cancelTest: cancelTest,
   getPageSpeedData: getPageSpeedData,
+  getTestBalance : getTestBalance,
   getHARData: getHARData,
   getUtilizationData: getUtilizationData,
   getRequestData: getRequestData,

test/command-line-test.js

@@ -327,7 +327,7 @@ describe('WebPageTest Command Line', function() {
     '', 'status', 'results', 'locations', 'testers', 'test', 'restart', 'cancel', 'har',
     'pagespeed', 'utilization', 'request', 'timeline', 'netlog', 'chrometrace',
     'console', 'testinfo', 'history', 'googlecsi', 'response', 'waterfall',
-    'screenshot', 'video', 'player', 'listen', 'batch'
+    'screenshot', 'video', 'player', 'listen', 'batch','testBalance'
   ].forEach(function eachCmd(command) {
       it('gets a ' + command + ' help input and returns the help text', function(done) {
         exec(mock(command + ' --help'), function(err, data) {

test/fixtures/command-line/help-testBalance.txt

@@ -0,0 +1,9 @@
+Usage: webpagetest testBalance [options]
+
+get remaining tests for the account
+
+Options:
+  -k, --key <api_key>                 API key (if assigned). Contact the
+                                      WebPageTest server administrator for a
+                                      key if required
+  -h, --help          display help for command

test/fixtures/command-line/help.txt

@@ -14,6 +14,7 @@ Commands:
   results [options] <id>            get test results
   locations [options]               list locations and the number of pending
                                     tests
+  testBalance [options]             get remaining tests for the account
   testers [options]                 list testers status and details
   test [options] <url_or_script>    run test
   restart [options] <id>            restart test