@readme/httpsnippet 2.5.0 → 3.0.2

package/src/targets/ocaml/cohttp.js

@@ -8,64 +8,66 @@
  * 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')
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  const opts = Object.assign({
-    indent: '  '
-  }, options)
+  const opts = {
+    indent: '  ',
+    ...options,
+  };
 
-  const methods = ['get', 'post', 'head', 'delete', 'patch', 'put', 'options']
-  const code = new CodeBuilder(opts.indent)
+  const methods = ['get', 'post', 'head', 'delete', 'patch', 'put', 'options'];
+  const code = new CodeBuilder(opts.indent);
 
-  code.push('open Cohttp_lwt_unix')
+  code
+    .push('open Cohttp_lwt_unix')
     .push('open Cohttp')
     .push('open Lwt')
     .blank()
-    .push('let uri = Uri.of_string "%s" in', source.fullUrl)
+    .push('let uri = Uri.of_string "%s" in', source.fullUrl);
 
   // Add headers, including the cookies
-  const headers = Object.keys(source.allHeaders)
+  const headers = Object.keys(source.allHeaders);
 
   if (headers.length === 1) {
-    code.push('let headers = Header.add (Header.init ()) "%s" "%s" in', headers[0], source.allHeaders[headers[0]])
+    code.push('let headers = Header.add (Header.init ()) "%s" "%s" in', headers[0], source.allHeaders[headers[0]]);
   } else if (headers.length > 1) {
-    code.push('let headers = Header.add_list (Header.init ()) [')
+    code.push('let headers = Header.add_list (Header.init ()) [');
 
     headers.forEach(function (key) {
-      code.push(1, '("%s", "%s");', key, source.allHeaders[key])
-    })
+      code.push(1, '("%s", "%s");', key, source.allHeaders[key]);
+    });
 
-    code.push('] in')
+    code.push('] in');
   }
 
   // Add body
   if (source.postData.text) {
     // Just text
-    code.push('let body = Cohttp_lwt_body.of_string %s in', JSON.stringify(source.postData.text))
+    code.push('let body = Cohttp_lwt_body.of_string %s in', JSON.stringify(source.postData.text));
   }
 
   // Do the request
-  code.blank()
+  code.blank();
 
-  code.push('Client.call %s%s%s uri',
+  code.push(
+    'Client.call %s%s%s uri',
     headers.length ? '~headers ' : '',
     source.postData.text ? '~body ' : '',
-    (methods.indexOf(source.method.toLowerCase()) >= 0 ? ('`' + source.method.toUpperCase()) : '(Code.method_of_string "' + source.method + '")')
-  )
+    methods.indexOf(source.method.toLowerCase()) >= 0
+      ? `\`${source.method.toUpperCase()}`
+      : `(Code.method_of_string "${source.method}")`
+  );
 
   // Catch result
-  code.push('>>= fun (res, body_stream) ->')
-    .push(1, '(* Do stuff with the result *)')
+  code.push('>>= fun (res, body_stream) ->').push(1, '(* Do stuff with the result *)');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'cohttp',
   title: 'CoHTTP',
   link: 'https://github.com/mirage/ocaml-cohttp',
-  description: 'Cohttp is a very lightweight HTTP server using Lwt or Async for OCaml'
-}
+  description: 'Cohttp is a very lightweight HTTP server using Lwt or Async for OCaml',
+};

package/src/targets/ocaml/index.js

@@ -1,12 +1,10 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'ocaml',
     title: 'OCaml',
     extname: '.ml',
-    default: 'cohttp'
+    default: 'cohttp',
   },
 
-  cohttp: require('./cohttp')
-}
+  cohttp: require('./cohttp'),
+};

package/src/targets/php/curl.js

@@ -8,101 +8,108 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-const util = require('util')
-const CodeBuilder = require('../../helpers/code-builder')
+const { format } = require('util');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  const opts = Object.assign({
+  const opts = {
     closingTag: false,
     indent: '  ',
     maxRedirects: 10,
     namedErrors: false,
     noTags: false,
     shortTags: false,
-    timeout: 30
-  }, options)
+    timeout: 30,
+    ...options,
+  };
 
-  const 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();
   }
 
-  code.push('$curl = curl_init();')
-    .blank()
-
-  const curlOptions = [{
-    escape: true,
-    name: 'CURLOPT_PORT',
-    value: source.uriObj.port
-  }, {
-    escape: true,
-    name: 'CURLOPT_URL',
-    value: source.fullUrl
-  }, {
-    escape: false,
-    name: 'CURLOPT_RETURNTRANSFER',
-    value: 'true'
-  }, {
-    escape: true,
-    name: 'CURLOPT_ENCODING',
-    value: ''
-  }, {
-    escape: false,
-    name: 'CURLOPT_MAXREDIRS',
-    value: opts.maxRedirects
-  }, {
-    escape: false,
-    name: 'CURLOPT_TIMEOUT',
-    value: opts.timeout
-  }, {
-    escape: false,
-    name: 'CURLOPT_HTTP_VERSION',
-    value: source.httpVersion === 'HTTP/1.0' ? 'CURL_HTTP_VERSION_1_0' : 'CURL_HTTP_VERSION_1_1'
-  }, {
-    escape: true,
-    name: 'CURLOPT_CUSTOMREQUEST',
-    value: source.method
-  }, {
-    escape: true,
-    name: 'CURLOPT_POSTFIELDS',
-    value: source.postData ? source.postData.text : undefined
-  }]
-
-  code.push('curl_setopt_array($curl, [')
-
-  const curlopts = new CodeBuilder(opts.indent, '\n' + opts.indent)
+  code.push('$curl = curl_init();').blank();
+
+  const curlOptions = [
+    {
+      escape: true,
+      name: 'CURLOPT_PORT',
+      value: source.uriObj.port,
+    },
+    {
+      escape: true,
+      name: 'CURLOPT_URL',
+      value: source.fullUrl,
+    },
+    {
+      escape: false,
+      name: 'CURLOPT_RETURNTRANSFER',
+      value: 'true',
+    },
+    {
+      escape: true,
+      name: 'CURLOPT_ENCODING',
+      value: '',
+    },
+    {
+      escape: false,
+      name: 'CURLOPT_MAXREDIRS',
+      value: opts.maxRedirects,
+    },
+    {
+      escape: false,
+      name: 'CURLOPT_TIMEOUT',
+      value: opts.timeout,
+    },
+    {
+      escape: false,
+      name: 'CURLOPT_HTTP_VERSION',
+      value: source.httpVersion === 'HTTP/1.0' ? 'CURL_HTTP_VERSION_1_0' : 'CURL_HTTP_VERSION_1_1',
+    },
+    {
+      escape: true,
+      name: 'CURLOPT_CUSTOMREQUEST',
+      value: source.method,
+    },
+    {
+      escape: true,
+      name: 'CURLOPT_POSTFIELDS',
+      value: source.postData ? source.postData.text : undefined,
+    },
+  ];
+
+  code.push('curl_setopt_array($curl, [');
+
+  const curlopts = new CodeBuilder(opts.indent, `\n${opts.indent}`);
 
   curlOptions.forEach(function (option) {
-    if (!~[null, undefined].indexOf(option.value)) {
-      curlopts.push(util.format('%s => %s,', option.name, option.escape ? JSON.stringify(option.value) : option.value))
+    if (![null, undefined].includes(option.value)) {
+      curlopts.push(format('%s => %s,', option.name, option.escape ? JSON.stringify(option.value) : option.value));
     }
-  })
+  });
 
   // construct cookies
-  const cookies = source.cookies.map(function (cookie) {
-    return encodeURIComponent(cookie.name) + '=' + encodeURIComponent(cookie.value)
-  })
-
-  if (cookies.length) {
-    curlopts.push(util.format('CURLOPT_COOKIE => "%s",', cookies.join('; ')))
+  if (source.allHeaders.cookie) {
+    curlopts.push(format('CURLOPT_COOKIE => "%s",', source.allHeaders.cookie));
   }
 
   // construct cookies
-  const headers = Object.keys(source.headersObj).sort().map(function (key) {
-    return util.format('"%s: %s"', key, source.headersObj[key])
-  })
+  const headers = Object.keys(source.headersObj)
+    .sort()
+    .map(function (key) {
+      return format('"%s: %s"', key, source.headersObj[key]);
+    });
 
   if (headers.length) {
-    curlopts.push('CURLOPT_HTTPHEADER => [')
-      .push(1, headers.join(',\n' + opts.indent + opts.indent))
-      .push('],')
+    curlopts
+      .push('CURLOPT_HTTPHEADER => [')
+      .push(1, headers.join(`,\n${opts.indent}${opts.indent}`))
+      .push('],');
   }
 
-  code.push(1, curlopts.join())
+  code
+    .push(1, curlopts.join())
     .push(']);')
     .blank()
     .push('$response = curl_exec($curl);')
@@ -110,29 +117,26 @@ module.exports = function (source, options) {
     .blank()
     .push('curl_close($curl);')
     .blank()
-    .push('if ($err) {')
+    .push('if ($err) {');
 
   if (opts.namedErrors) {
-    code.push(1, 'echo array_flip(get_defined_constants(true)["curl"])[$err];')
+    code.push(1, 'echo array_flip(get_defined_constants(true)["curl"])[$err];');
   } else {
-    code.push(1, 'echo "cURL Error #:" . $err;')
+    code.push(1, 'echo "cURL Error #:" . $err;');
   }
 
-  code.push('} else {')
-    .push(1, 'echo $response;')
-    .push('}')
+  code.push('} else {').push(1, 'echo $response;').push('}');
 
   if (!opts.noTags && opts.closingTag) {
-    code.blank()
-      .push('?>')
+    code.blank().push('?>');
   }
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'curl',
   title: 'cURL',
   link: 'http://php.net/manual/en/book.curl.php',
-  description: 'PHP with ext-curl'
-}
+  description: 'PHP with ext-curl',
+};

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,59 +1,60 @@
-'use strict'
-
 const convert = function (obj, indent, lastIndent) {
-  let i, result
+  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',
@@ -81,6 +82,6 @@ module.exports = {
     'UNCHECKOUT',
     'UNLOCK',
     'UPDATE',
-    'VERSION_CONTROL'
-  ]
-}
+    'VERSION_CONTROL',
+  ],
+};