@readme/httpsnippet 2.4.5 → 3.0.1

package/src/targets/powershell/index.js

@@ -1,13 +1,11 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'powershell',
     title: 'Powershell',
     extname: '.ps1',
-    default: 'webrequest'
+    default: 'webrequest',
   },
 
   webrequest: require('./webrequest'),
-  restmethod: require('./restmethod')
-}
+  restmethod: require('./restmethod'),
+};

package/src/targets/powershell/restmethod.js

@@ -1,10 +1,8 @@
-'use strict'
-
-module.exports = require('./common')('Invoke-RestMethod')
+module.exports = require('./common')('Invoke-RestMethod');
 
 module.exports.info = {
   key: 'restmethod',
   title: 'Invoke-RestMethod',
   link: 'https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod',
-  description: 'Powershell Invoke-RestMethod client'
-}
+  description: 'Powershell Invoke-RestMethod client',
+};

package/src/targets/powershell/webrequest.js

@@ -1,10 +1,8 @@
-'use strict'
-
-module.exports = require('./common')('Invoke-WebRequest')
+module.exports = require('./common')('Invoke-WebRequest');
 
 module.exports.info = {
   key: 'webrequest',
   title: 'Invoke-WebRequest',
   link: 'https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-WebRequest',
-  description: 'Powershell Invoke-WebRequest client'
-}
+  description: 'Powershell Invoke-WebRequest client',
+};

package/src/targets/python/helpers.js

@@ -1,6 +1,4 @@
-'use strict'
-
-var util = require('util')
+const { format } = require('util');
 
 /**
  * Create an string of given length filled with blank spaces
@@ -9,26 +7,27 @@ var util = require('util')
  * @param {string} str String to pad out with
  * @return {string}
  */
-function buildString (length, str) {
-  return Array.apply(null, new Array(length)).map(String.prototype.valueOf, str).join('')
+function buildString(length, str) {
+  // eslint-disable-next-line prefer-spread
+  return Array.apply(null, new Array(length)).map(String.prototype.valueOf, str).join('');
 }
 
 /**
  * Create a string corresponding to a Dictionary or Array literal representation with pretty option
  * and indentation.
  */
-function concatValues (concatType, values, pretty, indentation, indentLevel) {
-  var currentIndent = buildString(indentLevel, indentation)
-  var closingBraceIndent = buildString(indentLevel - 1, indentation)
-  var join = pretty ? ',\n' + currentIndent : ', '
-  var openingBrace = concatType === 'object' ? '{' : '['
-  var closingBrace = concatType === 'object' ? '}' : ']'
+function concatValues(concatType, values, pretty, indentation, indentLevel) {
+  const currentIndent = buildString(indentLevel, indentation);
+  const closingBraceIndent = buildString(indentLevel - 1, indentation);
+  const join = pretty ? `,\n${currentIndent}` : ', ';
+  const openingBrace = concatType === 'object' ? '{' : '[';
+  const closingBrace = concatType === 'object' ? '}' : ']';
 
   if (pretty) {
-    return openingBrace + '\n' + currentIndent + values.join(join) + '\n' + closingBraceIndent + closingBrace
-  } else {
-    return openingBrace + values.join(join) + closingBrace
+    return `${openingBrace}\n${currentIndent}${values.join(join)}\n${closingBraceIndent}${closingBrace}`;
   }
+
+  return openingBrace + values.join(join) + closingBrace;
 }
 
 module.exports = {
@@ -40,41 +39,47 @@ module.exports = {
    * @return {string}
    */
   literalRepresentation: function (value, opts, indentLevel) {
-    indentLevel = indentLevel === undefined ? 1 : indentLevel + 1
+    // eslint-disable-next-line no-param-reassign
+    indentLevel = indentLevel === undefined ? 1 : indentLevel + 1;
 
     switch (Object.prototype.toString.call(value)) {
       case '[object Number]':
-        return value
+        return value;
 
-      case '[object Array]':
-        var pretty = false
-        var valuesRepresentation = value.map(function (v) {
-          // Switch to prettify if the value is a dictionary with multiple keys
-          if (Object.prototype.toString.call(v) === '[object Object]') {
-            pretty = Object.keys(v).length > 1
-          }
-          return this.literalRepresentation(v, opts, indentLevel)
-        }.bind(this))
-        return concatValues('array', valuesRepresentation, pretty, opts.indent, indentLevel)
+      case '[object Array]': {
+        let pretty = false;
+        const valuesRepresentation = value.map(
+          function (v) {
+            // Switch to prettify if the value is a dictionary with multiple keys
+            if (Object.prototype.toString.call(v) === '[object Object]') {
+              pretty = Object.keys(v).length > 1;
+            }
+            return this.literalRepresentation(v, opts, indentLevel);
+          }.bind(this)
+        );
+        return concatValues('array', valuesRepresentation, pretty, opts.indent, indentLevel);
+      }
 
-      case '[object Object]':
-        var keyValuePairs = []
-        for (var k in value) {
-          keyValuePairs.push(util.format('"%s": %s', k, this.literalRepresentation(value[k], opts, indentLevel)))
+      case '[object Object]': {
+        const keyValuePairs = [];
+        // eslint-disable-next-line guard-for-in, no-restricted-syntax
+        for (const k in value) {
+          keyValuePairs.push(format('"%s": %s', k, this.literalRepresentation(value[k], opts, indentLevel)));
         }
-        return concatValues('object', keyValuePairs, opts.pretty && keyValuePairs.length > 1, opts.indent, indentLevel)
+        return concatValues('object', keyValuePairs, opts.pretty && keyValuePairs.length > 1, opts.indent, indentLevel);
+      }
 
       case '[object Null]':
-        return 'None'
+        return 'None';
 
       case '[object Boolean]':
-        return value ? 'True' : 'False'
+        return value ? 'True' : 'False';
 
       default:
         if (value === null || value === undefined) {
-          return ''
+          return '';
         }
-        return '"' + value.toString().replace(/"/g, '\\"') + '"'
+        return `"${value.toString().replace(/"/g, '\\"')}"`;
     }
-  }
-}
+  },
+};

package/src/targets/python/index.js

@@ -1,13 +1,12 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'python',
     title: 'Python',
     extname: '.py',
-    default: 'python3'
+    default: 'python3',
+    cli: 'python3 %s',
   },
 
   python3: require('./python3'),
-  requests: require('./requests')
-}
+  requests: require('./requests'),
+};

package/src/targets/python/python3.js

@@ -8,85 +8,73 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
+const CodeBuilder = require('../../helpers/code-builder');
 
-var CodeBuilder = require('../../helpers/code-builder')
-
-module.exports = function (source, options) {
-  var code = new CodeBuilder()
+module.exports = function (source) {
+  const code = new CodeBuilder();
   // Start Request
-  code.push('import http.client')
-      .blank()
+  code.push('import http.client').blank();
 
   // Check which protocol to be used for the client connection
-  var protocol = source.uriObj.protocol
+  const protocol = source.uriObj.protocol;
   if (protocol === 'https:') {
-    code.push('conn = http.client.HTTPSConnection("%s")', source.uriObj.host)
-        .blank()
+    code.push('conn = http.client.HTTPSConnection("%s")', source.uriObj.host).blank();
   } else {
-    code.push('conn = http.client.HTTPConnection("%s")', source.uriObj.host)
-        .blank()
+    code.push('conn = http.client.HTTPConnection("%s")', source.uriObj.host).blank();
   }
 
   // Create payload string if it exists
-  var payload = JSON.stringify(source.postData.text)
+  const payload = JSON.stringify(source.postData.text);
   if (payload) {
-    code.push('payload = %s', payload)
-        .blank()
+    code.push('payload = %s', payload).blank();
   }
 
   // Create Headers
-  var header
-  var headers = source.allHeaders
-  var headerCount = Object.keys(headers).length
+  const headers = source.allHeaders;
+  const headerCount = Object.keys(headers).length;
   if (headerCount === 1) {
-    for (header in headers) {
-      code.push('headers = { \'%s\': "%s" }', header, headers[header])
-          .blank()
-    }
+    Object.keys(headers).forEach(header => {
+      code.push('headers = { \'%s\': "%s" }', header, headers[header]).blank();
+    });
   } else if (headerCount > 1) {
-    var count = 1
+    let count = 1;
 
-    code.push('headers = {')
+    code.push('headers = {');
 
-    for (header in headers) {
+    Object.keys(headers).forEach(header => {
+      // eslint-disable-next-line no-plusplus
       if (count++ !== headerCount) {
-        code.push('    \'%s\': "%s",', header, headers[header])
+        code.push('    \'%s\': "%s",', header, headers[header]);
       } else {
-        code.push('    \'%s\': "%s"', header, headers[header])
+        code.push('    \'%s\': "%s"', header, headers[header]);
       }
-    }
+    });
 
-    code.push('    }')
-        .blank()
+    code.push('    }').blank();
   }
 
   // Make Request
-  var method = source.method
-  var path = source.uriObj.path
+  const method = source.method;
+  const path = source.uriObj.path;
   if (payload && headerCount) {
-    code.push('conn.request("%s", "%s", payload, headers)', method, path)
+    code.push('conn.request("%s", "%s", payload, headers)', method, path);
   } else if (payload && !headerCount) {
-    code.push('conn.request("%s", "%s", payload)', method, path)
+    code.push('conn.request("%s", "%s", payload)', method, path);
   } else if (!payload && headerCount) {
-    code.push('conn.request("%s", "%s", headers=headers)', method, path)
+    code.push('conn.request("%s", "%s", headers=headers)', method, path);
   } else {
-    code.push('conn.request("%s", "%s")', method, path)
+    code.push('conn.request("%s", "%s")', method, path);
   }
 
   // Get Response
-  code.blank()
-      .push('res = conn.getresponse()')
-      .push('data = res.read()')
-      .blank()
-      .push('print(data.decode("utf-8"))')
+  code.blank().push('res = conn.getresponse()').push('data = res.read()').blank().push('print(data.decode("utf-8"))');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'python3',
   title: 'http.client',
   link: 'https://docs.python.org/3/library/http.client.html',
-  description: 'Python3 HTTP Client'
-}
+  description: 'Python3 HTTP Client',
+};

package/src/targets/python/requests.js

@@ -8,118 +8,94 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-var util = require('util')
-var CodeBuilder = require('../../helpers/code-builder')
-var helpers = require('./helpers')
+const { format } = require('util');
+const CodeBuilder = require('../../helpers/code-builder');
+const helpers = require('./helpers');
 
 module.exports = function (source, options) {
-  var opts = Object.assign({
+  const opts = {
     indent: '    ',
-    pretty: true
-  }, options)
+    pretty: true,
+    ...options,
+  };
 
   // Start snippet
-  var code = new CodeBuilder('    ')
+  const code = new CodeBuilder(opts.indent);
 
   // Import requests
-  code.push('import requests')
-      .blank()
+  code.push('import requests').blank();
 
   // Set URL
-  code.push('url = "%s"', source.url)
-      .blank()
-
-  // Construct query string
-  if (Object.keys(source.queryObj).length) {
-    var qs = 'querystring = ' + JSON.stringify(source.queryObj)
-
-    code.push(qs)
-        .blank()
-  }
+  code.push('url = "%s"', source.fullUrl).blank();
 
   // Construct payload
-  let hasPayload = false
-  let jsonPayload = false
-  switch (source.postData.mimeType) {
-    case 'application/json':
-      if (source.postData.jsonObj) {
-        code.push('payload = %s', helpers.literalRepresentation(source.postData.jsonObj, opts))
-        jsonPayload = true
-        hasPayload = true
-      }
-      break
-
-    default:
-      var payload = JSON.stringify(source.postData.text)
-      if (payload) {
-        code.push('payload = %s', payload)
-        hasPayload = true
-      }
+  let hasPayload = false;
+  let jsonPayload = false;
+  if (source.postData.mimeType === 'application/json') {
+    if (source.postData.jsonObj) {
+      code.push('payload = %s', helpers.literalRepresentation(source.postData.jsonObj, opts));
+      jsonPayload = true;
+      hasPayload = true;
+    }
+  } else {
+    const payload = JSON.stringify(source.postData.text);
+    if (payload) {
+      code.push('payload = %s', payload);
+      hasPayload = true;
+    }
   }
 
   // Construct headers
-  var header
-  var headers = source.allHeaders
-  var headerCount = Object.keys(headers).length
+  const headers = source.allHeaders;
+  const headerCount = Object.keys(headers).length;
 
   if (headerCount === 1) {
-    for (header in headers) {
-      code.push('headers = {"%s": "%s"}', header, headers[header])
-          .blank()
-    }
+    Object.keys(headers).forEach(header => {
+      code.push('headers = {"%s": "%s"}', header, headers[header]).blank();
+    });
   } else if (headerCount > 1) {
-    var count = 1
+    let count = 1;
 
-    code.push('headers = {')
+    code.push('headers = {');
 
-    for (header in headers) {
+    Object.keys(headers).forEach(header => {
+      // eslint-disable-next-line no-plusplus
       if (count++ !== headerCount) {
-        code.push(1, '"%s": "%s",', header, headers[header])
+        code.push(1, '"%s": "%s",', header, headers[header]);
       } else {
-        code.push(1, '"%s": "%s"', header, headers[header])
+        code.push(1, '"%s": "%s"', header, headers[header]);
       }
-    }
+    });
 
-    code.push('}')
-        .blank()
+    code.push('}').blank();
   }
 
   // Construct request
-  var method = source.method
-  var request = util.format('response = requests.request("%s", url', method)
+  const method = source.method;
+  let request = format('response = requests.request("%s", url', method);
 
   if (hasPayload) {
     if (jsonPayload) {
-      request += ', json=payload'
+      request += ', json=payload';
     } else {
-      request += ', data=payload'
+      request += ', data=payload';
     }
   }
 
   if (headerCount > 0) {
-    request += ', headers=headers'
+    request += ', headers=headers';
   }
 
-  if (qs) {
-    request += ', params=querystring'
-  }
-
-  request += ')'
-
-  code.push(request)
-      .blank()
+  request += ')';
 
-      // Print response
-      .push('print(response.text)')
+  code.push(request).blank().push('print(response.text)');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'requests',
   title: 'Requests',
   link: 'http://docs.python-requests.org/en/latest/api/#requests.request',
-  description: 'Requests HTTP library'
-}
+  description: 'Requests HTTP library',
+};