@readme/httpsnippet 4.0.1 → 4.0.4

package/src/helpers/__snapshots__/utils.test.ts.snap

@@ -1,364 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`availableTargets returns all available targets 1`] = `
-Array [
-  Object {
-    "clients": Array [
-      Object {
-        "description": "Simple REST and HTTP API Client for C",
-        "key": "libcurl",
-        "link": "http://curl.haxx.se/libcurl",
-        "title": "Libcurl",
-      },
-    ],
-    "default": "libcurl",
-    "extname": ".c",
-    "key": "c",
-    "title": "C",
-  },
-  Object {
-    "clients": Array [
-      Object {
-        "description": "An idiomatic clojure http client wrapping the apache client.",
-        "key": "clj_http",
-        "link": "https://github.com/dakrone/clj-http",
-        "title": "clj-http",
-      },
-    ],
-    "default": "clj_http",
-    "extname": ".clj",
-    "key": "clojure",
-    "title": "Clojure",
-  },
-  Object {
-    "clients": Array [
-      Object {
-        "description": ".NET Standard HTTP Client",
-        "key": "httpclient",
-        "link": "https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient",
-        "title": "HttpClient",
-      },
-      Object {
-        "description": "Simple REST and HTTP API Client for .NET",
-        "key": "restsharp",
-        "link": "http://restsharp.org/",
-        "title": "RestSharp",
-      },
-    ],
-    "default": "restsharp",
-    "extname": ".cs",
-    "key": "csharp",
-    "title": "C#",
-  },
-  Object {
-    "clients": Array [
-      Object {
-        "description": "Golang HTTP client request",
-        "key": "native",
-        "link": "http://golang.org/pkg/net/http/#NewRequest",
-        "title": "NewRequest",
-      },
-    ],
-    "default": "native",
-    "extname": ".go",
-    "key": "go",
-    "title": "Go",
-  },
-  Object {
-    "clients": Array [
-      Object {
-        "description": "HTTP/1.1 request string in accordance with RFC 7230",
-        "key": "http1.1",
-        "link": "https://tools.ietf.org/html/rfc7230",
-        "title": "HTTP/1.1",
-      },
-    ],
-    "default": "1.1",
-    "extname": null,
-    "key": "http",
-    "title": "HTTP",
-  },
-  Object {
-    "clients": Array [
-      Object {
-        "description": "Asynchronous Http and WebSocket Client library for Java",
-        "key": "asynchttp",
-        "link": "https://github.com/AsyncHttpClient/async-http-client",
-        "title": "AsyncHttp",
-      },
-      Object {
-        "description": "Java Standardized HTTP Client API",
-        "key": "nethttp",
-        "link": "https://openjdk.java.net/groups/net/httpclient/intro.html",
-        "title": "java.net.http",
-      },
-      Object {
-        "description": "An HTTP Request Client Library",
-        "key": "okhttp",
-        "link": "http://square.github.io/okhttp/",
-        "title": "OkHttp",
-      },
-      Object {
-        "description": "Lightweight HTTP Request Client Library",
-        "key": "unirest",
-        "link": "http://unirest.io/java.html",
-        "title": "Unirest",
-      },
-    ],
-    "default": "unirest",
-    "extname": ".java",
-    "key": "java",
-    "title": "Java",
-  },
-  Object {
-    "clients": Array [
-      Object {
-        "description": "W3C Standard API that provides scripted client functionality",
-        "key": "xhr",
-        "link": "https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest",
-        "title": "XMLHttpRequest",
-      },
-      Object {
-        "description": "Promise based HTTP client for the browser and node.js",
-        "key": "axios",
-        "link": "https://github.com/axios/axios",
-        "title": "Axios",
-      },
-      Object {
-        "description": "Perform asynchronous HTTP requests with the Fetch API",
-        "key": "fetch",
-        "link": "https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch",
-        "title": "fetch",
-      },
-      Object {
-        "description": "Perform an asynchronous HTTP (Ajax) requests with jQuery",
-        "key": "jquery",
-        "link": "http://api.jquery.com/jquery.ajax/",
-        "title": "jQuery",
-      },
-    ],
-    "default": "xhr",
-    "extname": ".js",
-    "key": "javascript",
-    "title": "JavaScript",
-  },
-  Object {
-    "clients": Array [
-      Object {
-        "description": "An HTTP Request Client Library",
-        "key": "okhttp",
-        "link": "http://square.github.io/okhttp/",
-        "title": "OkHttp",
-      },
-    ],
-    "default": "okhttp",
-    "extname": ".kt",
-    "key": "kotlin",
-    "title": "Kotlin",
-  },
-  Object {
-    "cli": "node %s",
-    "clients": Array [
-      Object {
-        "description": "Node.js native HTTP interface",
-        "key": "native",
-        "link": "http://nodejs.org/api/http.html#http_http_request_options_callback",
-        "title": "HTTP",
-      },
-      Object {
-        "description": "Simplified HTTP request client",
-        "key": "request",
-        "link": "https://github.com/request/request",
-        "title": "Request",
-      },
-      Object {
-        "description": "Lightweight HTTP Request Client Library",
-        "key": "unirest",
-        "link": "http://unirest.io/nodejs.html",
-        "title": "Unirest",
-      },
-      Object {
-        "description": "Promise based HTTP client for the browser and node.js",
-        "key": "axios",
-        "link": "https://github.com/axios/axios",
-        "title": "Axios",
-      },
-      Object {
-        "description": "Simplified HTTP node-fetch client",
-        "key": "fetch",
-        "link": "https://github.com/bitinn/node-fetch",
-        "title": "Fetch",
-      },
-    ],
-    "default": "native",
-    "extname": ".js",
-    "key": "node",
-    "title": "Node.js",
-  },
-  Object {
-    "clients": Array [
-      Object {
-        "description": "Foundation's NSURLSession request",
-        "key": "nsurlsession",
-        "link": "https://developer.apple.com/library/mac/documentation/Foundation/Reference/NSURLSession_class/index.html",
-        "title": "NSURLSession",
-      },
-    ],
-    "default": "nsurlsession",
-    "extname": ".m",
-    "key": "objc",
-    "title": "Objective-C",
-  },
-  Object {
-    "clients": Array [
-      Object {
-        "description": "Cohttp is a very lightweight HTTP server using Lwt or Async for OCaml",
-        "key": "cohttp",
-        "link": "https://github.com/mirage/ocaml-cohttp",
-        "title": "CoHTTP",
-      },
-    ],
-    "default": "cohttp",
-    "extname": ".ml",
-    "key": "ocaml",
-    "title": "OCaml",
-  },
-  Object {
-    "cli": "php %s",
-    "clients": Array [
-      Object {
-        "description": "PHP with ext-curl",
-        "key": "curl",
-        "link": "http://php.net/manual/en/book.curl.php",
-        "title": "cURL",
-      },
-      Object {
-        "description": "PHP with Guzzle",
-        "key": "guzzle",
-        "link": "http://docs.guzzlephp.org/en/stable/",
-        "title": "Guzzle",
-      },
-      Object {
-        "description": "PHP with pecl/http v1",
-        "key": "http1",
-        "link": "http://php.net/manual/en/book.http.php",
-        "title": "HTTP v1",
-      },
-      Object {
-        "description": "PHP with pecl/http v2",
-        "key": "http2",
-        "link": "http://devel-m6w6.rhcloud.com/mdref/http",
-        "title": "HTTP v2",
-      },
-    ],
-    "default": "curl",
-    "extname": ".php",
-    "key": "php",
-    "title": "PHP",
-  },
-  Object {
-    "clients": Array [
-      Object {
-        "description": "Powershell Invoke-WebRequest client",
-        "key": "webrequest",
-        "link": "https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-WebRequest",
-        "title": "Invoke-WebRequest",
-      },
-      Object {
-        "description": "Powershell Invoke-RestMethod client",
-        "key": "restmethod",
-        "link": "https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod",
-        "title": "Invoke-RestMethod",
-      },
-    ],
-    "default": "webrequest",
-    "extname": ".ps1",
-    "key": "powershell",
-    "title": "Powershell",
-  },
-  Object {
-    "cli": "python3 %s",
-    "clients": Array [
-      Object {
-        "description": "Requests HTTP library",
-        "key": "requests",
-        "link": "http://docs.python-requests.org/en/latest/api/#requests.request",
-        "title": "Requests",
-      },
-    ],
-    "default": "requests",
-    "extname": ".py",
-    "key": "python",
-    "title": "Python",
-  },
-  Object {
-    "clients": Array [
-      Object {
-        "description": "httr: Tools for Working with URLs and HTTP",
-        "key": "httr",
-        "link": "https://cran.r-project.org/web/packages/httr/vignettes/quickstart.html",
-        "title": "httr",
-      },
-    ],
-    "default": "httr",
-    "extname": ".r",
-    "key": "r",
-    "title": "R",
-  },
-  Object {
-    "clients": Array [
-      Object {
-        "description": "Ruby HTTP client",
-        "key": "native",
-        "link": "http://ruby-doc.org/stdlib-2.2.1/libdoc/net/http/rdoc/Net/HTTP.html",
-        "title": "net::http",
-      },
-    ],
-    "default": "native",
-    "extname": ".rb",
-    "key": "ruby",
-    "title": "Ruby",
-  },
-  Object {
-    "cli": "%s",
-    "clients": Array [
-      Object {
-        "description": "cURL is a command line tool and library for transferring data with URL syntax",
-        "key": "curl",
-        "link": "http://curl.haxx.se/",
-        "title": "cURL",
-      },
-      Object {
-        "description": "a CLI, cURL-like tool for humans",
-        "key": "httpie",
-        "link": "http://httpie.org/",
-        "title": "HTTPie",
-      },
-      Object {
-        "description": "a free software package for retrieving files using HTTP, HTTPS",
-        "key": "wget",
-        "link": "https://www.gnu.org/software/wget/",
-        "title": "Wget",
-      },
-    ],
-    "default": "curl",
-    "extname": ".sh",
-    "key": "shell",
-    "title": "Shell",
-  },
-  Object {
-    "clients": Array [
-      Object {
-        "description": "Foundation's NSURLSession request",
-        "key": "nsurlsession",
-        "link": "https://developer.apple.com/library/mac/documentation/Foundation/Reference/NSURLSession_class/index.html",
-        "title": "NSURLSession",
-      },
-    ],
-    "default": "nsurlsession",
-    "extname": ".swift",
-    "key": "swift",
-    "title": "Swift",
-  },
-]
-`;

package/src/helpers/code-builder.test.ts

@@ -1,42 +0,0 @@
-import { CodeBuilder } from './code-builder';
-
-describe('codeBuilder', () => {
-  describe('indentLine', () => {
-    const indent = '\t';
-    const builder = new CodeBuilder({ indent });
-    const line = 'console.log("hello world")';
-
-    it('handles a single argument', () => {
-      const result = builder.indentLine(line);
-
-      expect(result).toStrictEqual(line);
-    });
-
-    it('handels indentation', () => {
-      const result = builder.indentLine(line, 2);
-
-      expect(result).toBe(`${indent.repeat(2)}${line}`);
-    });
-  });
-
-  describe('addPostProcessor', () => {
-    it('replaces accordingly with one replacer', () => {
-      const indent = '\t';
-      const { join, addPostProcessor, push } = new CodeBuilder({ indent });
-      push('console.log("hello world")');
-      addPostProcessor(code => code.replace(/console/, 'REPLACED'));
-
-      expect(join()).toBe('REPLACED.log("hello world")');
-    });
-
-    it('replaces accordingly with multiple replacers', () => {
-      const indent = '\t';
-      const { join, addPostProcessor, push } = new CodeBuilder({ indent });
-      push('console.log("hello world")');
-      addPostProcessor(code => code.replace(/world/, 'nurse!!'));
-      addPostProcessor(code => code.toUpperCase());
-
-      expect(join()).toBe('CONSOLE.LOG("HELLO NURSE!!")');
-    });
-  });
-});

package/src/helpers/code-builder.ts

@@ -1,85 +0,0 @@
-const DEFAULT_INDENTATION_CHARACTER = '';
-const DEFAULT_LINE_JOIN = '\n';
-
-export type PostProcessor = (unreplacedCode: string) => string;
-
-export interface CodeBuilderOptions {
-  /**
-   * Desired indentation character for aggregated lines of code
-   * @default ''
-   */
-  indent?: string;
-
-  /**
-   * Desired character to join each line of code
-   * @default \n
-   */
-  join?: string;
-}
-
-export class CodeBuilder {
-  postProcessors: PostProcessor[] = [];
-
-  code: string[] = [];
-
-  indentationCharacter: string = DEFAULT_INDENTATION_CHARACTER;
-
-  lineJoin = DEFAULT_LINE_JOIN;
-
-  /**
-   * Helper object to format and aggragate lines of code.
-   * Lines are aggregated in a `code` array, and need to be joined to obtain a proper code snippet.
-   */
-  constructor({ indent, join }: CodeBuilderOptions = {}) {
-    this.indentationCharacter = indent || DEFAULT_INDENTATION_CHARACTER;
-    this.lineJoin = join ?? DEFAULT_LINE_JOIN;
-  }
-
-  /**
-   * Add given indentation level to given line of code
-   */
-  indentLine = (line: string, indentationLevel = 0) => {
-    const indent = this.indentationCharacter.repeat(indentationLevel);
-    return `${indent}${line}`;
-  };
-
-  /**
-   * Add the line at the beginning of the current lines
-   */
-  unshift = (line: string, indentationLevel?: number) => {
-    const newLine = this.indentLine(line, indentationLevel);
-    this.code.unshift(newLine);
-  };
-
-  /**
-   * Add the line at the end of the current lines
-   */
-  push = (line: string, indentationLevel?: number) => {
-    const newLine = this.indentLine(line, indentationLevel);
-    this.code.push(newLine);
-  };
-
-  /**
-   * Add an empty line at the end of current lines
-   */
-  blank = () => {
-    this.code.push('');
-  };
-
-  /**
-   * Concatenate all current lines using the given lineJoin, then apply any replacers that may have been added
-   */
-  join = () => {
-    const unreplacedCode = this.code.join(this.lineJoin);
-    const replacedOutput = this.postProcessors.reduce((accumulator, replacer) => replacer(accumulator), unreplacedCode);
-    return replacedOutput;
-  };
-
-  /**
-   * Often when writing modules you may wish to add a literal tag or bit of metadata that you wish to transform after other processing as a final step.
-   * To do so, you can provide a PostProcessor function and it will be run automatically for you when you call `join()` later on.
-   */
-  addPostProcessor = (postProcessor: PostProcessor) => {
-    this.postProcessors = [...this.postProcessors, postProcessor];
-  };
-}

package/src/helpers/form-data.ts

@@ -1,76 +0,0 @@
-/**
- * @license https://raw.githubusercontent.com/node-fetch/node-fetch/master/LICENSE.md
- *
- * The MIT License (MIT)
- *
- * Copyright (c) 2016 - 2020 Node Fetch Team
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
- * Extracted from https://github.com/node-fetch/node-fetch/blob/64c5c296a0250b852010746c76144cb9e14698d9/src/utils/form-data.js
- */
-
-import type FormData from 'form-data';
-
-const carriage = '\r\n';
-const dashes = '-'.repeat(2);
-
-const NAME = Symbol.toStringTag;
-
-export const isBlob = (object: any) =>
-  typeof object === 'object' &&
-  typeof object.arrayBuffer === 'function' &&
-  typeof object.type === 'string' &&
-  typeof object.stream === 'function' &&
-  typeof object.constructor === 'function' &&
-  /^(Blob|File)$/.test(object[NAME]);
-
-const getFooter = (boundary: string) => `${dashes}${boundary}${dashes}${carriage.repeat(2)}`;
-
-const getHeader = (boundary: string, name: string, field: { name: string; type: string }) => {
-  let header = '';
-
-  header += `${dashes}${boundary}${carriage}`;
-  header += `Content-Disposition: form-data; name="${name}"`;
-
-  if (isBlob(field)) {
-    header += `; filename="${field.name}"${carriage}`;
-    header += `Content-Type: ${field.type || 'application/octet-stream'}`;
-  }
-
-  return `${header}${carriage.repeat(2)}`;
-};
-
-export const formDataIterator = function* (form: FormData, boundary: string) {
-  // @ts-expect-error not sure how this ever worked
-  // eslint-disable-next-line no-restricted-syntax
-  for (const [name, value] of form) {
-    yield getHeader(boundary, name, value);
-
-    if (isBlob(value)) {
-      yield* value.stream();
-    } else {
-      yield value;
-    }
-
-    yield carriage;
-  }
-
-  yield getFooter(boundary);
-};

package/src/helpers/har-validator.ts

@@ -1,35 +0,0 @@
-import type { ErrorObject } from 'ajv';
-import type { Request } from 'har-format';
-import Ajv from 'ajv';
-import * as schema from 'har-schema';
-
-export class HARError extends Error {
-  name = 'HARError';
-
-  message = 'validation failed';
-
-  errors: ErrorObject[] = [];
-
-  constructor(errors: ErrorObject[]) {
-    super();
-    this.errors = errors;
-    Error.captureStackTrace(this, this.constructor);
-  }
-}
-
-const ajv = new Ajv({
-  allErrors: true,
-});
-ajv.addSchema(schema);
-
-export const validateHarRequest = (request: any): request is Request => {
-  const validate = ajv.getSchema('request.json');
-  if (!validate) {
-    throw new Error('failed to find HAR request schema');
-  }
-  const valid = validate(request);
-  if (!valid && validate.errors) {
-    throw new HARError(validate.errors);
-  }
-  return true;
-};

package/src/helpers/headers.test.ts

@@ -1,35 +0,0 @@
-import { getHeader, getHeaderName, hasHeader } from './headers';
-
-const headers = {
-  'Content-Type': 'multipart/form-data; boundary=---011000010111000001101001',
-  accept: 'application/json',
-};
-
-describe('headers', () => {
-  describe('getHeader', () => {
-    it('should get a header', () => {
-      expect(getHeader(headers, 'content-type')).toBe('multipart/form-data; boundary=---011000010111000001101001');
-      expect(getHeader(headers, 'content-TYPE')).toBe('multipart/form-data; boundary=---011000010111000001101001');
-      expect(getHeader(headers, 'Accept')).toBe('application/json');
-      expect(getHeader(headers, 'authorization')).toBeUndefined();
-    });
-  });
-
-  describe('getHeaderName', () => {
-    it('should get a header name', () => {
-      expect(getHeaderName(headers, 'content-type')).toBe('Content-Type');
-      expect(getHeaderName(headers, 'content-TYPE')).toBe('Content-Type');
-      expect(getHeaderName(headers, 'Accept')).toBe('accept');
-      expect(getHeaderName(headers, 'authorization')).toBeUndefined();
-    });
-  });
-
-  describe('hasHeader', () => {
-    it('should return if a header is present', () => {
-      expect(hasHeader(headers, 'content-type')).toBe(true);
-      expect(hasHeader(headers, 'content-TYPE')).toBe(true);
-      expect(hasHeader(headers, 'Accept')).toBe(true);
-      expect(hasHeader(headers, 'authorization')).toBe(false);
-    });
-  });
-});

package/src/helpers/headers.ts

@@ -1,31 +0,0 @@
-type Headers<T> = Record<string, T>;
-
-/**
- * Given a headers object retrieve a specific header out of it via a case-insensitive key.
- */
-export const getHeaderName = <T>(headers: Headers<T>, name: string) =>
-  Object.keys(headers).find(header => header.toLowerCase() === name.toLowerCase());
-
-/**
- * Given a headers object retrieve the contents of a header out of it via a case-insensitive key.
- */
-export const getHeader = <T>(headers: Headers<T>, name: string) => {
-  const headerName = getHeaderName(headers, name);
-  if (!headerName) {
-    return undefined;
-  }
-  return headers[headerName];
-};
-
-/**
- * Determine if a given case-insensitive header exists within a header object.
- */
-export const hasHeader = <T>(headers: Headers<T>, name: string) => Boolean(getHeaderName(headers, name));
-
-/**
- * Determines if a given MIME type is JSON, or a variant of such.
- */
-export const isMimeTypeJSON = (mimeType: string) =>
-  ['application/json', 'application/x-json', 'text/json', 'text/x-json', '+json'].some(
-    type => mimeType.indexOf(type) > -1
-  );