@readme/httpsnippet 2.4.5 → 3.0.1

package/src/targets/objc/nsurlsession.js

@@ -8,128 +8,157 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-var helpers = require('./helpers')
-var CodeBuilder = require('../../helpers/code-builder')
+const helpers = require('./helpers');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  var opts = Object.assign({
+  const opts = {
     indent: '    ',
     pretty: true,
-    timeout: '10'
-  }, options)
+    timeout: '10',
+    ...options,
+  };
 
-  var code = new CodeBuilder(opts.indent)
-  // Markers for headers to be created as litteral objects and later be set on the NSURLRequest if exist
-  var req = {
+  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)
-        for (var 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
+          .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
+          );
         }
-        break
+        break;
 
       case 'application/json':
         if (source.postData.jsonObj) {
-          code.push(helpers.nsDeclaration('NSDictionary', 'parameters', source.postData.jsonObj, opts.pretty))
-              .blank()
-              .push('NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];')
+          code
+            .push(helpers.nsDeclaration('NSDictionary', 'parameters', source.postData.jsonObj, opts.pretty))
+            .blank()
+            .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))
-            .push('NSString *boundary = @"%s";', source.postData.boundary)
-            .blank()
-            .push('NSError *error;')
-            .push('NSMutableString *body = [NSMutableString string];')
-            .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-Type: %@\\r\\n\\r\\n", param[@"contentType"]];')
-            .push(2, '[body appendFormat:@"%@", [NSString stringWithContentsOfFile:param[@"fileName"] encoding:NSUTF8StringEncoding error:&error]];')
-            .push(2, 'if (error) {')
-            .push(3, 'NSLog(@"%@", error);')
-            .push(2, '}')
-            .push(1, '} else {')
-            .push(2, '[body appendFormat:@"Content-Disposition:form-data; name=\\"%@\\"\\r\\n\\r\\n", param[@"name"]];')
-            .push(2, '[body appendFormat:@"%@", param[@"value"]];')
-            .push(1, '}')
-            .push('}')
-            .push('[body appendFormat:@"\\r\\n--%@--\\r\\n", boundary];')
-            .push('NSData *postData = [body dataUsingEncoding:NSUTF8StringEncoding];')
-        break
+        code
+          .push(helpers.nsDeclaration('NSArray', 'parameters', source.postData.params, opts.pretty))
+          .push('NSString *boundary = @"%s";', source.postData.boundary)
+          .blank()
+          .push('NSError *error;')
+          .push('NSMutableString *body = [NSMutableString string];')
+          .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-Type: %@\\r\\n\\r\\n", param[@"contentType"]];')
+          .push(
+            2,
+            '[body appendFormat:@"%@", [NSString stringWithContentsOfFile:param[@"fileName"] encoding:NSUTF8StringEncoding error:&error]];'
+          )
+          .push(2, 'if (error) {')
+          .push(3, 'NSLog(@"%@", error);')
+          .push(2, '}')
+          .push(1, '} else {')
+          .push(2, '[body appendFormat:@"Content-Disposition:form-data; name=\\"%@\\"\\r\\n\\r\\n", param[@"name"]];')
+          .push(2, '[body appendFormat:@"%@", param[@"value"]];')
+          .push(1, '}')
+          .push('}')
+          .push('[body appendFormat:@"\\r\\n--%@--\\r\\n", boundary];')
+          .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 + '"]')
-      // 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 + '"];')
+  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}"];`);
 
   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()
-      // 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(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, '                                            NSLog(@"%@", httpResponse);')
-      .push(1, '                                            }')
-      .push('                                            }];')
-      .push('[dataTask resume];')
-
-  return code.join()
-}
+  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(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, '                                            NSLog(@"%@", httpResponse);')
+    .push(1, '                                            }')
+    .push('                                            }];')
+    .push('[dataTask resume];');
+
+  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",
+};

package/src/targets/ocaml/cohttp.js

@@ -8,64 +8,66 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-var CodeBuilder = require('../../helpers/code-builder')
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  var opts = Object.assign({
-    indent: '  '
-  }, options)
+  const opts = {
+    indent: '  ',
+    ...options,
+  };
 
-  var methods = ['get', 'post', 'head', 'delete', 'patch', 'put', 'options']
-  var code = new CodeBuilder(opts.indent)
+  const methods = ['get', 'post', 'head', 'delete', 'patch', 'put', 'options'];
+  const code = new CodeBuilder(opts.indent);
 
-  code.push('open Cohttp_lwt_unix')
-      .push('open Cohttp')
-      .push('open Lwt')
-      .blank()
-      .push('let uri = Uri.of_string "%s" in', source.fullUrl)
+  code
+    .push('open Cohttp_lwt_unix')
+    .push('open Cohttp')
+    .push('open Lwt')
+    .blank()
+    .push('let uri = Uri.of_string "%s" in', source.fullUrl);
 
   // Add headers, including the cookies
-  var headers = Object.keys(source.allHeaders)
+  const headers = Object.keys(source.allHeaders);
 
   if (headers.length === 1) {
-    code.push('let headers = Header.add (Header.init ()) "%s" "%s" in', headers[0], source.allHeaders[headers[0]])
+    code.push('let headers = Header.add (Header.init ()) "%s" "%s" in', headers[0], source.allHeaders[headers[0]]);
   } else if (headers.length > 1) {
-    code.push('let headers = Header.add_list (Header.init ()) [')
+    code.push('let headers = Header.add_list (Header.init ()) [');
 
     headers.forEach(function (key) {
-      code.push(1, '("%s", "%s");', key, source.allHeaders[key])
-    })
+      code.push(1, '("%s", "%s");', key, source.allHeaders[key]);
+    });
 
-    code.push('] in')
+    code.push('] in');
   }
 
   // Add body
   if (source.postData.text) {
     // Just text
-    code.push('let body = Cohttp_lwt_body.of_string %s in', JSON.stringify(source.postData.text))
+    code.push('let body = Cohttp_lwt_body.of_string %s in', JSON.stringify(source.postData.text));
   }
 
   // Do the request
-  code.blank()
+  code.blank();
 
-  code.push('Client.call %s%s%s uri',
+  code.push(
+    'Client.call %s%s%s uri',
     headers.length ? '~headers ' : '',
     source.postData.text ? '~body ' : '',
-    (methods.indexOf(source.method.toLowerCase()) >= 0 ? ('`' + source.method.toUpperCase()) : '(Code.method_of_string "' + source.method + '")')
-  )
+    methods.indexOf(source.method.toLowerCase()) >= 0
+      ? `\`${source.method.toUpperCase()}`
+      : `(Code.method_of_string "${source.method}")`
+  );
 
   // Catch result
-  code.push('>>= fun (res, body_stream) ->')
-      .push(1, '(* Do stuff with the result *)')
+  code.push('>>= fun (res, body_stream) ->').push(1, '(* Do stuff with the result *)');
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'cohttp',
   title: 'CoHTTP',
   link: 'https://github.com/mirage/ocaml-cohttp',
-  description: 'Cohttp is a very lightweight HTTP server using Lwt or Async for OCaml'
-}
+  description: 'Cohttp is a very lightweight HTTP server using Lwt or Async for OCaml',
+};

package/src/targets/ocaml/index.js

@@ -1,12 +1,10 @@
-'use strict'
-
 module.exports = {
   info: {
     key: 'ocaml',
     title: 'OCaml',
     extname: '.ml',
-    default: 'cohttp'
+    default: 'cohttp',
   },
 
-  cohttp: require('./cohttp')
-}
+  cohttp: require('./cohttp'),
+};

package/src/targets/php/curl.js

@@ -8,101 +8,108 @@
  * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
  */
 
-'use strict'
-
-var util = require('util')
-var CodeBuilder = require('../../helpers/code-builder')
+const { format } = require('util');
+const CodeBuilder = require('../../helpers/code-builder');
 
 module.exports = function (source, options) {
-  var opts = Object.assign({
+  const opts = {
     closingTag: false,
     indent: '  ',
     maxRedirects: 10,
     namedErrors: false,
     noTags: false,
     shortTags: false,
-    timeout: 30
-  }, options)
+    timeout: 30,
+    ...options,
+  };
 
-  var code = new CodeBuilder(opts.indent)
+  const code = new CodeBuilder(opts.indent);
 
   if (!opts.noTags) {
-    code.push(opts.shortTags ? '<?' : '<?php')
-      .blank()
+    code.push(opts.shortTags ? '<?' : '<?php').blank();
   }
 
-  code.push('$curl = curl_init();')
-    .blank()
-
-  var curlOptions = [{
-    escape: true,
-    name: 'CURLOPT_PORT',
-    value: source.uriObj.port
-  }, {
-    escape: true,
-    name: 'CURLOPT_URL',
-    value: source.fullUrl
-  }, {
-    escape: false,
-    name: 'CURLOPT_RETURNTRANSFER',
-    value: 'true'
-  }, {
-    escape: true,
-    name: 'CURLOPT_ENCODING',
-    value: ''
-  }, {
-    escape: false,
-    name: 'CURLOPT_MAXREDIRS',
-    value: opts.maxRedirects
-  }, {
-    escape: false,
-    name: 'CURLOPT_TIMEOUT',
-    value: opts.timeout
-  }, {
-    escape: false,
-    name: 'CURLOPT_HTTP_VERSION',
-    value: source.httpVersion === 'HTTP/1.0' ? 'CURL_HTTP_VERSION_1_0' : 'CURL_HTTP_VERSION_1_1'
-  }, {
-    escape: true,
-    name: 'CURLOPT_CUSTOMREQUEST',
-    value: source.method
-  }, {
-    escape: true,
-    name: 'CURLOPT_POSTFIELDS',
-    value: source.postData ? source.postData.text : undefined
-  }]
-
-  code.push('curl_setopt_array($curl, [')
-
-  var curlopts = new CodeBuilder(opts.indent, '\n' + opts.indent)
+  code.push('$curl = curl_init();').blank();
+
+  const curlOptions = [
+    {
+      escape: true,
+      name: 'CURLOPT_PORT',
+      value: source.uriObj.port,
+    },
+    {
+      escape: true,
+      name: 'CURLOPT_URL',
+      value: source.fullUrl,
+    },
+    {
+      escape: false,
+      name: 'CURLOPT_RETURNTRANSFER',
+      value: 'true',
+    },
+    {
+      escape: true,
+      name: 'CURLOPT_ENCODING',
+      value: '',
+    },
+    {
+      escape: false,
+      name: 'CURLOPT_MAXREDIRS',
+      value: opts.maxRedirects,
+    },
+    {
+      escape: false,
+      name: 'CURLOPT_TIMEOUT',
+      value: opts.timeout,
+    },
+    {
+      escape: false,
+      name: 'CURLOPT_HTTP_VERSION',
+      value: source.httpVersion === 'HTTP/1.0' ? 'CURL_HTTP_VERSION_1_0' : 'CURL_HTTP_VERSION_1_1',
+    },
+    {
+      escape: true,
+      name: 'CURLOPT_CUSTOMREQUEST',
+      value: source.method,
+    },
+    {
+      escape: true,
+      name: 'CURLOPT_POSTFIELDS',
+      value: source.postData ? source.postData.text : undefined,
+    },
+  ];
+
+  code.push('curl_setopt_array($curl, [');
+
+  const curlopts = new CodeBuilder(opts.indent, `\n${opts.indent}`);
 
   curlOptions.forEach(function (option) {
-    if (!~[null, undefined].indexOf(option.value)) {
-      curlopts.push(util.format('%s => %s,', option.name, option.escape ? JSON.stringify(option.value) : option.value))
+    if (![null, undefined].includes(option.value)) {
+      curlopts.push(format('%s => %s,', option.name, option.escape ? JSON.stringify(option.value) : option.value));
     }
-  })
+  });
 
   // construct cookies
-  var cookies = source.cookies.map(function (cookie) {
-    return encodeURIComponent(cookie.name) + '=' + encodeURIComponent(cookie.value)
-  })
-
-  if (cookies.length) {
-    curlopts.push(util.format('CURLOPT_COOKIE => "%s",', cookies.join('; ')))
+  if (source.allHeaders.cookie) {
+    curlopts.push(format('CURLOPT_COOKIE => "%s",', source.allHeaders.cookie));
   }
 
   // construct cookies
-  var headers = Object.keys(source.headersObj).sort().map(function (key) {
-    return util.format('"%s: %s"', key, source.headersObj[key])
-  })
+  const headers = Object.keys(source.headersObj)
+    .sort()
+    .map(function (key) {
+      return format('"%s: %s"', key, source.headersObj[key]);
+    });
 
   if (headers.length) {
-    curlopts.push('CURLOPT_HTTPHEADER => [')
-      .push(1, headers.join(',\n' + opts.indent + opts.indent))
-      .push('],')
+    curlopts
+      .push('CURLOPT_HTTPHEADER => [')
+      .push(1, headers.join(`,\n${opts.indent}${opts.indent}`))
+      .push('],');
   }
 
-  code.push(1, curlopts.join())
+  code
+    .push(1, curlopts.join())
     .push(']);')
     .blank()
     .push('$response = curl_exec($curl);')
@@ -110,29 +117,26 @@ module.exports = function (source, options) {
     .blank()
     .push('curl_close($curl);')
     .blank()
-    .push('if ($err) {')
+    .push('if ($err) {');
 
   if (opts.namedErrors) {
-    code.push(1, 'echo array_flip(get_defined_constants(true)["curl"])[$err];')
+    code.push(1, 'echo array_flip(get_defined_constants(true)["curl"])[$err];');
   } else {
-    code.push(1, 'echo "cURL Error #:" . $err;')
+    code.push(1, 'echo "cURL Error #:" . $err;');
   }
 
-  code.push('} else {')
-    .push(1, 'echo $response;')
-    .push('}')
+  code.push('} else {').push(1, 'echo $response;').push('}');
 
   if (!opts.noTags && opts.closingTag) {
-    code.blank()
-      .push('?>')
+    code.blank().push('?>');
   }
 
-  return code.join()
-}
+  return code.join();
+};
 
 module.exports.info = {
   key: 'curl',
   title: 'cURL',
   link: 'http://php.net/manual/en/book.curl.php',
-  description: 'PHP with ext-curl'
-}
+  description: 'PHP with ext-curl',
+};