Merge pull request #16 from thibaultCha/feature/objc/native

objc: rewrote native with improved syntax

Author: ahmadnassri

README.md

@@ -24,7 +24,7 @@ See it in action on companion service: [APIembed](https://apiembed.com/)
 
 ## Targets
 
-currently the following output [targets](/src/targets) are supported:
+Currently the following output [targets](/src/targets) are supported:
 
 - [cURL](http://curl.haxx.se/)
 - [Go](http://golang.org/pkg/net/http/#NewRequest)
@@ -41,6 +41,8 @@ currently the following output [targets](/src/targets) are supported:
 - Python
   - [Python 3](https://docs.python.org/3/library/http.client.html)
 - [Wget](https://www.gnu.org/software/wget/)
+- Objective-C
+  - [NSURLSession](https://developer.apple.com/library/mac/documentation/Foundation/Reference/NSURLSession_class/index.html)
 
 ## Installation
 
@@ -102,6 +104,7 @@ process single file (assumes [HAR Request Object](http://www.softwareishard.com/
   }
 }
 ```
+
 ```shell
 httpsnippet my-api-endpoint.json --target php --output ./snippets
 ```
@@ -149,7 +152,7 @@ console.log(snippet.convert('curl', {
   indent: '\t';
 }));
 
-// generate nodeJS output
+// generate Node.js output
 console.log(snippet.convert('node'));
 
 // generate PHP output
@@ -223,6 +226,16 @@ module.exports.info = {
 | `indent`  | `  `    | line break & indent output value, set to `false` to disable line breaks  |
 | `verbose` | `false` | by default, `--quiet` is always used, unless `verbose` is set to `true`  |
 
+### Objective-C
+
+##### Native
+
+| Option    | Default | Description                                                              |
+| --------- | ------- | ------------------------------------------------------------------------ |
+| `timeout` | `10`    | NSURLRequest timeout                                                     |
+| `indent`  | `  `    | line break & indent output value, set to `false` to disable line         |
+| `pretty`  | `true`  | indent extracted headers/parameters in `NSDictionary` litterals          |
+
 ## Bugs and feature requests
 
 Have a bug or a feature request? Please first read the [issue guidelines](CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](/issues).

src/index.js

@@ -88,6 +88,7 @@ var HTTPSnippet = function (req, lang) {
           this.source.postData.text += data
         }.bind(this)))
 
+        this.source.postData.boundary = form.getBoundary()
         this.source.headersObj['content-type'] = 'multipart/form-data; boundary=' + form.getBoundary()
         break
 

src/targets/index.js

@@ -1,3 +1,3 @@
 'use strict'
 
-module.exports = require('require-directory')(module)
+module.exports = require('require-directory')(module, { exclude: /helpers\.js$/ })

src/targets/objc/helpers.js

@@ -0,0 +1,77 @@
+'use strict'
+
+var util = require('util')
+
+module.exports = {
+  /**
+   * Create an string of given length filled with blank spaces
+   *
+   * @param {number} length Length of the array to return
+   * @return {string}
+   */
+  blankString: function (length) {
+    return Array.apply(null, new Array(length)).map(String.prototype.valueOf, ' ').join('')
+  },
+
+  /**
+   * Create a string corresponding to a valid NSDictionary declaration and initialization for Objective-C.
+   *
+   * @param {string} name Desired name of the NSDictionary instance
+   * @param {Object} parameters Key-value object of parameters to translate to an Objective-C NSDictionary litearal
+   * @param {boolean} indent If true, will declare the NSDictionary litteral by indenting each new key/value pair.
+   * @return {string} A valid Objective-C declaration and initialization of an NSDictionary.
+   *
+   * @example
+   *   nsDictionaryBuilder('params', {a: 'b', c: 'd'}, true)
+   *   // returns:
+   *   NSDictionary *params = @{ @"a": @"b",
+   *                             @"c": @"d" };
+   *
+   *   nsDictionaryBuilder('params', {a: 'b', c: 'd'})
+   *   // returns:
+   *   NSDictionary *params = @{ @"a": @"b", @"c": @"d" };
+   */
+  nsDictionaryBuilder: function (name, parameters, indent) {
+    var dicOpening = 'NSDictionary *' + name + ' = '
+    var dicLiteral = this.literalRepresentation(parameters, indent ? dicOpening.length : undefined)
+    return dicOpening + dicLiteral + ';'
+  },
+
+  /**
+   * Similar to nsDictionaryBuilder but for NSArray literals.
+   * @see nsDictionaryBuilder
+   */
+  nsArrayBuilder: function (name, parameters, indent) {
+    var arrOpening = 'NSArray *' + name + ' = '
+    var arrLiteral = this.literalRepresentation(parameters, indent ? arrOpening.length : undefined)
+    return arrOpening + arrLiteral + ';'
+  },
+
+  /**
+   * Create a valid Objective-C string of a literal value according to its type.
+   *
+   * @param {*} value Any JavaScript literal
+   * @return {string}
+   */
+  literalRepresentation: function (value, indentation) {
+    var join = indentation === undefined ? ', ' : ',\n   ' + this.blankString(indentation)
+
+    switch (Object.prototype.toString.call(value)) {
+      case '[object Number]':
+        return '@' + value
+      case '[object Array]':
+        var values_representation = value.map(function (v) {
+          return this.literalRepresentation(v)
+        }.bind(this))
+        return '@[ ' + values_representation.join(join) + ' ]'
+      case '[object Object]':
+        var keyValuePairs = []
+        for (var k in value) {
+          keyValuePairs.push(util.format('@"%s": %s', k, this.literalRepresentation(value[k])))
+        }
+        return '@{ ' + keyValuePairs.join(join) + ' }'
+      default:
+        return '@"' + value.replace(/"/g, '\\"') + '"'
+    }
+  }
+}

src/targets/objc/native.js

@@ -1,58 +1,109 @@
 'use strict'
 
 var util = require('util')
+var objcHelpers = require('./helpers')
 
 module.exports = function (source, options) {
   var opts = util._extend({
-    timeout: '10'
+    timeout: '10',
+    indent: '    ',
+    pretty: true
   }, options)
 
   var code = []
 
-  // Dependencies
+  var req = {
+    hasHeaders: false,
+    hasBody: false
+  }
+
+  var indent = opts.indent
+
   code.push('#import <Foundation/Foundation.h>')
+
+  if (Object.keys(source.allHeaders).length) {
+    req.hasHeaders = true
+    code.push(null)
+    code.push(objcHelpers.nsDictionaryBuilder('headers', source.allHeaders, opts.pretty))
+  }
+
+  if (source.postData.text || source.postData.jsonObj || source.postData.params) {
+    req.hasBody = true
+
+    switch (source.postData.mimeType) {
+      case 'application/x-www-form-urlencoded':
+        code.push(null)
+        // Makes it easier to implement logice than just putting the entire body string
+        code.push(util.format('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(util.format('[postData appendData:[@"&%s=%s" dataUsingEncoding:NSUTF8StringEncoding]];', source.postData.params[i].name, source.postData.params[i].value))
+        }
+        break
+
+      case 'application/json':
+        if (source.postData.jsonObj) {
+          code.push(objcHelpers.nsDictionaryBuilder('parameters', source.postData.jsonObj, opts.pretty))
+          code.push(null)
+          code.push('NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];')
+        }
+        break
+
+      case 'multipart/form-data':
+        code.push(objcHelpers.nsArrayBuilder('parameters', source.postData.params, opts.pretty))
+        code.push(util.format('NSString *boundary = @"%s";', source.postData.boundary))
+        code.push(null)
+        code.push('NSError *error;')
+        code.push('NSMutableString *body = [NSMutableString string];')
+        code.push('for (NSDictionary *param in parameters) {')
+        code.push(indent + '[body appendFormat:@"--%@\\r\\n", boundary];')
+        code.push(indent + 'if (param[@"fileName"]) {')
+        code.push(indent + indent + '[body appendFormat:@"Content-Disposition:form-data; name=\\"%@\\"; filename=\\"%@\\"\\r\\n", param[@"name"], param[@"fileName"]];')
+        code.push(indent + indent + '[body appendFormat:@"Content-Type: %@\\r\\n\\r\\n", param[@"contentType"]];')
+        code.push(indent + indent + '[body appendFormat:@"%@", [[NSString alloc] initWithContentsOfFile:param[@"fileName"]')
+        code.push(indent + indent + '                                                          encoding:NSUTF8StringEncoding error:&error]];')
+        code.push(indent + indent + 'if (error) {')
+        code.push(indent + indent + indent + 'NSLog(@"%@", error);')
+        code.push(indent + indent + '}')
+        code.push(indent + '} else {')
+        code.push(indent + indent + '[body appendFormat:@"Content-Disposition:form-data; name=\\"%@\\"\\r\\n\\r\\n", param[@"name"]];')
+        code.push(indent + indent + '[body appendFormat:@"%@", param[@"value"]];')
+        code.push(indent + '}')
+        code.push('}')
+        code.push('[body appendFormat:@"\\r\\n--%@--\\r\\n", boundary];')
+        code.push('NSData *postData = [[NSData alloc] initWithData:[body dataUsingEncoding:NSUTF8StringEncoding]];')
+        break
+
+      default:
+        code.push(null)
+        code.push('NSData *postData = [[NSData alloc] initWithData:[@"' + source.postData.text + '" dataUsingEncoding:NSUTF8StringEncoding]];')
+    }
+  }
+
   code.push(null)
-  code.push('NSURLSession *session = [NSURLSession sharedSession];')
-  code.push(null)
-  // Create request object
   code.push('NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"' + source.fullUrl + '"]')
   code.push('                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy')
   code.push('                                                   timeoutInterval:' + parseInt(opts.timeout, 10).toFixed(1) + '];')
   code.push('[request setHTTPMethod:@"' + source.method + '"];')
 
-  // Set headers
-  Object.keys(source.allHeaders).sort().map(function (key) {
-    code.push('[request setValue:@"' + source.allHeaders[key] + '" forHTTPHeaderField:@"' + key + '"];')
-  })
-
-  // Set request body
-  if (source.postData && (source.postData.params || source.postData.text)) {
-    code.push(null)
-
-    if (source.postData.mimeType === 'application/x-www-form-urlencoded' && source.postData.params) {
-      var params = source.postData.params
-      code.push('NSMutableData *postData = [[NSMutableData alloc] initWithData:[@"' + params[0].name + '=' + params[0].value + '" dataUsingEncoding:NSUTF8StringEncoding]];')
-      for (var i = 1, len = params.length; i < len; i++) {
-        code.push('[postData appendData:[@"&' + params[i].name + '=' + params[i].value + '" dataUsingEncoding:NSUTF8StringEncoding]];')
-      }
-    } else if (source.postData.mimeType === 'application/json' && source.postData.text) {
-      code.push('NSData *postData = [[NSData alloc] initWithData:[@' + JSON.stringify(source.postData.text) + ' dataUsingEncoding:NSUTF8StringEncoding]];')
-    } else if (source.postData.text) {
-      code.push('NSData *postData = [[NSData alloc] initWithData:[@"' + source.postData.text + '" dataUsingEncoding:NSUTF8StringEncoding]];')
-    }
+  if (req.hasHeaders) {
+    code.push('[request setAllHTTPHeaderFields:headers];')
+  }
 
+  if (req.hasBody) {
     code.push('[request setHTTPBody:postData];')
   }
 
-  // Set completion block
   code.push(null)
+  code.push('NSURLSession *session = [NSURLSession sharedSession];') // Retrieve shared session for simplicity
   code.push('NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request')
   code.push('                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {')
-  code.push(null)
-  code.push('}];')
-
-  // Start request
-  code.push(null)
+  code.push('                                            ' + indent + 'if (error) {')
+  code.push('                                            ' + indent + indent + 'NSLog(@"%@", error);')
+  code.push('                                            ' + indent + '} else {')
+  code.push('                                            ' + indent + indent + 'NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;')
+  code.push('                                            ' + indent + indent + 'NSLog(@"%@", httpResponse);')
+  code.push('                                            ' + indent + '}')
+  code.push('                                            }];')
   code.push('[dataTask resume];')
 
   return code.join('\n')
@@ -62,5 +113,5 @@ module.exports.info = {
   key: 'native',
   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'
 }

test/fixtures/output/objc/native/application-form-encoded.m

@@ -1,20 +1,25 @@
 #import <Foundation/Foundation.h>
 
-NSURLSession *session = [NSURLSession sharedSession];
+NSDictionary *headers = @{ @"content-type": @"application/x-www-form-urlencoded" };
+
+NSMutableData *postData = [[NSMutableData alloc] initWithData:[@"foo=bar" dataUsingEncoding:NSUTF8StringEncoding]];
+[postData appendData:[@"&hello=world" dataUsingEncoding:NSUTF8StringEncoding]];
 
 NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"http://mockbin.com/har"]
                                                        cachePolicy:NSURLRequestUseProtocolCachePolicy
                                                    timeoutInterval:10.0];
 [request setHTTPMethod:@"POST"];
-[request setValue:@"application/x-www-form-urlencoded" forHTTPHeaderField:@"content-type"];
-
-NSMutableData *postData = [[NSMutableData alloc] initWithData:[@"foo=bar" dataUsingEncoding:NSUTF8StringEncoding]];
-[postData appendData:[@"&hello=world" dataUsingEncoding:NSUTF8StringEncoding]];
+[request setAllHTTPHeaderFields:headers];
 [request setHTTPBody:postData];
 
+NSURLSession *session = [NSURLSession sharedSession];
 NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
                                             completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
-
-}];
-
+                                                if (error) {
+                                                    NSLog(@"%@", error);
+                                                } else {
+                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
+                                                    NSLog(@"%@", httpResponse);
+                                                }
+                                            }];
 [dataTask resume];

test/fixtures/output/objc/native/application-json.m

@@ -1,19 +1,29 @@
 #import <Foundation/Foundation.h>
 
-NSURLSession *session = [NSURLSession sharedSession];
+NSDictionary *headers = @{ @"content-type": @"application/json" };
+NSDictionary *parameters = @{ @"number": @1,
+                              @"string": @"f\"oo",
+                              @"arr": @[ @1, @2, @3 ],
+                              @"nested": @{ @"a": @"b" },
+                              @"arr_mix": @[ @1, @"a", @{ @"arr_mix_nested": @{  } } ] };
+
+NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
 
 NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"http://mockbin.com/har"]
                                                        cachePolicy:NSURLRequestUseProtocolCachePolicy
                                                    timeoutInterval:10.0];
 [request setHTTPMethod:@"POST"];
-[request setValue:@"application/json" forHTTPHeaderField:@"content-type"];
-
-NSData *postData = [[NSData alloc] initWithData:[@"{\"number\": 1, \"string\": \"f\\\"oo\", \"arr\": [1, 2, 3], \"nested\": {\"a\": \"b\"}, \"arr_mix\": [1, \"a\", {\"arr_mix_nested\": {}}] }" dataUsingEncoding:NSUTF8StringEncoding]];
+[request setAllHTTPHeaderFields:headers];
 [request setHTTPBody:postData];
 
+NSURLSession *session = [NSURLSession sharedSession];
 NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
                                             completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
-
-}];
-
+                                                if (error) {
+                                                    NSLog(@"%@", error);
+                                                } else {
+                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
+                                                    NSLog(@"%@", httpResponse);
+                                                }
+                                            }];
 [dataTask resume];

test/fixtures/output/objc/native/cookies.m

@@ -1,16 +1,21 @@
 #import <Foundation/Foundation.h>
 
-NSURLSession *session = [NSURLSession sharedSession];
+NSDictionary *headers = @{ @"cookie": @"foo=bar; bar=baz" };
 
 NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"http://mockbin.com/har"]
                                                        cachePolicy:NSURLRequestUseProtocolCachePolicy
                                                    timeoutInterval:10.0];
 [request setHTTPMethod:@"POST"];
-[request setValue:@"foo=bar; bar=baz" forHTTPHeaderField:@"cookie"];
+[request setAllHTTPHeaderFields:headers];
 
+NSURLSession *session = [NSURLSession sharedSession];
 NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
                                             completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
-
-}];
-
+                                                if (error) {
+                                                    NSLog(@"%@", error);
+                                                } else {
+                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
+                                                    NSLog(@"%@", httpResponse);
+                                                }
+                                            }];
 [dataTask resume];