@scalar/snippetz 0.7.4 → 0.7.6

package/dist/httpsnippet-lite/targets/python/python3/client.js

@@ -1,71 +1,88 @@
-import { CodeBuilder } from "../../../../httpsnippet-lite/helpers/code-builder.js";
-import { escapeForDoubleQuotes } from "../../../../httpsnippet-lite/helpers/escape.js";
-const python3 = {
-  info: {
-    key: "python3",
-    title: "http.client",
-    link: "https://docs.python.org/3/library/http.client.html",
-    description: "Python3 HTTP Client"
-  },
-  convert: ({ uriObj: { path, protocol, host }, postData, allHeaders, method }, options = {}) => {
-    const { insecureSkipVerify = false } = options;
-    const { push, blank, join } = new CodeBuilder();
-    push("import http.client");
-    if (insecureSkipVerify) {
-      push("import ssl");
-    }
-    blank();
-    if (protocol === "https:") {
-      const sslContext = insecureSkipVerify ? ", context = ssl._create_unverified_context()" : "";
-      push(`conn = http.client.HTTPSConnection("${host}"${sslContext})`);
-      blank();
-    } else {
-      push(`conn = http.client.HTTPConnection("${host}")`);
-      blank();
-    }
-    const payload = JSON.stringify(postData === null || postData === void 0 ? void 0 : postData.text);
-    if (payload) {
-      push(`payload = ${payload}`);
-      blank();
-    }
-    const headers = allHeaders;
-    const headerCount = Object.keys(headers).length;
-    if (headerCount === 1) {
-      for (const header in headers) {
-        push(`headers = { '${header}': "${escapeForDoubleQuotes(headers[header])}" }`);
+/**
+ * @description
+ * HTTP code snippet generator for native Python3.
+ *
+ * @author
+ * @montanaflynn
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import { CodeBuilder } from '../../../../httpsnippet-lite/helpers/code-builder.js';
+import { escapeForDoubleQuotes } from '../../../../httpsnippet-lite/helpers/escape.js';
+export const python3 = {
+    info: {
+        key: 'python3',
+        title: 'http.client',
+        link: 'https://docs.python.org/3/library/http.client.html',
+        description: 'Python3 HTTP Client',
+    },
+    convert: ({ uriObj: { path, protocol, host }, postData, allHeaders, method }, options = {}) => {
+        const { insecureSkipVerify = false } = options;
+        const { push, blank, join } = new CodeBuilder();
+        // Start Request
+        push('import http.client');
+        if (insecureSkipVerify) {
+            push('import ssl');
+        }
         blank();
-      }
-    } else if (headerCount > 1) {
-      let count = 1;
-      push("headers = {");
-      for (const header in headers) {
-        if (count++ !== headerCount) {
-          push(`    '${header}': "${escapeForDoubleQuotes(headers[header])}",`);
-        } else {
-          push(`    '${header}': "${escapeForDoubleQuotes(headers[header])}"`);
+        // Check which protocol to be used for the client connection
+        if (protocol === 'https:') {
+            const sslContext = insecureSkipVerify ? ', context = ssl._create_unverified_context()' : '';
+            push(`conn = http.client.HTTPSConnection("${host}"${sslContext})`);
+            blank();
         }
-      }
-      push("}");
-      blank();
-    }
-    if (payload && headerCount) {
-      push(`conn.request("${method}", "${path}", payload, headers)`);
-    } else if (payload && !headerCount) {
-      push(`conn.request("${method}", "${path}", payload)`);
-    } else if (!payload && headerCount) {
-      push(`conn.request("${method}", "${path}", headers=headers)`);
-    } else {
-      push(`conn.request("${method}", "${path}")`);
-    }
-    blank();
-    push("res = conn.getresponse()");
-    push("data = res.read()");
-    blank();
-    push('print(data.decode("utf-8"))');
-    return join();
-  }
-};
-export {
-  python3
+        else {
+            push(`conn = http.client.HTTPConnection("${host}")`);
+            blank();
+        }
+        // Create payload string if it exists
+        const payload = JSON.stringify(postData === null || postData === void 0 ? void 0 : postData.text);
+        if (payload) {
+            push(`payload = ${payload}`);
+            blank();
+        }
+        // Create Headers
+        const headers = allHeaders;
+        const headerCount = Object.keys(headers).length;
+        if (headerCount === 1) {
+            for (const header in headers) {
+                push(`headers = { '${header}': "${escapeForDoubleQuotes(headers[header])}" }`);
+                blank();
+            }
+        }
+        else if (headerCount > 1) {
+            let count = 1;
+            push('headers = {');
+            for (const header in headers) {
+                if (count++ !== headerCount) {
+                    push(`    '${header}': "${escapeForDoubleQuotes(headers[header])}",`);
+                }
+                else {
+                    push(`    '${header}': "${escapeForDoubleQuotes(headers[header])}"`);
+                }
+            }
+            push('}');
+            blank();
+        }
+        // Make Request
+        if (payload && headerCount) {
+            push(`conn.request("${method}", "${path}", payload, headers)`);
+        }
+        else if (payload && !headerCount) {
+            push(`conn.request("${method}", "${path}", payload)`);
+        }
+        else if (!payload && headerCount) {
+            push(`conn.request("${method}", "${path}", headers=headers)`);
+        }
+        else {
+            push(`conn.request("${method}", "${path}")`);
+        }
+        // Get Response
+        blank();
+        push('res = conn.getresponse()');
+        push('data = res.read()');
+        blank();
+        push('print(data.decode("utf-8"))');
+        return join();
+    },
 };
-//# sourceMappingURL=client.js.map

package/dist/httpsnippet-lite/targets/r/httr/client.js

@@ -1,96 +1,115 @@
-import { CodeBuilder } from "../../../../httpsnippet-lite/helpers/code-builder.js";
-import { escapeForDoubleQuotes, escapeForSingleQuotes } from "../../../../httpsnippet-lite/helpers/escape.js";
-import { getHeader } from "../../../../httpsnippet-lite/helpers/headers.js";
-const httr = {
-  info: {
-    key: "httr",
-    title: "httr",
-    link: "https://cran.r-project.org/web/packages/httr/vignettes/quickstart.html",
-    description: "httr: Tools for Working with URLs and HTTP"
-  },
-  convert: ({ url, queryObj, queryString, postData, allHeaders, method }, options = {}) => {
-    let _a, _b;
-    const { push, blank, join } = new CodeBuilder({
-      indent: (_a = options.indent) !== null && _a !== void 0 ? _a : "  "
-    });
-    push("library(httr)");
-    blank();
-    push(`url <- "${url}"`);
-    blank();
-    const qs = queryObj;
-    delete queryObj.key;
-    const entries = Object.entries(qs).flatMap(
-      ([key, value]) => Array.isArray(value) ? value.map((item) => [key, item]) : [[key, value]]
-    );
-    const entriesCount = entries.length;
-    if (entriesCount === 1) {
-      const entry = entries[0];
-      push(`queryString <- list(${entry[0]} = "${entry[1]}")`);
-      blank();
-    } else if (entriesCount > 1) {
-      push("queryString <- list(");
-      entries.forEach(([key, value], i) => {
-        const isLastItem = i !== entriesCount - 1;
-        const maybeComma = isLastItem ? "," : "";
-        push(`${key} = "${value}"${maybeComma}`, 1);
-      });
-      push(")");
-      blank();
-    }
-    const payload = JSON.stringify(postData === null || postData === void 0 ? void 0 : postData.text);
-    if (payload) {
-      push(`payload <- ${payload}`);
-      blank();
-    }
-    if (postData && (postData.text || postData.jsonObj || postData.params)) {
-      switch (postData.mimeType) {
-        case "application/x-www-form-urlencoded":
-          push('encode <- "form"');
-          blank();
-          break;
-        case "application/json":
-          push('encode <- "json"');
-          blank();
-          break;
-        case "multipart/form-data":
-          push('encode <- "multipart"');
-          blank();
-          break;
-        default:
-          push('encode <- "raw"');
-          blank();
-          break;
-      }
-    }
-    const cookieHeader = getHeader(allHeaders, "cookie");
-    const acceptHeader = getHeader(allHeaders, "accept");
-    const setCookies = cookieHeader ? `set_cookies(\`${String(cookieHeader).replace(/;/g, '", `').replace(/` /g, "`").replace(/[=]/g, '` = "')}")` : void 0;
-    const setAccept = acceptHeader ? `accept("${escapeForDoubleQuotes(acceptHeader)}")` : void 0;
-    const setContentType = `content_type("${escapeForDoubleQuotes((_b = postData === null || postData === void 0 ? void 0 : postData.mimeType) !== null && _b !== void 0 ? _b : "application/octet-stream")}")`;
-    const otherHeaders = Object.entries(allHeaders).filter(([key]) => !["cookie", "accept", "content-type"].includes(key.toLowerCase())).map(([key, value]) => `'${key}' = '${escapeForSingleQuotes(value)}'`).join(", ");
-    const setHeaders = otherHeaders ? `add_headers(${otherHeaders})` : void 0;
-    let request = `response <- VERB("${method}", url`;
-    if (payload) {
-      request += ", body = payload";
-    }
-    if (queryString.length) {
-      request += ", query = queryString";
-    }
-    const headerAdditions = [setHeaders, setContentType, setAccept, setCookies].filter((x) => !!x).join(", ");
-    if (headerAdditions) {
-      request += `, ${headerAdditions}`;
-    }
-    if (postData && (postData.text || postData.jsonObj || postData.params)) {
-      request += ", encode = encode";
-    }
-    request += ")";
-    push(request);
-    blank();
-    push('content(response, "text")');
-    return join();
-  }
+/**
+ * @description
+ * HTTP code snippet generator for R using httr
+ *
+ * @author
+ * @gabrielakoreeda
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import { CodeBuilder } from '../../../../httpsnippet-lite/helpers/code-builder.js';
+import { escapeForDoubleQuotes, escapeForSingleQuotes } from '../../../../httpsnippet-lite/helpers/escape.js';
+import { getHeader } from '../../../../httpsnippet-lite/helpers/headers.js';
+export const httr = {
+    info: {
+        key: 'httr',
+        title: 'httr',
+        link: 'https://cran.r-project.org/web/packages/httr/vignettes/quickstart.html',
+        description: 'httr: Tools for Working with URLs and HTTP',
+    },
+    convert: ({ url, queryObj, queryString, postData, allHeaders, method }, options = {}) => {
+        let _a, _b;
+        // Start snippet
+        const { push, blank, join } = new CodeBuilder({
+            indent: (_a = options.indent) !== null && _a !== void 0 ? _a : '  ',
+        });
+        // Import httr
+        push('library(httr)');
+        blank();
+        // Set URL
+        push(`url <- "${url}"`);
+        blank();
+        // Construct query string
+        const qs = queryObj;
+        delete queryObj.key;
+        const entries = Object.entries(qs).flatMap(([key, value]) => Array.isArray(value) ? value.map((item) => [key, item]) : [[key, value]]);
+        const entriesCount = entries.length;
+        if (entriesCount === 1) {
+            const entry = entries[0];
+            push(`queryString <- list(${entry[0]} = "${entry[1]}")`);
+            blank();
+        }
+        else if (entriesCount > 1) {
+            push('queryString <- list(');
+            entries.forEach(([key, value], i) => {
+                const isLastItem = i !== entriesCount - 1;
+                const maybeComma = isLastItem ? ',' : '';
+                push(`${key} = "${value}"${maybeComma}`, 1);
+            });
+            push(')');
+            blank();
+        }
+        // Construct payload
+        const payload = JSON.stringify(postData === null || postData === void 0 ? void 0 : postData.text);
+        if (payload) {
+            push(`payload <- ${payload}`);
+            blank();
+        }
+        // Define encode
+        if (postData && (postData.text || postData.jsonObj || postData.params)) {
+            switch (postData.mimeType) {
+                case 'application/x-www-form-urlencoded':
+                    push('encode <- "form"');
+                    blank();
+                    break;
+                case 'application/json':
+                    push('encode <- "json"');
+                    blank();
+                    break;
+                case 'multipart/form-data':
+                    push('encode <- "multipart"');
+                    blank();
+                    break;
+                default:
+                    push('encode <- "raw"');
+                    blank();
+                    break;
+            }
+        }
+        // Construct headers
+        const cookieHeader = getHeader(allHeaders, 'cookie');
+        const acceptHeader = getHeader(allHeaders, 'accept');
+        const setCookies = cookieHeader
+            ? `set_cookies(\`${String(cookieHeader).replace(/;/g, '", `').replace(/` /g, '`').replace(/[=]/g, '` = "')}")`
+            : undefined;
+        const setAccept = acceptHeader ? `accept("${escapeForDoubleQuotes(acceptHeader)}")` : undefined;
+        const setContentType = `content_type("${escapeForDoubleQuotes((_b = postData === null || postData === void 0 ? void 0 : postData.mimeType) !== null && _b !== void 0 ? _b : 'application/octet-stream')}")`;
+        const otherHeaders = Object.entries(allHeaders)
+            // These headers are all handled separately:
+            .filter(([key]) => !['cookie', 'accept', 'content-type'].includes(key.toLowerCase()))
+            .map(([key, value]) => `'${key}' = '${escapeForSingleQuotes(value)}'`)
+            .join(', ');
+        const setHeaders = otherHeaders ? `add_headers(${otherHeaders})` : undefined;
+        // Construct request
+        let request = `response <- VERB("${method}", url`;
+        if (payload) {
+            request += ', body = payload';
+        }
+        if (queryString.length) {
+            request += ', query = queryString';
+        }
+        const headerAdditions = [setHeaders, setContentType, setAccept, setCookies].filter((x) => !!x).join(', ');
+        if (headerAdditions) {
+            request += `, ${headerAdditions}`;
+        }
+        if (postData && (postData.text || postData.jsonObj || postData.params)) {
+            request += ', encode = encode';
+        }
+        request += ')';
+        push(request);
+        blank();
+        // Print response
+        push('content(response, "text")');
+        return join();
+    },
 };
-export {
-  httr
-};
-//# sourceMappingURL=client.js.map

package/dist/httpsnippet-lite/targets/ruby/native/client.js

@@ -1,71 +1,67 @@
-import { CodeBuilder } from "../../../../httpsnippet-lite/helpers/code-builder.js";
-import { escapeForSingleQuotes } from "../../../../httpsnippet-lite/helpers/escape.js";
-const native = {
-  info: {
-    key: "native",
-    title: "net::http",
-    link: "http://ruby-doc.org/stdlib-2.2.1/libdoc/net/http/rdoc/Net/HTTP.html",
-    description: "Ruby HTTP client"
-  },
-  convert: ({ uriObj, method: rawMethod, fullUrl, postData, allHeaders }, options = {}) => {
-    const { insecureSkipVerify = false } = options;
-    const { push, blank, join } = new CodeBuilder();
-    push("require 'uri'");
-    push("require 'net/http'");
-    blank();
-    const method = rawMethod.toUpperCase();
-    const methods = [
-      "GET",
-      "POST",
-      "HEAD",
-      "DELETE",
-      "PATCH",
-      "PUT",
-      "OPTIONS",
-      "COPY",
-      "LOCK",
-      "UNLOCK",
-      "MOVE",
-      "TRACE"
-    ];
-    const capMethod = method.charAt(0) + method.substring(1).toLowerCase();
-    if (!methods.includes(method)) {
-      push(`class Net::HTTP::${capMethod} < Net::HTTPRequest`);
-      push(`  METHOD = '${method.toUpperCase()}'`);
-      push(
-        `  REQUEST_HAS_BODY = '${(postData === null || postData === void 0 ? void 0 : postData.text) ? "true" : "false"}'`
-      );
-      push("  RESPONSE_HAS_BODY = true");
-      push("end");
-      blank();
-    }
-    push(`url = URI("${fullUrl}")`);
-    blank();
-    push("http = Net::HTTP.new(url.host, url.port)");
-    if (uriObj.protocol === "https:") {
-      push("http.use_ssl = true");
-      if (insecureSkipVerify) {
-        push("http.verify_mode = OpenSSL::SSL::VERIFY_NONE");
-      }
-    }
-    blank();
-    push(`request = Net::HTTP::${capMethod}.new(url)`);
-    const headers = Object.keys(allHeaders);
-    if (headers.length) {
-      headers.forEach((key) => {
-        push(`request["${key}"] = '${escapeForSingleQuotes(allHeaders[key])}'`);
-      });
-    }
-    if (postData === null || postData === void 0 ? void 0 : postData.text) {
-      push(`request.body = ${JSON.stringify(postData.text)}`);
-    }
-    blank();
-    push("response = http.request(request)");
-    push("puts response.read_body");
-    return join();
-  }
+import { CodeBuilder } from '../../../../httpsnippet-lite/helpers/code-builder.js';
+import { escapeForSingleQuotes } from '../../../../httpsnippet-lite/helpers/escape.js';
+export const native = {
+    info: {
+        key: 'native',
+        title: 'net::http',
+        link: 'http://ruby-doc.org/stdlib-2.2.1/libdoc/net/http/rdoc/Net/HTTP.html',
+        description: 'Ruby HTTP client',
+    },
+    convert: ({ uriObj, method: rawMethod, fullUrl, postData, allHeaders }, options = {}) => {
+        const { insecureSkipVerify = false } = options;
+        const { push, blank, join } = new CodeBuilder();
+        push("require 'uri'");
+        push("require 'net/http'");
+        blank();
+        // To support custom methods we check for the supported methods
+        // and if doesn't exist then we build a custom class for it
+        const method = rawMethod.toUpperCase();
+        const methods = [
+            'GET',
+            'POST',
+            'HEAD',
+            'DELETE',
+            'PATCH',
+            'PUT',
+            'OPTIONS',
+            'COPY',
+            'LOCK',
+            'UNLOCK',
+            'MOVE',
+            'TRACE',
+        ];
+        const capMethod = method.charAt(0) + method.substring(1).toLowerCase();
+        if (!methods.includes(method)) {
+            push(`class Net::HTTP::${capMethod} < Net::HTTPRequest`);
+            push(`  METHOD = '${method.toUpperCase()}'`);
+            push(`  REQUEST_HAS_BODY = '${(postData === null || postData === void 0 ? void 0 : postData.text) ? 'true' : 'false'}'`);
+            push('  RESPONSE_HAS_BODY = true');
+            push('end');
+            blank();
+        }
+        push(`url = URI("${fullUrl}")`);
+        blank();
+        push('http = Net::HTTP.new(url.host, url.port)');
+        if (uriObj.protocol === 'https:') {
+            push('http.use_ssl = true');
+            if (insecureSkipVerify) {
+                push('http.verify_mode = OpenSSL::SSL::VERIFY_NONE');
+            }
+        }
+        blank();
+        push(`request = Net::HTTP::${capMethod}.new(url)`);
+        const headers = Object.keys(allHeaders);
+        if (headers.length) {
+            headers.forEach((key) => {
+                push(`request["${key}"] = '${escapeForSingleQuotes(allHeaders[key])}'`);
+            });
+        }
+        if (postData === null || postData === void 0 ? void 0 : postData.text) {
+            push(`request.body = ${JSON.stringify(postData.text)}`);
+        }
+        blank();
+        push('response = http.request(request)');
+        push('puts response.read_body');
+        return join();
+    },
 };
-export {
-  native
-};
-//# sourceMappingURL=client.js.map