@readme/httpsnippet 2.5.0 → 3.0.2

package/src/targets/node/request.js

@@ -8,119 +8,119 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-const util = require('util')
-const stringifyObject = require('stringify-object')
-const CodeBuilder = require('../../helpers/code-builder')
+const stringifyObject = require('stringify-object');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  const opts = Object.assign({
-    indent: '  '
-  }, options)
+  const opts = {
+    indent: '  ',
+    ...options,
+  };
 
-  let includeFS = false
-  const code = new CodeBuilder(opts.indent)
+  let includeFS = false;
+  const code = new CodeBuilder(opts.indent);
 
-  code.push("const request = require('request');")
-    .blank()
+  code.push("const request = require('request');").blank();
 
   const reqOpts = {
     method: source.method,
-    url: source.url
-  }
-
-  if (Object.keys(source.queryObj).length) {
-    reqOpts.qs = source.queryObj
-  }
+    url: source.fullUrl,
+  };
 
   if (Object.keys(source.headersObj).length) {
-    reqOpts.headers = source.headersObj
+    reqOpts.headers = source.headersObj;
   }
 
   switch (source.postData.mimeType) {
     case 'application/x-www-form-urlencoded':
-      reqOpts.form = source.postData.paramsObj
-      break
+      reqOpts.form = source.postData.paramsObj;
+      break;
 
     case 'application/json':
       if (source.postData.jsonObj) {
-        reqOpts.body = source.postData.jsonObj
-        reqOpts.json = true
+        reqOpts.body = source.postData.jsonObj;
+        reqOpts.json = true;
       }
-      break
+      break;
 
     case 'multipart/form-data':
-      reqOpts.formData = {}
+      if (source.postData.params) {
+        reqOpts.formData = {};
 
-      source.postData.params.forEach(function (param) {
-        const attachment = {}
+        source.postData.params.forEach(function (param) {
+          const attachment = {};
 
-        if (!param.fileName && !param.fileName && !param.contentType) {
-          reqOpts.formData[param.name] = param.value
-          return
-        }
+          if (!param.fileName && !param.contentType) {
+            reqOpts.formData[param.name] = param.value;
+            return;
+          }
 
-        if (param.fileName) {
-          includeFS = true
+          if (param.fileName) {
+            includeFS = true;
 
-          attachment.value = 'fs.createReadStream("' + param.fileName + '")'
-        } else if (param.value) {
-          attachment.value = param.value
-        }
+            attachment.value = `fs.createReadStream("${param.fileName}")`;
+          } else if (param.value) {
+            attachment.value = param.value;
+          }
 
-        if (param.fileName) {
-          attachment.options = {
-            filename: param.fileName,
-            contentType: param.contentType ? param.contentType : null
+          if (param.fileName) {
+            attachment.options = {
+              filename: param.fileName,
+              contentType: param.contentType ? param.contentType : null,
+            };
           }
-        }
 
-        reqOpts.formData[param.name] = attachment
-      })
-      break
+          reqOpts.formData[param.name] = attachment;
+        });
+      }
+      break;
 
     default:
       if (source.postData.text) {
-        reqOpts.body = source.postData.text
+        reqOpts.body = source.postData.text;
       }
   }
 
   // construct cookies argument
-  if (source.cookies.length) {
-    reqOpts.jar = 'JAR'
+  if (source.allHeaders.cookie) {
+    reqOpts.jar = 'JAR';
 
-    code.push('const jar = request.jar();')
+    code.push('const jar = request.jar();');
 
-    const url = source.url
+    const url = source.url;
 
-    source.cookies.forEach(function (cookie) {
-      code.push("jar.setCookie(request.cookie('%s=%s'), '%s');", encodeURIComponent(cookie.name), encodeURIComponent(cookie.value), url)
-    })
-    code.blank()
+    // Cookies are already encoded within `source.allHeaders` so we can pull them out of that instead of doing our
+    // own encoding work.
+    source.allHeaders.cookie.split('; ').forEach(function (cookie) {
+      const [name, value] = cookie.split('=');
+      code.push("jar.setCookie(request.cookie('%s=%s'), '%s');", name, value, url);
+    });
+    code.blank();
   }
 
   if (includeFS) {
-    code.unshift("const fs = require('fs');")
+    code.unshift("const fs = require('fs');");
   }
 
-  code.push('const options = %s;', stringifyObject(reqOpts, { indent: '  ', inlineCharacterLimit: 80 }))
-    .blank()
-
-  code.push(util.format('request(options, %s', 'function (error, response, body) {'))
+  code.push('const options = %s;', stringifyObject(reqOpts, { indent: '  ', inlineCharacterLimit: 80 })).blank();
 
+  code
+    .push('request(options, function (error, response, body) {')
     .push(1, 'if (error) throw new Error(error);')
     .blank()
     .push(1, 'console.log(body);')
     .push('});')
-    .blank()
+    .blank();
 
-  return code.join().replace('"JAR"', 'jar').replace(/'fs\.createReadStream\("(.+)"\)'/g, "fs.createReadStream('$1')")
-}
+  return code
+    .join()
+    .replace("'JAR'", 'jar')
+    .replace(/'fs\.createReadStream\("(.+)"\)'/g, "fs.createReadStream('$1')");
+};
 
 module.exports.info = {
   key: 'request',
   title: 'Request',
   link: 'https://github.com/request/request',
-  description: 'Simplified HTTP request client'
-}
+  description: 'Simplified HTTP request client',
+};

package/src/targets/node/unirest.js

@@ -8,112 +8,113 @@
  * 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 opts = Object.assign({
-    indent: '  '
-  }, options)
+  const opts = {
+    indent: '  ',
+    ...options,
+  };
 
-  let includeFS = false
-  const code = new CodeBuilder(opts.indent)
+  let includeFS = false;
+  const code = new CodeBuilder(opts.indent);
 
-  code.push('const unirest = require("unirest");')
+  code
+    .push('const unirest = require("unirest");')
     .blank()
     .push('const req = unirest("%s", "%s");', source.method, source.url)
-    .blank()
+    .blank();
 
-  if (source.cookies.length) {
-    code.push('const CookieJar = unirest.jar();')
+  if (source.allHeaders.cookie) {
+    code.push('const CookieJar = unirest.jar();');
 
-    source.cookies.forEach(function (cookie) {
-      code.push('CookieJar.add("%s=%s","%s");', encodeURIComponent(cookie.name), encodeURIComponent(cookie.value), source.url)
-    })
+    // Cookies are already encoded within `source.allHeaders` so we can pull them out of that instead of doing our
+    // own encoding work.
+    source.allHeaders.cookie.split('; ').forEach(function (cookie) {
+      const [name, value] = cookie.split('=');
+      code.push('CookieJar.add("%s=%s","%s");', name, value, source.url);
+    });
 
-    code.push('req.jar(CookieJar);')
-      .blank()
+    code.push('req.jar(CookieJar);').blank();
   }
 
   if (Object.keys(source.queryObj).length) {
-    code.push('req.query(%s);', JSON.stringify(source.queryObj, null, opts.indent))
-      .blank()
+    code.push('req.query(%s);', JSON.stringify(source.queryObj, null, opts.indent)).blank();
   }
 
   if (Object.keys(source.headersObj).length) {
-    code.push('req.headers(%s);', JSON.stringify(source.headersObj, null, opts.indent))
-      .blank()
+    code.push('req.headers(%s);', JSON.stringify(source.headersObj, null, opts.indent)).blank();
   }
 
   switch (source.postData.mimeType) {
     case 'application/x-www-form-urlencoded':
       if (source.postData.paramsObj) {
-        code.push('req.form(%s);', JSON.stringify(source.postData.paramsObj, null, opts.indent))
-          .blank()
+        code.push('req.form(%s);', JSON.stringify(source.postData.paramsObj, null, opts.indent)).blank();
       }
-      break
+      break;
 
     case 'application/json':
       if (source.postData.jsonObj) {
-        code.push('req.type("json");')
+        code
+          .push('req.type("json");')
           .push('req.send(%s);', JSON.stringify(source.postData.jsonObj, null, opts.indent))
-          .blank()
+          .blank();
       }
-      break
+      break;
 
     case 'multipart/form-data': {
-      const multipart = []
+      if (source.postData.params) {
+        const multipart = [];
 
-      source.postData.params.forEach(function (param) {
-        const part = {}
+        source.postData.params.forEach(function (param) {
+          const part = {};
 
-        if (param.fileName && !param.value) {
-          includeFS = true
+          if (param.fileName && !param.value) {
+            includeFS = true;
 
-          part.body = 'fs.createReadStream("' + param.fileName + '")'
-        } else if (param.value) {
-          part.body = param.value
-        }
-
-        if (part.body) {
-          if (param.contentType) {
-            part['content-type'] = param.contentType
+            part.body = `fs.createReadStream("${param.fileName}")`;
+          } else if (param.value) {
+            part.body = param.value;
           }
 
-          multipart.push(part)
-        }
-      })
+          if (part.body) {
+            if (param.contentType) {
+              part['content-type'] = param.contentType;
+            }
 
-      code.push('req.multipart(%s);', JSON.stringify(multipart, null, opts.indent))
-        .blank()
-      break
+            multipart.push(part);
+          }
+        });
+
+        code.push('req.multipart(%s);', JSON.stringify(multipart, null, opts.indent)).blank();
+      }
+      break;
     }
 
     default:
       if (source.postData.text) {
-        code.push('req.send(%s);', JSON.stringify(source.postData.text, null, opts.indent))
-          .blank()
+        code.push('req.send(%s);', JSON.stringify(source.postData.text, null, opts.indent)).blank();
       }
   }
 
   if (includeFS) {
-    code.unshift('const fs = require("fs");')
+    code.unshift('const fs = require("fs");');
   }
 
-  code.push('req.end(function (res) {')
+  code
+    .push('req.end(function (res) {')
     .push(1, 'if (res.error) throw new Error(res.error);')
     .blank()
     .push(1, 'console.log(res.body);')
     .push('});')
-    .blank()
+    .blank();
 
-  return code.join().replace(/"fs\.createReadStream\(\\"(.+)\\"\)"/, 'fs.createReadStream("$1")')
-}
+  return code.join().replace(/"fs\.createReadStream\(\\"(.+)\\"\)"/, 'fs.createReadStream("$1")');
+};
 
 module.exports.info = {
   key: 'unirest',
   title: 'Unirest',
   link: 'http://unirest.io/nodejs.html',
-  description: 'Lightweight HTTP Request Client Library'
-}
+  description: 'Lightweight HTTP Request Client Library',
+};

package/src/targets/objc/helpers.js

@@ -1,6 +1,4 @@
-'use strict'
-
-const util = require('util')
+const { format } = require('util');
 
 module.exports = {
   /**
@@ -10,7 +8,8 @@ module.exports = {
    * @return {string}
    */
   blankString: function (length) {
-    return Array.apply(null, new Array(length)).map(String.prototype.valueOf, ' ').join('')
+    // eslint-disable-next-line prefer-spread
+    return Array.apply(null, new Array(length)).map(String.prototype.valueOf, ' ').join('');
   },
 
   /**
@@ -33,9 +32,9 @@ module.exports = {
    *   NSDictionary *params = @{ @"a": @"b", @"c": @"d" };
    */
   nsDeclaration: function (nsClass, name, parameters, indent) {
-    const opening = nsClass + ' *' + name + ' = '
-    const literal = this.literalRepresentation(parameters, indent ? opening.length : undefined)
-    return opening + literal + ';'
+    const opening = `${nsClass} *${name} = `;
+    const literal = this.literalRepresentation(parameters, indent ? opening.length : undefined);
+    return `${opening + literal};`;
   },
 
   /**
@@ -45,35 +44,37 @@ module.exports = {
    * @return {string}
    */
   literalRepresentation: function (value, indentation) {
-    const join = indentation === undefined ? ', ' : ',\n   ' + this.blankString(indentation)
+    const join = indentation === undefined ? ', ' : `,\n   ${this.blankString(indentation)}`;
 
     switch (Object.prototype.toString.call(value)) {
       case '[object Number]':
-        return '@' + value
+        return `@${value}`;
 
       case '[object Array]': {
-        const valuesRepresentation = value.map(function (v) {
-          return this.literalRepresentation(v)
-        }.bind(this))
-        return '@[ ' + valuesRepresentation.join(join) + ' ]'
+        const valuesRepresentation = value.map(
+          function (v) {
+            return this.literalRepresentation(v);
+          }.bind(this)
+        );
+        return `@[ ${valuesRepresentation.join(join)} ]`;
       }
 
       case '[object Object]': {
-        const keyValuePairs = []
-        for (const k in value) {
-          keyValuePairs.push(util.format('@"%s": %s', k, this.literalRepresentation(value[k])))
-        }
-        return '@{ ' + keyValuePairs.join(join) + ' }'
+        const keyValuePairs = [];
+        Object.keys(value).forEach(k => {
+          keyValuePairs.push(format('@"%s": %s', k, this.literalRepresentation(value[k])));
+        });
+        return `@{ ${keyValuePairs.join(join)} }`;
       }
 
       case '[object Boolean]':
-        return value ? '@YES' : '@NO'
+        return value ? '@YES' : '@NO';
 
       default:
         if (value === null || value === undefined) {
-          return ''
+          return '';
         }
-        return '@"' + value.toString().replace(/"/g, '\\"') + '"'
+        return `@"${value.toString().replace(/"/g, '\\"')}"`;
     }
-  }
-}
+  },
+};

package/src/targets/objc/index.js

@@ -1,12 +1,10 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'objc',
     title: 'Objective-C',
     extname: '.m',
-    default: 'nsurlsession'
+    default: 'nsurlsession',
   },
 
-  nsurlsession: require('./nsurlsession')
-}
+  nsurlsession: require('./nsurlsession'),
+};

package/src/targets/objc/nsurlsession.js

@@ -8,65 +8,73 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-const helpers = require('./helpers')
-const CodeBuilder = require('../../helpers/code-builder')
+const helpers = require('./helpers');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  const opts = Object.assign({
+  const opts = {
     indent: '    ',
     pretty: true,
-    timeout: '10'
-  }, options)
+    timeout: '10',
+    ...options,
+  };
 
-  const code = new CodeBuilder(opts.indent)
+  const code = new CodeBuilder(opts.indent);
   // Markers for headers to be created as literal objects and later be set on the NSURLRequest if exist
   const req = {
     hasHeaders: false,
-    hasBody: false
-  }
+    hasBody: false,
+  };
 
   // We just want to make sure people understand that is the only dependency
-  code.push('#import <Foundation/Foundation.h>')
+  code.push('#import <Foundation/Foundation.h>');
 
   if (Object.keys(source.allHeaders).length) {
-    req.hasHeaders = true
-    code.blank()
-      .push(helpers.nsDeclaration('NSDictionary', 'headers', source.allHeaders, opts.pretty))
+    req.hasHeaders = true;
+    code.blank().push(helpers.nsDeclaration('NSDictionary', 'headers', source.allHeaders, opts.pretty));
   }
 
   if (source.postData.text || source.postData.jsonObj || source.postData.params) {
-    req.hasBody = true
+    req.hasBody = true;
 
     switch (source.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.
-        code.blank()
-          .push('NSMutableData *postData = [[NSMutableData alloc] initWithData:[@"%s=%s" dataUsingEncoding:NSUTF8StringEncoding]];',
-            source.postData.params[0].name, source.postData.params[0].value)
+        code
+          .blank()
+          .push(
+            'NSMutableData *postData = [[NSMutableData alloc] initWithData:[@"%s=%s" dataUsingEncoding:NSUTF8StringEncoding]];',
+            source.postData.params[0].name,
+            source.postData.params[0].value
+          );
 
+        // eslint-disable-next-line no-plusplus
         for (let i = 1, len = source.postData.params.length; i < len; i++) {
-          code.push('[postData appendData:[@"&%s=%s" dataUsingEncoding:NSUTF8StringEncoding]];',
-            source.postData.params[i].name, source.postData.params[i].value)
+          code.push(
+            '[postData appendData:[@"&%s=%s" dataUsingEncoding:NSUTF8StringEncoding]];',
+            source.postData.params[i].name,
+            source.postData.params[i].value
+          );
         }
-        break
+        break;
 
       case 'application/json':
         if (source.postData.jsonObj) {
-          code.push(helpers.nsDeclaration('NSDictionary', 'parameters', source.postData.jsonObj, opts.pretty))
+          code
+            .push(helpers.nsDeclaration('NSDictionary', 'parameters', source.postData.jsonObj, opts.pretty))
             .blank()
-            .push('NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];')
+            .push('NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];');
         }
-        break
+        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.
-        code.push(helpers.nsDeclaration('NSArray', 'parameters', source.postData.params, opts.pretty))
+        code
+          .push(helpers.nsDeclaration('NSArray', 'parameters', source.postData.params, opts.pretty))
           .push('NSString *boundary = @"%s";', source.postData.boundary)
           .blank()
           .push('NSError *error;')
@@ -74,9 +82,15 @@ module.exports = function (source, options) {
           .push('for (NSDictionary *param in parameters) {')
           .push(1, '[body appendFormat:@"--%@\\r\\n", boundary];')
           .push(1, 'if (param[@"fileName"]) {')
-          .push(2, '[body appendFormat:@"Content-Disposition:form-data; name=\\"%@\\"; filename=\\"%@\\"\\r\\n", param[@"name"], param[@"fileName"]];')
+          .push(
+            2,
+            '[body appendFormat:@"Content-Disposition:form-data; name=\\"%@\\"; filename=\\"%@\\"\\r\\n", param[@"name"], param[@"fileName"]];'
+          )
           .push(2, '[body appendFormat:@"Content-Type: %@\\r\\n\\r\\n", param[@"contentType"]];')
-          .push(2, '[body appendFormat:@"%@", [NSString stringWithContentsOfFile:param[@"fileName"] encoding:NSUTF8StringEncoding error:&error]];')
+          .push(
+            2,
+            '[body appendFormat:@"%@", [NSString stringWithContentsOfFile:param[@"fileName"] encoding:NSUTF8StringEncoding error:&error]];'
+          )
           .push(2, 'if (error) {')
           .push(3, 'NSLog(@"%@", error);')
           .push(2, '}')
@@ -86,51 +100,65 @@ module.exports = function (source, options) {
           .push(1, '}')
           .push('}')
           .push('[body appendFormat:@"\\r\\n--%@--\\r\\n", boundary];')
-          .push('NSData *postData = [body dataUsingEncoding:NSUTF8StringEncoding];')
-        break
+          .push('NSData *postData = [body dataUsingEncoding:NSUTF8StringEncoding];');
+        break;
 
       default:
-        code.blank()
-          .push('NSData *postData = [[NSData alloc] initWithData:[@"' + source.postData.text + '" dataUsingEncoding:NSUTF8StringEncoding]];')
+        code
+          .blank()
+          .push(
+            `NSData *postData = [[NSData alloc] initWithData:[@"${source.postData.text}" dataUsingEncoding:NSUTF8StringEncoding]];`
+          );
     }
   }
 
-  code.blank()
-    .push('NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"' + source.fullUrl + '"]')
+  code
+    .blank()
+    .push(
+      `NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"${source.fullUrl}"]`
+    )
     // NSURLRequestUseProtocolCachePolicy is the default policy, let's just always set it to avoid confusion.
     .push('                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy')
-    .push('                                                   timeoutInterval:' + parseInt(opts.timeout, 10).toFixed(1) + '];')
-    .push('[request setHTTPMethod:@"' + source.method + '"];')
+    .push(
+      `                                                   timeoutInterval:${parseInt(opts.timeout, 10).toFixed(1)}];`
+    )
+    .push(`[request setHTTPMethod:@"${source.method}"];`);
 
   if (req.hasHeaders) {
-    code.push('[request setAllHTTPHeaderFields:headers];')
+    code.push('[request setAllHTTPHeaderFields:headers];');
   }
 
   if (req.hasBody) {
-    code.push('[request setHTTPBody:postData];')
+    code.push('[request setHTTPBody:postData];');
   }
 
-  code.blank()
+  code
+    .blank()
     // Retrieving the shared session will be less verbose than creating a new one.
     .push('NSURLSession *session = [NSURLSession sharedSession];')
     .push('NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request')
-    .push('                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {')
+    .push(
+      '                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {'
+    )
     .push(1, '                                            if (error) {')
     .push(2, '                                            NSLog(@"%@", error);')
     .push(1, '                                            } else {')
     // Casting the NSURLResponse to NSHTTPURLResponse so the user can see the status     .
-    .push(2, '                                            NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;')
+    .push(
+      2,
+      '                                            NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;'
+    )
     .push(2, '                                            NSLog(@"%@", httpResponse);')
     .push(1, '                                            }')
     .push('                                            }];')
-    .push('[dataTask resume];')
+    .push('[dataTask resume];');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'nsurlsession',
   title: 'NSURLSession',
   link: 'https://developer.apple.com/library/mac/documentation/Foundation/Reference/NSURLSession_class/index.html',
-  description: 'Foundation\'s NSURLSession request'
-}
+  description: "Foundation's NSURLSession request",
+};