@readme/httpsnippet 3.1.1 → 4.0.0

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

@@ -0,0 +1,6 @@
+wget --quiet \
+  --method POST \
+  --header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
+  --body-data '-----011000010111000001101001\r\nContent-Disposition: form-data; name="foo"; filename="hello.txt"\r\nContent-Type: text/plain\r\n\r\nHello World\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name="bar"\r\n\r\nBonjour le monde\r\n-----011000010111000001101001--\r\n' \
+  --output-document \
+  - https://httpbin.org/anything

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

@@ -0,0 +1,6 @@
+wget --quiet \
+  --method POST \
+  --header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
+  --body-data '-----011000010111000001101001\r\nContent-Disposition: form-data; name="foo"; filename="hello.txt"\r\nContent-Type: text/plain\r\n\r\n\r\n-----011000010111000001101001--\r\n' \
+  --output-document \
+  - https://httpbin.org/anything

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

@@ -0,0 +1,5 @@
+wget --quiet \
+  --method POST \
+  --header 'Content-Type: multipart/form-data' \
+  --output-document \
+  - https://httpbin.org/anything

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

@@ -0,0 +1,6 @@
+wget --quiet \
+  --method POST \
+  --header 'Content-Type: multipart/form-data; boundary=---011000010111000001101001' \
+  --body-data '-----011000010111000001101001\r\nContent-Disposition: form-data; name="foo"\r\n\r\nbar\r\n-----011000010111000001101001--\r\n' \
+  --output-document \
+  - https://httpbin.org/anything

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

@@ -0,0 +1,4 @@
+wget --quiet \
+  --method GET \
+  --output-document \
+  - 'https://httpbin.org/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value'

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

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

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

@@ -0,0 +1,4 @@
+wget --quiet \
+  --method GET \
+  --output-document \
+  - 'https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value'

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

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

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

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

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

@@ -0,0 +1,6 @@
+wget --quiet \
+  --method POST \
+  --header 'content-type: text/plain' \
+  --body-data 'Hello World' \
+  --output-document \
+  - https://httpbin.org/anything

package/src/targets/shell/wget/fixtures/v-output.sh

@@ -0,0 +1 @@
+wget -v --method GET -O - https://httpbin.org/anything

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

@@ -0,0 +1 @@
+wget --verbose --method GET --output-document - https://httpbin.org/anything

package/src/targets/swift/helpers.ts

@@ -0,0 +1,86 @@
+/**
+ * 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
+ */
+const buildString = (length: number, str: string) => str.repeat(length);
+
+/**
+ * Create a string corresponding to a Dictionary or Array literal representation with pretty option and indentation.
+ */
+const concatArray = <T>(arr: T[], pretty: boolean, indentation: string, indentLevel: number) => {
+  const currentIndent = buildString(indentLevel, indentation);
+  const closingBraceIndent = buildString(indentLevel - 1, indentation);
+  const join = pretty ? `,\n${currentIndent}` : ', ';
+
+  if (pretty) {
+    return `[\n${currentIndent}${arr.join(join)}\n${closingBraceIndent}]`;
+  }
+  return `[${arr.join(join)}]`;
+};
+
+/**
+ * Create a string corresponding to a valid declaration and initialization of a Swift array or dictionary literal
+ *
+ * @param name Desired name of the instance
+ * @param parameters Key-value object of parameters to translate to a Swift object litearal
+ * @param opts Target options
+ * @return {string}
+ */
+export const literalDeclaration = <T, U>(name: string, parameters: T, opts: U) =>
+  `let ${name} = ${literalRepresentation(parameters, opts)}`;
+
+/**
+ * Create a valid Swift string of a literal value according to its type.
+ *
+ * @param value Any JavaScript literal
+ * @param opts Target options
+ */
+export const literalRepresentation = <T, U>(value: T, opts: U, indentLevel?: number): number | string => {
+  indentLevel = indentLevel === undefined ? 1 : indentLevel + 1;
+
+  switch (Object.prototype.toString.call(value)) {
+    case '[object Number]':
+      return value as unknown as number;
+
+    case '[object Array]': {
+      // Don't prettify arrays nto not take too much space
+      let pretty = false;
+      const valuesRepresentation = (value as unknown as any[]).map((v: any) => {
+        // 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);
+      });
+      // @ts-expect-error needs better types
+      return concatArray(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 concatArray(
+        keyValuePairs,
+        // @ts-expect-error needs better types
+        opts.pretty && keyValuePairs.length > 1,
+        // @ts-expect-error needs better types
+        opts.indent,
+        indentLevel
+      );
+    }
+
+    case '[object Boolean]':
+      return (value as unknown as boolean).toString();
+
+    default:
+      if (value === null || value === undefined) {
+        return '';
+      }
+      return `"${(value as any).toString().replace(/"/g, '\\"')}"`;
+  }
+};

package/src/targets/swift/nsurlsession/client.test.ts

@@ -0,0 +1,44 @@
+import type { Request } from '../../..';
+import full from '../../../fixtures/requests/full';
+import jsonNullValue from '../../../fixtures/requests/jsonObj-null-value';
+import short from '../../../fixtures/requests/short';
+import { runCustomFixtures } from '../../../fixtures/runCustomFixtures';
+
+runCustomFixtures({
+  targetId: 'swift',
+  clientId: 'nsurlsession',
+  tests: [
+    {
+      it: 'should support an indent option',
+      input: short.log.entries[0].request as Request,
+      options: {
+        indent: '    ',
+      },
+      expected: 'indent-option.swift',
+    },
+    {
+      it: 'should support a timeout option',
+      input: short.log.entries[0].request as Request,
+      options: {
+        timeout: 5,
+      },
+      expected: 'timeout-option.swift',
+    },
+    {
+      it: 'should support pretty option',
+      input: full.log.entries[0].request as Request,
+      options: {
+        pretty: false,
+      },
+      expected: 'pretty-option.swift',
+    },
+    {
+      it: 'should support json object with null value',
+      input: jsonNullValue.log.entries[0].request as unknown as Request,
+      options: {
+        pretty: false,
+      },
+      expected: 'json-null-value.swift',
+    },
+  ],
+});

package/src/targets/swift/nsurlsession/client.ts

@@ -0,0 +1,157 @@
+/**
+ * @description
+ * HTTP code snippet generator for Swift using NSURLSession.
+ *
+ * @author
+ * @thibaultCha
+ *
+ * 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 { literalDeclaration } from '../helpers';
+
+export interface NsurlsessionOptions {
+  pretty?: boolean;
+  timeout?: number | string;
+}
+
+export const nsurlsession: Client<NsurlsessionOptions> = {
+  info: {
+    key: 'nsurlsession',
+    title: 'NSURLSession',
+    link: 'https://developer.apple.com/library/mac/documentation/Foundation/Reference/NSURLSession_class/index.html',
+    description: "Foundation's NSURLSession request",
+  },
+  convert: ({ allHeaders, postData, fullUrl, method }, options) => {
+    const opts = {
+      indent: '  ',
+      pretty: true,
+      timeout: '10',
+      ...options,
+    };
+
+    const { push, blank, join } = new CodeBuilder({ indent: opts.indent });
+
+    // Markers for headers to be created as litteral objects and later be set on the NSURLRequest if exist
+    const req = {
+      hasHeaders: false,
+      hasBody: false,
+    };
+
+    // We just want to make sure people understand that is the only dependency
+    push('import Foundation');
+
+    if (Object.keys(allHeaders).length) {
+      req.hasHeaders = true;
+      blank();
+      push(literalDeclaration('headers', allHeaders, opts));
+    }
+
+    if (postData.text || postData.jsonObj || postData.params) {
+      req.hasBody = true;
+
+      switch (postData.mimeType) {
+        case 'application/x-www-form-urlencoded':
+          // By appending parameters one by one in the resulting snippet,
+          // we make it easier for the user to edit it according to his or her needs after pasting.
+          // The user can just add/remove lines adding/removing body parameters.
+          blank();
+          if (postData.params) {
+            const [head, ...tail] = postData.params;
+            push(`let postData = NSMutableData(data: "${head.name}=${head.value}".data(using: String.Encoding.utf8)!)`);
+            tail.forEach(({ name, value }) => {
+              push(`postData.append("&${name}=${value}".data(using: String.Encoding.utf8)!)`);
+            });
+          } else {
+            req.hasBody = false;
+          }
+          break;
+
+        case 'application/json':
+          if (postData.jsonObj) {
+            push(`${literalDeclaration('parameters', postData.jsonObj, opts)} as [String : Any]`);
+            blank();
+
+            push('let postData = JSONSerialization.data(withJSONObject: parameters, options: [])');
+          }
+          break;
+
+        case 'multipart/form-data':
+          /**
+           * By appending multipart parameters one by one in the resulting snippet,
+           * we make it easier for the user to edit it according to his or her needs after pasting.
+           * The user can just edit the parameters NSDictionary or put this part of a snippet in a multipart builder method.
+           */
+
+          push(literalDeclaration('parameters', postData.params, opts));
+          blank();
+          push(`let boundary = "${postData.boundary}"`);
+          blank();
+          push('var body = ""');
+          push('var error: NSError? = nil');
+          push('for param in parameters {');
+          push('let paramName = param["name"]!', 1);
+          push('body += "--\\(boundary)\\r\\n"', 1);
+          push('body += "Content-Disposition:form-data; name=\\"\\(paramName)\\""', 1);
+          push('if let filename = param["fileName"] {', 1);
+          push('let contentType = param["content-type"]!', 2);
+          push('let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)', 2);
+          push('if (error != nil) {', 2);
+          push('print(error as Any)', 3);
+          push('}', 2);
+          push('body += "; filename=\\"\\(filename)\\"\\r\\n"', 2);
+          push('body += "Content-Type: \\(contentType)\\r\\n\\r\\n"', 2);
+          push('body += fileContent', 2);
+          push('} else if let paramValue = param["value"] {', 1);
+          push('body += "\\r\\n\\r\\n\\(paramValue)"', 2);
+          push('}', 1);
+          push('}');
+          break;
+
+        default:
+          blank();
+          push(`let postData = NSData(data: "${postData.text}".data(using: String.Encoding.utf8)!)`);
+      }
+    }
+
+    blank();
+
+    // NSURLRequestUseProtocolCachePolicy is the default policy, let's just always set it to avoid confusion.
+    push(`let request = NSMutableURLRequest(url: NSURL(string: "${fullUrl}")! as URL,`);
+    push('                                        cachePolicy: .useProtocolCachePolicy,');
+    push(
+      // @ts-expect-error needs better types
+      `                                    timeoutInterval: ${parseInt(opts.timeout, 10).toFixed(1)})`
+    );
+    push(`request.httpMethod = "${method}"`);
+
+    if (req.hasHeaders) {
+      push('request.allHTTPHeaderFields = headers');
+    }
+
+    if (req.hasBody) {
+      push('request.httpBody = postData as Data');
+    }
+
+    blank();
+    // Retrieving the shared session will be less verbose than creating a new one.
+
+    push('let session = URLSession.shared');
+    push(
+      'let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in'
+    );
+    push('if (error != nil) {', 1);
+    push('print(error as Any)', 2);
+    push('} else {', 1); // Casting the NSURLResponse to NSHTTPURLResponse so the user can see the status     .
+    push('let httpResponse = response as? HTTPURLResponse', 2);
+    push('print(httpResponse)', 2);
+    push('}', 1);
+    push('})');
+    blank();
+    push('dataTask.resume()');
+
+    return join();
+  },
+};

package/src/targets/swift/nsurlsession/fixtures/application-form-encoded.swift

@@ -0,0 +1,25 @@
+import Foundation
+
+let headers = ["content-type": "application/x-www-form-urlencoded"]
+
+let postData = NSMutableData(data: "foo=bar".data(using: String.Encoding.utf8)!)
+postData.append("&hello=world".data(using: String.Encoding.utf8)!)
+
+let request = NSMutableURLRequest(url: NSURL(string: "https://httpbin.org/anything")! as URL,
+                                        cachePolicy: .useProtocolCachePolicy,
+                                    timeoutInterval: 10.0)
+request.httpMethod = "POST"
+request.allHTTPHeaderFields = headers
+request.httpBody = postData as Data
+
+let session = URLSession.shared
+let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
+  if (error != nil) {
+    print(error as Any)
+  } else {
+    let httpResponse = response as? HTTPURLResponse
+    print(httpResponse)
+  }
+})
+
+dataTask.resume()

package/src/targets/swift/nsurlsession/fixtures/application-json.swift

@@ -0,0 +1,32 @@
+import Foundation
+
+let headers = ["content-type": "application/json"]
+let parameters = [
+  "number": 1,
+  "string": "f\"oo",
+  "arr": [1, 2, 3],
+  "nested": ["a": "b"],
+  "arr_mix": [1, "a", ["arr_mix_nested": []]],
+  "boolean": false
+] as [String : Any]
+
+let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
+
+let request = NSMutableURLRequest(url: NSURL(string: "https://httpbin.org/anything")! as URL,
+                                        cachePolicy: .useProtocolCachePolicy,
+                                    timeoutInterval: 10.0)
+request.httpMethod = "POST"
+request.allHTTPHeaderFields = headers
+request.httpBody = postData as Data
+
+let session = URLSession.shared
+let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
+  if (error != nil) {
+    print(error as Any)
+  } else {
+    let httpResponse = response as? HTTPURLResponse
+    print(httpResponse)
+  }
+})
+
+dataTask.resume()

package/src/targets/swift/nsurlsession/fixtures/cookies.swift

@@ -0,0 +1,21 @@
+import Foundation
+
+let headers = ["cookie": "foo=bar; bar=baz"]
+
+let request = NSMutableURLRequest(url: NSURL(string: "https://httpbin.org/cookies")! as URL,
+                                        cachePolicy: .useProtocolCachePolicy,
+                                    timeoutInterval: 10.0)
+request.httpMethod = "GET"
+request.allHTTPHeaderFields = headers
+
+let session = URLSession.shared
+let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
+  if (error != nil) {
+    print(error as Any)
+  } else {
+    let httpResponse = response as? HTTPURLResponse
+    print(httpResponse)
+  }
+})
+
+dataTask.resume()

package/src/targets/swift/nsurlsession/fixtures/custom-method.swift

@@ -0,0 +1,18 @@
+import Foundation
+
+let request = NSMutableURLRequest(url: NSURL(string: "https://httpbin.org/anything")! as URL,
+                                        cachePolicy: .useProtocolCachePolicy,
+                                    timeoutInterval: 10.0)
+request.httpMethod = "PROPFIND"
+
+let session = URLSession.shared
+let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
+  if (error != nil) {
+    print(error as Any)
+  } else {
+    let httpResponse = response as? HTTPURLResponse
+    print(httpResponse)
+  }
+})
+
+dataTask.resume()

package/src/targets/swift/nsurlsession/fixtures/full.swift

@@ -0,0 +1,28 @@
+import Foundation
+
+let headers = [
+  "cookie": "foo=bar; bar=baz",
+  "accept": "application/json",
+  "content-type": "application/x-www-form-urlencoded"
+]
+
+let postData = NSMutableData(data: "foo=bar".data(using: String.Encoding.utf8)!)
+
+let request = NSMutableURLRequest(url: NSURL(string: "https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value")! as URL,
+                                        cachePolicy: .useProtocolCachePolicy,
+                                    timeoutInterval: 10.0)
+request.httpMethod = "POST"
+request.allHTTPHeaderFields = headers
+request.httpBody = postData as Data
+
+let session = URLSession.shared
+let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
+  if (error != nil) {
+    print(error as Any)
+  } else {
+    let httpResponse = response as? HTTPURLResponse
+    print(httpResponse)
+  }
+})
+
+dataTask.resume()

package/src/targets/swift/nsurlsession/fixtures/headers.swift

@@ -0,0 +1,25 @@
+import Foundation
+
+let headers = [
+  "accept": "application/json",
+  "x-foo": "Bar",
+  "x-bar": "Foo"
+]
+
+let request = NSMutableURLRequest(url: NSURL(string: "https://httpbin.org/headers")! as URL,
+                                        cachePolicy: .useProtocolCachePolicy,
+                                    timeoutInterval: 10.0)
+request.httpMethod = "GET"
+request.allHTTPHeaderFields = headers
+
+let session = URLSession.shared
+let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
+  if (error != nil) {
+    print(error as Any)
+  } else {
+    let httpResponse = response as? HTTPURLResponse
+    print(httpResponse)
+  }
+})
+
+dataTask.resume()

package/src/targets/swift/nsurlsession/fixtures/http-insecure.swift

@@ -0,0 +1,18 @@
+import Foundation
+
+let request = NSMutableURLRequest(url: NSURL(string: "http://httpbin.org/anything")! as URL,
+                                        cachePolicy: .useProtocolCachePolicy,
+                                    timeoutInterval: 10.0)
+request.httpMethod = "GET"
+
+let session = URLSession.shared
+let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
+  if (error != nil) {
+    print(error as Any)
+  } else {
+    let httpResponse = response as? HTTPURLResponse
+    print(httpResponse)
+  }
+})
+
+dataTask.resume()

package/src/targets/swift/nsurlsession/fixtures/indent-option.swift

@@ -0,0 +1,18 @@
+import Foundation
+
+let request = NSMutableURLRequest(url: NSURL(string: "https://httpbin.org/anything")! as URL,
+                                        cachePolicy: .useProtocolCachePolicy,
+                                    timeoutInterval: 10.0)
+request.httpMethod = "GET"
+
+let session = URLSession.shared
+let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
+    if (error != nil) {
+        print(error as Any)
+    } else {
+        let httpResponse = response as? HTTPURLResponse
+        print(httpResponse)
+    }
+})
+
+dataTask.resume()

package/src/targets/swift/nsurlsession/fixtures/json-null-value.swift

@@ -0,0 +1,25 @@
+import Foundation
+
+let headers = ["content-type": "application/json"]
+let parameters = ["foo": ] as [String : Any]
+
+let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
+
+let request = NSMutableURLRequest(url: NSURL(string: "https://httpbin.org/anything")! as URL,
+                                        cachePolicy: .useProtocolCachePolicy,
+                                    timeoutInterval: 10.0)
+request.httpMethod = "POST"
+request.allHTTPHeaderFields = headers
+request.httpBody = postData as Data
+
+let session = URLSession.shared
+let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
+  if (error != nil) {
+    print(error as Any)
+  } else {
+    let httpResponse = response as? HTTPURLResponse
+    print(httpResponse)
+  }
+})
+
+dataTask.resume()

package/src/targets/swift/nsurlsession/fixtures/jsonObj-multiline.swift

@@ -0,0 +1,25 @@
+import Foundation
+
+let headers = ["content-type": "application/json"]
+let parameters = ["foo": "bar"] as [String : Any]
+
+let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
+
+let request = NSMutableURLRequest(url: NSURL(string: "https://httpbin.org/anything")! as URL,
+                                        cachePolicy: .useProtocolCachePolicy,
+                                    timeoutInterval: 10.0)
+request.httpMethod = "POST"
+request.allHTTPHeaderFields = headers
+request.httpBody = postData as Data
+
+let session = URLSession.shared
+let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
+  if (error != nil) {
+    print(error as Any)
+  } else {
+    let httpResponse = response as? HTTPURLResponse
+    print(httpResponse)
+  }
+})
+
+dataTask.resume()

package/src/targets/swift/nsurlsession/fixtures/jsonObj-null-value.swift

@@ -0,0 +1,25 @@
+import Foundation
+
+let headers = ["content-type": "application/json"]
+let parameters = ["foo": ] as [String : Any]
+
+let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
+
+let request = NSMutableURLRequest(url: NSURL(string: "https://httpbin.org/anything")! as URL,
+                                        cachePolicy: .useProtocolCachePolicy,
+                                    timeoutInterval: 10.0)
+request.httpMethod = "POST"
+request.allHTTPHeaderFields = headers
+request.httpBody = postData as Data
+
+let session = URLSession.shared
+let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
+  if (error != nil) {
+    print(error as Any)
+  } else {
+    let httpResponse = response as? HTTPURLResponse
+    print(httpResponse)
+  }
+})
+
+dataTask.resume()