Merge pull request #4 from max-ostapenko/rich-platypus

Pull the Wappalyzer config for a single test

Author: pmeenan

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
@@ -98,6 +98,7 @@ webpagetest --help
 - **-s, --server** _\<server\>_: the WPT server URL [https://www.webpagetest.org]
 - **-d, --dryrun**: just return the RESTful API URL
 - **-o, --out** _\<file\>_: place the output into \<file\>. Defaults to stdout
+- **--http_method** _\<method\>_: the HTTP method to use (GET, POST) [GET]
 
 _The default WPT server can also be specified via environment variable `WEBPAGETEST_SERVER`_
 
@@ -139,6 +140,7 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
 - **-b, --block** _\<urls\>_: space-delimited list of urls to block (substring match)
 - **-Z, --spof** _\<domains\>_: space-delimited list of domains to simulate failure by re-routing to blackhole.webpagetest.org to silently drop all requests
 - **-c, --custom** _\<script\>_: execute arbitrary javascript at the end of a test to collect custom metrics
+- **-w, --wappalyzerpr** _\<number\>_: set the wappalyzer fork PR number to use for technology detection
 - **-a, --authtype** _\<type\>_: type of authentication: 0 = Basic, 1 = SNS [0]
 - **-n, --notify** _\<e-mail\>_: e-mail address to notify with the test results
 - **-B, --pingback** _\<url\>_: URL to ping when the test is complete (the test ID will be passed as an "id" parameter)
@@ -239,10 +241,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
@@ -270,41 +272,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
@@ -323,10 +294,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
@@ -344,10 +315,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
@@ -379,23 +350,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
@@ -522,6 +482,7 @@ wpt.runTest(script, (err, data) => {
 
 - **dryRun**: _Boolean_, if `true`, method does not make an actual request to the API Server but rather returns an object with `url` which contains the actual URL to make the GET request to WebPageTest API Server
 - **server**: _String_, if specified, overrides the WebPageTest server informed in the constructor only for that method call
+- **http_method**: _String_, if specified, overrides the HTTP method in the constructor only for that method call (GET, POST) [GET]
 
 #### Test (works with `runTest` and `runTestAndWait`)
 
@@ -559,6 +520,7 @@ wpt.runTest(script, (err, data) => {
 - **block**: _String_, space-delimited list of urls to block (substring match)
 - **spof**: _String_, space-delimited list of domains to simulate failure by re-routing to blackhole.webpagetest.org to silently drop all requests
 - **customMetrics**: _String_, execute arbitrary JavaScript at the end of a test to collect custom metrics
+- **wappalyzerpr** _Integer_, set the wappalyzer fork PR number to use for technology detection
 - **authenticationType**: _Number_, type of authentication: 0 = Basic, 1 = SNS [0]
 - **notifyEmail**: _String_, e-mail address to notify with the test results
 - **pingback**: _String_, URL to ping when the test is complete (the test ID will be passed as an "id" parameter)

bin/webpagetest

@@ -269,14 +269,16 @@ function cleanupProgram() {
   delete program.server;
   delete program.dryrun;
   delete program.out;
+  delete program.http_method;
 }
 
 function execCommand() {
-  var wpt = new WebPageTest(program.server || defaultServer);
+  var wpt = new WebPageTest(program.server || defaultServer, options.key);
 
   // options
   if (options) {
     options.dryRun = program.dryrun;
+    options.http_method = program.http_method;
     args.push(options);
   }
 

lib/helper.js

@@ -5,25 +5,25 @@
  * Released under the MIT License
  */
 
-var xml2js = require('xml2js'),
-  url = require('url'),
-  os = require('os'),
-  csv = require('csv'),
-  entities = require('entities'),
-  qs = require('querystring');
+var xml2js   = require('xml2js'),
+    url      = require('url'),
+    os       = require('os'),
+    csv      = require('csv'),
+    entities = require('entities')
+    qs       = require('querystring');
 
-var parser = new xml2js.Parser({ explicitArray: false, mergeAttrs: true });
+var parser = new xml2js.Parser({explicitArray: false, mergeAttrs: true});
 
 var reNumber = /^[\.\+\-]?[\d\.]+$/,
-  reInvalidDec = /(?:\.\d*){2,}/,
-  reDec = /\./,
-  reLineBreak = /[\n\r]+/g,
-  reLastBreak = /\n$/,
-  reProtocol = /^https?:\/\//i,
-  reIp = /\d+\.\d+\.\d+\.\d+/, // 127.0.0.1
+    reInvalidDec = /(?:\.\d*){2,}/,
+    reDec = /\./,
+    reLineBreak = /[\n\r]+/g,
+    reLastBreak = /\n$/,
+    reProtocol = /^https?:\/\//i,
+    reIp = /\d+\.\d+\.\d+\.\d+/, // 127.0.0.1
 
-  TAB = '\t',
-  NEWLINE = '\n';
+    TAB = '\t',
+    NEWLINE = '\n';
 
 function parseNumber(s) {
   if (typeof s !== 'string' || !reNumber.test(s) || reInvalidDec.test(s)) {
@@ -35,7 +35,7 @@ function parseNumber(s) {
 
 function normalizeObj(root) {
   if (typeof root === 'object') {
-    Object.keys(root).forEach(function (key) {
+    Object.keys(root).forEach(function(key) {
       var value = root[key];
       if (typeof value === 'string') {
         if (value.length === 0 || value === '\n') {
@@ -63,8 +63,8 @@ function xmlToObj(xml, callback) {
 
 function svToObj(delimiter, headers, sv) {
   var data,
-    start = 0,
-    obj = {};
+      start = 0,
+      obj = {};
 
   delimiter = delimiter || ',';
 
@@ -102,11 +102,11 @@ function svToObj(delimiter, headers, sv) {
 }
 
 function csvParser(data, callback) {
-  csv.parse(data.toString(), { columns: true }, function (err, data) {
+  csv.parse(data.toString(), { columns: true }, function(err, data) {
     if (err) {
       callback.bind(this, err);
     }
-    csv.transform(data, function (row) {
+    csv.transform(data, function(row) {
       var key, value;
       for (key in row) {
         value = row[key].replace(/<b>|<\/b>/g, '');
@@ -170,18 +170,18 @@ function dryRun(config, path, form) {
       }),
       form: qs.stringify(form)
     };
-  } else {
-    return {
-      url: url.format({
-        protocol: config.protocol,
-        hostname: config.hostname,
-        port: (config.port !== 80 && config.port !== 443 ?
-          config.port : undefined),
-        pathname: path.pathname,
-        query: path.query
-      })
-    };
   }
+  
+  return {
+    url: url.format({
+      protocol: config.protocol,
+      hostname: config.hostname,
+      port: (config.port !== 80 && config.port !== 443 ?
+        config.port : undefined),
+      pathname: path.pathname,
+      query: path.query
+    })
+  };
 }
 
 // Normalize server config
@@ -235,8 +235,8 @@ function setQuery(map, options, query) {
   map.options.forEach(function eachOpts(opt) {
     Object.keys(opt).forEach(function eachOpt(key) {
       var param = opt[key],
-        name = param.name,
-        value = options[name] || options[key];
+          name = param.name,
+          value = options[name] || options[key];
 
       if (value !== undefined && param.api) {
         if (param.array) {