@readme/httpsnippet 3.1.1 → 4.0.0

package/src/targets/python/requests/fixtures/multipart-form-data-no-params.py

@@ -0,0 +1,9 @@
+import requests
+
+url = "https://httpbin.org/anything"
+
+headers = {"Content-Type": "multipart/form-data"}
+
+response = requests.post(url, headers=headers)
+
+print(response.text)

package/src/targets/python/requests/fixtures/multipart-form-data.py

@@ -0,0 +1,10 @@
+import requests
+
+url = "https://httpbin.org/anything"
+
+payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"\r\n\r\nbar\r\n-----011000010111000001101001--\r\n"
+headers = {"Content-Type": "multipart/form-data; boundary=---011000010111000001101001"}
+
+response = requests.post(url, data=payload, headers=headers)
+
+print(response.text)

package/src/targets/python/requests/fixtures/nested.py

@@ -0,0 +1,7 @@
+import requests
+
+url = "https://httpbin.org/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value"
+
+response = requests.get(url)
+
+print(response.text)

package/src/targets/python/requests/fixtures/query-encoded.py

@@ -0,0 +1,7 @@
+import requests
+
+url = "https://httpbin.org/anything?startTime=2019-06-13T19%3A08%3A25.455Z&endTime=2015-09-15T14%3A00%3A12-04%3A00"
+
+response = requests.get(url)
+
+print(response.text)

package/src/targets/python/requests/fixtures/query.py

@@ -0,0 +1,7 @@
+import requests
+
+url = "https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value"
+
+response = requests.get(url)
+
+print(response.text)

package/src/targets/python/requests/fixtures/short.py

@@ -0,0 +1,7 @@
+import requests
+
+url = "https://httpbin.org/anything"
+
+response = requests.get(url)
+
+print(response.text)

package/src/targets/python/requests/fixtures/text-plain.py

@@ -0,0 +1,10 @@
+import requests
+
+url = "https://httpbin.org/anything"
+
+payload = "Hello World"
+headers = {"content-type": "text/plain"}
+
+response = requests.post(url, data=payload, headers=headers)
+
+print(response.text)

package/src/targets/python/target.ts

@@ -0,0 +1,15 @@
+import type { Target } from '../targets';
+import { requests } from './requests/client';
+
+export const python: Target = {
+  info: {
+    key: 'python',
+    title: 'Python',
+    extname: '.py',
+    default: 'requests',
+    cli: 'python3 %s',
+  },
+  clientsById: {
+    requests,
+  },
+};

package/src/targets/r/httr/client.test.ts

@@ -0,0 +1,29 @@
+import type { Request } from '../../..';
+import { runCustomFixtures } from '../../../fixtures/runCustomFixtures';
+
+runCustomFixtures({
+  targetId: 'r',
+  clientId: 'httr',
+  tests: [
+    {
+      it: "should properly concatenate query strings that aren't nested",
+      input: {
+        method: 'GET',
+        url: 'http://mockbin.com/har',
+        httpVersion: 'HTTP/1.1',
+        queryString: [
+          {
+            name: 'perPage',
+            value: '100',
+          },
+          {
+            name: 'page',
+            value: '1',
+          },
+        ],
+      } as Request,
+      options: {},
+      expected: 'query-two-params.r',
+    },
+  ],
+});

package/src/targets/r/httr/client.ts

@@ -0,0 +1,146 @@
+/**
+ * @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 type { Client } from '../../targets';
+import { CodeBuilder } from '../../../helpers/code-builder';
+
+export const httr: Client = {
+  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 }) => {
+    // Start snippet
+    const { push, blank, join } = new CodeBuilder();
+
+    // Import httr
+    push('library(httr)');
+    blank();
+
+    // Set URL
+    push(`url <- "${url}"`);
+    blank();
+
+    // Construct query string
+    const qs = queryObj;
+    delete queryObj.key;
+
+    const queryCount = Object.keys(qs).length;
+    if (queryString.length === 1) {
+      push(`queryString <- list(${Object.keys(qs)} = "${Object.values(qs).toString()}")`);
+      blank();
+    } else if (queryString.length > 1) {
+      push('queryString <- list(');
+
+      Object.keys(qs).forEach((query, i) => {
+        if (i !== queryCount - 1) {
+          push(`  ${query} = "${qs[query].toString()}",`);
+        } else {
+          push(`  ${query} = "${qs[query].toString()}"`);
+        }
+      });
+
+      push(')');
+      blank();
+    }
+
+    // Construct payload
+    const payload = JSON.stringify(postData.text);
+
+    if (payload) {
+      push(`payload <- ${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
+    const headers: string[] = [];
+    let cookies;
+    let accept;
+
+    Object.keys(allHeaders).forEach(header => {
+      if (header.toLowerCase() === 'accept') {
+        accept = `, accept("${allHeaders[header]}")`;
+      } else if (header.toLowerCase() === 'cookie') {
+        cookies = `, set_cookies(\`${String(allHeaders[header])
+          .replace(/;/g, '", `')
+          .replace(/` /g, '`')
+          .replace(/[=]/g, '` = "')}")`;
+      } else if (header.toLowerCase() !== 'content-type') {
+        headers.push(`'${header}' = '${allHeaders[header]}'`);
+      }
+    });
+
+    // Construct request
+    let request = `response <- VERB("${method}", url`;
+
+    if (payload) {
+      request += ', body = payload';
+    }
+
+    if (headers.length) {
+      request += `, add_headers(${headers.join(', ')})`;
+    }
+
+    if (queryString.length) {
+      request += ', query = queryString';
+    }
+
+    request += `, content_type("${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/src/targets/r/httr/fixtures/application-form-encoded.r

@@ -0,0 +1,11 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+payload <- "foo=bar&hello=world"
+
+encode <- "form"
+
+response <- VERB("POST", url, body = payload, content_type("application/x-www-form-urlencoded"), encode = encode)
+
+content(response, "text")

package/src/targets/r/httr/fixtures/application-json.r

@@ -0,0 +1,11 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+payload <- "{\"number\":1,\"string\":\"f\\\"oo\",\"arr\":[1,2,3],\"nested\":{\"a\":\"b\"},\"arr_mix\":[1,\"a\",{\"arr_mix_nested\":{}}],\"boolean\":false}"
+
+encode <- "json"
+
+response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
+
+content(response, "text")

package/src/targets/r/httr/fixtures/cookies.r

@@ -0,0 +1,7 @@
+library(httr)
+
+url <- "https://httpbin.org/cookies"
+
+response <- VERB("GET", url, content_type("application/octet-stream"), set_cookies(`foo` = "bar", `bar` = "baz"))
+
+content(response, "text")

package/src/targets/r/httr/fixtures/custom-method.r

@@ -0,0 +1,7 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+response <- VERB("PROPFIND", url, content_type("application/octet-stream"))
+
+content(response, "text")

package/src/targets/r/httr/fixtures/full.r

@@ -0,0 +1,16 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+queryString <- list(
+  foo = "bar,baz",
+  baz = "abc"
+)
+
+payload <- "foo=bar"
+
+encode <- "form"
+
+response <- VERB("POST", url, body = payload, query = queryString, content_type("application/x-www-form-urlencoded"), accept("application/json"), set_cookies(`foo` = "bar", `bar` = "baz"), encode = encode)
+
+content(response, "text")

package/src/targets/r/httr/fixtures/headers.r

@@ -0,0 +1,7 @@
+library(httr)
+
+url <- "https://httpbin.org/headers"
+
+response <- VERB("GET", url, add_headers('x-foo' = 'Bar', 'x-bar' = 'Foo'), content_type("application/octet-stream"), accept("application/json"))
+
+content(response, "text")

package/src/targets/r/httr/fixtures/http-insecure.r

@@ -0,0 +1,7 @@
+library(httr)
+
+url <- "http://httpbin.org/anything"
+
+response <- VERB("GET", url, content_type("application/octet-stream"))
+
+content(response, "text")

package/src/targets/r/httr/fixtures/jsonObj-multiline.r

@@ -0,0 +1,11 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+payload <- "{\n  \"foo\": \"bar\"\n}"
+
+encode <- "json"
+
+response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
+
+content(response, "text")

package/src/targets/r/httr/fixtures/jsonObj-null-value.r

@@ -0,0 +1,11 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+payload <- "{\"foo\":null}"
+
+encode <- "json"
+
+response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
+
+content(response, "text")

package/src/targets/r/httr/fixtures/multipart-data.r

@@ -0,0 +1,11 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+payload <- "-----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"
+
+encode <- "multipart"
+
+response <- VERB("POST", url, body = payload, content_type("multipart/form-data"), encode = encode)
+
+content(response, "text")

package/src/targets/r/httr/fixtures/multipart-file.r

@@ -0,0 +1,11 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+payload <- "-----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"
+
+encode <- "multipart"
+
+response <- VERB("POST", url, body = payload, content_type("multipart/form-data"), encode = encode)
+
+content(response, "text")

package/src/targets/r/httr/fixtures/multipart-form-data-no-params.r

@@ -0,0 +1,9 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+payload <- ""
+
+response <- VERB("POST", url, body = payload, content_type("multipart/form-data"))
+
+content(response, "text")

package/src/targets/r/httr/fixtures/multipart-form-data.r

@@ -0,0 +1,11 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+payload <- "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"\r\n\r\nbar\r\n-----011000010111000001101001--\r\n"
+
+encode <- "multipart"
+
+response <- VERB("POST", url, body = payload, content_type("multipart/form-data"), encode = encode)
+
+content(response, "text")

package/src/targets/r/httr/fixtures/nested.r

@@ -0,0 +1,12 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+queryString <- list(
+  foo[bar] = "baz,zap",
+  fiz = "buz"
+)
+
+response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
+
+content(response, "text")

package/src/targets/r/httr/fixtures/query-encoded.r

@@ -0,0 +1,12 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+queryString <- list(
+  startTime = "2019-06-13T19%3A08%3A25.455Z",
+  endTime = "2015-09-15T14%3A00%3A12-04%3A00"
+)
+
+response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
+
+content(response, "text")

package/src/targets/r/httr/fixtures/query-two-params.r

@@ -0,0 +1,12 @@
+library(httr)
+
+url <- "http://mockbin.com/har"
+
+queryString <- list(
+  perPage = "100",
+  page = "1"
+)
+
+response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
+
+content(response, "text")

package/src/targets/r/httr/fixtures/query.r

@@ -0,0 +1,12 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+queryString <- list(
+  foo = "bar,baz",
+  baz = "abc"
+)
+
+response <- VERB("GET", url, query = queryString, content_type("application/octet-stream"))
+
+content(response, "text")

package/src/targets/r/httr/fixtures/short.r

@@ -0,0 +1,7 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+response <- VERB("GET", url, content_type("application/octet-stream"))
+
+content(response, "text")

package/src/targets/r/httr/fixtures/text-plain.r

@@ -0,0 +1,11 @@
+library(httr)
+
+url <- "https://httpbin.org/anything"
+
+payload <- "Hello World"
+
+encode <- "raw"
+
+response <- VERB("POST", url, body = payload, content_type("text/plain"), encode = encode)
+
+content(response, "text")

package/src/targets/r/target.ts

@@ -0,0 +1,14 @@
+import type { Target } from '../targets';
+import { httr } from './httr/client';
+
+export const r: Target = {
+  info: {
+    key: 'r',
+    title: 'R',
+    extname: '.r',
+    default: 'httr',
+  },
+  clientsById: {
+    httr,
+  },
+};

package/src/targets/ruby/native/client.ts

@@ -0,0 +1,78 @@
+import type { Client } from '../../targets';
+import { CodeBuilder } from '../../../helpers/code-builder';
+
+export const native: Client = {
+  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 }) => {
+    const { push, blank, join } = new CodeBuilder();
+
+    push("require 'uri'");
+    push("require 'net/http'");
+
+    if (uriObj.protocol === 'https:') {
+      push("require 'openssl'");
+    }
+
+    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.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');
+    }
+
+    blank();
+    push(`request = Net::HTTP::${capMethod}.new(url)`);
+
+    const headers = Object.keys(allHeaders);
+    if (headers.length) {
+      headers.forEach(key => {
+        push(`request["${key}"] = '${allHeaders[key]}'`);
+      });
+    }
+
+    if (postData.text) {
+      push(`request.body = ${JSON.stringify(postData.text)}`);
+    }
+
+    blank();
+    push('response = http.request(request)');
+    push('puts response.read_body');
+
+    return join();
+  },
+};

package/src/targets/ruby/native/fixtures/application-form-encoded.rb

@@ -0,0 +1,15 @@
+require 'uri'
+require 'net/http'
+require 'openssl'
+
+url = URI("https://httpbin.org/anything")
+
+http = Net::HTTP.new(url.host, url.port)
+http.use_ssl = true
+
+request = Net::HTTP::Post.new(url)
+request["content-type"] = 'application/x-www-form-urlencoded'
+request.body = "foo=bar&hello=world"
+
+response = http.request(request)
+puts response.read_body

package/src/targets/ruby/native/fixtures/application-json.rb

@@ -0,0 +1,15 @@
+require 'uri'
+require 'net/http'
+require 'openssl'
+
+url = URI("https://httpbin.org/anything")
+
+http = Net::HTTP.new(url.host, url.port)
+http.use_ssl = true
+
+request = Net::HTTP::Post.new(url)
+request["content-type"] = 'application/json'
+request.body = "{\"number\":1,\"string\":\"f\\\"oo\",\"arr\":[1,2,3],\"nested\":{\"a\":\"b\"},\"arr_mix\":[1,\"a\",{\"arr_mix_nested\":{}}],\"boolean\":false}"
+
+response = http.request(request)
+puts response.read_body

package/src/targets/ruby/native/fixtures/cookies.rb

@@ -0,0 +1,14 @@
+require 'uri'
+require 'net/http'
+require 'openssl'
+
+url = URI("https://httpbin.org/cookies")
+
+http = Net::HTTP.new(url.host, url.port)
+http.use_ssl = true
+
+request = Net::HTTP::Get.new(url)
+request["cookie"] = 'foo=bar; bar=baz'
+
+response = http.request(request)
+puts response.read_body

package/src/targets/ruby/native/fixtures/custom-method.rb

@@ -0,0 +1,19 @@
+require 'uri'
+require 'net/http'
+require 'openssl'
+
+class Net::HTTP::Propfind < Net::HTTPRequest
+  METHOD = 'PROPFIND'
+  REQUEST_HAS_BODY = 'false'
+  RESPONSE_HAS_BODY = true
+end
+
+url = URI("https://httpbin.org/anything")
+
+http = Net::HTTP.new(url.host, url.port)
+http.use_ssl = true
+
+request = Net::HTTP::Propfind.new(url)
+
+response = http.request(request)
+puts response.read_body