@readme/httpsnippet 3.1.2 → 4.0.1

package/src/targets/objc/nsurlsession.js

@@ -1,164 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Objective-C using NSURLSession.
- *
- * @author
- * @thibaultCha
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const helpers = require('./helpers');
-const CodeBuilder = require('../../helpers/code-builder');
-
-module.exports = function (source, options) {
-  const opts = {
-    indent: '    ',
-    pretty: true,
-    timeout: '10',
-    ...options,
-  };
-
-  const code = new CodeBuilder(opts.indent);
-  // Markers for headers to be created as literal objects and later be set on the NSURLRequest if exist
-  const req = {
-    hasHeaders: false,
-    hasBody: false,
-  };
-
-  // We just want to make sure people understand that is the only dependency
-  code.push('#import <Foundation/Foundation.h>');
-
-  if (Object.keys(source.allHeaders).length) {
-    req.hasHeaders = true;
-    code.blank().push(helpers.nsDeclaration('NSDictionary', 'headers', source.allHeaders, opts.pretty));
-  }
-
-  if (source.postData.text || source.postData.jsonObj || source.postData.params) {
-    req.hasBody = true;
-
-    switch (source.postData.mimeType) {
-      case 'application/x-www-form-urlencoded':
-        // By appending parameters one by one in the resulting snippet,
-        // we make it easier for the user to edit it according to his or her needs after pasting.
-        // The user can just add/remove lines adding/removing body parameters.
-        code
-          .blank()
-          .push(
-            'NSMutableData *postData = [[NSMutableData alloc] initWithData:[@"%s=%s" dataUsingEncoding:NSUTF8StringEncoding]];',
-            source.postData.params[0].name,
-            source.postData.params[0].value
-          );
-
-        // eslint-disable-next-line no-plusplus
-        for (let i = 1, len = source.postData.params.length; i < len; i++) {
-          code.push(
-            '[postData appendData:[@"&%s=%s" dataUsingEncoding:NSUTF8StringEncoding]];',
-            source.postData.params[i].name,
-            source.postData.params[i].value
-          );
-        }
-        break;
-
-      case 'application/json':
-        if (source.postData.jsonObj) {
-          code
-            .push(helpers.nsDeclaration('NSDictionary', 'parameters', source.postData.jsonObj, opts.pretty))
-            .blank()
-            .push('NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];');
-        }
-        break;
-
-      case 'multipart/form-data':
-        // By appending multipart parameters one by one in the resulting snippet,
-        // we make it easier for the user to edit it according to his or her needs after pasting.
-        // The user can just edit the parameters NSDictionary or put this part of a snippet in a multipart builder method.
-        code
-          .push(helpers.nsDeclaration('NSArray', 'parameters', source.postData.params, opts.pretty))
-          .push('NSString *boundary = @"%s";', source.postData.boundary)
-          .blank()
-          .push('NSError *error;')
-          .push('NSMutableString *body = [NSMutableString string];')
-          .push('for (NSDictionary *param in parameters) {')
-          .push(1, '[body appendFormat:@"--%@\\r\\n", boundary];')
-          .push(1, 'if (param[@"fileName"]) {')
-          .push(
-            2,
-            '[body appendFormat:@"Content-Disposition:form-data; name=\\"%@\\"; filename=\\"%@\\"\\r\\n", param[@"name"], param[@"fileName"]];'
-          )
-          .push(2, '[body appendFormat:@"Content-Type: %@\\r\\n\\r\\n", param[@"contentType"]];')
-          .push(
-            2,
-            '[body appendFormat:@"%@", [NSString stringWithContentsOfFile:param[@"fileName"] encoding:NSUTF8StringEncoding error:&error]];'
-          )
-          .push(2, 'if (error) {')
-          .push(3, 'NSLog(@"%@", error);')
-          .push(2, '}')
-          .push(1, '} else {')
-          .push(2, '[body appendFormat:@"Content-Disposition:form-data; name=\\"%@\\"\\r\\n\\r\\n", param[@"name"]];')
-          .push(2, '[body appendFormat:@"%@", param[@"value"]];')
-          .push(1, '}')
-          .push('}')
-          .push('[body appendFormat:@"\\r\\n--%@--\\r\\n", boundary];')
-          .push('NSData *postData = [body dataUsingEncoding:NSUTF8StringEncoding];');
-        break;
-
-      default:
-        code
-          .blank()
-          .push(
-            `NSData *postData = [[NSData alloc] initWithData:[@"${source.postData.text}" dataUsingEncoding:NSUTF8StringEncoding]];`
-          );
-    }
-  }
-
-  code
-    .blank()
-    .push(
-      `NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"${source.fullUrl}"]`
-    )
-    // NSURLRequestUseProtocolCachePolicy is the default policy, let's just always set it to avoid confusion.
-    .push('                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy')
-    .push(
-      `                                                   timeoutInterval:${parseInt(opts.timeout, 10).toFixed(1)}];`
-    )
-    .push(`[request setHTTPMethod:@"${source.method}"];`);
-
-  if (req.hasHeaders) {
-    code.push('[request setAllHTTPHeaderFields:headers];');
-  }
-
-  if (req.hasBody) {
-    code.push('[request setHTTPBody:postData];');
-  }
-
-  code
-    .blank()
-    // Retrieving the shared session will be less verbose than creating a new one.
-    .push('NSURLSession *session = [NSURLSession sharedSession];')
-    .push('NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request')
-    .push(
-      '                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {'
-    )
-    .push(1, '                                            if (error) {')
-    .push(2, '                                            NSLog(@"%@", error);')
-    .push(1, '                                            } else {')
-    // Casting the NSURLResponse to NSHTTPURLResponse so the user can see the status     .
-    .push(
-      2,
-      '                                            NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;'
-    )
-    .push(2, '                                            NSLog(@"%@", httpResponse);')
-    .push(1, '                                            }')
-    .push('                                            }];')
-    .push('[dataTask resume];');
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'nsurlsession',
-  title: 'NSURLSession',
-  link: 'https://developer.apple.com/library/mac/documentation/Foundation/Reference/NSURLSession_class/index.html',
-  description: "Foundation's NSURLSession request",
-};

package/src/targets/ocaml/cohttp.js

@@ -1,73 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for OCaml using CoHTTP.
- *
- * @author
- * @SGrondin
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const CodeBuilder = require('../../helpers/code-builder');
-
-module.exports = function (source, options) {
-  const opts = {
-    indent: '  ',
-    ...options,
-  };
-
-  const methods = ['get', 'post', 'head', 'delete', 'patch', 'put', 'options'];
-  const code = new CodeBuilder(opts.indent);
-
-  code
-    .push('open Cohttp_lwt_unix')
-    .push('open Cohttp')
-    .push('open Lwt')
-    .blank()
-    .push('let uri = Uri.of_string "%s" in', source.fullUrl);
-
-  // Add headers, including the cookies
-  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]]);
-  } else if (headers.length > 1) {
-    code.push('let headers = Header.add_list (Header.init ()) [');
-
-    headers.forEach(function (key) {
-      code.push(1, '("%s", "%s");', key, source.allHeaders[key]);
-    });
-
-    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));
-  }
-
-  // Do the request
-  code.blank();
-
-  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}")`
-  );
-
-  // Catch result
-  code.push('>>= fun (res, body_stream) ->').push(1, '(* Do stuff with the result *)');
-
-  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',
-};

package/src/targets/ocaml/index.js

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

package/src/targets/php/curl.js

@@ -1,142 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for PHP using curl-ext.
- *
- * @author
- * @AhmadNassri
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const { format } = require('util');
-const CodeBuilder = require('../../helpers/code-builder');
-
-module.exports = function (source, options) {
-  const opts = {
-    closingTag: false,
-    indent: '  ',
-    maxRedirects: 10,
-    namedErrors: false,
-    noTags: false,
-    shortTags: false,
-    timeout: 30,
-    ...options,
-  };
-
-  const code = new CodeBuilder(opts.indent);
-
-  if (!opts.noTags) {
-    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}`);
-
-  curlOptions.forEach(function (option) {
-    if (![null, undefined].includes(option.value)) {
-      curlopts.push(format('%s => %s,', option.name, option.escape ? JSON.stringify(option.value) : option.value));
-    }
-  });
-
-  // construct cookies
-  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 format('"%s: %s"', key, source.headersObj[key]);
-    });
-
-  if (headers.length) {
-    curlopts
-      .push('CURLOPT_HTTPHEADER => [')
-      .push(1, headers.join(`,\n${opts.indent}${opts.indent}`))
-      .push('],');
-  }
-
-  code
-    .push(1, curlopts.join())
-    .push(']);')
-    .blank()
-    .push('$response = curl_exec($curl);')
-    .push('$err = curl_error($curl);')
-    .blank()
-    .push('curl_close($curl);')
-    .blank()
-    .push('if ($err) {');
-
-  if (opts.namedErrors) {
-    code.push(1, 'echo array_flip(get_defined_constants(true)["curl"])[$err];');
-  } else {
-    code.push(1, 'echo "cURL Error #:" . $err;');
-  }
-
-  code.push('} else {').push(1, 'echo $response;').push('}');
-
-  if (!opts.noTags && opts.closingTag) {
-    code.blank().push('?>');
-  }
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'curl',
-  title: 'cURL',
-  link: 'http://php.net/manual/en/book.curl.php',
-  description: 'PHP with ext-curl',
-};

package/src/targets/php/guzzle.js

@@ -1,135 +0,0 @@
-/**
- * @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',
-  link: 'http://docs.guzzlephp.org/en/stable/',
-  description: 'PHP with guzzle',
-};

package/src/targets/php/helpers.js

@@ -1,87 +0,0 @@
-const convert = function (obj, indent, lastIndent) {
-  let i;
-  let result;
-
-  if (!lastIndent) {
-    // eslint-disable-next-line no-param-reassign
-    lastIndent = '';
-  }
-
-  switch (Object.prototype.toString.call(obj)) {
-    case '[object Null]':
-      result = 'null';
-      break;
-
-    case '[object Undefined]':
-      result = 'null';
-      break;
-
-    case '[object String]':
-      result = `'${obj.replace(/\\/g, '\\\\').replace(/'/g, "'")}'`;
-      break;
-
-    case '[object Number]':
-      result = obj.toString();
-      break;
-
-    case '[object Array]':
-      result = [];
-
-      obj.forEach(function (item) {
-        result.push(convert(item, indent + indent, indent));
-      });
-
-      result = `[\n${indent}${result.join(`,\n${indent}`)}\n${lastIndent}]`;
-      break;
-
-    case '[object Object]':
-      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 = `[\n${indent}${result.join(`,\n${indent}`)}\n${lastIndent}]`;
-      break;
-
-    default:
-      result = 'null';
-  }
-
-  return result;
-};
-
-module.exports = {
-  convert,
-  methods: [
-    'ACL',
-    'BASELINE_CONTROL',
-    'CHECKIN',
-    'CHECKOUT',
-    'CONNECT',
-    'COPY',
-    'DELETE',
-    'GET',
-    'HEAD',
-    'LABEL',
-    'LOCK',
-    'MERGE',
-    'MKACTIVITY',
-    'MKCOL',
-    'MKWORKSPACE',
-    'MOVE',
-    'OPTIONS',
-    'POST',
-    'PROPFIND',
-    'PROPPATCH',
-    'PUT',
-    'REPORT',
-    'TRACE',
-    'UNCHECKOUT',
-    'UNLOCK',
-    'UPDATE',
-    'VERSION_CONTROL',
-  ],
-};

package/src/targets/php/http1.js

@@ -1,85 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for PHP using curl-ext.
- *
- * @author
- * @AhmadNassri
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const helpers = require('./helpers');
-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').blank();
-  }
-
-  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));
-
-  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.blank();
-
-  if (Object.keys(source.queryObj).length) {
-    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();
-  }
-
-  if (Object.keys(source.cookiesObj).length) {
-    code.push('$request->setCookies(%s);', helpers.convert(source.cookiesObj, opts.indent)).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('}');
-
-  if (!opts.noTags && opts.closingTag) {
-    code.blank().push('?>');
-  }
-
-  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',
-};