feature silkimen#34: add support for transfering raw string as utf-8 encoded data

Author: Sefa Ilkimen

plugin.xml

@@ -10,9 +10,11 @@
   <dependency id="cordova-plugin-file" version=">=2.0.0"/>
   <js-module src="www/lodash.js" name="lodash"/>
   <js-module src="www/umd-tough-cookie.js" name="tough-cookie"/>
+  <js-module src="www/messages.js" name="messages"/>
   <js-module src="www/local-storage-store.js" name="local-storage-store"/>
   <js-module src="www/cookie-handler.js" name="cookie-handler"/>
   <js-module src="www/angular-integration.js" name="angular-integration"/>
+  <js-module src="www/helpers.js" name="helpers"/>
   <js-module src="www/advanced-http.js" name="http">
     <clobbers target="cordova.plugin.http"/>
   </js-module>
@@ -24,6 +26,7 @@
     </config-file>
     <header-file src="src/ios/CordovaHttpPlugin.h"/>
     <header-file src="src/ios/TextResponseSerializer.h"/>
+    <header-file src="src/ios/TextRequestSerializer.h"/>
     <header-file src="src/ios/AFNetworking/AFHTTPSessionManager.h"/>
     <header-file src="src/ios/AFNetworking/AFNetworking.h"/>
     <header-file src="src/ios/AFNetworking/AFNetworkReachabilityManager.h"/>
@@ -33,6 +36,7 @@
     <header-file src="src/ios/AFNetworking/AFURLSessionManager.h"/>
     <source-file src="src/ios/CordovaHttpPlugin.m"/>
     <source-file src="src/ios/TextResponseSerializer.m"/>
+    <source-file src="src/ios/TextRequestSerializer.m"/>
     <source-file src="src/ios/AFNetworking/AFHTTPSessionManager.m"/>
     <source-file src="src/ios/AFNetworking/AFNetworkReachabilityManager.m"/>
     <source-file src="src/ios/AFNetworking/AFSecurityPolicy.m"/>
@@ -64,4 +68,4 @@
     <source-file src="src/android/com/synconset/cordovahttp/CordovaHttpPatch.java" target-dir="src/com/synconset/cordovahttp"/>
     <source-file src="src/android/com/synconset/cordovahttp/CordovaHttpUpload.java" target-dir="src/com/synconset/cordovahttp"/>
   </platform>
-</plugin>
+</plugin>

src/android/com/synconset/cordovahttp/CordovaHttp.java

@@ -144,7 +144,11 @@ protected HttpRequest setupDataSerializer(HttpRequest request) throws JSONExcept
       if (new String("json").equals(this.getSerializerName())) {
           request.contentType(request.CONTENT_TYPE_JSON, request.CHARSET_UTF8);
           request.send(this.getParamsObject().toString());
-      } else {
+      } else if (new String("utf8").equals(this.getSerializerName())) {
+          request.contentType("text/plain", request.CHARSET_UTF8);
+          request.send(this.getParamsMap().get("text").toString());
+      } else
+      {
           request.form(this.getParamsMap());
       }
 

src/ios/CordovaHttpPlugin.m

@@ -0,0 +1,8 @@
+#import <Foundation/Foundation.h>
+#import "AFURLRequestSerialization.h"
+
+@interface TextRequestSerializer : AFHTTPRequestSerializer
+
++ (instancetype)serializer;
+
+@end

src/ios/TextRequestSerializer.h

@@ -0,0 +1,53 @@
+#import "TextRequestSerializer.h"
+
+@implementation TextRequestSerializer
+
++ (instancetype)serializer
+{
+    TextRequestSerializer *serializer = [[self alloc] init];
+    return serializer;
+}
+
+#pragma mark - AFURLRequestSerialization
+
+- (NSURLRequest *)requestBySerializingRequest:(NSURLRequest *)request
+                               withParameters:(id)parameters
+                                        error:(NSError *__autoreleasing *)error
+{
+    NSParameterAssert(request);
+
+    if ([self.HTTPMethodsEncodingParametersInURI containsObject:[[request HTTPMethod] uppercaseString]]) {
+        return [super requestBySerializingRequest:request withParameters:parameters error:error];
+    }
+
+    NSMutableURLRequest *mutableRequest = [request mutableCopy];
+
+    [self.HTTPRequestHeaders enumerateKeysAndObjectsUsingBlock:^(id field, id value, BOOL * __unused stop) {
+        if (![request valueForHTTPHeaderField:field]) {
+            [mutableRequest setValue:value forHTTPHeaderField:field];
+        }
+    }];
+
+    if (parameters) {
+        if (![mutableRequest valueForHTTPHeaderField:@"Content-Type"]) {
+            [mutableRequest setValue:@"text/plain; charset=utf-8" forHTTPHeaderField:@"Content-Type"];
+        }
+
+        [mutableRequest setHTTPBody: [[parameters valueForKey:@"text"] dataUsingEncoding:NSUTF8StringEncoding]];
+    }
+
+    return mutableRequest;
+}
+
+#pragma mark - NSSecureCoding
+
+- (instancetype)initWithCoder:(NSCoder *)decoder {
+    self = [super initWithCoder:decoder];
+    if (!self) {
+        return nil;
+    }
+
+    return self;
+}
+
+@end

src/ios/TextRequestSerializer.m

@@ -8,6 +8,7 @@ const hooks = {
 const helpers = {
   acceptAllCerts: function(done) { cordova.plugin.http.acceptAllCerts(true, done, done); },
   setJsonSerializer: function(done) { done(cordova.plugin.http.setDataSerializer('json')); },
+  setUtf8StringSerializer: function(done) { done(cordova.plugin.http.setDataSerializer('utf8')); },
   setUrlEncodedSerializer: function(done) { done(cordova.plugin.http.setDataSerializer('urlencoded')); },
   getWithXhr: function(done, url) {
     var xhr = new XMLHttpRequest();
@@ -382,6 +383,17 @@ const tests = [
       cookies.myCookie.should.be.equal('myValue');
       cookies.mySecondCookie.should.be.equal('mySecondValue');
     }
+  },{
+    description: 'should send UTF-8 encoded raw string correctly (POST)',
+    expected: 'resolved: {"status": 200, "data": "{\\"data\\": \\"this is a test string\\"...',
+    before: helpers.setUtf8StringSerializer,
+    func: function(resolve, reject) {
+      cordova.plugin.http.post('http://httpbin.org/anything', 'this is a test string', {}, resolve, reject);
+    },
+    validationFunc: function(driver, result) {
+      result.type.should.be.equal('resolved');
+      JSON.parse(result.data.data).data.should.eql('this is a test string');
+    }
   }
 ];
 

test/app-test-definitions.js

@@ -3,12 +3,18 @@ const mock = require('mock-require');
 const path = require('path');
 
 const should = chai.should();
+
+const HELPERS_ID = path.resolve(__dirname, '..', 'www', 'helpers');
 const PLUGIN_ID = path.resolve(__dirname, '..', 'www', 'advanced-http');
 
 describe('Advanced HTTP www interface', function() {
   let http = {};
+  let helpers = {};
+
   const noop = () => { /* intentionally doing nothing */ };
+
   const loadHttp = () => {
+    mock(`${PLUGIN_ID}.helpers`, mock.reRequire('../www/helpers'));
     http = mock.reRequire('../www/advanced-http');
   };
 
@@ -19,8 +25,12 @@ describe('Advanced HTTP www interface', function() {
     global.btoa = decoded => new Buffer(decoded).toString('base64');
 
     mock('cordova/exec', noop);
-    mock(`${PLUGIN_ID}.angular-integration`, { registerService: noop });
     mock(`${PLUGIN_ID}.cookie-handler`, {});
+    mock(`${HELPERS_ID}.cookie-handler`, {});
+    mock(`${PLUGIN_ID}.messages`, require('../www/messages'));
+    mock(`${HELPERS_ID}.messages`, require('../www/messages'));
+    mock(`${PLUGIN_ID}.angular-integration`, { registerService: noop });
+
     loadHttp();
   });
 
@@ -40,7 +50,7 @@ describe('Advanced HTTP www interface', function() {
   });
 
   it('resolves global headers correctly #24', () => {
-    mock(`${PLUGIN_ID}.cookie-handler`, {
+    mock(`${HELPERS_ID}.cookie-handler`, {
       getCookieString: () => 'fakeCookieString'
     });
 
@@ -59,7 +69,7 @@ describe('Advanced HTTP www interface', function() {
   });
 
   it('resolves host headers correctly (set without port number) #37', () => {
-    mock(`${PLUGIN_ID}.cookie-handler`, {
+    mock(`${HELPERS_ID}.cookie-handler`, {
       getCookieString: () => 'fakeCookieString'
     });
 
@@ -78,7 +88,7 @@ describe('Advanced HTTP www interface', function() {
   });
 
   it('resolves host headers correctly (set with port number) #37', () => {
-    mock(`${PLUGIN_ID}.cookie-handler`, {
+    mock(`${HELPERS_ID}.cookie-handler`, {
       getCookieString: () => 'fakeCookieString'
     });
 
@@ -97,7 +107,7 @@ describe('Advanced HTTP www interface', function() {
   });
 
   it('resolves request headers correctly', () => {
-    mock(`${PLUGIN_ID}.cookie-handler`, {
+    mock(`${HELPERS_ID}.cookie-handler`, {
       getCookieString: () => 'fakeCookieString'
     });