@readme/httpsnippet 3.1.3 → 4.0.0

package/src/targets/php/http1/fixtures/short.php

@@ -0,0 +1,13 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/anything');
+$request->setMethod(HTTP_METH_GET);
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}

package/src/targets/php/http1/fixtures/text-plain.php

@@ -0,0 +1,19 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/anything');
+$request->setMethod(HTTP_METH_POST);
+
+$request->setHeaders([
+  'content-type' => 'text/plain'
+]);
+
+$request->setBody('Hello World');
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}

package/src/targets/php/http2/client.ts

@@ -0,0 +1,153 @@
+/**
+ * @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.
+ */
+
+import type { Client } from '../../targets';
+import { CodeBuilder } from '../../../helpers/code-builder';
+import { getHeader, getHeaderName, hasHeader } from '../../../helpers/headers';
+import { convertType } from '../helpers';
+
+export interface Http2Options {
+  closingTag?: boolean;
+  noTags?: boolean;
+  shortTags?: boolean;
+}
+
+export const http2: Client<Http2Options> = {
+  info: {
+    key: 'http2',
+    title: 'HTTP v2',
+    link: 'http://devel-m6w6.rhcloud.com/mdref/http',
+    description: 'PHP with pecl/http v2',
+  },
+  convert: ({ postData, headersObj, method, queryObj, cookiesObj, url }, options) => {
+    const opts = {
+      closingTag: false,
+      indent: '  ',
+      noTags: false,
+      shortTags: false,
+      ...options,
+    };
+
+    const { push, blank, join } = new CodeBuilder({ indent: opts.indent });
+    let hasBody = false;
+
+    if (!opts.noTags) {
+      push(opts.shortTags ? '<?' : '<?php');
+      blank();
+    }
+
+    push('$client = new http\\Client;');
+    push('$request = new http\\Client\\Request;');
+    blank();
+
+    switch (postData.mimeType) {
+      case 'application/x-www-form-urlencoded':
+        push('$body = new http\\Message\\Body;');
+        push(`$body->append(new http\\QueryString(${convertType(postData.paramsObj, opts.indent)}));`);
+        blank();
+        hasBody = true;
+        break;
+
+      case 'multipart/form-data': {
+        if (!postData.params) {
+          break;
+        }
+
+        const files: {
+          name: string;
+          type: string | undefined;
+          file: string;
+          data: string | undefined;
+          [anything: string]: string | undefined;
+        }[] = [];
+        const fields: Record<string, any> = {};
+        postData.params.forEach(({ name, fileName, value, contentType }) => {
+          if (fileName) {
+            files.push({
+              name,
+              type: contentType,
+              file: fileName,
+              data: value,
+            });
+            return;
+          }
+          if (value) {
+            fields[name] = value;
+          }
+        });
+
+        const field = Object.keys(fields).length ? convertType(fields, opts.indent) : 'null';
+        const formValue = files.length ? convertType(files, opts.indent) : 'null';
+
+        push('$body = new http\\Message\\Body;');
+        push(`$body->addForm(${field}, ${formValue});`);
+
+        // remove the contentType header
+        if (hasHeader(headersObj, 'content-type')) {
+          if (String(getHeader(headersObj, 'content-type')).indexOf('boundary')) {
+            const headerName = getHeaderName(headersObj, 'content-type');
+            if (headerName) {
+              delete headersObj[headerName];
+            }
+          }
+        }
+
+        blank();
+
+        hasBody = true;
+        break;
+      }
+
+      default:
+        if (postData.text) {
+          push('$body = new http\\Message\\Body;');
+          push(`$body->append(${convertType(postData.text)});`);
+          blank();
+          hasBody = true;
+        }
+    }
+
+    push(`$request->setRequestUrl(${convertType(url)});`);
+    push(`$request->setRequestMethod(${convertType(method)});`);
+
+    if (hasBody) {
+      push('$request->setBody($body);');
+      blank();
+    }
+
+    if (Object.keys(queryObj).length) {
+      push(`$request->setQuery(new http\\QueryString(${convertType(queryObj, opts.indent)}));`);
+      blank();
+    }
+
+    if (Object.keys(headersObj).length) {
+      push(`$request->setHeaders(${convertType(headersObj, opts.indent)});`);
+      blank();
+    }
+
+    if (Object.keys(cookiesObj).length) {
+      blank();
+      push(`$client->setCookies(${convertType(cookiesObj, opts.indent)});`);
+      blank();
+    }
+
+    push('$client->enqueue($request)->send();');
+    push('$response = $client->getResponse();');
+    blank();
+    push('echo $response->getBody();');
+
+    if (!opts.noTags && opts.closingTag) {
+      blank();
+      push('?>');
+    }
+
+    return join();
+  },
+};

package/src/targets/php/http2/fixtures/application-form-encoded.php

@@ -0,0 +1,23 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$body = new http\Message\Body;
+$body->append(new http\QueryString([
+  'foo' => 'bar',
+  'hello' => 'world'
+]));
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('POST');
+$request->setBody($body);
+
+$request->setHeaders([
+  'content-type' => 'application/x-www-form-urlencoded'
+]);
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/application-json.php

@@ -0,0 +1,20 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$body = new http\Message\Body;
+$body->append('{"number":1,"string":"f\\"oo","arr":[1,2,3],"nested":{"a":"b"},"arr_mix":[1,"a",{"arr_mix_nested":{}}],"boolean":false}');
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('POST');
+$request->setBody($body);
+
+$request->setHeaders([
+  'content-type' => 'application/json'
+]);
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/cookies.php

@@ -0,0 +1,17 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$request->setRequestUrl('https://httpbin.org/cookies');
+$request->setRequestMethod('GET');
+
+$client->setCookies([
+  'bar' => 'baz',
+  'foo' => 'bar'
+]);
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/custom-method.php

@@ -0,0 +1,11 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('PROPFIND');
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/full.php

@@ -0,0 +1,38 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$body = new http\Message\Body;
+$body->append(new http\QueryString([
+  'foo' => 'bar'
+]));
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('POST');
+$request->setBody($body);
+
+$request->setQuery(new http\QueryString([
+  'foo' => [
+    'bar',
+    'baz'
+  ],
+  'baz' => 'abc',
+  'key' => 'value'
+]));
+
+$request->setHeaders([
+  'accept' => 'application/json',
+  'content-type' => 'application/x-www-form-urlencoded'
+]);
+
+
+$client->setCookies([
+  'bar' => 'baz',
+  'foo' => 'bar'
+]);
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/headers.php

@@ -0,0 +1,17 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$request->setRequestUrl('https://httpbin.org/headers');
+$request->setRequestMethod('GET');
+$request->setHeaders([
+  'accept' => 'application/json',
+  'x-foo' => 'Bar',
+  'x-bar' => 'Foo'
+]);
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/http-insecure.php

@@ -0,0 +1,11 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$request->setRequestUrl('http://httpbin.org/anything');
+$request->setRequestMethod('GET');
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/jsonObj-multiline.php

@@ -0,0 +1,22 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$body = new http\Message\Body;
+$body->append('{
+  "foo": "bar"
+}');
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('POST');
+$request->setBody($body);
+
+$request->setHeaders([
+  'content-type' => 'application/json'
+]);
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/jsonObj-null-value.php

@@ -0,0 +1,20 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$body = new http\Message\Body;
+$body->append('{"foo":null}');
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('POST');
+$request->setBody($body);
+
+$request->setHeaders([
+  'content-type' => 'application/json'
+]);
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/multipart-data.php

@@ -0,0 +1,25 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$body = new http\Message\Body;
+$body->addForm([
+  'bar' => 'Bonjour le monde'
+], [
+  [
+    'name' => 'foo',
+    'type' => 'text/plain',
+    'file' => 'src/fixtures/files/hello.txt',
+    'data' => 'Hello World'
+  ]
+]);
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('POST');
+$request->setBody($body);
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/multipart-file.php

@@ -0,0 +1,23 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$body = new http\Message\Body;
+$body->addForm(null, [
+  [
+    'name' => 'foo',
+    'type' => 'text/plain',
+    'file' => 'src/fixtures/files/hello.txt',
+    'data' => null
+  ]
+]);
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('POST');
+$request->setBody($body);
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/multipart-form-data-no-params.php

@@ -0,0 +1,15 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('POST');
+$request->setHeaders([
+  'Content-Type' => 'multipart/form-data'
+]);
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/multipart-form-data.php

@@ -0,0 +1,18 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$body = new http\Message\Body;
+$body->addForm([
+  'foo' => 'bar'
+], null);
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('POST');
+$request->setBody($body);
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/nested.php

@@ -0,0 +1,17 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('GET');
+$request->setQuery(new http\QueryString([
+  'foo[bar]' => 'baz,zap',
+  'fiz' => 'buz',
+  'key' => 'value'
+]));
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/query-encoded.php

@@ -0,0 +1,16 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('GET');
+$request->setQuery(new http\QueryString([
+  'startTime' => '2019-06-13T19%3A08%3A25.455Z',
+  'endTime' => '2015-09-15T14%3A00%3A12-04%3A00'
+]));
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/query.php

@@ -0,0 +1,20 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('GET');
+$request->setQuery(new http\QueryString([
+  'foo' => [
+    'bar',
+    'baz'
+  ],
+  'baz' => 'abc',
+  'key' => 'value'
+]));
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/short.php

@@ -0,0 +1,11 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('GET');
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/http2/fixtures/text-plain.php

@@ -0,0 +1,20 @@
+<?php
+
+$client = new http\Client;
+$request = new http\Client\Request;
+
+$body = new http\Message\Body;
+$body->append('Hello World');
+
+$request->setRequestUrl('https://httpbin.org/anything');
+$request->setRequestMethod('POST');
+$request->setBody($body);
+
+$request->setHeaders([
+  'content-type' => 'text/plain'
+]);
+
+$client->enqueue($request)->send();
+$response = $client->getResponse();
+
+echo $response->getBody();

package/src/targets/php/target.ts

@@ -0,0 +1,21 @@
+import type { Target } from '../targets';
+import { curl } from './curl/client';
+import { guzzle } from './guzzle/client';
+import { http1 } from './http1/client';
+import { http2 } from './http2/client';
+
+export const php: Target = {
+  info: {
+    key: 'php',
+    title: 'PHP',
+    extname: '.php',
+    default: 'curl',
+    cli: 'php %s',
+  },
+  clientsById: {
+    curl,
+    guzzle,
+    http1,
+    http2,
+  },
+};

package/src/targets/powershell/common.ts

@@ -0,0 +1,58 @@
+import type { Converter } from '../targets';
+import { CodeBuilder } from '../../helpers/code-builder';
+import { getHeader } from '../../helpers/headers';
+
+export type PowershellCommand = 'Invoke-RestMethod' | 'Invoke-WebRequest';
+
+export const generatePowershellConvert = (command: PowershellCommand) => {
+  const convert: Converter<any> = ({ method, headersObj, cookies, uriObj, fullUrl, postData, allHeaders }) => {
+    const { push, join } = new CodeBuilder();
+    const methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'];
+
+    if (!methods.includes(method.toUpperCase())) {
+      return 'Method not supported';
+    }
+
+    const commandOptions = [];
+
+    // Add headers, including the cookies
+    const headers = Object.keys(headersObj);
+
+    // construct headers
+    if (headers.length) {
+      push('$headers=@{}');
+      headers.forEach(key => {
+        if (key !== 'connection') {
+          // Not allowed
+          push(`$headers.Add("${key}", "${headersObj[key]}")`);
+        }
+      });
+      commandOptions.push('-Headers $headers');
+    }
+
+    // construct cookies
+    if (cookies.length) {
+      push('$session = New-Object Microsoft.PowerShell.Commands.WebRequestSession');
+
+      cookies.forEach(cookie => {
+        push('$cookie = New-Object System.Net.Cookie');
+
+        push(`$cookie.Name = '${cookie.name}'`);
+        push(`$cookie.Value = '${cookie.value}'`);
+        push(`$cookie.Domain = '${uriObj.host}'`);
+
+        push('$session.Cookies.Add($cookie)');
+      });
+      commandOptions.push('-WebSession $session');
+    }
+
+    if (postData.text) {
+      commandOptions.push(`-ContentType '${getHeader(allHeaders, 'content-type')}'`);
+      commandOptions.push(`-Body '${postData.text}'`);
+    }
+
+    push(`$response = ${command} -Uri '${fullUrl}' -Method ${method} ${commandOptions.join(' ')}`.trim());
+    return join();
+  };
+  return convert;
+};

package/src/targets/powershell/restmethod/client.ts

@@ -0,0 +1,12 @@
+import type { Client } from '../../targets';
+import { generatePowershellConvert } from '../common';
+
+export const restmethod: Client = {
+  info: {
+    key: 'restmethod',
+    title: 'Invoke-RestMethod',
+    link: 'https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod',
+    description: 'Powershell Invoke-RestMethod client',
+  },
+  convert: generatePowershellConvert('Invoke-RestMethod'),
+};

package/src/targets/powershell/restmethod/fixtures/application-form-encoded.ps1

@@ -0,0 +1,3 @@
+$headers=@{}
+$headers.Add("content-type", "application/x-www-form-urlencoded")
+$response = Invoke-RestMethod -Uri 'https://httpbin.org/anything' -Method POST -Headers $headers -ContentType 'application/x-www-form-urlencoded' -Body 'foo=bar&hello=world'

package/src/targets/powershell/restmethod/fixtures/application-json.ps1

@@ -0,0 +1,3 @@
+$headers=@{}
+$headers.Add("content-type", "application/json")
+$response = Invoke-RestMethod -Uri 'https://httpbin.org/anything' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"number":1,"string":"f\"oo","arr":[1,2,3],"nested":{"a":"b"},"arr_mix":[1,"a",{"arr_mix_nested":{}}],"boolean":false}'

package/src/targets/powershell/restmethod/fixtures/cookies.ps1

@@ -0,0 +1,12 @@
+$session = New-Object Microsoft.PowerShell.Commands.WebRequestSession
+$cookie = New-Object System.Net.Cookie
+$cookie.Name = 'foo'
+$cookie.Value = 'bar'
+$cookie.Domain = 'httpbin.org'
+$session.Cookies.Add($cookie)
+$cookie = New-Object System.Net.Cookie
+$cookie.Name = 'bar'
+$cookie.Value = 'baz'
+$cookie.Domain = 'httpbin.org'
+$session.Cookies.Add($cookie)
+$response = Invoke-RestMethod -Uri 'https://httpbin.org/cookies' -Method GET -WebSession $session

package/src/targets/powershell/restmethod/fixtures/custom-method.ps1

@@ -0,0 +1 @@
+Method not supported