- implement all HTTP operations as shorthand functions of "sendRequest"

- add some more type checking

Author: Sefa Ilkimen

test/app-test-definitions.js

@@ -288,14 +288,14 @@ const tests = [
         .should.be.equal('http://httpbin.org/get?myArray[]=val1&myArray[]=val2&myArray[]=val3&myString=testString');
     }
   },{
-    description: 'should reject non-string values in local header object #54',
-    expected: 'rejected: {"status": 0, "error": "advanced-http: header values must be strings" ...',
+    description: 'should throw on non-string values in local header object #54',
+    expected: 'throwed: {"message": "advanced-http: header values must be strings"}',
     func: function(resolve, reject) {
       cordova.plugin.http.get('http://httpbin.org/get', {}, { myTestHeader: 1 }, resolve, reject);
     },
     validationFunc: function(driver, result) {
-      result.type.should.be.equal('rejected');
-      result.data.error.should.be.equal('advanced-http: header values must be strings');
+      result.type.should.be.equal('throwed');
+      result.message.should.be.equal('advanced-http: header values must be strings');
     }
   },{
     description: 'should throw an error while setting non-string value as global header #54',

test/js-mocha-specs.js

@@ -27,7 +27,6 @@ describe('Advanced HTTP www interface', function() {
     mock('cordova/exec', 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 });
 

www/advanced-http.js

@@ -1,30 +1,5 @@
-/*global angular*/
-
-/*
- *
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- *
- * Modified by Andrew Stephan for Sync OnSet
- * Modified by Sefa Ilkimen
-*/
-
 /*
- * An HTTP Plugin for PhoneGap.
+ * A native HTTP Plugin for Cordova / PhoneGap.
  */
 
 var pluginId = module.id.slice(0, module.id.lastIndexOf('.'));
@@ -33,222 +8,124 @@ var exec = require('cordova/exec');
 var angularIntegration = require(pluginId +'.angular-integration');
 var cookieHandler = require(pluginId + '.cookie-handler');
 var helpers = require(pluginId + '.helpers');
-var messages = require(pluginId + '.messages');
 
-var internals = {
+var globalConfigs = {
   headers: {},
-  dataSerializer: 'urlencoded',
-  timeoutInSeconds: 60.0,
+  serializer: 'urlencoded',
+  timeout: 60.0,
 };
 
 var publicInterface = {
-    getBasicAuthHeader: function (username, password) {
-        return {'Authorization': 'Basic ' + helpers.b64EncodeUnicode(username + ':' + password)};
-    },
-    useBasicAuth: function (username, password) {
-        this.setHeader('*', 'Authorization', 'Basic ' + helpers.b64EncodeUnicode(username + ':' + password));
-    },
-    getHeaders: function (host) {
-        return internals.headers[host || '*'] || null;
-    },
-    setHeader: function () {
-        // this one is for being backward compatible
-        var host = '*';
-        var header = arguments[0];
-        var value = arguments[1];
-
-        if (arguments.length === 3) {
-            host = arguments[0];
-            header = arguments[1];
-            value = arguments[2];
-        }
-
-        if (header.toLowerCase() === 'cookie') {
-          throw new Error(messages.ADDING_COOKIES_NOT_SUPPORTED);
-        }
-
-        if (helpers.getTypeOf(value) !== 'String') {
-          throw new Error(messages.HEADER_VALUE_MUST_BE_STRING);
-        }
-
-        internals.headers[host] = internals.headers[host] || {};
-        internals.headers[host][header] = value;
-    },
-    getDataSerializer: function () {
-        return internals.dataSerializer;
-    },
-    setDataSerializer: function (serializer) {
-        internals.dataSerializer = helpers.checkSerializer(serializer);
-    },
-    setCookie: function (url, cookie, options) {
-        cookieHandler.setCookie(url, cookie, options);
-    },
-    clearCookies: function () {
-        cookieHandler.clearCookies();
-    },
-    removeCookies: function (url, callback) {
-        cookieHandler.removeCookies(url, callback);
-    },
-    getCookieString: function (url) {
-        return cookieHandler.getCookieString(url);
-    },
-    getRequestTimeout: function () {
-        return internals.timeoutInSeconds;
-    },
-    setRequestTimeout: function (timeout) {
-        internals.timeoutInSeconds = timeout;
-    },
-    enableSSLPinning: function (enable, success, failure) {
-        return exec(success, failure, 'CordovaHttpPlugin', 'enableSSLPinning', [enable]);
-    },
-    acceptAllCerts: function (allow, success, failure) {
-        return exec(success, failure, 'CordovaHttpPlugin', 'acceptAllCerts', [allow]);
-    },
-    disableRedirect: function (disable, success, failure) {
-        return exec(success, failure, 'CordovaHttpPlugin', 'disableRedirect', [disable]);
-    },
-    validateDomainName: function (validate, success, failure) {
-        failure(messages.DEPRECATED_VDN);
-    },
-    sendRequest: function (url, options, success, failure) {
-        helpers.handleMissingCallbacks(success, failure);
-
-        options = helpers.handleMissingOptions(options, internals);
-
-        var headers = helpers.getMergedHeaders(url, options.headers, internals.headers);
-        var onSuccess = helpers.injectCookieHandler(url, success);
-        var onFail = helpers.injectCookieHandler(url, failure);
-        var payload;
-
-        if ([ 'get', 'delete', 'head' ].indexOf(method) < 0) {
-          payload = helpers.getProcessedData(options.data, options.serializer);
-        } else {
-          payload = params;
-        }
-
-        return exec(onSuccess, onFail, 'CordovaHttpPlugin', options.method, [ url, payload, options.serializer, headers, options.timeout ]);
-    },
-    post: function (url, data, headers, success, failure) {
-        helpers.handleMissingCallbacks(success, failure);
-
-        data = helpers.getProcessedData(data, internals.dataSerializer);
-        headers = helpers.getMergedHeaders(url, headers, internals.headers);
-
-        if (!helpers.checkHeaders(headers)) {
-          return helpers.onInvalidHeader(failure);
-        }
-
-        var onSuccess = helpers.injectCookieHandler(url, success);
-        var onFail = helpers.injectCookieHandler(url, failure);
-
-        return exec(onSuccess, onFail, 'CordovaHttpPlugin', 'post', [url, data, internals.dataSerializer, headers, internals.timeoutInSeconds]);
-    },
-    get: function (url, params, headers, success, failure) {
-        helpers.handleMissingCallbacks(success, failure);
-
-        params = params || {};
-        headers = helpers.getMergedHeaders(url, headers, internals.headers);
-
-        if (!helpers.checkHeaders(headers)) {
-          return helpers.onInvalidHeader(failure);
-        }
-
-        var onSuccess = helpers.injectCookieHandler(url, success);
-        var onFail = helpers.injectCookieHandler(url, failure);
-
-        return exec(onSuccess, onFail, 'CordovaHttpPlugin', 'get', [url, params, headers, internals.timeoutInSeconds]);
-    },
-    put: function (url, data, headers, success, failure) {
-        helpers.handleMissingCallbacks(success, failure);
-
-        data = helpers.getProcessedData(data, internals.dataSerializer);
-        headers = helpers.getMergedHeaders(url, headers, internals.headers);
-
-        if (!helpers.checkHeaders(headers)) {
-          return helpers.onInvalidHeader(failure);
-        }
-
-        var onSuccess = helpers.injectCookieHandler(url, success);
-        var onFail = helpers.injectCookieHandler(url, failure);
-
-        return exec(onSuccess, onFail, 'CordovaHttpPlugin', 'put', [url, data, internals.dataSerializer, headers, internals.timeoutInSeconds]);
-    },
-    patch: function (url, data, headers, success, failure) {
-        helpers.handleMissingCallbacks(success, failure);
-
-        data = helpers.getProcessedData(data, internals.dataSerializer);
-        headers = helpers.getMergedHeaders(url, headers, internals.headers);
-
-        if (!helpers.checkHeaders(headers)) {
-          return helpers.onInvalidHeader(failure);
-        }
-
-        var onSuccess = helpers.injectCookieHandler(url, success);
-        var onFail = helpers.injectCookieHandler(url, failure);
-
-        return exec(onSuccess, onFail, 'CordovaHttpPlugin', 'patch', [url, data, internals.dataSerializer, headers, internals.timeoutInSeconds]);
-    },
-    delete: function (url, params, headers, success, failure) {
-        helpers.handleMissingCallbacks(success, failure);
-
-        params = params || {};
-        headers = helpers.getMergedHeaders(url, headers, internals.headers);
-
-        if (!helpers.checkHeaders(headers)) {
-          return helpers.onInvalidHeader(failure);
-        }
-
-        var onSuccess = helpers.injectCookieHandler(url, success);
-        var onFail = helpers.injectCookieHandler(url, failure);
-
-        return exec(onSuccess, onFail, 'CordovaHttpPlugin', 'delete', [url, params, headers, internals.timeoutInSeconds]);
-    },
-    head: function (url, params, headers, success, failure) {
-        helpers.handleMissingCallbacks(success, failure);
-
-        params = params || {};
-        headers = helpers.getMergedHeaders(url, headers, internals.headers);
-
-        if (!helpers.checkHeaders(headers)) {
-          return helpers.onInvalidHeader(failure);
-        }
-
-        var onSuccess = helpers.injectCookieHandler(url, success);
-        var onFail = helpers.injectCookieHandler(url, failure);
-
-        return exec(onSuccess, onFail, 'CordovaHttpPlugin', 'head', [url, params, headers, internals.timeoutInSeconds]);
-    },
-    uploadFile: function (url, params, headers, filePath, name, success, failure) {
-        helpers.handleMissingCallbacks(success, failure);
-
-        params = params || {};
-        headers = helpers.getMergedHeaders(url, headers, internals.headers);
-
-        if (!helpers.checkHeaders(headers)) {
-          return helpers.onInvalidHeader(failure);
-        }
-
-        var onSuccess = helpers.injectCookieHandler(url, success);
-        var onFail = helpers.injectCookieHandler(url, failure);
-
-        return exec(onSuccess, onFail, 'CordovaHttpPlugin', 'uploadFile', [url, params, headers, filePath, name, internals.timeoutInSeconds]);
-    },
-    downloadFile: function (url, params, headers, filePath, success, failure) {
-        helpers.handleMissingCallbacks(success, failure);
-
-        params = params || {};
-        headers = helpers.getMergedHeaders(url, headers, internals.headers);
-
-        if (!helpers.checkHeaders(headers)) {
-          return helpers.onInvalidHeader(failure);
-        }
-
-        var onSuccess = helpers.injectCookieHandler(url, helpers.injectFileEntryHandler(success));
-        var onFail = helpers.injectCookieHandler(url, failure);
+  getBasicAuthHeader: function (username, password) {
+    return {'Authorization': 'Basic ' + helpers.b64EncodeUnicode(username + ':' + password)};
+  },
+  useBasicAuth: function (username, password) {
+    this.setHeader('*', 'Authorization', 'Basic ' + helpers.b64EncodeUnicode(username + ':' + password));
+  },
+  getHeaders: function (host) {
+    return globalConfigs.headers[host || '*'] || null;
+  },
+  setHeader: function () {
+    // this one is for being backward compatible
+    var host = '*';
+    var header = arguments[0];
+    var value = arguments[1];
+
+    if (arguments.length === 3) {
+        host = arguments[0];
+        header = arguments[1];
+        value = arguments[2];
+    }
 
-        return exec(onSuccess, onFail, 'CordovaHttpPlugin', 'downloadFile', [url, params, headers, filePath, internals.timeoutInSeconds]);
+    helpers.checkForBlacklistedHeaderKey(header);
+    helpers.checkForInvalidHeaderValue(value);
+
+    globalConfigs.headers[host] = globalConfigs.headers[host] || {};
+    globalConfigs.headers[host][header] = value;
+  },
+  getDataSerializer: function () {
+    return globalConfigs.serializer;
+  },
+  setDataSerializer: function (serializer) {
+    globalConfigs.serializer = helpers.checkSerializer(serializer);
+  },
+  setCookie: function (url, cookie, options) {
+    cookieHandler.setCookie(url, cookie, options);
+  },
+  clearCookies: function () {
+    cookieHandler.clearCookies();
+  },
+  removeCookies: function (url, callback) {
+    cookieHandler.removeCookies(url, callback);
+  },
+  getCookieString: function (url) {
+    return cookieHandler.getCookieString(url);
+  },
+  getRequestTimeout: function () {
+    return globalConfigs.timeout;
+  },
+  setRequestTimeout: function (timeout) {
+    globalConfigs.timeout = timeout;
+  },
+  enableSSLPinning: function (enable, success, failure) {
+    return exec(success, failure, 'CordovaHttpPlugin', 'enableSSLPinning', [enable]);
+  },
+  acceptAllCerts: function (allow, success, failure) {
+    return exec(success, failure, 'CordovaHttpPlugin', 'acceptAllCerts', [allow]);
+  },
+  disableRedirect: function (disable, success, failure) {
+    return exec(success, failure, 'CordovaHttpPlugin', 'disableRedirect', [disable]);
+  },
+  sendRequest: function (url, options, success, failure) {
+    helpers.handleMissingCallbacks(success, failure);
+
+    options = helpers.handleMissingOptions(options, globalConfigs);
+
+    var headers = helpers.getMergedHeaders(url, options.headers, globalConfigs.headers);
+    var onSuccess = helpers.injectCookieHandler(url, success);
+    var onFail = helpers.injectCookieHandler(url, failure);
+
+    switch(options.method) {
+      case 'post':
+      case 'put':
+      case 'patch':
+        var data = helpers.getProcessedData(options.data, options.serializer);
+        return exec(onSuccess, onFail, 'CordovaHttpPlugin', options.method, [ url, data, options.serializer, headers, options.timeout ]);
+      case 'upload':
+        return exec(onSuccess, onFail, 'CordovaHttpPlugin', 'uploadFile', [ url, options.params, headers, options.filePath, options.name, options.timeout ]);
+      case 'download':
+        var onDownloadSuccess = helpers.injectCookieHandler(url, helpers.injectFileEntryHandler(success));
+        return exec(onDownloadSuccess, onFail, 'CordovaHttpPlugin', 'downloadFile', [ url, options.params, headers, options.filePath, options.timeout ]);
+      default:
+        return exec(onSuccess, onFail, 'CordovaHttpPlugin', options.method, [ url, options.params, headers, options.timeout ]);
     }
+  },
+  post: function (url, data, headers, success, failure) {
+    return publicInterface.sendRequest(url, { method: 'post', data: data, headers: headers }, success, failure);
+  },
+  get: function (url, params, headers, success, failure) {
+    return publicInterface.sendRequest(url, { method: 'get', params: params, headers: headers }, success, failure);
+  },
+  put: function (url, data, headers, success, failure) {
+    return publicInterface.sendRequest(url, { method: 'put', data: data, headers: headers }, success, failure);
+  },
+  patch: function (url, data, headers, success, failure) {
+    return publicInterface.sendRequest(url, { method: 'patch', data: data, headers: headers }, success, failure);
+  },
+  delete: function (url, params, headers, success, failure) {
+    return publicInterface.sendRequest(url, { method: 'delete', params: params, headers: headers }, success, failure);
+  },
+  head: function (url, params, headers, success, failure) {
+    return publicInterface.sendRequest(url, { method: 'head', params: params, headers: headers }, success, failure);
+  },
+  uploadFile: function (url, params, headers, filePath, name, success, failure) {
+    return publicInterface.sendRequest(url, { method: 'upload', params: params, headers: headers, filePath: filePath, name: name }, success, failure);
+  },
+  downloadFile: function (url, params, headers, filePath, success, failure) {
+    return publicInterface.sendRequest(url, { method: 'download', params: params, headers: headers, filePath: filePath }, success, failure);
+  }
 };
 
+// angular service is deprecated and will be removed anytime soon
 angularIntegration.registerService(publicInterface);
 module.exports = publicInterface;