@readme/httpsnippet 4.0.0 → 4.0.3

package/src/targets/python/helpers.ts

@@ -1,81 +0,0 @@
-/**
- * Create an string of given length filled with blank spaces
- *
- * @param length Length of the array to return
- * @param str String to pad out with
- */
-function buildString(length: number, str: string) {
-  return str.repeat(length);
-}
-
-/**
- * Create a string corresponding to a Dictionary or Array literal representation with pretty option
- * and indentation.
- */
-function concatValues(
-  concatType: 'array' | 'object',
-  values: any,
-  pretty: boolean,
-  indentation: string,
-  indentLevel: number
-) {
-  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}`;
-  }
-  return openingBrace + values.join(join) + closingBrace;
-}
-
-/**
- * Create a valid Python string of a literal value according to its type.
- *
- * @param {*} value Any JavaScript literal
- * @param {Object} opts Target options
- * @return {string}
- */
-export const literalRepresentation = (value: any, opts: Record<string, any>, indentLevel?: number): any => {
-  indentLevel = indentLevel === undefined ? 1 : indentLevel + 1;
-
-  switch (Object.prototype.toString.call(value)) {
-    case '[object Number]':
-      return value;
-
-    case '[object Array]': {
-      let pretty = false;
-      const valuesRepresentation: any = (value as any[]).map(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 literalRepresentation(v, opts, indentLevel);
-      });
-      return concatValues('array', valuesRepresentation, pretty, opts.indent, indentLevel);
-    }
-
-    case '[object Object]': {
-      const keyValuePairs = [];
-      // eslint-disable-next-line guard-for-in, no-restricted-syntax
-      for (const key in value) {
-        keyValuePairs.push(`"${key}": ${literalRepresentation(value[key], opts, indentLevel)}`);
-      }
-      return concatValues('object', keyValuePairs, opts.pretty && keyValuePairs.length > 1, opts.indent, indentLevel);
-    }
-
-    case '[object Null]':
-      return 'None';
-
-    case '[object Boolean]':
-      return value ? 'True' : 'False';
-
-    default:
-      if (value === null || value === undefined) {
-        return '';
-      }
-      return `"${value.toString().replace(/"/g, '\\"')}"`;
-  }
-};

package/src/targets/python/requests/client.ts

@@ -1,175 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Python using Requests
- *
- * @author
- * @montanaflynn
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-import type { Client } from '../../targets';
-import { CodeBuilder } from '../../../helpers/code-builder';
-import { getHeaderName } from '../../../helpers/headers';
-import { literalRepresentation } from '../helpers';
-
-export interface RequestsOptions {
-  pretty?: true;
-}
-
-export const requests: Client<RequestsOptions> = {
-  info: {
-    key: 'requests',
-    title: 'Requests',
-    link: 'http://docs.python-requests.org/en/latest/api/#requests.request',
-    description: 'Requests HTTP library',
-  },
-  convert: ({ fullUrl, postData, allHeaders, method }, options) => {
-    const opts = {
-      indent: '    ',
-      pretty: true,
-      ...options,
-    };
-    // Start snippet
-    const { push, blank, join, addPostProcessor } = new CodeBuilder({ indent: opts.indent });
-
-    // Import requests
-    push('import requests');
-    blank();
-
-    // Set URL
-    push(`url = "${fullUrl}"`);
-    blank();
-
-    const headers = allHeaders;
-
-    // Construct payload
-    let payload: Record<string, any> = {};
-    const files: Record<string, string> = {};
-
-    let hasFiles = false;
-    let hasPayload = false;
-    let jsonPayload = false;
-    switch (postData.mimeType) {
-      case 'application/json':
-        if (postData.jsonObj) {
-          push(`payload = ${literalRepresentation(postData.jsonObj, opts)}`);
-          jsonPayload = true;
-          hasPayload = true;
-        }
-        break;
-
-      case 'multipart/form-data':
-        if (!postData.params) {
-          break;
-        }
-
-        payload = {};
-        postData.params.forEach(p => {
-          if (p.fileName) {
-            files[p.name] = `open('${p.fileName}', 'rb')`;
-            hasFiles = true;
-          } else {
-            payload[p.name] = p.value;
-            hasPayload = true;
-          }
-        });
-
-        if (hasFiles) {
-          push(`files = ${literalRepresentation(files, opts)}`);
-
-          if (hasPayload) {
-            push(`payload = ${literalRepresentation(payload, opts)}`);
-          }
-
-          // The requests library will only automatically add a `multipart/form-data` header if there are files being sent. If we're **only** sending form data we still need to send the boundary ourselves.
-          const headerName = getHeaderName(headers, 'content-type');
-          if (headerName) {
-            delete headers[headerName];
-          }
-        } else {
-          const nonFilePayload = JSON.stringify(postData.text);
-          if (nonFilePayload) {
-            push(`payload = ${nonFilePayload}`);
-            hasPayload = true;
-          }
-        }
-
-        // The `open()` call must be a literal in the code snippet.
-        addPostProcessor(code => code.replace(/"open\('(.+)', 'rb'\)"/g, 'open("$1", "rb")'));
-        break;
-
-      default: {
-        const stringPayload = JSON.stringify(postData.text);
-        if (stringPayload) {
-          push(`payload = ${stringPayload}`);
-          hasPayload = true;
-        }
-      }
-    }
-
-    // Construct headers
-    const headerCount = Object.keys(headers).length;
-
-    if (headerCount === 0 && (hasPayload || hasFiles)) {
-      // If we don't have any heads but we do have a payload we should put a blank line here between that payload consturction and our execution of the requests library.
-      blank();
-    } else if (headerCount === 1) {
-      Object.keys(headers).forEach(header => {
-        push(`headers = {"${header}": "${headers[header]}"}`);
-        blank();
-      });
-    } else if (headerCount > 1) {
-      let count = 1;
-
-      push('headers = {');
-
-      Object.keys(headers).forEach(header => {
-        if (count !== headerCount) {
-          push(`"${header}": "${headers[header]}",`, 1);
-        } else {
-          push(`"${header}": "${headers[header]}"`, 1);
-        }
-        count += 1;
-      });
-
-      push('}');
-      blank();
-    }
-
-    // Construct request
-    let request;
-    // Method list pulled from their api reference https://docs.python-requests.org/en/latest/api/#requests.head
-    if (['HEAD', 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'].includes(method)) {
-      request = `response = requests.${method.toLowerCase()}(url`;
-    } else {
-      request = `response = requests.request("${method}", url`;
-    }
-
-    if (hasPayload) {
-      if (jsonPayload) {
-        request += ', json=payload';
-      } else {
-        request += ', data=payload';
-      }
-    }
-
-    if (hasFiles) {
-      request += ', files=files';
-    }
-
-    if (headerCount > 0) {
-      request += ', headers=headers';
-    }
-
-    request += ')';
-
-    push(request);
-    blank();
-
-    // Print response
-    push('print(response.text)');
-
-    return join();
-  },
-};

package/src/targets/python/requests/fixtures/application-form-encoded.py

@@ -1,10 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything"
-
-payload = "foo=bar&hello=world"
-headers = {"content-type": "application/x-www-form-urlencoded"}
-
-response = requests.post(url, data=payload, headers=headers)
-
-print(response.text)

package/src/targets/python/requests/fixtures/application-json.py

@@ -1,17 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything"
-
-payload = {
-    "number": 1,
-    "string": "f\"oo",
-    "arr": [1, 2, 3],
-    "nested": {"a": "b"},
-    "arr_mix": [1, "a", {"arr_mix_nested": {}}],
-    "boolean": False
-}
-headers = {"content-type": "application/json"}
-
-response = requests.post(url, json=payload, headers=headers)
-
-print(response.text)

package/src/targets/python/requests/fixtures/cookies.py

@@ -1,9 +0,0 @@
-import requests
-
-url = "https://httpbin.org/cookies"
-
-headers = {"cookie": "foo=bar; bar=baz"}
-
-response = requests.get(url, headers=headers)
-
-print(response.text)

package/src/targets/python/requests/fixtures/custom-method.py

@@ -1,7 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything"
-
-response = requests.request("PROPFIND", url)
-
-print(response.text)

package/src/targets/python/requests/fixtures/full.py

@@ -1,14 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value"
-
-payload = "foo=bar"
-headers = {
-    "cookie": "foo=bar; bar=baz",
-    "accept": "application/json",
-    "content-type": "application/x-www-form-urlencoded"
-}
-
-response = requests.post(url, data=payload, headers=headers)
-
-print(response.text)

package/src/targets/python/requests/fixtures/headers.py

@@ -1,13 +0,0 @@
-import requests
-
-url = "https://httpbin.org/headers"
-
-headers = {
-    "accept": "application/json",
-    "x-foo": "Bar",
-    "x-bar": "Foo"
-}
-
-response = requests.get(url, headers=headers)
-
-print(response.text)

package/src/targets/python/requests/fixtures/http-insecure.py

@@ -1,7 +0,0 @@
-import requests
-
-url = "http://httpbin.org/anything"
-
-response = requests.get(url)
-
-print(response.text)

package/src/targets/python/requests/fixtures/jsonObj-multiline.py

@@ -1,10 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything"
-
-payload = {"foo": "bar"}
-headers = {"content-type": "application/json"}
-
-response = requests.post(url, json=payload, headers=headers)
-
-print(response.text)

package/src/targets/python/requests/fixtures/jsonObj-null-value.py

@@ -1,10 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything"
-
-payload = {"foo": None}
-headers = {"content-type": "application/json"}
-
-response = requests.post(url, json=payload, headers=headers)
-
-print(response.text)

package/src/targets/python/requests/fixtures/multipart-data.py

@@ -1,10 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything"
-
-files = {"foo": open("src/fixtures/files/hello.txt", "rb")}
-payload = {"bar": "Bonjour le monde"}
-
-response = requests.post(url, data=payload, files=files)
-
-print(response.text)

package/src/targets/python/requests/fixtures/multipart-file.py

@@ -1,9 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything"
-
-files = {"foo": open("src/fixtures/files/hello.txt", "rb")}
-
-response = requests.post(url, files=files)
-
-print(response.text)

package/src/targets/python/requests/fixtures/multipart-form-data-no-params.py

@@ -1,9 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything"
-
-headers = {"Content-Type": "multipart/form-data"}
-
-response = requests.post(url, headers=headers)
-
-print(response.text)

package/src/targets/python/requests/fixtures/multipart-form-data.py

@@ -1,10 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything"
-
-payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"\r\n\r\nbar\r\n-----011000010111000001101001--\r\n"
-headers = {"Content-Type": "multipart/form-data; boundary=---011000010111000001101001"}
-
-response = requests.post(url, data=payload, headers=headers)
-
-print(response.text)

package/src/targets/python/requests/fixtures/nested.py

@@ -1,7 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value"
-
-response = requests.get(url)
-
-print(response.text)

package/src/targets/python/requests/fixtures/query-encoded.py

@@ -1,7 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything?startTime=2019-06-13T19%3A08%3A25.455Z&endTime=2015-09-15T14%3A00%3A12-04%3A00"
-
-response = requests.get(url)
-
-print(response.text)

package/src/targets/python/requests/fixtures/query.py

@@ -1,7 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value"
-
-response = requests.get(url)
-
-print(response.text)

package/src/targets/python/requests/fixtures/short.py

@@ -1,7 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything"
-
-response = requests.get(url)
-
-print(response.text)

package/src/targets/python/requests/fixtures/text-plain.py

@@ -1,10 +0,0 @@
-import requests
-
-url = "https://httpbin.org/anything"
-
-payload = "Hello World"
-headers = {"content-type": "text/plain"}
-
-response = requests.post(url, data=payload, headers=headers)
-
-print(response.text)

package/src/targets/python/target.ts

@@ -1,15 +0,0 @@
-import type { Target } from '../targets';
-import { requests } from './requests/client';
-
-export const python: Target = {
-  info: {
-    key: 'python',
-    title: 'Python',
-    extname: '.py',
-    default: 'requests',
-    cli: 'python3 %s',
-  },
-  clientsById: {
-    requests,
-  },
-};

package/src/targets/r/httr/client.test.ts

@@ -1,29 +0,0 @@
-import type { Request } from '../../..';
-import { runCustomFixtures } from '../../../fixtures/runCustomFixtures';
-
-runCustomFixtures({
-  targetId: 'r',
-  clientId: 'httr',
-  tests: [
-    {
-      it: "should properly concatenate query strings that aren't nested",
-      input: {
-        method: 'GET',
-        url: 'http://mockbin.com/har',
-        httpVersion: 'HTTP/1.1',
-        queryString: [
-          {
-            name: 'perPage',
-            value: '100',
-          },
-          {
-            name: 'page',
-            value: '1',
-          },
-        ],
-      } as Request,
-      options: {},
-      expected: 'query-two-params.r',
-    },
-  ],
-});

package/src/targets/r/httr/client.ts

@@ -1,146 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for R using httr
- *
- * @author
- * @gabrielakoreeda
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-import type { Client } from '../../targets';
-import { CodeBuilder } from '../../../helpers/code-builder';
-
-export const httr: Client = {
-  info: {
-    key: 'httr',
-    title: 'httr',
-    link: 'https://cran.r-project.org/web/packages/httr/vignettes/quickstart.html',
-    description: 'httr: Tools for Working with URLs and HTTP',
-  },
-  convert: ({ url, queryObj, queryString, postData, allHeaders, method }) => {
-    // Start snippet
-    const { push, blank, join } = new CodeBuilder();
-
-    // Import httr
-    push('library(httr)');
-    blank();
-
-    // Set URL
-    push(`url <- "${url}"`);
-    blank();
-
-    // Construct query string
-    const qs = queryObj;
-    delete queryObj.key;
-
-    const queryCount = Object.keys(qs).length;
-    if (queryString.length === 1) {
-      push(`queryString <- list(${Object.keys(qs)} = "${Object.values(qs).toString()}")`);
-      blank();
-    } else if (queryString.length > 1) {
-      push('queryString <- list(');
-
-      Object.keys(qs).forEach((query, i) => {
-        if (i !== queryCount - 1) {
-          push(`  ${query} = "${qs[query].toString()}",`);
-        } else {
-          push(`  ${query} = "${qs[query].toString()}"`);
-        }
-      });
-
-      push(')');
-      blank();
-    }
-
-    // Construct payload
-    const payload = JSON.stringify(postData.text);
-
-    if (payload) {
-      push(`payload <- ${payload}`);
-      blank();
-    }
-
-    // Define encode
-    if (postData.text || postData.jsonObj || postData.params) {
-      switch (postData.mimeType) {
-        case 'application/x-www-form-urlencoded':
-          push('encode <- "form"');
-          blank();
-          break;
-
-        case 'application/json':
-          push('encode <- "json"');
-          blank();
-          break;
-
-        case 'multipart/form-data':
-          push('encode <- "multipart"');
-          blank();
-          break;
-
-        default:
-          push('encode <- "raw"');
-          blank();
-          break;
-      }
-    }
-
-    // Construct headers
-    const headers: string[] = [];
-    let cookies;
-    let accept;
-
-    Object.keys(allHeaders).forEach(header => {
-      if (header.toLowerCase() === 'accept') {
-        accept = `, accept("${allHeaders[header]}")`;
-      } else if (header.toLowerCase() === 'cookie') {
-        cookies = `, set_cookies(\`${String(allHeaders[header])
-          .replace(/;/g, '", `')
-          .replace(/` /g, '`')
-          .replace(/[=]/g, '` = "')}")`;
-      } else if (header.toLowerCase() !== 'content-type') {
-        headers.push(`'${header}' = '${allHeaders[header]}'`);
-      }
-    });
-
-    // Construct request
-    let request = `response <- VERB("${method}", url`;
-
-    if (payload) {
-      request += ', body = payload';
-    }
-
-    if (headers.length) {
-      request += `, add_headers(${headers.join(', ')})`;
-    }
-
-    if (queryString.length) {
-      request += ', query = queryString';
-    }
-
-    request += `, content_type("${postData.mimeType}")`;
-
-    if (typeof accept !== 'undefined') {
-      request += accept;
-    }
-
-    if (typeof cookies !== 'undefined') {
-      request += cookies;
-    }
-
-    if (postData.text || postData.jsonObj || postData.params) {
-      request += ', encode = encode';
-    }
-
-    request += ')';
-
-    push(request);
-
-    blank();
-    // Print response
-    push('content(response, "text")');
-
-    return join();
-  },
-};

package/src/targets/r/httr/fixtures/application-form-encoded.r

@@ -1,11 +0,0 @@
-library(httr)
-
-url <- "https://httpbin.org/anything"
-
-payload <- "foo=bar&hello=world"
-
-encode <- "form"
-
-response <- VERB("POST", url, body = payload, content_type("application/x-www-form-urlencoded"), encode = encode)
-
-content(response, "text")

package/src/targets/r/httr/fixtures/application-json.r

@@ -1,11 +0,0 @@
-library(httr)
-
-url <- "https://httpbin.org/anything"
-
-payload <- "{\"number\":1,\"string\":\"f\\\"oo\",\"arr\":[1,2,3],\"nested\":{\"a\":\"b\"},\"arr_mix\":[1,\"a\",{\"arr_mix_nested\":{}}],\"boolean\":false}"
-
-encode <- "json"
-
-response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
-
-content(response, "text")