Merge pull request #13 from Xitstrategies/master

Implement ajaxSetup for reverse compatibility with $.ajaxSetup

Author: bmomberger-bitovi

can-ajax.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var Global = require("can-globals/global/global");
-var assign = require("can-assign");
+var canReflect = require("can-reflect");
 var namespace = require("can-namespace");
 var parseURI = require('can-parse-uri');
 var param = require("can-param");
@@ -36,9 +36,31 @@ var param = require("can-param");
  *      - __data__ `{Object}` The data of the request. If data needs to be urlencoded (e.g. for GET requests or for CORS) it is serialized with [can-param].
  *      - __dataType__ `{String}` Type of data. _Default is `json`_.
  *      - __crossDomain__ `{Boolean}` If you wish to force a crossDomain request (such as JSONP) on the same domain, set the value of crossDomain to true. This allows, for example, server-side redirection to another domain. Default: `false` for same-domain requests, `true` for cross-domain requests.
+ *      - __xhrFields__ `{Object}` Any fields to be set directly on the xhr request, [https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest] such as the withCredentials attribute that indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies or authorization headers.
  *
  *    @return {Promise} A Promise that resolves to the data. The Promise instance is abortable and exposes an `abort` method. Invoking abort on the Promise instance indirectly rejects it.
  *
+ *
+ * @signature `ajaxSetup( ajaxOptions )`
+ *
+ *    Is used to persist ajaxOptions across all ajax requests and they can be over-written in the ajaxOptions of the actual request.
+ *    [https://api.jquery.com/jquery.ajaxsetup/]
+ *
+ *    ```
+ *    var ajax = require("can-ajax");
+ *
+ *    ajax.ajaxSetup({xhrFields: {withCredentials: true}});
+ *
+ *    ajax({
+ *      url: "http://query.yahooapis.com/v1/public/yql",
+ *      data: {
+ *        format: "json",
+ *        q: 'select * from geo.places where text="sunnyvale, ca"'
+ *      }
+ *    }).then(function(response){
+ *      console.log( response.query.count ); // => 2
+ *    });
+ *    ```
  */
 
 // from https://gist.github.com/mythz/1334560
@@ -52,6 +74,8 @@ var xhrs = [
 // used to check for Cross Domain requests
 var originUrl = parseURI(Global().location.href);
 
+var globalSettings = {};
+
 var makeXhr = function () {
 	if (_xhrf != null) {
 		return _xhrf();
@@ -92,7 +116,7 @@ var _xhrResp = function (xhr, options) {
 	}
 };
 
-module.exports = namespace.ajax = function (o) {
+function ajax(o) {
 	var xhr = makeXhr(), timer, n = 0;
 	var deferred = {};
 	var promise = new Promise(function(resolve,reject){
@@ -105,13 +129,15 @@ module.exports = namespace.ajax = function (o) {
 		xhr.abort();
 	};
 
-	o = assign({
-		userAgent: "XMLHttpRequest",
-		lang: "en",
-		type: "GET",
-		data: null,
-		dataType: "json"
-	}, o);
+	o = [{
+			userAgent: "XMLHttpRequest",
+			lang: "en",
+			type: "GET",
+			data: null,
+			dataType: "json"
+	}, globalSettings, o].reduce(function(a,b,i) {
+		return canReflect.assignDeep(a,b);
+	});
 
 	// Set the default contentType
 	if(!o.contentType) {
@@ -179,7 +205,7 @@ module.exports = namespace.ajax = function (o) {
 
 	// For CORS to send a "simple" request (to avoid a preflight check), the following methods are allowed: GET/POST/HEAD,
 	// see https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS#Simple_requests
-	
+
 	var isSimpleCors = o.crossDomain && ['GET', 'POST', 'HEAD'].indexOf(type) !== -1;
 
 	if (isPost) {
@@ -200,6 +226,17 @@ module.exports = namespace.ajax = function (o) {
 		xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest");
 	}
 
+        if (o.xhrFields) {
+            for (var f in o.xhrFields) {
+                xhr[f] = o.xhrFields[f];
+            }
+        }
+
 	xhr.send(data);
 	return promise;
+}
+
+module.exports = namespace.ajax = ajax;
+module.exports.ajaxSetup = function (o) {
+    globalSettings = o || {};
 };

package.json

@@ -47,11 +47,11 @@
     ]
   },
   "dependencies": {
-    "can-assign": "^1.0.0",
     "can-globals": "^0.2.2",
     "can-namespace": "^1.0.0",
     "can-param": "^1.0.1",
-    "can-parse-uri": "^1.0.0"
+    "can-parse-uri": "^1.0.0",
+    "can-reflect": "^1.4.5"
   },
   "devDependencies": {
     "can-make-map": "^1.0.0",

test.html

@@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <title>can-ajax</title>
 <script src="node_modules/steal/steal.js" main="can-ajax/can-ajax-test"></script>
 <div id="qunit-fixture"></div>