@readme/httpsnippet 2.5.1 → 3.0.3

package/src/targets/python/python3.js

@@ -8,84 +8,73 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
+const CodeBuilder = require('../../helpers/code-builder');
 
-const CodeBuilder = require('../../helpers/code-builder')
-
-module.exports = function (source, options) {
-  const code = new CodeBuilder()
+module.exports = function (source) {
+  const code = new CodeBuilder();
   // Start Request
-  code.push('import http.client')
-    .blank()
+  code.push('import http.client').blank();
 
   // Check which protocol to be used for the client connection
-  const protocol = source.uriObj.protocol
+  const protocol = source.uriObj.protocol;
   if (protocol === 'https:') {
-    code.push('conn = http.client.HTTPSConnection("%s")', source.uriObj.host)
-      .blank()
+    code.push('conn = http.client.HTTPSConnection("%s")', source.uriObj.host).blank();
   } else {
-    code.push('conn = http.client.HTTPConnection("%s")', source.uriObj.host)
-      .blank()
+    code.push('conn = http.client.HTTPConnection("%s")', source.uriObj.host).blank();
   }
 
   // Create payload string if it exists
-  const payload = JSON.stringify(source.postData.text)
+  const payload = JSON.stringify(source.postData.text);
   if (payload) {
-    code.push('payload = %s', payload)
-      .blank()
+    code.push('payload = %s', payload).blank();
   }
 
   // Create Headers
-  const headers = source.allHeaders
-  const headerCount = Object.keys(headers).length
+  const headers = source.allHeaders;
+  const headerCount = Object.keys(headers).length;
   if (headerCount === 1) {
-    for (const header in headers) {
-      code.push('headers = { \'%s\': "%s" }', header, headers[header])
-        .blank()
-    }
+    Object.keys(headers).forEach(header => {
+      code.push('headers = { \'%s\': "%s" }', header, headers[header]).blank();
+    });
   } else if (headerCount > 1) {
-    let count = 1
+    let count = 1;
 
-    code.push('headers = {')
+    code.push('headers = {');
 
-    for (const header in headers) {
+    Object.keys(headers).forEach(header => {
+      // eslint-disable-next-line no-plusplus
       if (count++ !== headerCount) {
-        code.push('    \'%s\': "%s",', header, headers[header])
+        code.push('    \'%s\': "%s",', header, headers[header]);
       } else {
-        code.push('    \'%s\': "%s"', header, headers[header])
+        code.push('    \'%s\': "%s"', header, headers[header]);
       }
-    }
+    });
 
-    code.push('    }')
-      .blank()
+    code.push('    }').blank();
   }
 
   // Make Request
-  const method = source.method
-  const path = source.uriObj.path
+  const method = source.method;
+  const path = source.uriObj.path;
   if (payload && headerCount) {
-    code.push('conn.request("%s", "%s", payload, headers)', method, path)
+    code.push('conn.request("%s", "%s", payload, headers)', method, path);
   } else if (payload && !headerCount) {
-    code.push('conn.request("%s", "%s", payload)', method, path)
+    code.push('conn.request("%s", "%s", payload)', method, path);
   } else if (!payload && headerCount) {
-    code.push('conn.request("%s", "%s", headers=headers)', method, path)
+    code.push('conn.request("%s", "%s", headers=headers)', method, path);
   } else {
-    code.push('conn.request("%s", "%s")', method, path)
+    code.push('conn.request("%s", "%s")', method, path);
   }
 
   // Get Response
-  code.blank()
-    .push('res = conn.getresponse()')
-    .push('data = res.read()')
-    .blank()
-    .push('print(data.decode("utf-8"))')
+  code.blank().push('res = conn.getresponse()').push('data = res.read()').blank().push('print(data.decode("utf-8"))');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'python3',
   title: 'http.client',
   link: 'https://docs.python.org/3/library/http.client.html',
-  description: 'Python3 HTTP Client'
-}
+  description: 'Python3 HTTP Client',
+};

package/src/targets/python/requests.js

@@ -8,119 +8,94 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-const util = require('util')
-const CodeBuilder = require('../../helpers/code-builder')
-const helpers = require('./helpers')
+const { format } = require('util');
+const CodeBuilder = require('../../helpers/code-builder');
+const helpers = require('./helpers');
 
 module.exports = function (source, options) {
-  const opts = Object.assign({
+  const opts = {
     indent: '    ',
-    pretty: true
-  }, options)
+    pretty: true,
+    ...options,
+  };
 
   // Start snippet
-  const code = new CodeBuilder(opts.indent)
+  const code = new CodeBuilder(opts.indent);
 
   // Import requests
-  code.push('import requests')
-    .blank()
+  code.push('import requests').blank();
 
   // Set URL
-  code.push('url = "%s"', source.url)
-    .blank()
-
-  // Construct query string
-  let qs
-  if (Object.keys(source.queryObj).length) {
-    qs = 'querystring = ' + JSON.stringify(source.queryObj)
-
-    code.push(qs)
-      .blank()
-  }
+  code.push('url = "%s"', source.fullUrl).blank();
 
   // Construct payload
-  let hasPayload = false
-  let jsonPayload = false
-  switch (source.postData.mimeType) {
-    case 'application/json':
-      if (source.postData.jsonObj) {
-        code.push('payload = %s', helpers.literalRepresentation(source.postData.jsonObj, opts))
-        jsonPayload = true
-        hasPayload = true
-      }
-      break
-
-    default: {
-      const payload = JSON.stringify(source.postData.text)
-      if (payload) {
-        code.push('payload = %s', payload)
-        hasPayload = true
-      }
+  let hasPayload = false;
+  let jsonPayload = false;
+  if (source.postData.mimeType === 'application/json') {
+    if (source.postData.jsonObj) {
+      code.push('payload = %s', helpers.literalRepresentation(source.postData.jsonObj, opts));
+      jsonPayload = true;
+      hasPayload = true;
+    }
+  } else {
+    const payload = JSON.stringify(source.postData.text);
+    if (payload) {
+      code.push('payload = %s', payload);
+      hasPayload = true;
     }
   }
 
   // Construct headers
-  const headers = source.allHeaders
-  const headerCount = Object.keys(headers).length
+  const headers = source.allHeaders;
+  const headerCount = Object.keys(headers).length;
 
   if (headerCount === 1) {
-    for (const header in headers) {
-      code.push('headers = {"%s": "%s"}', header, headers[header])
-        .blank()
-    }
+    Object.keys(headers).forEach(header => {
+      code.push('headers = {"%s": "%s"}', header, headers[header]).blank();
+    });
   } else if (headerCount > 1) {
-    let count = 1
+    let count = 1;
 
-    code.push('headers = {')
+    code.push('headers = {');
 
-    for (const header in headers) {
+    Object.keys(headers).forEach(header => {
+      // eslint-disable-next-line no-plusplus
       if (count++ !== headerCount) {
-        code.push(1, '"%s": "%s",', header, headers[header])
+        code.push(1, '"%s": "%s",', header, headers[header]);
       } else {
-        code.push(1, '"%s": "%s"', header, headers[header])
+        code.push(1, '"%s": "%s"', header, headers[header]);
       }
-    }
+    });
 
-    code.push('}')
-      .blank()
+    code.push('}').blank();
   }
 
   // Construct request
-  const method = source.method
-  let request = util.format('response = requests.request("%s", url', method)
+  const method = source.method;
+  let request = format('response = requests.request("%s", url', method);
 
   if (hasPayload) {
     if (jsonPayload) {
-      request += ', json=payload'
+      request += ', json=payload';
     } else {
-      request += ', data=payload'
+      request += ', data=payload';
     }
   }
 
   if (headerCount > 0) {
-    request += ', headers=headers'
+    request += ', headers=headers';
   }
 
-  if (qs) {
-    request += ', params=querystring'
-  }
-
-  request += ')'
-
-  code.push(request)
-    .blank()
+  request += ')';
 
-    // Print response
-    .push('print(response.text)')
+  code.push(request).blank().push('print(response.text)');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'requests',
   title: 'Requests',
   link: 'http://docs.python-requests.org/en/latest/api/#requests.request',
-  description: 'Requests HTTP library'
-}
+  description: 'Requests HTTP library',
+};

package/src/targets/r/httr.js

@@ -8,145 +8,134 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
+const { format } = require('util');
+const CodeBuilder = require('../../helpers/code-builder');
 
-const util = require('util')
-const CodeBuilder = require('../../helpers/code-builder')
-
-module.exports = function (source, options) {
+module.exports = function (source) {
   // Start snippet
-  const code = new CodeBuilder()
+  const code = new CodeBuilder();
 
   // Import httr
-  code.push('library(httr)')
-    .blank()
+  code.push('library(httr)').blank();
 
   // Set URL
-  code.push('url <- "%s"', source.url)
-    .blank()
+  code.push('url <- "%s"', source.url).blank();
 
   // Construct query string
-  const qs = source.queryObj
-  const queryCount = Object.keys(qs).length
-  delete source.queryObj.key
+  const qs = source.queryObj;
+  const queryCount = Object.keys(qs).length;
+  // eslint-disable-next-line no-param-reassign
+  delete source.queryObj.key;
 
   if (source.queryString.length === 1) {
-    code.push('queryString <- list(%s = "%s")', Object.keys(qs), Object.values(qs).toString())
-      .blank()
+    code.push('queryString <- list(%s = "%s")', Object.keys(qs), Object.values(qs).toString()).blank();
   } else if (source.queryString.length > 1) {
-    let count = 1
+    let count = 1;
 
-    code.push('queryString <- list(')
+    code.push('queryString <- list(');
 
-    for (const query in qs) {
+    Object.keys(qs).forEach(query => {
+      // eslint-disable-next-line no-plusplus
       if (count++ !== queryCount - 1) {
-        code.push('  %s = "%s",', query, qs[query].toString())
+        code.push('  %s = "%s",', query, qs[query].toString());
       } else {
-        code.push('  %s = "%s"', query, qs[query].toString())
+        code.push('  %s = "%s"', query, qs[query].toString());
       }
-    }
+    });
 
-    code.push(')')
-      .blank()
+    code.push(')').blank();
   }
 
   // Construct payload
-  const payload = JSON.stringify(source.postData.text)
+  const payload = JSON.stringify(source.postData.text);
 
   if (payload) {
-    code.push('payload <- %s', payload)
-      .blank()
+    code.push('payload <- %s', payload).blank();
   }
 
   // Define encode
   if (source.postData.text || source.postData.jsonObj || source.postData.params) {
     switch (source.postData.mimeType) {
       case 'application/x-www-form-urlencoded':
-        code.push('encode <- "form"')
-          .blank()
-        break
+        code.push('encode <- "form"').blank();
+        break;
 
       case 'application/json':
-        code.push('encode <- "json"')
-          .blank()
-        break
+        code.push('encode <- "json"').blank();
+        break;
 
       case 'multipart/form-data':
-        code.push('encode <- "multipart"')
-          .blank()
-        break
+        code.push('encode <- "multipart"').blank();
+        break;
 
       default:
-        code.push('encode <- "raw"')
-          .blank()
-        break
+        code.push('encode <- "raw"').blank();
+        break;
     }
   }
 
   // Construct headers
-  const headers = source.allHeaders
-  let headerCount = Object.keys(headers).length
-  let header = ''
-  let cookies
-  let accept
+  const headers = source.allHeaders;
+  let headerCount = 0;
+  let header = '';
+  let cookies;
+  let accept;
 
-  for (const head in headers) {
+  Object.keys(headers).forEach(head => {
     if (head.toLowerCase() === 'accept') {
-      accept = ', accept("' + headers[head] + '")'
-      headerCount = headerCount - 1
+      accept = `, accept("${headers[head]}")`;
+      headerCount += 1;
     } else if (head.toLowerCase() === 'cookie') {
-      cookies = ', set_cookies(`' + headers[head].replace(/;/g, '", `').replace(/` /g, '`').replace(/=/g, '` = "') + '")'
-      headerCount = headerCount - 1
+      cookies = `, set_cookies(\`${headers[head].replace(/;/g, '", `').replace(/` /g, '`').replace(/=/g, '` = "')}")`;
+      headerCount += 1;
     } else if (head.toLowerCase() !== 'content-type') {
-      header = header + head.replace('-', '_') + " = '" + headers[head]
-      if (headerCount > 1) { header = header + "', " }
+      header = `${header + head.replace('-', '_')} = '${headers[head]}`;
+      if (headerCount > 1) {
+        header += "', ";
+      }
     }
-  }
+  });
 
   // Construct request
-  const method = source.method
-  let request = util.format('response <- VERB("%s", url', method)
+  const method = source.method;
+  let request = format('response <- VERB("%s", url', method);
 
   if (payload) {
-    request += ', body = payload'
+    request += ', body = payload';
   }
 
   if (header !== '') {
-    request += ', add_headers(' + header + "')"
+    request += `, add_headers(${header}')`;
   }
 
   if (source.queryString.length) {
-    request += ', query = queryString'
+    request += ', query = queryString';
   }
 
-  request += ', content_type("' + source.postData.mimeType + '")'
+  request += `, content_type("${source.postData.mimeType}")`;
 
   if (typeof accept !== 'undefined') {
-    request += accept
+    request += accept;
   }
 
   if (typeof cookies !== 'undefined') {
-    request += cookies
+    request += cookies;
   }
 
   if (source.postData.text || source.postData.jsonObj || source.postData.params) {
-    request += ', encode = encode'
+    request += ', encode = encode';
   }
 
-  request += ')'
-
-  code.push(request)
-    .blank()
+  request += ')';
 
-  // Print response
-    .push('content(response, "text")')
+  code.push(request).blank().push('content(response, "text")');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.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'
-}
+  description: 'httr: Tools for Working with URLs and HTTP',
+};

package/src/targets/r/index.js

@@ -1,12 +1,10 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'r',
     title: 'R',
     extname: '.r',
-    default: 'httr'
+    default: 'httr',
   },
 
-  httr: require('./httr')
-}
+  httr: require('./httr'),
+};

package/src/targets/ruby/index.js

@@ -1,12 +1,10 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'ruby',
     title: 'Ruby',
     extname: '.rb',
-    default: 'native'
+    default: 'native',
   },
 
-  native: require('./native')
-}
+  native: require('./native'),
+};

package/src/targets/ruby/native.js

@@ -1,65 +1,71 @@
-'use strict'
+const CodeBuilder = require('../../helpers/code-builder');
 
-const CodeBuilder = require('../../helpers/code-builder')
+module.exports = function (source) {
+  const code = new CodeBuilder();
 
-module.exports = function (source, options) {
-  const code = new CodeBuilder()
-
-  code.push('require \'uri\'')
-    .push('require \'net/http\'')
+  code.push("require 'uri'").push("require 'net/http'");
 
   if (source.uriObj.protocol === 'https:') {
-    code.push('require \'openssl\'')
+    code.push("require 'openssl'");
   }
 
-  code.blank()
+  code.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 = source.method.toUpperCase()
-  const methods = ['GET', 'POST', 'HEAD', 'DELETE', 'PATCH', 'PUT', 'OPTIONS', 'COPY', 'LOCK', 'UNLOCK', 'MOVE', 'TRACE']
-  const capMethod = method.charAt(0) + method.substring(1).toLowerCase()
+  const method = source.method.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.indexOf(method) < 0) {
-    code.push('class Net::HTTP::%s < Net::HTTPRequest', capMethod)
-      .push('  METHOD = \'%s\'', method.toUpperCase())
-      .push('  REQUEST_HAS_BODY = \'%s\'', source.postData.text ? 'true' : 'false')
+    code
+      .push('class Net::HTTP::%s < Net::HTTPRequest', capMethod)
+      .push("  METHOD = '%s'", method.toUpperCase())
+      .push("  REQUEST_HAS_BODY = '%s'", source.postData.text ? 'true' : 'false')
       .push('  RESPONSE_HAS_BODY = true')
       .push('end')
-      .blank()
+      .blank();
   }
 
-  code.push('url = URI("%s")', source.fullUrl)
-    .blank()
-    .push('http = Net::HTTP.new(url.host, url.port)')
+  code.push('url = URI("%s")', source.fullUrl).blank().push('http = Net::HTTP.new(url.host, url.port)');
 
   if (source.uriObj.protocol === 'https:') {
-    code.push('http.use_ssl = true')
+    code.push('http.use_ssl = true');
   }
 
-  code.blank()
-    .push('request = Net::HTTP::%s.new(url)', capMethod)
+  code.blank().push('request = Net::HTTP::%s.new(url)', capMethod);
 
-  const headers = Object.keys(source.allHeaders)
+  const headers = Object.keys(source.allHeaders);
   if (headers.length) {
     headers.forEach(function (key) {
-      code.push('request["%s"] = \'%s\'', key, source.allHeaders[key])
-    })
+      code.push('request["%s"] = \'%s\'', key, source.allHeaders[key]);
+    });
   }
 
   if (source.postData.text) {
-    code.push('request.body = %s', JSON.stringify(source.postData.text))
+    code.push('request.body = %s', JSON.stringify(source.postData.text));
   }
 
-  code.blank()
-    .push('response = http.request(request)')
-    .push('puts response.read_body')
+  code.blank().push('response = http.request(request)').push('puts response.read_body');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.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'
-}
+  description: 'Ruby HTTP client',
+};