webpagetest - npm Package Compare versions

Comparing version 0.7.3 to 0.7.4

lib/mapping.js

@@ -1330,3 +1330,3 @@ /**
     name: "getTesters",
-    options: [options.request],
+    options: [options.request, options.apikey],
     info: "list testers status and details",
@@ -1368,2 +1368,3 @@ },
     param: "id",
+    options: [options.apikey],
     info: "get the HTTP Archive (HAR) from test",
@@ -1374,3 +1375,3 @@ },
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the Google Page Speed results (if available) from test",
@@ -1381,3 +1382,3 @@ },
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the CPU, bandwidth and memory utilization data from test",
@@ -1388,3 +1389,3 @@ },
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the request data from test",
@@ -1395,3 +1396,3 @@ },
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the Chrome Developer Tools Timeline data (if available) from test",
@@ -1402,3 +1403,3 @@ },
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the Chrome Developer Tools Net log data (if available) from test",
@@ -1409,3 +1410,3 @@ },
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the Chrome Trace data (if available) from test",
@@ -1416,3 +1417,3 @@ },
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get the browser console log data (if available) from test",
@@ -1423,2 +1424,3 @@ },
     param: "id",
+    options: [options.apikey],
     info: "get test request info/details",
@@ -1430,2 +1432,3 @@ },
     optional: true,
+    options: [options.apikey],
     info: "get history of previously run tests",
@@ -1436,3 +1439,3 @@ },
     param: "id",
-    options: [options.run],
+    options: [options.run, options.apikey],
     info: "get Google CSI data (Client Side Instrumentation)",
@@ -1443,3 +1446,3 @@ },
     param: "id",
-    options: [options.run, options.response],
+    options: [options.run, options.response, options.apikey],
     info: "get response body for text resources",
@@ -1450,3 +1453,3 @@ },
     param: "id",
-    options: [options.run, options.image, options.waterfall],
+    options: [options.run, options.image, options.waterfall, options.apikey],
     info: "get the waterfall PNG image",
@@ -1457,3 +1460,3 @@ },
     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)",
@@ -1464,3 +1467,3 @@ },
     param: "tests",
-    options: [options.video],
+    options: [options.video, options.apikey],
     info: "create a video from <tests> (comma separated test ids)",
@@ -1471,2 +1474,3 @@ },
     param: "id",
+    options: [options.apikey],
     info: "get a html5 player for a video <id>",
@@ -1478,3 +1482,3 @@ },
     optional: true,
-    options: [options.listen],
+    options: [options.listen,options.apikey],
     info: "start webpagetest-api proxy server on <hostname>:<port> [hostname:%s]",
@@ -1481,0 +1485,0 @@ },

lib/webpagetest.js

@@ -94,7 +94,6 @@ /**
 
-  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";
 
@@ -101,0 +100,0 @@ if (agent) {

package.json

 {
   "name": "webpagetest",
-  "version": "0.7.3",
+  "version": "0.7.4",
   "description": "WebPageTest API wrapper for NodeJS",
@@ -5,0 +5,0 @@ "author": "WebPageTest <[e-mail]> (http://github.com/WebPageTest)",

README.md

@@ -6,3 +6,3 @@ <p align="center"><img width="80%" src="assets/images/recipe-banner.png" alt="WebPageTest Logo" /></p>
 
-[![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)
@@ -26,3 +26,3 @@ [![NPM Downloads](https://img.shields.io/npm/dm/webpagetest.svg?style=flat)](https://www.npmjs.org/package/webpagetest)
 ```bash
-webpagetest test https://docs.webpagetest.org/api/integrations/
+webpagetest test https://docs.webpagetest.org/api/integrations/ -k YOURAPIKEY
 ```
@@ -244,6 +244,6 @@
 
-#### 1. Get all available locations
+#### 1. Get API available locations
 
 ```bash
-$ webpagetest locations
+$ webpagetest locations -k YOURAPIKEY
 ```
@@ -276,6 +276,6 @@
 
-#### 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
+webpagetest test https://docs.webpagetest.org/api/integrations/ -k YOURAPIKEY --location SanJose_IE9
 ```
@@ -285,33 +285,2 @@
 {
-  "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
-```
-
-```javascript
-{
   "statusCode": 200,
@@ -331,6 +300,6 @@ "statusText": "Ok",
 
-#### 4. Check current test status
+#### 3. Check current test status
 
 ```bash
-webpagetest status 121025_PT_N8K
+webpagetest status 121025_PT_N8K -k YOURAPIKEY
 ```
@@ -353,6 +322,6 @@
 
-#### 5. Get test results
+#### 4. Get test results
 
 ```bash
-webpagetest results 121025_PT_N8K
+webpagetest results 121025_PT_N8K -k YOURAPIKEY 
 ```
@@ -389,19 +358,8 @@
 
-#### 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="
-}
-```
+#### 5. Get remaining tests count for the account
 
-#### 7. Get remaining tests count for the account
-
 ```bash
-webpagetest testBalance --key 1F2A3K4E5
+webpagetest testBalance -k YOURAPIKEY
 ```
@@ -408,0 +366,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Lines of code

117401

Worsened metrics

Total package byte prevSize

5845311

decreased by-0.01%

Number of lines in readme file

852

decreased by-4.7%

No dependency changes