@readme/httpsnippet 3.1.1 → 4.0.0

package/src/targets/shell/curl/fixtures/heredoc-json-encoded-data.sh

@@ -0,0 +1,9 @@
+curl --request POST \
+  --url https://httpbin.org/anything \
+  --header 'content-type: application/json' \
+  --data @- <<EOF
+{
+  "number": 1,
+  "string": "f'oo"
+}
+EOF

package/src/targets/shell/curl/fixtures/http-insecure.sh

@@ -0,0 +1,2 @@
+curl --request GET \
+  --url http://httpbin.org/anything

package/src/targets/shell/curl/fixtures/http1.sh

@@ -0,0 +1,3 @@
+curl --request GET \
+  --url "http://mockbin.com/request" \
+  --http1.0

package/src/targets/shell/curl/fixtures/http10.sh

@@ -0,0 +1 @@
+curl --request GET --url http://mockbin.com/request --http1.0

package/src/targets/shell/curl/fixtures/json-payloads-smaller-than-20-characters.sh

@@ -0,0 +1,4 @@
+curl --request POST \
+  --url https://httpbin.org/anything \
+  --header 'content-type: application/json' \
+  --data '{"foo": "bar"}'

package/src/targets/shell/curl/fixtures/jsonObj-multiline.sh

@@ -0,0 +1,6 @@
+curl --request POST \
+  --url https://httpbin.org/anything \
+  --header 'content-type: application/json' \
+  --data '{
+  "foo": "bar"
+}'

package/src/targets/shell/curl/fixtures/jsonObj-null-value.sh

@@ -0,0 +1,4 @@
+curl --request POST \
+  --url https://httpbin.org/anything \
+  --header 'content-type: application/json' \
+  --data '{"foo":null}'

package/src/targets/shell/curl/fixtures/long-globoff-option.sh

@@ -0,0 +1 @@
+curl --request GET --globoff --url 'https://httpbin.org/anything?foo[bar]=baz,zap&fiz=buz&key=value'

package/src/targets/shell/curl/fixtures/multipart-data.sh

@@ -0,0 +1,5 @@
+curl --request POST \
+  --url https://httpbin.org/anything \
+  --header 'content-type: multipart/form-data' \
+  --form foo=@src/fixtures/files/hello.txt \
+  --form 'bar=Bonjour le monde'

package/src/targets/shell/curl/fixtures/multipart-file.sh

@@ -0,0 +1,4 @@
+curl --request POST \
+  --url https://httpbin.org/anything \
+  --header 'content-type: multipart/form-data' \
+  --form foo=@src/fixtures/files/hello.txt

package/src/targets/shell/curl/fixtures/multipart-form-data-no-params.sh

@@ -0,0 +1,3 @@
+curl --request POST \
+  --url https://httpbin.org/anything \
+  --header 'Content-Type: multipart/form-data'

package/src/targets/shell/curl/fixtures/multipart-form-data.sh

@@ -0,0 +1,4 @@
+curl --request POST \
+  --url https://httpbin.org/anything \
+  --header 'Content-Type: multipart/form-data' \
+  --form foo=bar

package/src/targets/shell/curl/fixtures/nested.sh

@@ -0,0 +1,2 @@
+curl --request GET \
+  --url 'https://httpbin.org/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value'

package/src/targets/shell/curl/fixtures/query-encoded.sh

@@ -0,0 +1,2 @@
+curl --request GET \
+  --url 'https://httpbin.org/anything?startTime=2019-06-13T19%3A08%3A25.455Z&endTime=2015-09-15T14%3A00%3A12-04%3A00'

package/src/targets/shell/curl/fixtures/query.sh

@@ -0,0 +1,2 @@
+curl --request GET \
+  --url 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value'

package/src/targets/shell/curl/fixtures/short-options.sh

@@ -0,0 +1 @@
+curl -X POST 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value' -H 'accept: application/json' -H 'content-type: application/x-www-form-urlencoded' -b 'foo=bar; bar=baz' --data foo=bar

package/src/targets/shell/curl/fixtures/short.sh

@@ -0,0 +1,2 @@
+curl --request GET \
+  --url https://httpbin.org/anything

package/src/targets/shell/curl/fixtures/text-plain.sh

@@ -0,0 +1,4 @@
+curl --request POST \
+  --url https://httpbin.org/anything \
+  --header 'content-type: text/plain' \
+  --data 'Hello World'

package/src/targets/shell/curl/fixtures/urlencode.sh

@@ -0,0 +1,5 @@
+curl --request POST \
+  --url http://mockbin.com/har \
+  --header 'content-type: application/x-www-form-urlencoded' \
+  --data-urlencode 'user%20name=John Doe' \
+  --data-urlencode '%24filter=by id'

package/src/targets/shell/httpie/client.test.ts

@@ -0,0 +1,72 @@
+import type { Request } from '../../..';
+import applicationFormEncoded from '../../../fixtures/requests/application-form-encoded';
+import full from '../../../fixtures/requests/full';
+import query from '../../../fixtures/requests/query';
+import short from '../../../fixtures/requests/short';
+import { runCustomFixtures } from '../../../fixtures/runCustomFixtures';
+
+runCustomFixtures({
+  targetId: 'shell',
+  clientId: 'httpie',
+  tests: [
+    {
+      it: 'should ask for verbose output',
+      input: short.log.entries[0].request as Request,
+      options: { indent: false, verbose: true },
+      expected: 'verbose-output.sh',
+    },
+    {
+      it: 'should use short flags',
+      input: short.log.entries[0].request as Request,
+      options: {
+        body: true,
+        cert: 'foo',
+        headers: true,
+        indent: false,
+        pretty: 'x',
+        print: 'y',
+        short: true,
+        style: 'z',
+        timeout: 1,
+        verbose: true,
+        verify: 'v',
+      },
+      expected: 'short-flags.sh',
+    },
+    {
+      it: 'should use long flags',
+      input: short.log.entries[0].request as Request,
+      options: {
+        body: true,
+        cert: 'foo',
+        headers: true,
+        indent: false,
+        pretty: 'x',
+        print: 'y',
+        style: 'z',
+        timeout: 1,
+        verbose: true,
+        verify: 'v',
+      },
+      expected: 'long-flags.sh',
+    },
+    {
+      it: 'should use custom indentation',
+      input: full.log.entries[0].request as Request,
+      options: { indent: '@' },
+      expected: 'custom-indentation.sh',
+    },
+    {
+      it: 'should use queryString parameters',
+      input: query.log.entries[0].request as Request,
+      options: { indent: false, queryParams: true },
+      expected: 'querystring-parameters.sh',
+    },
+    {
+      it: 'should build parameterized output of post data',
+      input: applicationFormEncoded.log.entries[0].request as Request,
+      options: { short: true, indent: false, queryParams: true },
+      expected: 'build-parameters.sh',
+    },
+  ],
+});

package/src/targets/shell/httpie/client.ts

@@ -0,0 +1,144 @@
+/**
+ * @description
+ * HTTP code snippet generator for the Shell using HTTPie.
+ *
+ * @author
+ * @AhmadNassri
+ *
+ * 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 { quote } from '../../../helpers/shell';
+
+export interface HttpieOptions {
+  body?: boolean;
+  cert?: boolean;
+  headers?: boolean;
+  pretty?: boolean;
+  print?: boolean;
+  queryParams?: boolean;
+  short?: boolean;
+  style?: boolean;
+  timeout?: boolean;
+  verbose?: boolean;
+  verify?: boolean;
+}
+
+export const httpie: Client<HttpieOptions> = {
+  info: {
+    key: 'httpie',
+    title: 'HTTPie',
+    link: 'http://httpie.org/',
+    description: 'a CLI, cURL-like tool for humans',
+  },
+  convert: ({ allHeaders, postData, queryObj, fullUrl, method, url }, options) => {
+    const opts = {
+      body: false,
+      cert: false,
+      headers: false,
+      indent: '  ',
+      pretty: false,
+      print: false,
+      queryParams: false,
+      short: false,
+      style: false,
+      timeout: false,
+      verbose: false,
+      verify: false,
+      ...options,
+    };
+
+    const { push, join, unshift } = new CodeBuilder({
+      indent: opts.indent,
+      // @ts-expect-error SEEMS LEGIT
+      join: opts.indent !== false ? ` \\\n${opts.indent}` : ' ',
+    });
+
+    let raw = false;
+    const flags = [];
+
+    if (opts.headers) {
+      flags.push(opts.short ? '-h' : '--headers');
+    }
+
+    if (opts.body) {
+      flags.push(opts.short ? '-b' : '--body');
+    }
+
+    if (opts.verbose) {
+      flags.push(opts.short ? '-v' : '--verbose');
+    }
+
+    if (opts.print) {
+      flags.push(`${opts.short ? '-p' : '--print'}=${opts.print}`);
+    }
+
+    if (opts.verify) {
+      flags.push(`--verify=${opts.verify}`);
+    }
+
+    if (opts.cert) {
+      flags.push(`--cert=${opts.cert}`);
+    }
+
+    if (opts.pretty) {
+      flags.push(`--pretty=${opts.pretty}`);
+    }
+
+    if (opts.style) {
+      flags.push(`--style=${opts.style}`);
+    }
+
+    if (opts.timeout) {
+      flags.push(`--timeout=${opts.timeout}`);
+    }
+
+    // construct query params
+    if (opts.queryParams) {
+      Object.keys(queryObj).forEach(name => {
+        const value = queryObj[name];
+
+        if (Array.isArray(value)) {
+          value.forEach(val => {
+            push(`${name}==${quote(val)}`);
+          });
+        } else {
+          push(`${name}==${quote(value)}`);
+        }
+      });
+    }
+
+    // construct headers
+    Object.keys(allHeaders)
+      .sort()
+      .forEach(key => {
+        push(`${key}:${quote(allHeaders[key] as string)}`);
+      });
+
+    if (postData.mimeType === 'application/x-www-form-urlencoded') {
+      // construct post params
+      if (postData.params && postData.params.length) {
+        flags.push(opts.short ? '-f' : '--form');
+
+        postData.params.forEach(param => {
+          push(`${param.name}=${quote(param.value)}`);
+        });
+      }
+    } else {
+      raw = true;
+    }
+
+    const cliFlags = flags.length ? `${flags.join(' ')} ` : '';
+    url = quote(opts.queryParams ? url : fullUrl);
+    unshift(`http ${cliFlags}${method} ${url}`);
+
+    if (raw && postData.text) {
+      const postDataText = quote(postData.text);
+      unshift(`echo ${postDataText} | `);
+    }
+
+    return join();
+  },
+};

package/src/targets/shell/httpie/fixtures/application-form-encoded.sh

@@ -0,0 +1,4 @@
+http --form POST https://httpbin.org/anything \
+  content-type:application/x-www-form-urlencoded \
+  foo=bar \
+  hello=world

package/src/targets/shell/httpie/fixtures/application-json.sh

@@ -0,0 +1,3 @@
+echo '{"number":1,"string":"f\"oo","arr":[1,2,3],"nested":{"a":"b"},"arr_mix":[1,"a",{"arr_mix_nested":{}}],"boolean":false}' |  \
+  http POST https://httpbin.org/anything \
+  content-type:application/json

package/src/targets/shell/httpie/fixtures/build-parameters.sh

@@ -0,0 +1 @@
+http -f POST https://httpbin.org/anything content-type:application/x-www-form-urlencoded foo=bar hello=world

package/src/targets/shell/httpie/fixtures/cookies.sh

@@ -0,0 +1,2 @@
+http GET https://httpbin.org/cookies \
+  cookie:'foo=bar; bar=baz'

package/src/targets/shell/httpie/fixtures/custom-indentation.sh

@@ -0,0 +1,5 @@
+http --form POST 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value' \
+@accept:application/json \
+@content-type:application/x-www-form-urlencoded \
+@cookie:'foo=bar; bar=baz' \
+@foo=bar

package/src/targets/shell/httpie/fixtures/custom-method.sh

@@ -0,0 +1 @@
+http PROPFIND https://httpbin.org/anything

package/src/targets/shell/httpie/fixtures/full.sh

@@ -0,0 +1,5 @@
+http --form POST 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value' \
+  accept:application/json \
+  content-type:application/x-www-form-urlencoded \
+  cookie:'foo=bar; bar=baz' \
+  foo=bar

package/src/targets/shell/httpie/fixtures/headers.sh

@@ -0,0 +1,4 @@
+http GET https://httpbin.org/headers \
+  accept:application/json \
+  x-bar:Foo \
+  x-foo:Bar

package/src/targets/shell/httpie/fixtures/http-insecure.sh

@@ -0,0 +1 @@
+http GET http://httpbin.org/anything

package/src/targets/shell/httpie/fixtures/jsonObj-multiline.sh

@@ -0,0 +1,5 @@
+echo '{
+  "foo": "bar"
+}' |  \
+  http POST https://httpbin.org/anything \
+  content-type:application/json

package/src/targets/shell/httpie/fixtures/jsonObj-null-value.sh

@@ -0,0 +1,3 @@
+echo '{"foo":null}' |  \
+  http POST https://httpbin.org/anything \
+  content-type:application/json

package/src/targets/shell/httpie/fixtures/long-flags.sh

@@ -0,0 +1 @@
+http --headers --body --verbose --print=y --verify=v --cert=foo --pretty=x --style=z --timeout=1 GET https://httpbin.org/anything

package/src/targets/shell/httpie/fixtures/multipart-data.sh

@@ -0,0 +1,13 @@
+echo '-----011000010111000001101001
+Content-Disposition: form-data; name="foo"; filename="hello.txt"
+Content-Type: text/plain
+
+Hello World
+-----011000010111000001101001
+Content-Disposition: form-data; name="bar"
+
+Bonjour le monde
+-----011000010111000001101001--
+' |  \
+  http POST https://httpbin.org/anything \
+  content-type:'multipart/form-data; boundary=---011000010111000001101001'

package/src/targets/shell/httpie/fixtures/multipart-file.sh

@@ -0,0 +1,9 @@
+echo '-----011000010111000001101001
+Content-Disposition: form-data; name="foo"; filename="hello.txt"
+Content-Type: text/plain
+
+
+-----011000010111000001101001--
+' |  \
+  http POST https://httpbin.org/anything \
+  content-type:'multipart/form-data; boundary=---011000010111000001101001'

package/src/targets/shell/httpie/fixtures/multipart-form-data-no-params.sh

@@ -0,0 +1,2 @@
+http POST https://httpbin.org/anything \
+  Content-Type:multipart/form-data

package/src/targets/shell/httpie/fixtures/multipart-form-data.sh

@@ -0,0 +1,8 @@
+echo '-----011000010111000001101001
+Content-Disposition: form-data; name="foo"
+
+bar
+-----011000010111000001101001--
+' |  \
+  http POST https://httpbin.org/anything \
+  Content-Type:'multipart/form-data; boundary=---011000010111000001101001'

package/src/targets/shell/httpie/fixtures/nested.sh

@@ -0,0 +1 @@
+http GET 'https://httpbin.org/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value'

package/src/targets/shell/httpie/fixtures/query-encoded.sh

@@ -0,0 +1 @@
+http GET 'https://httpbin.org/anything?startTime=2019-06-13T19%3A08%3A25.455Z&endTime=2015-09-15T14%3A00%3A12-04%3A00'

package/src/targets/shell/httpie/fixtures/query.sh

@@ -0,0 +1 @@
+http GET 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value'

package/src/targets/shell/httpie/fixtures/querystring-parameters.sh

@@ -0,0 +1 @@
+http GET https://httpbin.org/anything foo==bar foo==baz baz==abc key==value

package/src/targets/shell/httpie/fixtures/short-flags.sh

@@ -0,0 +1 @@
+http -h -b -v -p=y --verify=v --cert=foo --pretty=x --style=z --timeout=1 GET https://httpbin.org/anything

package/src/targets/shell/httpie/fixtures/short.sh

@@ -0,0 +1 @@
+http GET https://httpbin.org/anything

package/src/targets/shell/httpie/fixtures/text-plain.sh

@@ -0,0 +1,3 @@
+echo 'Hello World' |  \
+  http POST https://httpbin.org/anything \
+  content-type:text/plain

package/src/targets/shell/httpie/fixtures/verbose-output.sh

@@ -0,0 +1 @@
+http --verbose GET https://httpbin.org/anything

package/src/targets/shell/target.ts

@@ -0,0 +1,19 @@
+import type { Target } from '../targets';
+import { curl } from './curl/client';
+import { httpie } from './httpie/client';
+import { wget } from './wget/client';
+
+export const shell: Target = {
+  info: {
+    key: 'shell',
+    title: 'Shell',
+    extname: '.sh',
+    default: 'curl',
+    cli: '%s',
+  },
+  clientsById: {
+    curl,
+    httpie,
+    wget,
+  },
+};

package/src/targets/shell/wget/client.test.ts

@@ -0,0 +1,35 @@
+import type { Request } from '../../..';
+import full from '../../../fixtures/requests/full';
+import short from '../../../fixtures/requests/short';
+import { runCustomFixtures } from '../../../fixtures/runCustomFixtures';
+
+runCustomFixtures({
+  targetId: 'shell',
+  clientId: 'wget',
+  tests: [
+    {
+      it: 'should use short options',
+      input: full.log.entries[0].request as Request,
+      options: { short: true, indent: false },
+      expected: 'short-options.sh',
+    },
+    {
+      it: 'should ask for -v output',
+      input: short.log.entries[0].request as Request,
+      options: { short: true, indent: false, verbose: true },
+      expected: 'v-output.sh',
+    },
+    {
+      it: 'should ask for --verbose output',
+      input: short.log.entries[0].request as Request,
+      options: { short: false, indent: false, verbose: true },
+      expected: 'verbose-output.sh',
+    },
+    {
+      it: 'should use custom indentation',
+      input: full.log.entries[0].request as Request,
+      options: { indent: '@' },
+      expected: 'custom-indentation.sh',
+    },
+  ],
+});

package/src/targets/shell/wget/client.ts

@@ -0,0 +1,63 @@
+/**
+ * @description
+ * HTTP code snippet generator for the Shell using Wget.
+ *
+ * @author
+ * @AhmadNassri
+ *
+ * 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 { escape, quote } from '../../../helpers/shell';
+
+export interface WgetOptions {
+  indent?: string | false;
+  short?: boolean;
+  verbose?: boolean;
+}
+
+export const wget: Client<WgetOptions> = {
+  info: {
+    key: 'wget',
+    title: 'Wget',
+    link: 'https://www.gnu.org/software/wget/',
+    description: 'a free software package for retrieving files using HTTP, HTTPS',
+  },
+  convert: ({ method, postData, allHeaders, fullUrl }, options) => {
+    const opts = {
+      indent: '  ',
+      short: false,
+      verbose: false,
+      ...options,
+    };
+
+    const { push, join } = new CodeBuilder({
+      ...(typeof opts.indent === 'string' ? { indent: opts.indent } : {}),
+      join: opts.indent !== false ? ` \\\n${opts.indent}` : ' ',
+    });
+
+    if (opts.verbose) {
+      push(`wget ${opts.short ? '-v' : '--verbose'}`);
+    } else {
+      push(`wget ${opts.short ? '-q' : '--quiet'}`);
+    }
+
+    push(`--method ${quote(method)}`);
+
+    Object.keys(allHeaders).forEach(key => {
+      const header = `${key}: ${allHeaders[key]}`;
+      push(`--header ${quote(header)}`);
+    });
+
+    if (postData.text) {
+      push(`--body-data ${escape(quote(postData.text))}`);
+    }
+
+    push(opts.short ? '-O' : '--output-document');
+    push(`- ${quote(fullUrl)}`);
+
+    return join();
+  },
+};

package/src/targets/shell/wget/fixtures/application-form-encoded.sh

@@ -0,0 +1,6 @@
+wget --quiet \
+  --method POST \
+  --header 'content-type: application/x-www-form-urlencoded' \
+  --body-data 'foo=bar&hello=world' \
+  --output-document \
+  - https://httpbin.org/anything

package/src/targets/shell/wget/fixtures/application-json.sh

@@ -0,0 +1,6 @@
+wget --quiet \
+  --method POST \
+  --header 'content-type: application/json' \
+  --body-data '{"number":1,"string":"f\"oo","arr":[1,2,3],"nested":{"a":"b"},"arr_mix":[1,"a",{"arr_mix_nested":{}}],"boolean":false}' \
+  --output-document \
+  - https://httpbin.org/anything

package/src/targets/shell/wget/fixtures/cookies.sh

@@ -0,0 +1,5 @@
+wget --quiet \
+  --method GET \
+  --header 'cookie: foo=bar; bar=baz' \
+  --output-document \
+  - https://httpbin.org/cookies

package/src/targets/shell/wget/fixtures/custom-indentation.sh

@@ -0,0 +1,8 @@
+wget --quiet \
+@--method POST \
+@--header 'cookie: foo=bar; bar=baz' \
+@--header 'accept: application/json' \
+@--header 'content-type: application/x-www-form-urlencoded' \
+@--body-data foo=bar \
+@--output-document \
+@- 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value'

package/src/targets/shell/wget/fixtures/custom-method.sh

@@ -0,0 +1,4 @@
+wget --quiet \
+  --method PROPFIND \
+  --output-document \
+  - https://httpbin.org/anything

package/src/targets/shell/wget/fixtures/full.sh

@@ -0,0 +1,8 @@
+wget --quiet \
+  --method POST \
+  --header 'cookie: foo=bar; bar=baz' \
+  --header 'accept: application/json' \
+  --header 'content-type: application/x-www-form-urlencoded' \
+  --body-data foo=bar \
+  --output-document \
+  - 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value'

package/src/targets/shell/wget/fixtures/headers.sh

@@ -0,0 +1,7 @@
+wget --quiet \
+  --method GET \
+  --header 'accept: application/json' \
+  --header 'x-foo: Bar' \
+  --header 'x-bar: Foo' \
+  --output-document \
+  - https://httpbin.org/headers

package/src/targets/shell/wget/fixtures/http-insecure.sh

@@ -0,0 +1,4 @@
+wget --quiet \
+  --method GET \
+  --output-document \
+  - http://httpbin.org/anything

package/src/targets/shell/wget/fixtures/jsonObj-multiline.sh

@@ -0,0 +1,6 @@
+wget --quiet \
+  --method POST \
+  --header 'content-type: application/json' \
+  --body-data '{\n  "foo": "bar"\n}' \
+  --output-document \
+  - https://httpbin.org/anything

package/src/targets/shell/wget/fixtures/jsonObj-null-value.sh

@@ -0,0 +1,6 @@
+wget --quiet \
+  --method POST \
+  --header 'content-type: application/json' \
+  --body-data '{"foo":null}' \
+  --output-document \
+  - https://httpbin.org/anything