Merge branch 'master' into gentle-mite

Author: max-ostapenko

README.md

@@ -3,7 +3,7 @@
 
 # WebPageTest API Wrapper for NodeJS
 
-[![Build Status](https://travis-ci.com/WebPageTest/webpagetest-api.svg?branch=master)](https://travis-ci.com/WebPageTest/webpagetest-api)
+<!-- [![Build Status](https://travis-ci.com/WebPageTest/webpagetest-api.svg?branch=master)](https://travis-ci.com/WebPageTest/webpagetest-api) -->
 [![NPM Version](https://img.shields.io/npm/v/webpagetest.svg?style=flat)](https://www.npmjs.org/package/webpagetest)
 [![NPM Downloads](https://img.shields.io/npm/dm/webpagetest.svg?style=flat)](https://www.npmjs.org/package/webpagetest)
 
@@ -22,7 +22,7 @@ npm install webpagetest -g
 ### Command line
 
 ```bash
-webpagetest test https://docs.webpagetest.org/api/integrations/
+webpagetest test https://docs.webpagetest.org/api/integrations/ -k YOURAPIKEY
 ```
 
 ### Docker
@@ -240,10 +240,10 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
 
 ### Examples
 
-#### 1. Get all available locations
+#### 1. Get API available locations
 
 ```bash
-$ webpagetest locations
+$ webpagetest locations -k YOURAPIKEY
 ```
 
 ```javascript
@@ -271,41 +271,10 @@ $ webpagetest locations
 }
 ```
 
-#### 2. Get API available locations
+#### 2. Run test on https://docs.webpagetest.org/api/integrations/ from San Jose on IE9
 
 ```bash
-webpagetest locations --key 1F2A3K4E5
-```
-
-```javascript
-{
-  "response": {
-    "statusCode": 200, "statusText": "Ok",
-    "data": {
-      "location": [
-        ...
-        {
-          "id": "SanJose_IE9",
-          "Label": "San Jose, CA USA (IE 9,Chrome,Firefox)",
-          "location": "SanJose_IE9",
-          "Browser": "IE 9",
-          "PendingTests": {
-            "p1": 0, "p2": 0, "p3": 0, "p4": 0, "p5": 2, "p6": 2, "p7": 0,
-            "p8": 0, "p9": 0, "Total": 7, "HighPriority": 2, "LowPriority": 4,
-            "Testing": 1, "Idle": 0
-          }
-        },
-        ...
-      ]
-    }
-  }
-}
-```
-
-#### 3. Run test on https://docs.webpagetest.org/api/integrations/ from San Jose on IE9
-
-```bash
-webpagetest test https://docs.webpagetest.org/api/integrations/ --key 1F2A3K4E5 --location SanJose_IE9
+webpagetest test https://docs.webpagetest.org/api/integrations/ -k YOURAPIKEY --location SanJose_IE9
 ```
 
 ```javascript
@@ -324,10 +293,10 @@ webpagetest test https://docs.webpagetest.org/api/integrations/ --key 1F2A3K4E5
 }
 ```
 
-#### 4. Check current test status
+#### 3. Check current test status
 
 ```bash
-webpagetest status 121025_PT_N8K
+webpagetest status 121025_PT_N8K -k YOURAPIKEY
 ```
 
 ```javascript
@@ -345,10 +314,10 @@ webpagetest status 121025_PT_N8K
 }
 ```
 
-#### 5. Get test results
+#### 4. Get test results
 
 ```bash
-webpagetest results 121025_PT_N8K
+webpagetest results 121025_PT_N8K -k YOURAPIKEY 
 ```
 
 ```javascript
@@ -380,23 +349,12 @@ webpagetest results 121025_PT_N8K
 }
 ```
 
-#### 6. Get test waterfall thumbnail from repeat view as data URI
-
-```bash
-webpagetest waterfall 121025_PT_N8K --thumbnail --cached --uri
-```
 
-```javascript
-{
-  "type": "image/png",
-  "data": "iVBORw0KGgoAAAANSUhEUgA...RK5CYII="
-}
-```
 
-#### 7. Get remaining tests count for the account
+#### 5. Get remaining tests count for the account
 
 ```bash
-webpagetest testBalance --key 1F2A3K4E5
+webpagetest testBalance -k YOURAPIKEY
 ```
 
 ```javascript

bin/webpagetest

@@ -273,7 +273,7 @@ function cleanupProgram() {
 }
 
 function execCommand() {
-  var wpt = new WebPageTest(program.server || defaultServer);
+  var wpt = new WebPageTest(program.server || defaultServer, options.key);
 
   // options
   if (options) {

lib/mapping.js

@@ -1332,7 +1332,7 @@ var commands = {
   },
   testers: {
     name: "getTesters",
-    options: [options.request],
+    options: [options.request, options.apikey],
     info: "list testers status and details",
   },
   test: {
@@ -1369,101 +1369,105 @@ var commands = {
   har: {
     name: "getHARData",
     param: "id",
+    options: [options.apikey],
     info: "get the HTTP Archive (HAR) from test",
   },
   pagespeed: {
     name: "getPageSpeedData",
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the Google Page Speed results (if available) from test",
   },
   utilization: {
     name: "getUtilizationData",
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the CPU, bandwidth and memory utilization data from test",
   },
   request: {
     name: "getRequestData",
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the request data from test",
   },
   timeline: {
     name: "getTimelineData",
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the Chrome Developer Tools Timeline data (if available) from test",
   },
   netlog: {
     name: "getNetLogData",
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the Chrome Developer Tools Net log data (if available) from test",
   },
   chrometrace: {
     name: "getChromeTraceData",
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the Chrome Trace data (if available) from test",
   },
   console: {
     name: "getConsoleLogData",
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the browser console log data (if available) from test",
   },
   testinfo: {
     name: "getTestInfo",
     param: "id",
+    options: [options.apikey],
     info: "get test request info/details",
   },
   history: {
     name: "getHistory",
     param: "days",
     optional: true,
+    options: [options.apikey],
     info: "get history of previously run tests",
   },
   googlecsi: {
     name: "getGoogleCsiData",
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get Google CSI data (Client Side Instrumentation)",
   },
   response: {
     name: "getResponseBody",
     param: "id",
-    options: [options.run, options.response],
+    options: [options.run, options.response, options.apikey],
     info: "get response body for text resources",
   },
   waterfall: {
     name: "getWaterfallImage",
     param: "id",
-    options: [options.run, options.image, options.waterfall],
+    options: [options.run, options.image, options.waterfall, options.apikey],
     info: "get the waterfall PNG image",
   },
   screenshot: {
     name: "getScreenshotImage",
     param: "id",
-    options: [options.run, options.image, options.screenshot],
+    options: [options.run, options.image, options.screenshot, options.apikey],
     info: "get the fully loaded page screenshot in JPG format (PNG if in full resolution)",
   },
   video: {
     name: "createVideo",
     param: "tests",
-    options: [options.video],
+    options: [options.video, options.apikey],
     info: "create a video from <tests> (comma separated test ids)",
   },
   player: {
     name: "getEmbedVideoPlayer",
     param: "id",
+    options: [options.apikey],
     info: "get a html5 player for a video <id>",
   },
   listen: {
     name: "listen",
     param: "hostname:port",
     optional: true,
-    options: [options.listen],
+    options: [options.listen,options.apikey],
     info: "start webpagetest-api proxy server on <hostname>:<port> [hostname:%s]",
   },
 };

lib/webpagetest.js

@@ -99,11 +99,10 @@ function get(config, pathname, data, proxy, agent, callback, encoding) {
     options.headers['Content-Type'] = 'application/x-www-form-urlencoded';
   }
 
-  if (encoding !== "binary") {
-    options.headers["X-WPT-API-KEY"] = this.config.key;
-    options.headers["accept-encoding"] = "gzip,deflate";
-    options.headers["User-Agent"] = "WebpagetestNodeWrapper/v0.6.0";
-  }
+  // api key always required
+  options.headers["X-WPT-API-KEY"] = this.config.key;
+  options.headers["accept-encoding"] = "gzip,deflate";
+  options.headers["User-Agent"] = "WebpagetestNodeWrapper/v0.7.4";
 
   if (agent) {
     options.agent = agent;
@@ -347,9 +346,6 @@ function getLocations(options, callback) {
   options = options === callback ? undefined : options;
 
   var query = helper.setQuery(mapping.commands.locations, options);
-  if (!query.k && this.config.key && !options.allLocations) {
-    query.k = this.config.key;
-  }
   return api.call(this, paths.locations, callback, query, options);
 }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpagetest",
-  "version": "0.7.1",
+  "version": "0.7.4",
   "description": "WebPageTest API wrapper for NodeJS",
   "author": "WebPageTest <github@WebPageTest.com> (http://github.com/WebPageTest)",
   "homepage": "http://github.com/WebPageTest/webpagetest-api",
@@ -34,9 +34,9 @@
     "csv": "^6.2.2",
     "entities": "^4.4.0",
     "mocha": "^10.1.0",
-    "xml2js": "^0.4.23"
+    "xml2js": "^0.6.2"
   },
   "devDependencies": {
     "nock": "^13.2.9"
   }
-}
+}