@readme/httpsnippet 3.1.2 → 4.0.1

package/src/targets/csharp/httpclient.js

@@ -1,157 +0,0 @@
-const CodeBuilder = require('../../helpers/code-builder');
-const helpers = require('../../helpers/headers');
-
-function getDecompressionMethods(source) {
-  const acceptEncoding = helpers.getHeader(source.allHeaders, 'accept-encoding');
-  if (!acceptEncoding) {
-    return []; // no decompression
-  }
-
-  const supportedMethods = {
-    gzip: 'DecompressionMethods.GZip',
-    deflate: 'DecompressionMethods.Deflate',
-  };
-
-  const methods = [];
-  acceptEncoding.split(',').forEach(function (encoding) {
-    const match = /\s*([^;\s]+)/.exec(encoding);
-    if (match) {
-      const method = supportedMethods[match[1]];
-      if (method) {
-        methods.push(method);
-      }
-    }
-  });
-
-  return methods;
-}
-
-module.exports = function (source, options) {
-  const opts = {
-    indent: '    ',
-    ...options,
-  };
-
-  const code = new CodeBuilder(opts.indent);
-
-  let clienthandler = '';
-  const cookies = !!source.allHeaders.cookie;
-  const decompressionMethods = getDecompressionMethods(source);
-  if (cookies || decompressionMethods.length) {
-    clienthandler = 'clientHandler';
-    code.push('var clientHandler = new HttpClientHandler');
-    code.push('{');
-    if (cookies) {
-      // enable setting the cookie header
-      code.push(1, 'UseCookies = false,');
-    }
-    if (decompressionMethods.length) {
-      // enable decompression for supported methods
-      code.push(1, 'AutomaticDecompression = %s,', decompressionMethods.join(' | '));
-    }
-    code.push('};');
-  }
-
-  code.push('var client = new HttpClient(%s);', clienthandler);
-
-  code.push('var request = new HttpRequestMessage');
-  code.push('{');
-
-  const methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE'];
-  let method = source.method.toUpperCase();
-  if (method && methods.indexOf(method) !== -1) {
-    // buildin method
-    method = `HttpMethod.${method[0]}${method.substring(1).toLowerCase()}`;
-  } else {
-    // custom method
-    method = `new HttpMethod("${method}")`;
-  }
-  code.push(1, 'Method = %s,', method);
-
-  code.push(1, 'RequestUri = new Uri("%s"),', source.fullUrl);
-
-  const headers = Object.keys(source.allHeaders).filter(function (header) {
-    switch (header.toLowerCase()) {
-      case 'content-type':
-      case 'content-length':
-      case 'accept-encoding':
-        // skip these headers
-        return false;
-      default:
-        return true;
-    }
-  });
-  if (headers.length) {
-    code.push(1, 'Headers =');
-    code.push(1, '{');
-    headers.forEach(function (key) {
-      code.push(2, '{ "%s", "%s" },', key, source.allHeaders[key]);
-    });
-    code.push(1, '},');
-  }
-
-  if (source.postData.text) {
-    const contentType = source.postData.mimeType;
-    switch (contentType) {
-      case 'application/x-www-form-urlencoded':
-        code.push(1, 'Content = new FormUrlEncodedContent(new Dictionary<string, string>');
-        code.push(1, '{');
-        source.postData.params.forEach(function (param) {
-          code.push(2, '{ "%s", "%s" },', param.name, param.value);
-        });
-        code.push(1, '}),');
-        break;
-      case 'multipart/form-data':
-        code.push(1, 'Content = new MultipartFormDataContent');
-        code.push(1, '{');
-        source.postData.params.forEach(function (param) {
-          code.push(2, 'new StringContent(%s)', JSON.stringify(param.value || ''));
-          code.push(2, '{');
-          code.push(3, 'Headers =');
-          code.push(3, '{');
-          if (param.contentType) {
-            code.push(4, 'ContentType = new MediaTypeHeaderValue("%s"),', param.contentType);
-          }
-          code.push(4, 'ContentDisposition = new ContentDispositionHeaderValue("form-data")');
-          code.push(4, '{');
-          code.push(5, 'Name = "%s",', param.name);
-          if (param.fileName) {
-            code.push(5, 'FileName = "%s",', param.fileName);
-          }
-          code.push(4, '}');
-          code.push(3, '}');
-          code.push(2, '},');
-        });
-
-        code.push(1, '},');
-        break;
-      default:
-        code.push(1, 'Content = new StringContent(%s)', JSON.stringify(source.postData.text || ''));
-        code.push(1, '{');
-        code.push(2, 'Headers =');
-        code.push(2, '{');
-        code.push(3, 'ContentType = new MediaTypeHeaderValue("%s")', contentType);
-        code.push(2, '}');
-        code.push(1, '}');
-        break;
-    }
-  }
-  code.push('};');
-
-  // send and read response
-  code.push('using (var response = await client.SendAsync(request))');
-  code.push('{');
-  code.push(1, 'response.EnsureSuccessStatusCode();');
-  code.push(1, 'var body = await response.Content.ReadAsStringAsync();');
-  code.push(1, 'Console.WriteLine(body);');
-  code.push('}');
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'httpclient',
-  title: 'HttpClient',
-  link: 'https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient',
-  description: '.NET Standard HTTP Client',
-};

package/src/targets/csharp/index.js

@@ -1,11 +0,0 @@
-module.exports = {
-  info: {
-    key: 'csharp',
-    title: 'C#',
-    extname: '.cs',
-    default: 'restsharp',
-  },
-
-  restsharp: require('./restsharp'),
-  httpclient: require('./httpclient'),
-};

package/src/targets/csharp/restsharp.js

@@ -1,49 +0,0 @@
-const CodeBuilder = require('../../helpers/code-builder');
-const helpers = require('../../helpers/headers');
-
-module.exports = 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';
-  }
-
-  code.push('var client = new RestClient("%s");', source.fullUrl);
-  code.push('var request = new RestRequest(Method.%s);', source.method.toUpperCase());
-
-  // Add headers, including the cookies
-  const headers = Object.keys(source.headersObj);
-
-  // construct headers
-  if (headers.length) {
-    headers.forEach(function (key) {
-      code.push('request.AddHeader("%s", "%s");', key, source.headersObj[key]);
-    });
-  }
-
-  // construct cookies
-  if (source.cookies.length) {
-    source.cookies.forEach(function (cookie) {
-      code.push('request.AddCookie("%s", "%s");', cookie.name, cookie.value);
-    });
-  }
-
-  if (source.postData.text) {
-    code.push(
-      'request.AddParameter("%s", %s, ParameterType.RequestBody);',
-      helpers.getHeader(source.allHeaders, 'content-type'),
-      JSON.stringify(source.postData.text)
-    );
-  }
-
-  code.push('IRestResponse response = client.Execute(request);');
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'restsharp',
-  title: 'RestSharp',
-  link: 'http://restsharp.org/',
-  description: 'Simple REST and HTTP API Client for .NET',
-};

package/src/targets/go/index.js

@@ -1,10 +0,0 @@
-module.exports = {
-  info: {
-    key: 'go',
-    title: 'Go',
-    extname: '.go',
-    default: 'native',
-  },
-
-  native: require('./native'),
-};

package/src/targets/go/native.js

@@ -1,130 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for native Go.
- *
- * @author
- * @montanaflynn
- *
- * 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) {
-  // Let's Go!
-  const code = new CodeBuilder('\t');
-
-  // Define Options
-  const opts = {
-    showBoilerplate: true,
-    checkErrors: false,
-    printBody: true,
-    timeout: -1,
-    ...options,
-  };
-
-  const errorPlaceholder = opts.checkErrors ? 'err' : '_';
-
-  const indent = opts.showBoilerplate ? 1 : 0;
-
-  const errorCheck = function () {
-    if (opts.checkErrors) {
-      code
-        .push(indent, 'if err != nil {')
-        .push(indent + 1, 'panic(err)')
-        .push(indent, '}');
-    }
-  };
-
-  // Create boilerplate
-  if (opts.showBoilerplate) {
-    code.push('package main').blank().push('import (').push(indent, '"fmt"');
-
-    if (opts.timeout > 0) {
-      code.push(indent, '"time"');
-    }
-
-    if (source.postData.text) {
-      code.push(indent, '"strings"');
-    }
-
-    code.push(indent, '"net/http"');
-
-    if (opts.printBody) {
-      code.push(indent, '"io/ioutil"');
-    }
-
-    code.push(')').blank().push('func main() {').blank();
-  }
-
-  // Create client
-  let client;
-  if (opts.timeout > 0) {
-    client = 'client';
-    code
-      .push(indent, 'client := http.Client{')
-      .push(indent + 1, 'Timeout: time.Duration(%s * time.Second),', opts.timeout)
-      .push(indent, '}')
-      .blank();
-  } else {
-    client = 'http.DefaultClient';
-  }
-
-  code.push(indent, 'url := "%s"', source.fullUrl).blank();
-
-  // If we have body content or not create the var and reader or nil
-  if (source.postData.text) {
-    code
-      .push(indent, 'payload := strings.NewReader(%s)', JSON.stringify(source.postData.text))
-      .blank()
-      .push(indent, 'req, %s := http.NewRequest("%s", url, payload)', errorPlaceholder, source.method)
-      .blank();
-  } else {
-    code.push(indent, 'req, %s := http.NewRequest("%s", url, nil)', errorPlaceholder, source.method).blank();
-  }
-
-  errorCheck();
-
-  // Add headers
-  if (Object.keys(source.allHeaders).length) {
-    Object.keys(source.allHeaders).forEach(function (key) {
-      code.push(indent, 'req.Header.Add("%s", "%s")', key, source.allHeaders[key]);
-    });
-
-    code.blank();
-  }
-
-  // Make request
-  code.push(indent, 'res, %s := %s.Do(req)', errorPlaceholder, client);
-  errorCheck();
-
-  // Get Body
-  if (opts.printBody) {
-    code
-      .blank()
-      .push(indent, 'defer res.Body.Close()')
-      .push(indent, 'body, %s := ioutil.ReadAll(res.Body)', errorPlaceholder);
-    errorCheck();
-  }
-
-  // Print it
-  code.blank().push(indent, 'fmt.Println(res)');
-
-  if (opts.printBody) {
-    code.push(indent, 'fmt.Println(string(body))');
-  }
-
-  // End main block
-  if (opts.showBoilerplate) {
-    code.blank().push('}');
-  }
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'native',
-  title: 'NewRequest',
-  link: 'http://golang.org/pkg/net/http/#NewRequest',
-  description: 'Golang HTTP client request',
-};

package/src/targets/http/http1.1.js

@@ -1,89 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator to generate raw HTTP/1.1 request strings,
- * in accordance to the RFC 7230 (and RFC 7231) specifications.
- *
- * @author
- * @irvinlim
- *
- * For any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-const CRLF = '\r\n';
-const CodeBuilder = require('../../helpers/code-builder');
-const { format } = require('util');
-
-/**
- * Request follows the request message format in accordance to RFC 7230, Section 3.
- * Each section is prepended with the RFC and section number.
- * See more at https://tools.ietf.org/html/rfc7230#section-3.
- */
-module.exports = function (source, options) {
-  const opts = {
-    absoluteURI: false,
-    autoContentLength: true,
-    autoHost: true,
-    ...options,
-  };
-
-  // RFC 7230 Section 3. Message Format
-  // All lines have no indentation, and should be terminated with CRLF.
-  const code = new CodeBuilder('', CRLF);
-
-  // RFC 7230 Section 5.3. Request Target
-  // Determines if the Request-Line should use 'absolute-form' or 'origin-form'.
-  // Basically it means whether the "http://domain.com" will prepend the full url.
-  const requestUrl = opts.absoluteURI ? source.fullUrl : source.uriObj.path;
-
-  // RFC 7230 Section 3.1.1. Request-Line
-  code.push('%s %s %s', source.method, requestUrl, source.httpVersion);
-
-  // RFC 7231 Section 5. Header Fields
-  Object.keys(source.allHeaders).forEach(function (key) {
-    // Capitalize header keys, even though it's not required by the spec.
-    const keyCapitalized = key.toLowerCase().replace(/(^|-)(\w)/g, function (x) {
-      return x.toUpperCase();
-    });
-
-    code.push('%s', format('%s: %s', keyCapitalized, source.allHeaders[key]));
-  });
-
-  // RFC 7230 Section 5.4. Host
-  // Automatically set Host header if option is on and on header already exists.
-  if (opts.autoHost && Object.keys(source.allHeaders).indexOf('host') === -1) {
-    code.push('Host: %s', source.uriObj.host);
-  }
-
-  // RFC 7230 Section 3.3.3. Message Body Length
-  // Automatically set Content-Length header if option is on, postData is present and no header already exists.
-  if (
-    opts.autoContentLength &&
-    source.postData.text &&
-    Object.keys(source.allHeaders).indexOf('content-length') === -1
-  ) {
-    code.push('Content-Length: %d', Buffer.byteLength(source.postData.text, 'ascii'));
-  }
-
-  // Add extra line after header section.
-  code.blank();
-
-  // Separate header section and message body section.
-  const headerSection = code.join();
-  let messageBody = '';
-
-  // RFC 7230 Section 3.3. Message Body
-  if (source.postData.text) {
-    messageBody = source.postData.text;
-  }
-
-  // RFC 7230 Section 3. Message Format
-  // Extra CRLF separating the headers from the body.
-  return headerSection + CRLF + messageBody;
-};
-
-module.exports.info = {
-  key: '1.1',
-  title: 'HTTP/1.1',
-  link: 'https://tools.ietf.org/html/rfc7230',
-  description: 'HTTP/1.1 request string in accordance with RFC 7230',
-};

package/src/targets/http/index.js

@@ -1,10 +0,0 @@
-module.exports = {
-  info: {
-    key: 'http',
-    title: 'HTTP',
-    extname: '',
-    default: '1.1',
-  },
-
-  1.1: require('./http1.1'),
-};

package/src/targets/index.js

@@ -1,20 +0,0 @@
-module.exports = {
-  c: require('./c'),
-  clojure: require('./clojure'),
-  csharp: require('./csharp'),
-  go: require('./go'),
-  http: require('./http'),
-  java: require('./java'),
-  javascript: require('./javascript'),
-  kotlin: require('./kotlin'),
-  node: require('./node'),
-  objc: require('./objc'),
-  ocaml: require('./ocaml'),
-  php: require('./php'),
-  powershell: require('./powershell'),
-  python: require('./python'),
-  r: require('./r'),
-  ruby: require('./ruby'),
-  shell: require('./shell'),
-  swift: require('./swift'),
-};

package/src/targets/java/asynchttp.js

@@ -1,54 +0,0 @@
-/**
- * @description
- * Asynchronous Http and WebSocket Client library for Java
- *
- * @author
- * @windard
- *
- * 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 code = new CodeBuilder(opts.indent);
-
-  code.push('AsyncHttpClient client = new DefaultAsyncHttpClient();');
-
-  code.push(`client.prepare("${source.method.toUpperCase()}", "${source.fullUrl}")`);
-
-  // Add headers, including the cookies
-  const headers = Object.keys(source.allHeaders);
-
-  // construct headers
-  if (headers.length) {
-    headers.forEach(function (key) {
-      code.push(1, '.setHeader("%s", "%s")', key, source.allHeaders[key]);
-    });
-  }
-
-  if (source.postData.text) {
-    code.push(1, '.setBody(%s)', JSON.stringify(source.postData.text));
-  }
-
-  code.push(1, '.execute()');
-  code.push(1, '.toCompletableFuture()');
-  code.push(1, '.thenAccept(System.out::println)');
-  code.push(1, '.join();');
-  code.blank();
-  code.push('client.close();');
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'asynchttp',
-  title: 'AsyncHttp',
-  link: 'https://github.com/AsyncHttpClient/async-http-client',
-  description: 'Asynchronous Http and WebSocket Client library for Java',
-};

package/src/targets/java/index.js

@@ -1,13 +0,0 @@
-module.exports = {
-  info: {
-    key: 'java',
-    title: 'Java',
-    extname: '.java',
-    default: 'unirest',
-  },
-
-  okhttp: require('./okhttp'),
-  unirest: require('./unirest'),
-  asynchttp: require('./asynchttp'),
-  nethttp: require('./nethttp'),
-};

package/src/targets/java/nethttp.js

@@ -1,59 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Java using java.net.http.
- *
- * @author
- * @wtetsu
- *
- * 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 code = new CodeBuilder(opts.indent);
-
-  code.push('HttpRequest request = HttpRequest.newBuilder()');
-  code.push(2, '.uri(URI.create("%s"))', source.fullUrl);
-
-  const headers = Object.keys(source.allHeaders);
-
-  // construct headers
-  if (headers.length) {
-    headers.forEach(function (key) {
-      code.push(2, '.header("%s", "%s")', key, source.allHeaders[key]);
-    });
-  }
-
-  if (source.postData.text) {
-    code.push(
-      2,
-      '.method("%s", HttpRequest.BodyPublishers.ofString(%s))',
-      source.method.toUpperCase(),
-      JSON.stringify(source.postData.text)
-    );
-  } else {
-    code.push(2, '.method("%s", HttpRequest.BodyPublishers.noBody())', source.method.toUpperCase());
-  }
-
-  code.push(2, '.build();');
-
-  code.push(
-    'HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());'
-  );
-  code.push('System.out.println(response.body());');
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'nethttp',
-  title: 'java.net.http',
-  link: 'https://openjdk.java.net/groups/net/httpclient/intro.html',
-  description: 'Java Standardized HTTP Client API',
-};

package/src/targets/java/okhttp.js

@@ -1,78 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Java using OkHttp.
- *
- * @author
- * @shashiranjan84
- *
- * 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 code = new CodeBuilder(opts.indent);
-
-  const methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD'];
-
-  const methodsWithBody = ['POST', 'PUT', 'DELETE', 'PATCH'];
-
-  code.push('OkHttpClient client = new OkHttpClient();').blank();
-
-  if (source.postData.text) {
-    if (source.postData.boundary) {
-      code.push(
-        'MediaType mediaType = MediaType.parse("%s; boundary=%s");',
-        source.postData.mimeType,
-        source.postData.boundary
-      );
-    } else {
-      code.push('MediaType mediaType = MediaType.parse("%s");', source.postData.mimeType);
-    }
-    code.push('RequestBody body = RequestBody.create(mediaType, %s);', JSON.stringify(source.postData.text));
-  }
-
-  code.push('Request request = new Request.Builder()');
-  code.push(1, '.url("%s")', source.fullUrl);
-  if (methods.indexOf(source.method.toUpperCase()) === -1) {
-    if (source.postData.text) {
-      code.push(1, '.method("%s", body)', source.method.toUpperCase());
-    } else {
-      code.push(1, '.method("%s", null)', source.method.toUpperCase());
-    }
-  } else if (methodsWithBody.indexOf(source.method.toUpperCase()) >= 0) {
-    if (source.postData.text) {
-      code.push(1, '.%s(body)', source.method.toLowerCase());
-    } else {
-      code.push(1, '.%s(null)', source.method.toLowerCase());
-    }
-  } else {
-    code.push(1, '.%s()', source.method.toLowerCase());
-  }
-
-  // Add headers, including the cookies
-  const headers = Object.keys(source.allHeaders);
-
-  // construct headers
-  if (headers.length) {
-    headers.forEach(function (key) {
-      code.push(1, '.addHeader("%s", "%s")', key, source.allHeaders[key]);
-    });
-  }
-
-  code.push(1, '.build();').blank().push('Response response = client.newCall(request).execute();');
-
-  return code.join();
-};
-
-module.exports.info = {
-  key: 'okhttp',
-  title: 'OkHttp',
-  link: 'http://square.github.io/okhttp/',
-  description: 'An HTTP Request Client Library',
-};