@readme/httpsnippet 3.1.3 → 4.0.2

package/dist/src/targets/php/http2/client.js

@@ -0,0 +1,128 @@
+"use strict";
+/**
+ * @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.
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+exports.__esModule = true;
+exports.http2 = void 0;
+var code_builder_1 = require("../../../helpers/code-builder");
+var headers_1 = require("../../../helpers/headers");
+var helpers_1 = require("../helpers");
+exports.http2 = {
+    info: {
+        key: 'http2',
+        title: 'HTTP v2',
+        link: 'http://devel-m6w6.rhcloud.com/mdref/http',
+        description: 'PHP with pecl/http v2'
+    },
+    convert: function (_a, options) {
+        var postData = _a.postData, headersObj = _a.headersObj, method = _a.method, queryObj = _a.queryObj, cookiesObj = _a.cookiesObj, url = _a.url;
+        var opts = __assign({ closingTag: false, indent: '  ', noTags: false, shortTags: false }, options);
+        var _b = new code_builder_1.CodeBuilder({ indent: opts.indent }), push = _b.push, blank = _b.blank, join = _b.join;
+        var 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(".concat((0, helpers_1.convertType)(postData.paramsObj, opts.indent), "));"));
+                blank();
+                hasBody = true;
+                break;
+            case 'multipart/form-data': {
+                if (!postData.params) {
+                    break;
+                }
+                var files_1 = [];
+                var fields_1 = {};
+                postData.params.forEach(function (_a) {
+                    var name = _a.name, fileName = _a.fileName, value = _a.value, contentType = _a.contentType;
+                    if (fileName) {
+                        files_1.push({
+                            name: name,
+                            type: contentType,
+                            file: fileName,
+                            data: value
+                        });
+                        return;
+                    }
+                    if (value) {
+                        fields_1[name] = value;
+                    }
+                });
+                var field = Object.keys(fields_1).length ? (0, helpers_1.convertType)(fields_1, opts.indent) : 'null';
+                var formValue = files_1.length ? (0, helpers_1.convertType)(files_1, opts.indent) : 'null';
+                push('$body = new http\\Message\\Body;');
+                push("$body->addForm(".concat(field, ", ").concat(formValue, ");"));
+                // remove the contentType header
+                if ((0, headers_1.hasHeader)(headersObj, 'content-type')) {
+                    if (String((0, headers_1.getHeader)(headersObj, 'content-type')).indexOf('boundary')) {
+                        var headerName = (0, headers_1.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(".concat((0, helpers_1.convertType)(postData.text), ");"));
+                    blank();
+                    hasBody = true;
+                }
+        }
+        push("$request->setRequestUrl(".concat((0, helpers_1.convertType)(url), ");"));
+        push("$request->setRequestMethod(".concat((0, helpers_1.convertType)(method), ");"));
+        if (hasBody) {
+            push('$request->setBody($body);');
+            blank();
+        }
+        if (Object.keys(queryObj).length) {
+            push("$request->setQuery(new http\\QueryString(".concat((0, helpers_1.convertType)(queryObj, opts.indent), "));"));
+            blank();
+        }
+        if (Object.keys(headersObj).length) {
+            push("$request->setHeaders(".concat((0, helpers_1.convertType)(headersObj, opts.indent), ");"));
+            blank();
+        }
+        if (Object.keys(cookiesObj).length) {
+            blank();
+            push("$client->setCookies(".concat((0, helpers_1.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/dist/src/targets/php/target.js

@@ -0,0 +1,22 @@
+"use strict";
+exports.__esModule = true;
+exports.php = void 0;
+var client_1 = require("./curl/client");
+var client_2 = require("./guzzle/client");
+var client_3 = require("./http1/client");
+var client_4 = require("./http2/client");
+exports.php = {
+    info: {
+        key: 'php',
+        title: 'PHP',
+        extname: '.php',
+        "default": 'curl',
+        cli: 'php %s'
+    },
+    clientsById: {
+        curl: client_1.curl,
+        guzzle: client_2.guzzle,
+        http1: client_3.http1,
+        http2: client_4.http2
+    }
+};

package/dist/src/targets/powershell/common.js

@@ -0,0 +1,49 @@
+"use strict";
+exports.__esModule = true;
+exports.generatePowershellConvert = void 0;
+var code_builder_1 = require("../../helpers/code-builder");
+var headers_1 = require("../../helpers/headers");
+var generatePowershellConvert = function (command) {
+    var convert = function (_a) {
+        var method = _a.method, headersObj = _a.headersObj, cookies = _a.cookies, uriObj = _a.uriObj, fullUrl = _a.fullUrl, postData = _a.postData, allHeaders = _a.allHeaders;
+        var _b = new code_builder_1.CodeBuilder(), push = _b.push, join = _b.join;
+        var methods = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS'];
+        if (!methods.includes(method.toUpperCase())) {
+            return 'Method not supported';
+        }
+        var commandOptions = [];
+        // Add headers, including the cookies
+        var headers = Object.keys(headersObj);
+        // construct headers
+        if (headers.length) {
+            push('$headers=@{}');
+            headers.forEach(function (key) {
+                if (key !== 'connection') {
+                    // Not allowed
+                    push("$headers.Add(\"".concat(key, "\", \"").concat(headersObj[key], "\")"));
+                }
+            });
+            commandOptions.push('-Headers $headers');
+        }
+        // construct cookies
+        if (cookies.length) {
+            push('$session = New-Object Microsoft.PowerShell.Commands.WebRequestSession');
+            cookies.forEach(function (cookie) {
+                push('$cookie = New-Object System.Net.Cookie');
+                push("$cookie.Name = '".concat(cookie.name, "'"));
+                push("$cookie.Value = '".concat(cookie.value, "'"));
+                push("$cookie.Domain = '".concat(uriObj.host, "'"));
+                push('$session.Cookies.Add($cookie)');
+            });
+            commandOptions.push('-WebSession $session');
+        }
+        if (postData.text) {
+            commandOptions.push("-ContentType '".concat((0, headers_1.getHeader)(allHeaders, 'content-type'), "'"));
+            commandOptions.push("-Body '".concat(postData.text, "'"));
+        }
+        push("$response = ".concat(command, " -Uri '").concat(fullUrl, "' -Method ").concat(method, " ").concat(commandOptions.join(' ')).trim());
+        return join();
+    };
+    return convert;
+};
+exports.generatePowershellConvert = generatePowershellConvert;

package/dist/src/targets/powershell/restmethod/client.js

@@ -0,0 +1,13 @@
+"use strict";
+exports.__esModule = true;
+exports.restmethod = void 0;
+var common_1 = require("../common");
+exports.restmethod = {
+    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: (0, common_1.generatePowershellConvert)('Invoke-RestMethod')
+};

package/dist/src/targets/powershell/target.js

@@ -0,0 +1,17 @@
+"use strict";
+exports.__esModule = true;
+exports.powershell = void 0;
+var client_1 = require("./restmethod/client");
+var client_2 = require("./webrequest/client");
+exports.powershell = {
+    info: {
+        key: 'powershell',
+        title: 'Powershell',
+        extname: '.ps1',
+        "default": 'webrequest'
+    },
+    clientsById: {
+        webrequest: client_2.webrequest,
+        restmethod: client_1.restmethod
+    }
+};

package/dist/src/targets/powershell/webrequest/client.js

@@ -0,0 +1,13 @@
+"use strict";
+exports.__esModule = true;
+exports.webrequest = void 0;
+var common_1 = require("../common");
+exports.webrequest = {
+    info: {
+        key: 'webrequest',
+        title: 'Invoke-WebRequest',
+        link: 'https://docs.microsoft.com/en-us/powershell/module/Microsoft.PowerShell.Utility/Invoke-WebRequest',
+        description: 'Powershell Invoke-WebRequest client'
+    },
+    convert: (0, common_1.generatePowershellConvert)('Invoke-WebRequest')
+};

package/dist/src/targets/python/helpers.js

@@ -0,0 +1,70 @@
+"use strict";
+exports.__esModule = true;
+exports.literalRepresentation = void 0;
+/**
+ * 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
+ */
+function buildString(length, str) {
+    return str.repeat(length);
+}
+/**
+ * Create a string corresponding to a Dictionary or Array literal representation with pretty option
+ * and indentation.
+ */
+function concatValues(concatType, values, pretty, indentation, indentLevel) {
+    var currentIndent = buildString(indentLevel, indentation);
+    var closingBraceIndent = buildString(indentLevel - 1, indentation);
+    var join = pretty ? ",\n".concat(currentIndent) : ', ';
+    var openingBrace = concatType === 'object' ? '{' : '[';
+    var closingBrace = concatType === 'object' ? '}' : ']';
+    if (pretty) {
+        return "".concat(openingBrace, "\n").concat(currentIndent).concat(values.join(join), "\n").concat(closingBraceIndent).concat(closingBrace);
+    }
+    return openingBrace + values.join(join) + closingBrace;
+}
+/**
+ * Create a valid Python string of a literal value according to its type.
+ *
+ * @param {*} value Any JavaScript literal
+ * @param {Object} opts Target options
+ * @return {string}
+ */
+var literalRepresentation = function (value, opts, indentLevel) {
+    indentLevel = indentLevel === undefined ? 1 : indentLevel + 1;
+    switch (Object.prototype.toString.call(value)) {
+        case '[object Number]':
+            return value;
+        case '[object Array]': {
+            var pretty_1 = false;
+            var valuesRepresentation = value.map(function (v) {
+                // Switch to prettify if the value is a dictionary with multiple keys
+                if (Object.prototype.toString.call(v) === '[object Object]') {
+                    pretty_1 = Object.keys(v).length > 1;
+                }
+                return (0, exports.literalRepresentation)(v, opts, indentLevel);
+            });
+            return concatValues('array', valuesRepresentation, pretty_1, opts.indent, indentLevel);
+        }
+        case '[object Object]': {
+            var keyValuePairs = [];
+            // eslint-disable-next-line guard-for-in, no-restricted-syntax
+            for (var key in value) {
+                keyValuePairs.push("\"".concat(key, "\": ").concat((0, exports.literalRepresentation)(value[key], opts, indentLevel)));
+            }
+            return concatValues('object', keyValuePairs, opts.pretty && keyValuePairs.length > 1, opts.indent, indentLevel);
+        }
+        case '[object Null]':
+            return 'None';
+        case '[object Boolean]':
+            return value ? 'True' : 'False';
+        default:
+            if (value === null || value === undefined) {
+                return '';
+            }
+            return "\"".concat(value.toString().replace(/"/g, '\\"'), "\"");
+    }
+};
+exports.literalRepresentation = literalRepresentation;

package/dist/src/targets/python/requests/client.js

@@ -0,0 +1,161 @@
+"use strict";
+/**
+ * @description
+ * HTTP code snippet generator for Python using Requests
+ *
+ * @author
+ * @montanaflynn
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+exports.__esModule = true;
+exports.requests = void 0;
+var code_builder_1 = require("../../../helpers/code-builder");
+var headers_1 = require("../../../helpers/headers");
+var helpers_1 = require("../helpers");
+exports.requests = {
+    info: {
+        key: 'requests',
+        title: 'Requests',
+        link: 'http://docs.python-requests.org/en/latest/api/#requests.request',
+        description: 'Requests HTTP library'
+    },
+    convert: function (_a, options) {
+        var fullUrl = _a.fullUrl, postData = _a.postData, allHeaders = _a.allHeaders, method = _a.method;
+        var opts = __assign({ indent: '    ', pretty: true }, options);
+        // Start snippet
+        var _b = new code_builder_1.CodeBuilder({ indent: opts.indent }), push = _b.push, blank = _b.blank, join = _b.join, addPostProcessor = _b.addPostProcessor;
+        // Import requests
+        push('import requests');
+        blank();
+        // Set URL
+        push("url = \"".concat(fullUrl, "\""));
+        blank();
+        var headers = allHeaders;
+        // Construct payload
+        var payload = {};
+        var files = {};
+        var hasFiles = false;
+        var hasPayload = false;
+        var jsonPayload = false;
+        switch (postData.mimeType) {
+            case 'application/json':
+                if (postData.jsonObj) {
+                    push("payload = ".concat((0, helpers_1.literalRepresentation)(postData.jsonObj, opts)));
+                    jsonPayload = true;
+                    hasPayload = true;
+                }
+                break;
+            case 'multipart/form-data':
+                if (!postData.params) {
+                    break;
+                }
+                payload = {};
+                postData.params.forEach(function (p) {
+                    if (p.fileName) {
+                        files[p.name] = "open('".concat(p.fileName, "', 'rb')");
+                        hasFiles = true;
+                    }
+                    else {
+                        payload[p.name] = p.value;
+                        hasPayload = true;
+                    }
+                });
+                if (hasFiles) {
+                    push("files = ".concat((0, helpers_1.literalRepresentation)(files, opts)));
+                    if (hasPayload) {
+                        push("payload = ".concat((0, helpers_1.literalRepresentation)(payload, opts)));
+                    }
+                    // The requests library will only automatically add a `multipart/form-data` header if there are files being sent. If we're **only** sending form data we still need to send the boundary ourselves.
+                    var headerName = (0, headers_1.getHeaderName)(headers, 'content-type');
+                    if (headerName) {
+                        delete headers[headerName];
+                    }
+                }
+                else {
+                    var nonFilePayload = JSON.stringify(postData.text);
+                    if (nonFilePayload) {
+                        push("payload = ".concat(nonFilePayload));
+                        hasPayload = true;
+                    }
+                }
+                // The `open()` call must be a literal in the code snippet.
+                addPostProcessor(function (code) { return code.replace(/"open\('(.+)', 'rb'\)"/g, 'open("$1", "rb")'); });
+                break;
+            default: {
+                var stringPayload = JSON.stringify(postData.text);
+                if (stringPayload) {
+                    push("payload = ".concat(stringPayload));
+                    hasPayload = true;
+                }
+            }
+        }
+        // Construct headers
+        var headerCount = Object.keys(headers).length;
+        if (headerCount === 0 && (hasPayload || hasFiles)) {
+            // If we don't have any heads but we do have a payload we should put a blank line here between that payload consturction and our execution of the requests library.
+            blank();
+        }
+        else if (headerCount === 1) {
+            Object.keys(headers).forEach(function (header) {
+                push("headers = {\"".concat(header, "\": \"").concat(headers[header], "\"}"));
+                blank();
+            });
+        }
+        else if (headerCount > 1) {
+            var count_1 = 1;
+            push('headers = {');
+            Object.keys(headers).forEach(function (header) {
+                if (count_1 !== headerCount) {
+                    push("\"".concat(header, "\": \"").concat(headers[header], "\","), 1);
+                }
+                else {
+                    push("\"".concat(header, "\": \"").concat(headers[header], "\""), 1);
+                }
+                count_1 += 1;
+            });
+            push('}');
+            blank();
+        }
+        // Construct request
+        var request;
+        // Method list pulled from their api reference https://docs.python-requests.org/en/latest/api/#requests.head
+        if (['HEAD', 'GET', 'POST', 'PUT', 'PATCH', 'DELETE'].includes(method)) {
+            request = "response = requests.".concat(method.toLowerCase(), "(url");
+        }
+        else {
+            request = "response = requests.request(\"".concat(method, "\", url");
+        }
+        if (hasPayload) {
+            if (jsonPayload) {
+                request += ', json=payload';
+            }
+            else {
+                request += ', data=payload';
+            }
+        }
+        if (hasFiles) {
+            request += ', files=files';
+        }
+        if (headerCount > 0) {
+            request += ', headers=headers';
+        }
+        request += ')';
+        push(request);
+        blank();
+        // Print response
+        push('print(response.text)');
+        return join();
+    }
+};

package/dist/src/targets/python/target.js

@@ -0,0 +1,16 @@
+"use strict";
+exports.__esModule = true;
+exports.python = void 0;
+var client_1 = require("./requests/client");
+exports.python = {
+    info: {
+        key: 'python',
+        title: 'Python',
+        extname: '.py',
+        "default": 'requests',
+        cli: 'python3 %s'
+    },
+    clientsById: {
+        requests: client_1.requests
+    }
+};

package/dist/src/targets/r/httr/client.js

@@ -0,0 +1,125 @@
+"use strict";
+/**
+ * @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.
+ */
+exports.__esModule = true;
+exports.httr = void 0;
+var code_builder_1 = require("../../../helpers/code-builder");
+exports.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: function (_a) {
+        var url = _a.url, queryObj = _a.queryObj, queryString = _a.queryString, postData = _a.postData, allHeaders = _a.allHeaders, method = _a.method;
+        // Start snippet
+        var _b = new code_builder_1.CodeBuilder(), push = _b.push, blank = _b.blank, join = _b.join;
+        // Import httr
+        push('library(httr)');
+        blank();
+        // Set URL
+        push("url <- \"".concat(url, "\""));
+        blank();
+        // Construct query string
+        var qs = queryObj;
+        delete queryObj.key;
+        var queryCount = Object.keys(qs).length;
+        if (queryString.length === 1) {
+            push("queryString <- list(".concat(Object.keys(qs), " = \"").concat(Object.values(qs).toString(), "\")"));
+            blank();
+        }
+        else if (queryString.length > 1) {
+            push('queryString <- list(');
+            Object.keys(qs).forEach(function (query, i) {
+                if (i !== queryCount - 1) {
+                    push("  ".concat(query, " = \"").concat(qs[query].toString(), "\","));
+                }
+                else {
+                    push("  ".concat(query, " = \"").concat(qs[query].toString(), "\""));
+                }
+            });
+            push(')');
+            blank();
+        }
+        // Construct payload
+        var payload = JSON.stringify(postData.text);
+        if (payload) {
+            push("payload <- ".concat(payload));
+            blank();
+        }
+        // Define encode
+        if (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
+        var headers = [];
+        var cookies;
+        var accept;
+        Object.keys(allHeaders).forEach(function (header) {
+            if (header.toLowerCase() === 'accept') {
+                accept = ", accept(\"".concat(allHeaders[header], "\")");
+            }
+            else if (header.toLowerCase() === 'cookie') {
+                cookies = ", set_cookies(`".concat(String(allHeaders[header])
+                    .replace(/;/g, '", `')
+                    .replace(/` /g, '`')
+                    .replace(/[=]/g, '` = "'), "\")");
+            }
+            else if (header.toLowerCase() !== 'content-type') {
+                headers.push("'".concat(header, "' = '").concat(allHeaders[header], "'"));
+            }
+        });
+        // Construct request
+        var request = "response <- VERB(\"".concat(method, "\", url");
+        if (payload) {
+            request += ', body = payload';
+        }
+        if (headers.length) {
+            request += ", add_headers(".concat(headers.join(', '), ")");
+        }
+        if (queryString.length) {
+            request += ', query = queryString';
+        }
+        request += ", content_type(\"".concat(postData.mimeType, "\")");
+        if (typeof accept !== 'undefined') {
+            request += accept;
+        }
+        if (typeof cookies !== 'undefined') {
+            request += cookies;
+        }
+        if (postData.text || postData.jsonObj || postData.params) {
+            request += ', encode = encode';
+        }
+        request += ')';
+        push(request);
+        blank();
+        // Print response
+        push('content(response, "text")');
+        return join();
+    }
+};

package/dist/src/targets/r/target.js

@@ -0,0 +1,15 @@
+"use strict";
+exports.__esModule = true;
+exports.r = void 0;
+var client_1 = require("./httr/client");
+exports.r = {
+    info: {
+        key: 'r',
+        title: 'R',
+        extname: '.r',
+        "default": 'httr'
+    },
+    clientsById: {
+        httr: client_1.httr
+    }
+};