@readme/httpsnippet 2.4.5 → 3.0.1

package/src/targets/php/guzzle.js

@@ -0,0 +1,135 @@
+/**
+ * @description
+ * HTTP code snippet generator for PHP using Guzzle.
+ *
+ * @author
+ * @RobertoArruda
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+
+const { format } = require('util');
+const helpers = require('./helpers');
+const headerHelpers = require('../../helpers/headers');
+const CodeBuilder = require('../../helpers/code-builder');
+
+module.exports = function (source, options) {
+  const opts = {
+    closingTag: false,
+    indent: '  ',
+    noTags: false,
+    shortTags: false,
+    ...options,
+  };
+
+  const code = new CodeBuilder(opts.indent);
+
+  if (!opts.noTags) {
+    code.push(opts.shortTags ? '<?' : '<?php');
+  }
+
+  code.push("require_once('vendor/autoload.php');").blank();
+
+  const requestOptions = new CodeBuilder(opts.indent);
+
+  switch (source.postData.mimeType) {
+    case 'application/x-www-form-urlencoded':
+      requestOptions.push(
+        1,
+        "'form_params' => %s,",
+        helpers.convert(source.postData.paramsObj, opts.indent + opts.indent, opts.indent)
+      );
+      break;
+
+    case 'multipart/form-data': {
+      if (source.postData.params) {
+        const fields = [];
+
+        source.postData.params.forEach(function (param) {
+          if (param.fileName) {
+            const field = {
+              name: param.name,
+              filename: param.fileName,
+              contents: param.value,
+            };
+
+            if (param.contentType) {
+              field.headers = { 'Content-Type': param.contentType };
+            }
+
+            fields.push(field);
+          } else if (param.value) {
+            fields.push({
+              name: param.name,
+              contents: param.value,
+            });
+          }
+        });
+
+        if (fields.length) {
+          requestOptions.push(1, "'multipart' => %s", helpers.convert(fields, opts.indent + opts.indent, opts.indent));
+        }
+
+        // Guzzle adds its own boundary for multipart requests.
+        if (headerHelpers.hasHeader(source.headersObj, 'content-type')) {
+          if (headerHelpers.getHeader(source.headersObj, 'content-type').includes('boundary')) {
+            // eslint-disable-next-line no-param-reassign
+            delete source.headersObj[headerHelpers.getHeaderName(source.headersObj, 'content-type')];
+          }
+        }
+      }
+      break;
+    }
+
+    default:
+      if (source.postData.text) {
+        requestOptions.push(1, "'body' => %s,", helpers.convert(source.postData.text));
+      }
+  }
+
+  // construct headers
+  const headers = Object.keys(source.headersObj)
+    .sort()
+    .map(function (key) {
+      return opts.indent + opts.indent + format("'%s' => '%s',", key, source.headersObj[key]);
+    });
+
+  // construct cookies
+  const cookies = source.cookies.map(function (cookie) {
+    return `${encodeURIComponent(cookie.name)}=${encodeURIComponent(cookie.value)}`;
+  });
+
+  if (cookies.length) {
+    headers.push(opts.indent + opts.indent + format("'cookie' => '%s',", cookies.join('; ')));
+  }
+
+  if (headers.length) {
+    requestOptions.push(1, "'headers' => [").push(headers.join('\n')).push(1, '],');
+  }
+
+  code.push('$client = new \\GuzzleHttp\\Client();').blank();
+
+  if (requestOptions.code.length) {
+    code
+      .push(`$response = $client->request('${source.method}', '${source.fullUrl}', [`)
+      .push(requestOptions.join(','))
+      .push(']);');
+  } else {
+    code.push(`$response = $client->request('${source.method}', '${source.fullUrl}');`);
+  }
+
+  code.blank().push('echo $response->getBody();');
+
+  if (!opts.noTags && opts.closingTag) {
+    code.blank().push('?>');
+  }
+
+  return code.join();
+};
+
+module.exports.info = {
+  key: 'guzzle',
+  title: 'Guzzle v7',
+  link: 'http://docs.guzzlephp.org/en/stable/',
+  description: 'PHP with guzzle v7',
+};

package/src/targets/php/helpers.js

@@ -1,58 +1,60 @@
-'use strict'
-
-var convert = function (obj, indent, lastIndent) {
-  var i, result
+const convert = function (obj, indent, lastIndent) {
+  let i;
+  let result;
 
   if (!lastIndent) {
-    lastIndent = ''
+    // eslint-disable-next-line no-param-reassign
+    lastIndent = '';
   }
 
   switch (Object.prototype.toString.call(obj)) {
     case '[object Null]':
-      result = 'null'
-      break
+      result = 'null';
+      break;
 
     case '[object Undefined]':
-      result = 'null'
-      break
+      result = 'null';
+      break;
 
     case '[object String]':
-      result = "'" + obj.replace(/\\/g, '\\\\').replace(/'/g, "'") + "'"
-      break
+      result = `'${obj.replace(/\\/g, '\\\\').replace(/'/g, "'")}'`;
+      break;
 
     case '[object Number]':
-      result = obj.toString()
-      break
+      result = obj.toString();
+      break;
 
     case '[object Array]':
-      result = []
+      result = [];
 
       obj.forEach(function (item) {
-        result.push(convert(item, indent + indent, indent))
-      })
+        result.push(convert(item, indent + indent, indent));
+      });
 
-      result = '[\n' + indent + result.join(',\n' + indent) + '\n' + lastIndent + ']'
-      break
+      result = `[\n${indent}${result.join(`,\n${indent}`)}\n${lastIndent}]`;
+      break;
 
     case '[object Object]':
-      result = []
+      result = [];
+      // eslint-disable-next-line no-restricted-syntax
       for (i in obj) {
+        // eslint-disable-next-line no-prototype-builtins
         if (obj.hasOwnProperty(i)) {
-          result.push(convert(i, indent) + ' => ' + convert(obj[i], indent + indent, indent))
+          result.push(`${convert(i, indent)} => ${convert(obj[i], indent + indent, indent)}`);
         }
       }
-      result = '[\n' + indent + result.join(',\n' + indent) + '\n' + lastIndent + ']'
-      break
+      result = `[\n${indent}${result.join(`,\n${indent}`)}\n${lastIndent}]`;
+      break;
 
     default:
-      result = 'null'
+      result = 'null';
   }
 
-  return result
-}
+  return result;
+};
 
 module.exports = {
-  convert: convert,
+  convert,
   methods: [
     'ACL',
     'BASELINE_CONTROL',
@@ -80,6 +82,6 @@ module.exports = {
     'UNCHECKOUT',
     'UNLOCK',
     'UPDATE',
-    'VERSION_CONTROL'
-  ]
-}
+    'VERSION_CONTROL',
+  ],
+};

package/src/targets/php/http1.js

@@ -8,89 +8,78 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-var helpers = require('./helpers')
-var CodeBuilder = require('../../helpers/code-builder')
+const helpers = require('./helpers');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  var opts = Object.assign({
+  const opts = {
     closingTag: false,
     indent: '  ',
     noTags: false,
-    shortTags: false
-  }, options)
+    shortTags: false,
+    ...options,
+  };
 
-  var code = new CodeBuilder(opts.indent)
+  const code = new CodeBuilder(opts.indent);
 
   if (!opts.noTags) {
-    code.push(opts.shortTags ? '<?' : '<?php')
-        .blank()
+    code.push(opts.shortTags ? '<?' : '<?php').blank();
   }
 
-  if (!~helpers.methods.indexOf(source.method.toUpperCase())) {
-    code.push('HttpRequest::methodRegister(\'%s\');', source.method)
+  if (!helpers.methods.includes(source.method.toUpperCase())) {
+    code.push("HttpRequest::methodRegister('%s');", source.method);
   }
 
-  code.push('$request = new HttpRequest();')
-      .push('$request->setUrl(%s);', helpers.convert(source.url))
+  code.push('$request = new HttpRequest();').push('$request->setUrl(%s);', helpers.convert(source.url));
 
-  if (~helpers.methods.indexOf(source.method.toUpperCase())) {
-    code.push('$request->setMethod(HTTP_METH_%s);', source.method.toUpperCase())
+  if (helpers.methods.includes(source.method.toUpperCase())) {
+    code.push('$request->setMethod(HTTP_METH_%s);', source.method.toUpperCase());
   } else {
-    code.push('$request->setMethod(HttpRequest::HTTP_METH_%s);', source.method.toUpperCase())
+    code.push('$request->setMethod(HttpRequest::HTTP_METH_%s);', source.method.toUpperCase());
   }
 
-  code.blank()
+  code.blank();
 
   if (Object.keys(source.queryObj).length) {
-    code.push('$request->setQueryData(%s);', helpers.convert(source.queryObj, opts.indent))
-        .blank()
+    code.push('$request->setQueryData(%s);', helpers.convert(source.queryObj, opts.indent)).blank();
   }
 
   if (Object.keys(source.headersObj).length) {
-    code.push('$request->setHeaders(%s);', helpers.convert(source.headersObj, opts.indent))
-        .blank()
+    code.push('$request->setHeaders(%s);', helpers.convert(source.headersObj, opts.indent)).blank();
   }
 
   if (Object.keys(source.cookiesObj).length) {
-    code.push('$request->setCookies(%s);', helpers.convert(source.cookiesObj, opts.indent))
-        .blank()
+    code.push('$request->setCookies(%s);', helpers.convert(source.cookiesObj, opts.indent)).blank();
   }
 
-  switch (source.postData.mimeType) {
-    case 'application/x-www-form-urlencoded':
-      code.push('$request->setContentType(%s);', helpers.convert(source.postData.mimeType))
-          .push('$request->setPostFields(%s);', helpers.convert(source.postData.paramsObj, opts.indent))
-          .blank()
-      break
-
-    default:
-      if (source.postData.text) {
-        code.push('$request->setBody(%s);', helpers.convert(source.postData.text))
-            .blank()
-      }
+  if (source.postData.mimeType === 'application/x-www-form-urlencoded') {
+    code
+      .push('$request->setContentType(%s);', helpers.convert(source.postData.mimeType))
+      .push('$request->setPostFields(%s);', helpers.convert(source.postData.paramsObj, opts.indent))
+      .blank();
+  } else if (source.postData.text) {
+    code.push('$request->setBody(%s);', helpers.convert(source.postData.text)).blank();
   }
 
-  code.push('try {')
-      .push(1, '$response = $request->send();')
-      .blank()
-      .push(1, 'echo $response->getBody();')
-      .push('} catch (HttpException $ex) {')
-      .push(1, 'echo $ex;')
-      .push('}')
+  code
+    .push('try {')
+    .push(1, '$response = $request->send();')
+    .blank()
+    .push(1, 'echo $response->getBody();')
+    .push('} catch (HttpException $ex) {')
+    .push(1, 'echo $ex;')
+    .push('}');
 
   if (!opts.noTags && opts.closingTag) {
-    code.blank()
-        .push('?>')
+    code.blank().push('?>');
   }
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'http1',
   title: 'HTTP v1',
   link: 'http://php.net/manual/en/book.http.php',
-  description: 'PHP with pecl/http v1'
-}
+  description: 'PHP with pecl/http v1',
+};

package/src/targets/php/http2.js

@@ -8,124 +8,124 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-var helpers = require('./helpers')
-var headerHelpers = require('../../helpers/headers')
-var CodeBuilder = require('../../helpers/code-builder')
+const helpers = require('./helpers');
+const headerHelpers = require('../../helpers/headers');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  var opts = Object.assign({
+  const opts = {
     closingTag: false,
     indent: '  ',
     noTags: false,
-    shortTags: false
-  }, options)
+    shortTags: false,
+    ...options,
+  };
 
-  var code = new CodeBuilder(opts.indent)
-  var hasBody = false
+  const code = new CodeBuilder(opts.indent);
+  let hasBody = false;
 
   if (!opts.noTags) {
-    code.push(opts.shortTags ? '<?' : '<?php')
-        .blank()
+    code.push(opts.shortTags ? '<?' : '<?php').blank();
   }
 
-  code.push('$client = new http\\Client;')
-      .push('$request = new http\\Client\\Request;')
-      .blank()
+  code.push('$client = new http\\Client;').push('$request = new http\\Client\\Request;').blank();
 
   switch (source.postData.mimeType) {
     case 'application/x-www-form-urlencoded':
-      code.push('$body = new http\\Message\\Body;')
-          .push('$body->append(new http\\QueryString(%s));', helpers.convert(source.postData.paramsObj, opts.indent))
-          .blank()
-      hasBody = true
-      break
-
-    case 'multipart/form-data':
-      var files = []
-      var fields = {}
-
-      source.postData.params.forEach(function (param) {
-        if (param.fileName) {
-          files.push({
-            name: param.name,
-            type: param.contentType,
-            file: param.fileName,
-            data: param.value
-          })
-        } else if (param.value) {
-          fields[param.name] = param.value
-        }
-      })
-
-      code.push('$body = new http\\Message\\Body;')
-          .push('$body->addForm(%s, %s);',
+      code
+        .push('$body = new http\\Message\\Body;')
+        .push('$body->append(new http\\QueryString(%s));', helpers.convert(source.postData.paramsObj, opts.indent))
+        .blank();
+      hasBody = true;
+      break;
+
+    case 'multipart/form-data': {
+      if (source.postData.params) {
+        const files = [];
+        const fields = {};
+
+        source.postData.params.forEach(function (param) {
+          if (param.fileName) {
+            files.push({
+              name: param.name,
+              type: param.contentType,
+              file: param.fileName,
+              data: param.value,
+            });
+          } else if (param.value) {
+            fields[param.name] = param.value;
+          }
+        });
+
+        code
+          .push('$body = new http\\Message\\Body;')
+          .push(
+            '$body->addForm(%s, %s);',
             Object.keys(fields).length ? helpers.convert(fields, opts.indent) : 'null',
             files.length ? helpers.convert(files, opts.indent) : 'null'
-          )
-
-      // remove the contentType header
-      if (headerHelpers.hasHeader(source.headersObj, 'content-type')) {
-        if (headerHelpers.getHeader(source.headersObj, 'content-type').indexOf('boundary')) {
-          delete source.headersObj[headerHelpers.getHeaderName(source.headersObj, 'content-type')]
+          );
+
+        // remove the contentType header
+        if (headerHelpers.hasHeader(source.headersObj, 'content-type')) {
+          if (headerHelpers.getHeader(source.headersObj, 'content-type').includes('boundary')) {
+            // eslint-disable-next-line no-param-reassign
+            delete source.headersObj[headerHelpers.getHeaderName(source.headersObj, 'content-type')];
+          }
         }
-      }
 
-      code.blank()
+        code.blank();
 
-      hasBody = true
-      break
+        hasBody = true;
+      }
+      break;
+    }
 
     default:
       if (source.postData.text) {
-        code.push('$body = new http\\Message\\Body;')
-            .push('$body->append(%s);', helpers.convert(source.postData.text))
-            .blank()
-        hasBody = true
+        code
+          .push('$body = new http\\Message\\Body;')
+          .push('$body->append(%s);', helpers.convert(source.postData.text))
+          .blank();
+        hasBody = true;
       }
   }
 
-  code.push('$request->setRequestUrl(%s);', helpers.convert(source.url))
-      .push('$request->setRequestMethod(%s);', helpers.convert(source.method))
+  code
+    .push('$request->setRequestUrl(%s);', helpers.convert(source.url))
+    .push('$request->setRequestMethod(%s);', helpers.convert(source.method));
 
   if (hasBody) {
-    code.push('$request->setBody($body);')
-        .blank()
+    code.push('$request->setBody($body);').blank();
   }
 
   if (Object.keys(source.queryObj).length) {
-    code.push('$request->setQuery(new http\\QueryString(%s));', helpers.convert(source.queryObj, opts.indent))
-        .blank()
+    code.push('$request->setQuery(new http\\QueryString(%s));', helpers.convert(source.queryObj, opts.indent)).blank();
   }
 
   if (Object.keys(source.headersObj).length) {
-    code.push('$request->setHeaders(%s);', helpers.convert(source.headersObj, opts.indent))
-        .blank()
+    code.push('$request->setHeaders(%s);', helpers.convert(source.headersObj, opts.indent)).blank();
   }
 
   if (Object.keys(source.cookiesObj).length) {
-    code.blank()
-        .push('$client->setCookies(%s);', helpers.convert(source.cookiesObj, opts.indent))
-        .blank()
+    code.blank().push('$client->setCookies(%s);', helpers.convert(source.cookiesObj, opts.indent)).blank();
   }
 
-  code.push('$client->enqueue($request)->send();')
-      .push('$response = $client->getResponse();')
-      .blank()
-      .push('echo $response->getBody();')
+  code
+    .push('$client->enqueue($request)->send();')
+    .push('$response = $client->getResponse();')
+    .blank()
+    .push('echo $response->getBody();');
 
   if (!opts.noTags && opts.closingTag) {
-    code.blank()
-        .push('?>')
+    code.blank().push('?>');
   }
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'http2',
   title: 'HTTP v2',
   link: 'http://devel-m6w6.rhcloud.com/mdref/http',
-  description: 'PHP with pecl/http v2'
-}
+  description: 'PHP with pecl/http v2',
+};

package/src/targets/php/index.js

@@ -1,14 +1,14 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'php',
     title: 'PHP',
     extname: '.php',
-    default: 'curl'
+    default: 'curl',
+    cli: 'php %s',
   },
 
   curl: require('./curl'),
   http1: require('./http1'),
-  http2: require('./http2')
-}
+  http2: require('./http2'),
+  guzzle: require('./guzzle'),
+};

package/src/targets/powershell/common.js

@@ -1,55 +1,60 @@
-'use strict'
-
-var CodeBuilder = require('../../helpers/code-builder')
-var helpers = require('../../helpers/headers')
+const CodeBuilder = require('../../helpers/code-builder');
+const helpers = require('../../helpers/headers');
 
 module.exports = function (command) {
-  return function (source, options) {
-    var code = new CodeBuilder()
-    var methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS']
+  return function (source) {
+    const code = new CodeBuilder();
+    const methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'];
 
-    if (methods.indexOf(source.method.toUpperCase()) === -1) {
-      return 'Method not supported'
+    if (!methods.includes(source.method.toUpperCase())) {
+      return 'Method not supported';
     }
 
-    var commandOptions = []
+    const commandOptions = [];
 
     // Add headers, including the cookies
-    var headers = Object.keys(source.headersObj)
+    const headers = Object.keys(source.headersObj);
 
     // construct headers
     if (headers.length) {
-      code.push('$headers=@{}')
+      code.push('$headers=@{}');
       headers.forEach(function (key) {
-        if (key !== 'connection') { // Not allowed
-          code.push('$headers.Add("%s", "%s")', key, source.headersObj[key])
+        if (key !== 'connection') {
+          // Not allowed
+          code.push('$headers.Add("%s", "%s")', key, source.headersObj[key]);
         }
-      })
-      commandOptions.push('-Headers $headers')
+      });
+      commandOptions.push('-Headers $headers');
     }
 
     // construct cookies
     if (source.cookies.length) {
-      code.push('$session = New-Object Microsoft.PowerShell.Commands.WebRequestSession')
+      code.push('$session = New-Object Microsoft.PowerShell.Commands.WebRequestSession');
 
       source.cookies.forEach(function (cookie) {
-        code.push('$cookie = New-Object System.Net.Cookie')
+        code.push('$cookie = New-Object System.Net.Cookie');
 
-        code.push("$cookie.Name = '%s'", cookie.name)
-        code.push("$cookie.Value = '%s'", cookie.value)
-        code.push("$cookie.Domain = '%s'", source.uriObj.host)
+        code.push("$cookie.Name = '%s'", cookie.name);
+        code.push("$cookie.Value = '%s'", cookie.value);
+        code.push("$cookie.Domain = '%s'", source.uriObj.host);
 
-        code.push('$session.Cookies.Add($cookie)')
-      })
-      commandOptions.push('-WebSession $session')
+        code.push('$session.Cookies.Add($cookie)');
+      });
+      commandOptions.push('-WebSession $session');
     }
 
     if (source.postData.text) {
-      commandOptions.push("-ContentType '" + helpers.getHeader(source.allHeaders, 'content-type') + "'")
-      commandOptions.push("-Body '" + source.postData.text + "'")
+      commandOptions.push(`-ContentType '${helpers.getHeader(source.allHeaders, 'content-type')}'`);
+      commandOptions.push(`-Body '${source.postData.text}'`);
     }
 
-    code.push("$response = %s -Uri '%s' -Method %s %s", command, source.fullUrl, source.method, commandOptions.join(' '))
-    return code.join()
-  }
-}
+    code.push(
+      "$response = %s -Uri '%s' -Method %s %s",
+      command,
+      source.fullUrl,
+      source.method,
+      commandOptions.join(' ')
+    );
+    return code.join();
+  };
+};