@readme/httpsnippet 3.1.2 → 4.0.1

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

@@ -0,0 +1,13 @@
+<?php
+require_once('vendor/autoload.php');
+
+$client = new \GuzzleHttp\Client();
+
+$response = $client->request('POST', 'https://httpbin.org/anything', [
+  'body' => '{"foo":null}',
+  'headers' => [
+    'content-type' => 'application/json',
+  ],
+]);
+
+echo $response->getBody();

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

@@ -0,0 +1,23 @@
+<?php
+require_once('vendor/autoload.php');
+
+$client = new \GuzzleHttp\Client();
+
+$response = $client->request('POST', 'https://httpbin.org/anything', [
+  'multipart' => [
+    [
+        'name' => 'foo',
+        'filename' => 'src/fixtures/files/hello.txt',
+        'contents' => 'Hello World',
+        'headers' => [
+                'Content-Type' => 'text/plain'
+        ]
+    ],
+    [
+        'name' => 'bar',
+        'contents' => 'Bonjour le monde'
+    ]
+  ]
+]);
+
+echo $response->getBody();

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

@@ -0,0 +1,19 @@
+<?php
+require_once('vendor/autoload.php');
+
+$client = new \GuzzleHttp\Client();
+
+$response = $client->request('POST', 'https://httpbin.org/anything', [
+  'multipart' => [
+    [
+        'name' => 'foo',
+        'filename' => 'src/fixtures/files/hello.txt',
+        'contents' => null,
+        'headers' => [
+                'Content-Type' => 'text/plain'
+        ]
+    ]
+  ]
+]);
+
+echo $response->getBody();

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

@@ -0,0 +1,12 @@
+<?php
+require_once('vendor/autoload.php');
+
+$client = new \GuzzleHttp\Client();
+
+$response = $client->request('POST', 'https://httpbin.org/anything', [
+  'headers' => [
+    'Content-Type' => 'multipart/form-data',
+  ],
+]);
+
+echo $response->getBody();

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

@@ -0,0 +1,15 @@
+<?php
+require_once('vendor/autoload.php');
+
+$client = new \GuzzleHttp\Client();
+
+$response = $client->request('POST', 'https://httpbin.org/anything', [
+  'multipart' => [
+    [
+        'name' => 'foo',
+        'contents' => 'bar'
+    ]
+  ]
+]);
+
+echo $response->getBody();

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

@@ -0,0 +1,8 @@
+<?php
+require_once('vendor/autoload.php');
+
+$client = new \GuzzleHttp\Client();
+
+$response = $client->request('GET', 'https://httpbin.org/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value');
+
+echo $response->getBody();

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

@@ -0,0 +1,8 @@
+<?php
+require_once('vendor/autoload.php');
+
+$client = new \GuzzleHttp\Client();
+
+$response = $client->request('GET', 'https://httpbin.org/anything?startTime=2019-06-13T19%3A08%3A25.455Z&endTime=2015-09-15T14%3A00%3A12-04%3A00');
+
+echo $response->getBody();

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

@@ -0,0 +1,8 @@
+<?php
+require_once('vendor/autoload.php');
+
+$client = new \GuzzleHttp\Client();
+
+$response = $client->request('GET', 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value');
+
+echo $response->getBody();

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

@@ -0,0 +1,8 @@
+<?php
+require_once('vendor/autoload.php');
+
+$client = new \GuzzleHttp\Client();
+
+$response = $client->request('GET', 'https://httpbin.org/anything');
+
+echo $response->getBody();

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

@@ -0,0 +1,13 @@
+<?php
+require_once('vendor/autoload.php');
+
+$client = new \GuzzleHttp\Client();
+
+$response = $client->request('POST', 'https://httpbin.org/anything', [
+  'body' => 'Hello World',
+  'headers' => [
+    'content-type' => 'text/plain',
+  ],
+]);
+
+echo $response->getBody();

package/src/targets/php/helpers.ts

@@ -0,0 +1,67 @@
+export const convertType = (obj: any[] | any, indent?: string, lastIndent?: string) => {
+  lastIndent = lastIndent || '';
+  indent = indent || '';
+
+  switch (Object.prototype.toString.call(obj)) {
+    case '[object Null]':
+      return 'null';
+
+    case '[object Undefined]':
+      return 'null';
+
+    case '[object String]':
+      return `'${obj.replace(/\\/g, '\\\\').replace(/'/g, "'")}'`;
+
+    case '[object Number]':
+      return obj.toString();
+
+    case '[object Array]': {
+      const contents = obj.map((item: any) => convertType(item, `${indent}${indent}`, indent)).join(`,\n${indent}`);
+      return `[\n${indent}${contents}\n${lastIndent}]`;
+    }
+
+    case '[object Object]': {
+      const result: string[] = [];
+      // eslint-disable-next-line no-restricted-syntax
+      for (const i in obj) {
+        if (Object.prototype.hasOwnProperty.call(obj, i)) {
+          result.push(`${convertType(i, indent)} => ${convertType(obj[i], `${indent}${indent}`, indent)}`);
+        }
+      }
+      return `[\n${indent}${result.join(`,\n${indent}`)}\n${lastIndent}]`;
+    }
+
+    default:
+      return 'null';
+  }
+};
+
+export const supportedMethods = [
+  'ACL',
+  'BASELINE_CONTROL',
+  'CHECKIN',
+  'CHECKOUT',
+  'CONNECT',
+  'COPY',
+  'DELETE',
+  'GET',
+  'HEAD',
+  'LABEL',
+  'LOCK',
+  'MERGE',
+  'MKACTIVITY',
+  'MKCOL',
+  'MKWORKSPACE',
+  'MOVE',
+  'OPTIONS',
+  'POST',
+  'PROPFIND',
+  'PROPPATCH',
+  'PUT',
+  'REPORT',
+  'TRACE',
+  'UNCHECKOUT',
+  'UNLOCK',
+  'UPDATE',
+  'VERSION_CONTROL',
+];

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

@@ -0,0 +1,103 @@
+/**
+ * @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 { convertType, supportedMethods } from '../helpers';
+
+export interface Http1Options {
+  closingTag?: boolean;
+  noTags?: boolean;
+  shortTags?: boolean;
+}
+
+export const http1: Client<Http1Options> = {
+  info: {
+    key: 'http1',
+    title: 'HTTP v1',
+    link: 'http://php.net/manual/en/book.http.php',
+    description: 'PHP with pecl/http v1',
+  },
+  convert: ({ method, url, postData, queryObj, headersObj, cookiesObj }, options) => {
+    const opts = {
+      closingTag: false,
+      indent: '  ',
+      noTags: false,
+      shortTags: false,
+      ...options,
+    };
+
+    const { push, blank, join } = new CodeBuilder({ indent: opts.indent });
+
+    if (!opts.noTags) {
+      push(opts.shortTags ? '<?' : '<?php');
+      blank();
+    }
+
+    if (!supportedMethods.includes(method.toUpperCase())) {
+      push(`HttpRequest::methodRegister('${method}');`);
+    }
+
+    push('$request = new HttpRequest();');
+    push(`$request->setUrl(${convertType(url)});`);
+
+    if (supportedMethods.includes(method.toUpperCase())) {
+      push(`$request->setMethod(HTTP_METH_${method.toUpperCase()});`);
+    } else {
+      push(`$request->setMethod(HttpRequest::HTTP_METH_${method.toUpperCase()});`);
+    }
+
+    blank();
+
+    if (Object.keys(queryObj).length) {
+      push(`$request->setQueryData(${convertType(queryObj, opts.indent)});`);
+      blank();
+    }
+
+    if (Object.keys(headersObj).length) {
+      push(`$request->setHeaders(${convertType(headersObj, opts.indent)});`);
+      blank();
+    }
+
+    if (Object.keys(cookiesObj).length) {
+      push(`$request->setCookies(${convertType(cookiesObj, opts.indent)});`);
+      blank();
+    }
+
+    switch (postData.mimeType) {
+      case 'application/x-www-form-urlencoded':
+        push(`$request->setContentType(${convertType(postData.mimeType)});`);
+        push(`$request->setPostFields(${convertType(postData.paramsObj, opts.indent)});`);
+        blank();
+        break;
+
+      default:
+        if (postData.text) {
+          push(`$request->setBody(${convertType(postData.text)});`);
+          blank();
+        }
+    }
+
+    push('try {');
+    push('$response = $request->send();', 1);
+    blank();
+    push('echo $response->getBody();', 1);
+    push('} catch (HttpException $ex) {');
+    push('echo $ex;', 1);
+    push('}');
+
+    if (!opts.noTags && opts.closingTag) {
+      blank();
+      push('?>');
+    }
+
+    return join();
+  },
+};

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

@@ -0,0 +1,23 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/anything');
+$request->setMethod(HTTP_METH_POST);
+
+$request->setHeaders([
+  'content-type' => 'application/x-www-form-urlencoded'
+]);
+
+$request->setContentType('application/x-www-form-urlencoded');
+$request->setPostFields([
+  'foo' => 'bar',
+  'hello' => 'world'
+]);
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}

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

@@ -0,0 +1,19 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/anything');
+$request->setMethod(HTTP_METH_POST);
+
+$request->setHeaders([
+  'content-type' => 'application/json'
+]);
+
+$request->setBody('{"number":1,"string":"f\\"oo","arr":[1,2,3],"nested":{"a":"b"},"arr_mix":[1,"a",{"arr_mix_nested":{}}],"boolean":false}');
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}

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

@@ -0,0 +1,18 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/cookies');
+$request->setMethod(HTTP_METH_GET);
+
+$request->setCookies([
+  'bar' => 'baz',
+  'foo' => 'bar'
+]);
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}

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

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

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

@@ -0,0 +1,37 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/anything');
+$request->setMethod(HTTP_METH_POST);
+
+$request->setQueryData([
+  'foo' => [
+    'bar',
+    'baz'
+  ],
+  'baz' => 'abc',
+  'key' => 'value'
+]);
+
+$request->setHeaders([
+  'accept' => 'application/json',
+  'content-type' => 'application/x-www-form-urlencoded'
+]);
+
+$request->setCookies([
+  'bar' => 'baz',
+  'foo' => 'bar'
+]);
+
+$request->setContentType('application/x-www-form-urlencoded');
+$request->setPostFields([
+  'foo' => 'bar'
+]);
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}

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

@@ -0,0 +1,19 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/headers');
+$request->setMethod(HTTP_METH_GET);
+
+$request->setHeaders([
+  'accept' => 'application/json',
+  'x-foo' => 'Bar',
+  'x-bar' => 'Foo'
+]);
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}

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

@@ -0,0 +1,13 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('http://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/jsonObj-multiline.php

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

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

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

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

@@ -0,0 +1,29 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/anything');
+$request->setMethod(HTTP_METH_POST);
+
+$request->setHeaders([
+  'content-type' => 'multipart/form-data; boundary=---011000010111000001101001'
+]);
+
+$request->setBody('-----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--
+');
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}

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

@@ -0,0 +1,25 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/anything');
+$request->setMethod(HTTP_METH_POST);
+
+$request->setHeaders([
+  'content-type' => 'multipart/form-data; boundary=---011000010111000001101001'
+]);
+
+$request->setBody('-----011000010111000001101001
+Content-Disposition: form-data; name="foo"; filename="hello.txt"
+Content-Type: text/plain
+
+
+-----011000010111000001101001--
+');
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}

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

@@ -0,0 +1,17 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/anything');
+$request->setMethod(HTTP_METH_POST);
+
+$request->setHeaders([
+  'Content-Type' => 'multipart/form-data'
+]);
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}

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

@@ -0,0 +1,24 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/anything');
+$request->setMethod(HTTP_METH_POST);
+
+$request->setHeaders([
+  'Content-Type' => 'multipart/form-data; boundary=---011000010111000001101001'
+]);
+
+$request->setBody('-----011000010111000001101001
+Content-Disposition: form-data; name="foo"
+
+bar
+-----011000010111000001101001--
+');
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}

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

@@ -0,0 +1,19 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/anything');
+$request->setMethod(HTTP_METH_GET);
+
+$request->setQueryData([
+  'foo[bar]' => 'baz,zap',
+  'fiz' => 'buz',
+  'key' => 'value'
+]);
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}

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

@@ -0,0 +1,18 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/anything');
+$request->setMethod(HTTP_METH_GET);
+
+$request->setQueryData([
+  'startTime' => '2019-06-13T19%3A08%3A25.455Z',
+  'endTime' => '2015-09-15T14%3A00%3A12-04%3A00'
+]);
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}

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

@@ -0,0 +1,22 @@
+<?php
+
+$request = new HttpRequest();
+$request->setUrl('https://httpbin.org/anything');
+$request->setMethod(HTTP_METH_GET);
+
+$request->setQueryData([
+  'foo' => [
+    'bar',
+    'baz'
+  ],
+  'baz' => 'abc',
+  'key' => 'value'
+]);
+
+try {
+  $response = $request->send();
+
+  echo $response->getBody();
+} catch (HttpException $ex) {
+  echo $ex;
+}