@readme/httpsnippet 2.5.1 → 3.0.3

package/README.md

@@ -30,7 +30,7 @@ const HTTPSnippet = require('httpsnippet');
 
 const snippet = new HTTPSnippet({
   method: 'GET',
-  url: 'http://mockbin.com/request'
+  url: 'https://httpbin.com/anything'
 });
 ```
 
@@ -40,7 +40,7 @@ Type: `object`
 
 Available options:
 
-* `escapeQueryStrings` (`boolean`): In the event of you supplying a `source` that alreay contains escaped query strings, this allows you to disable automatic of query strings and prevents them from being double-escaped.
+* `harIsAlreadyEncoded` (`boolean`): In the event of you supplying a `source` HAR that already contains escaped data (query and cookie parameters)strings, this allows you to disable automatic encoding of those parameters to prevent them from being double-escaped.
 
 ### convert(target [, options])
 
@@ -62,7 +62,7 @@ const HTTPSnippet = require('httpsnippet');
 
 const snippet = new HTTPSnippet({
   method: 'GET',
-  url: 'http://mockbin.com/request'
+  url: 'https://httpbin.com/anything'
 });
 
 // generate Node.js: Native output
@@ -100,7 +100,7 @@ const HTTPSnippet = require('httpsnippet');
 
 const snippet = new HTTPSnippet({
   method: 'GET',
-  url: 'http://mockbin.com/request'
+  url: 'https://httpbin.com/anything'
 });
 
 // generate Shell: cURL output
@@ -147,7 +147,7 @@ HTTPSnippet.addTargetClient('node', customClient);
 
 ## Documentation
 
-At the heart of this module is the [HAR Format](http://www.softwareishard.com/blog/har-12-spec/#request) as the HTTP request description format, please review some of the sample JSON HAR Request objects in [test fixtures](/test/fixtures/requests), or read the [HAR Docs](http://www.softwareishard.com/blog/har-12-spec/#request) for more details.
+At the heart of this module is the [HAR Format](http://www.softwareishard.com/blog/har-12-spec/#request) as the HTTP request description format, please review some of the sample JSON HAR Request objects in [test fixtures](/__tests__/__fixtures__/requests), or read the [HAR Docs](http://www.softwareishard.com/blog/har-12-spec/#request) for more details.
 
 For detailed information on each target, please review the [wiki](https://github.com/kong/httpsnippet/wiki).
 
@@ -155,10 +155,20 @@ For detailed information on each target, please review the [wiki](https://github
 
 The main difference between this library and the upstream [httpsnippet](https://github.com/Kong/httpsnippet) library are:
 
-* This targets Node 10+
-* Does not ship with a CLI component
-* Adds a `useObjectBody` option to the `node` and `javascript` targets. This option is a boolean flag that causes the request body to be rendered as an object literal wrapped in `JSON.stringify`. If disabled, it falls back to the original behavior of a stringified object body. This flag defaults to disabled.
-* Contains a `escapeQueryStrings` option on the core library to disable escaping of query strings in URLs. Helpful if the HAR being supplied already has them escaped.
+* Does not ship with a CLI component.
+* The `fetch` target for Node and JS both treat body payloads as an object literal and wrap it within `JSON.stringify()`. We do this to keep those targets looking nicer with those kinds of payloads.
+* Contains a `harIsAlreadyEncoded` option on the core library to disable [escaping](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) of cookies and query strings in URLs. Helpful if the HAR being supplied already has them escaped.
+* PHP Guzzle snippets come with `require_once('vendor/autoload.php');` at the top of them.
+* A full integration suite for testing out snippets the library creates.
+
+### Running the integration suite
+
+```
+docker-compose run integration_node
+docker-compose run integration_php
+docker-compose run integration_python
+docker-compose run integration_shell
+```
 
 ## License
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.5.1",
+  "version": "3.0.3",
   "name": "@readme/httpsnippet",
   "description": "HTTP Request snippet generator for *most* languages",
   "homepage": "https://github.com/readmeio/httpsnippet",
@@ -47,39 +47,35 @@
     "url": "https://github.com/readmeio/httpsnippet.git"
   },
   "scripts": {
-    "coverage": "istanbul cover --dir coverage _mocha -- --fgrep 'Request Validation' --invert -R dot",
-    "posttest": "npm run coverage",
-    "pretest": "standard && echint",
-    "quick": "mocha --no-timeouts --fgrep 'Request Validation' --invert",
-    "test": "mocha --no-timeouts"
-  },
-  "standard": {
-    "env": "mocha",
-    "ignore": [
-      "**/test/fixtures/**"
-    ]
-  },
-  "echint": {
-    "ignore": [
-      "coverage/**",
-      "**/node_modules/**",
-      "**/fixtures/**"
-    ]
+    "lint": "eslint .",
+    "pretest": "npm run lint",
+    "prettier": "prettier --list-different --write \"./**/**.js\"",
+    "test": "jest --coverage"
   },
   "devDependencies": {
-    "echint": "^4.0.2",
-    "glob": "^7.1.6",
-    "istanbul": "^0.4.0",
-    "mocha": "^8.2.1",
-    "require-directory": "^2.1.1",
-    "should": "^13.2.3",
-    "standard": "^16.0.3"
+    "@readme/eslint-config": "^8.0.2",
+    "eslint": "^8.3.0",
+    "glob": "^7.1.7",
+    "jest": "^27.2.0",
+    "prettier": "^2.5.0",
+    "require-directory": "^2.1.1"
   },
   "dependencies": {
     "event-stream": "4.0.1",
-    "form-data": "3.0.0",
+    "form-data": "^4.0.0",
     "har-validator": "^5.0.0",
-    "qs": "^6.9.6",
+    "qs": "^6.10.1",
     "stringify-object": "^3.3.0"
+  },
+  "prettier": "@readme/eslint-config/prettier",
+  "jest": {
+    "coveragePathIgnorePatterns": [
+      "<rootDir>/__tests__/(.*)/__fixtures__/",
+      "<rootDir>/node_modules"
+    ],
+    "testPathIgnorePatterns": [
+      "<rootDir>/__tests__/__fixtures__/",
+      "<rootDir>/__tests__/targets/"
+    ]
   }
 }

package/src/helpers/code-builder.js

@@ -1,6 +1,5 @@
-'use strict'
-
-const util = require('util')
+/* eslint-disable no-param-reassign */
+const { format } = require('util');
 
 /**
  * Helper object to format and aggragate lines of code.
@@ -11,93 +10,99 @@ const util = require('util')
  * @param {string} indentation Desired indentation character for aggregated lines of code
  * @param {string} join Desired character to join each line of code
  */
-const CodeBuilder = function (indentation, join) {
-  this.code = []
-  this.indentation = indentation
-  this.lineJoin = join || '\n'
-}
-
-/**
- * Add given indentation level to given string and format the string (variadic)
- * @param {number} [indentationLevel=0] - Desired level of indentation for this line
- * @param {string} line - Line of code. Can contain formatting placeholders
- * @param {...anyobject} - Parameter to bind to `line`'s formatting placeholders
- * @return {string}
- *
- * @example
- *   var builder = CodeBuilder('\t')
- *
- *   builder.buildLine('console.log("hello world")')
- *   // returns: 'console.log("hello world")'
- *
- *   builder.buildLine(2, 'console.log("hello world")')
- *   // returns: 'console.log("\t\thello world")'
- *
- *   builder.buildLine(2, 'console.log("%s %s")', 'hello', 'world')
- *   // returns: 'console.log("\t\thello world")'
- */
-CodeBuilder.prototype.buildLine = function (indentationLevel, line) {
-  let lineIndentation = ''
-  let slice = 2
-  if (Object.prototype.toString.call(indentationLevel) === '[object String]') {
-    slice = 1
-    line = indentationLevel
-    indentationLevel = 0
-  } else if (indentationLevel === null) {
-    return null
+class CodeBuilder {
+  constructor(indentation, join) {
+    this.code = [];
+    this.indentation = indentation;
+    this.lineJoin = join || '\n';
   }
 
-  while (indentationLevel) {
-    lineIndentation += this.indentation
-    indentationLevel--
-  }
+  /**
+   * Add given indentation level to given string and format the string (variadic)
+   * @param {number} [indentationLevel=0] - Desired level of indentation for this line
+   * @param {string} line - Line of code. Can contain formatting placeholders
+   * @param {...anyobject} - Parameter to bind to `line`'s formatting placeholders
+   * @return {string}
+   *
+   * @example
+   *   var builder = CodeBuilder('\t')
+   *
+   *   builder.buildLine('console.log("hello world")')
+   *   // returns: 'console.log("hello world")'
+   *
+   *   builder.buildLine(2, 'console.log("hello world")')
+   *   // returns: 'console.log("\t\thello world")'
+   *
+   *   builder.buildLine(2, 'console.log("%s %s")', 'hello', 'world')
+   *   // returns: 'console.log("\t\thello world")'
+   */
+  buildLine(indentationLevel, line) {
+    let lineIndentation = '';
+    let slice = 2;
+    if (Object.prototype.toString.call(indentationLevel) === '[object String]') {
+      slice = 1;
+      line = indentationLevel;
+      indentationLevel = 0;
+    } else if (indentationLevel === null) {
+      return null;
+    }
 
-  const format = Array.prototype.slice.call(arguments, slice, arguments.length)
-  format.unshift(lineIndentation + line)
+    while (indentationLevel) {
+      lineIndentation += this.indentation;
+      // eslint-disable-next-line no-plusplus
+      indentationLevel--;
+    }
 
-  return util.format.apply(this, format)
-}
+    // eslint-disable-next-line prefer-rest-params
+    const data = Array.prototype.slice.call(arguments, slice, arguments.length);
+    data.unshift(lineIndentation + line);
 
-/**
- * Invoke buildLine() and add the line at the top of current lines
- * @param {number} [indentationLevel=0] Desired level of indentation for this line
- * @param {string} line Line of code
- * @return {this}
- */
-CodeBuilder.prototype.unshift = function () {
-  this.code.unshift(this.buildLine.apply(this, arguments))
+    return format.apply(this, data);
+  }
 
-  return this
-}
+  /**
+   * Invoke buildLine() and add the line at the top of current lines
+   * @param {number} [indentationLevel=0] Desired level of indentation for this line
+   * @param {string} line Line of code
+   * @return {this}
+   */
+  unshift(...args) {
+    // eslint-disable-next-line prefer-spread
+    this.code.unshift(this.buildLine.apply(this, args));
 
-/**
- * Invoke buildLine() and add the line at the bottom of current lines
- * @param {number} [indentationLevel=0] Desired level of indentation for this line
- * @param {string} line Line of code
- * @return {this}
- */
-CodeBuilder.prototype.push = function () {
-  this.code.push(this.buildLine.apply(this, arguments))
+    return this;
+  }
 
-  return this
-}
+  /**
+   * Invoke buildLine() and add the line at the bottom of current lines
+   * @param {number} [indentationLevel=0] Desired level of indentation for this line
+   * @param {string} line Line of code
+   * @return {this}
+   */
+  push(...args) {
+    // eslint-disable-next-line prefer-spread
+    this.code.push(this.buildLine.apply(this, args));
 
-/**
- * Add an empty line at the end of current lines
- * @return {this}
- */
-CodeBuilder.prototype.blank = function () {
-  this.code.push(null)
+    return this;
+  }
 
-  return this
-}
+  /**
+   * Add an empty line at the end of current lines
+   * @return {this}
+   */
+  blank() {
+    this.code.push(null);
 
-/**
- * Concatenate all current lines using the given lineJoin
- * @return {string}
- */
-CodeBuilder.prototype.join = function () {
-  return this.code.join(this.lineJoin)
+    return this;
+  }
+
+  /**
+   * Concatenate all current lines using the given lineJoin
+   * @return {string}
+   */
+  join() {
+    return this.code.join(this.lineJoin);
+  }
 }
 
-module.exports = CodeBuilder
+module.exports = CodeBuilder;

package/src/helpers/form-data.js

@@ -26,10 +26,10 @@
  * Extracted from https://github.com/node-fetch/node-fetch/blob/64c5c296a0250b852010746c76144cb9e14698d9/src/utils/form-data.js
  */
 
-const carriage = '\r\n'
-const dashes = '-'.repeat(2)
+const carriage = '\r\n';
+const dashes = '-'.repeat(2);
 
-const NAME = Symbol.toStringTag
+const NAME = Symbol.toStringTag;
 
 const isBlob = object => {
   return (
@@ -39,13 +39,13 @@ const isBlob = object => {
     typeof object.stream === 'function' &&
     typeof object.constructor === 'function' &&
     /^(Blob|File)$/.test(object[NAME])
-  )
-}
+  );
+};
 
 /**
  * @param {string} boundary
  */
-const getFooter = boundary => `${dashes}${boundary}${dashes}${carriage.repeat(2)}`
+const getFooter = boundary => `${dashes}${boundary}${dashes}${carriage.repeat(2)}`;
 
 /**
  * @param {string} boundary
@@ -54,18 +54,18 @@ const getFooter = boundary => `${dashes}${boundary}${dashes}${carriage.repeat(2)
  *
  * @return {string}
  */
-function getHeader (boundary, name, field) {
-  let header = ''
+function getHeader(boundary, name, field) {
+  let header = '';
 
-  header += `${dashes}${boundary}${carriage}`
-  header += `Content-Disposition: form-data; name="${name}"`
+  header += `${dashes}${boundary}${carriage}`;
+  header += `Content-Disposition: form-data; name="${name}"`;
 
   if (isBlob(field)) {
-    header += `; filename="${field.name}"${carriage}`
-    header += `Content-Type: ${field.type || 'application/octet-stream'}`
+    header += `; filename="${field.name}"${carriage}`;
+    header += `Content-Type: ${field.type || 'application/octet-stream'}`;
   }
 
-  return `${header}${carriage.repeat(2)}`
+  return `${header}${carriage.repeat(2)}`;
 }
 
 /**
@@ -74,32 +74,34 @@ function getHeader (boundary, name, field) {
 module.exports.getBoundary = () => {
   // This generates a 50 character boundary similar to those used by Firefox.
   // They are optimized for boyer-moore parsing.
-  let boundary = '--------------------------'
+  let boundary = '--------------------------';
+  // eslint-disable-next-line no-plusplus
   for (let i = 0; i < 24; i++) {
-    boundary += Math.floor(Math.random() * 10).toString(16)
+    boundary += Math.floor(Math.random() * 10).toString(16);
   }
 
-  return boundary
-}
+  return boundary;
+};
 
 /**
  * @param {FormData} form
  * @param {string} boundary
  */
-module.exports.formDataIterator = function * (form, boundary) {
+module.exports.formDataIterator = function* (form, boundary) {
+  // eslint-disable-next-line no-restricted-syntax
   for (const [name, value] of form) {
-    yield getHeader(boundary, name, value)
+    yield getHeader(boundary, name, value);
 
     if (isBlob(value)) {
-      yield * value.stream()
+      yield* value.stream();
     } else {
-      yield value
+      yield value;
     }
 
-    yield carriage
+    yield carriage;
   }
 
-  yield getFooter(boundary)
-}
+  yield getFooter(boundary);
+};
 
-module.exports.isBlob = isBlob
+module.exports.isBlob = isBlob;

package/src/helpers/headers.js

@@ -7,7 +7,7 @@ module.exports = {
    * @return {string}
    */
   getHeader: (headers, name) => {
-    return headers[Object.keys(headers).find(k => k.toLowerCase() === name.toLowerCase())]
+    return headers[Object.keys(headers).find(k => k.toLowerCase() === name.toLowerCase())];
   },
 
   /**
@@ -18,12 +18,9 @@ module.exports = {
    * @return {string}
    */
   getHeaderName: (headers, name) => {
-    // eslint-disable-next-line array-callback-return
     return Object.keys(headers).find(k => {
-      if (k.toLowerCase() === name.toLowerCase()) {
-        return k
-      }
-    })
+      return k.toLowerCase() === name.toLowerCase();
+    });
   },
 
   /**
@@ -34,7 +31,7 @@ module.exports = {
    * @return {(integer|boolean)}
    */
   hasHeader: (headers, name) => {
-    return Boolean(Object.keys(headers).find(k => k.toLowerCase() === name.toLowerCase()))
+    return Boolean(Object.keys(headers).find(k => k.toLowerCase() === name.toLowerCase()));
   },
 
   /**
@@ -43,15 +40,9 @@ module.exports = {
    * @param {string}} mimeType
    * @returns {boolean}
    */
-  isMimeTypeJson: (mimeType) => {
-    return [
-      'application/json',
-      'application/x-json',
-      'text/json',
-      'text/x-json',
-      '+json'
-    ].some(function (type) {
-      return mimeType.indexOf(type) > -1
-    })
-  }
-}
+  isMimeTypeJson: mimeType => {
+    return ['application/json', 'application/x-json', 'text/json', 'text/x-json', '+json'].some(function (type) {
+      return mimeType.indexOf(type) > -1;
+    });
+  },
+};

package/src/helpers/reducer.js

@@ -1,24 +1,20 @@
-'use strict'
-
+/* eslint-disable no-param-reassign */
 module.exports = function (obj, pair) {
   if (obj[pair.name] === undefined) {
-    obj[pair.name] = pair.value
-    return obj
+    obj[pair.name] = pair.value;
+    return obj;
   }
 
   // If we already have it as array just push the value
-  if (obj[pair.name] instanceof Array) {
-    obj[pair.name].push(pair.value)
-    return obj
+  if (Array.isArray(obj[pair.name])) {
+    obj[pair.name].push(pair.value);
+    return obj;
   }
 
   // convert to array
-  const arr = [
-    obj[pair.name],
-    pair.value
-  ]
+  const arr = [obj[pair.name], pair.value];
 
-  obj[pair.name] = arr
+  obj[pair.name] = arr;
 
-  return obj
-}
+  return obj;
+};