Merge branch 'master' of http://github.com/mrjjwright/backbone

backbone.js

@@ -27,8 +27,10 @@
   // For Backbone's purposes, jQuery owns the `$` variable.
   var $ = this.jQuery;
 
-  // Turn on `emulateHttp` to fake `"PUT"` and `"DELETE"` requests via
-  // the `_method` parameter.
+  // Turn on `emulateHttp` to use support legacy HTTP servers. Setting this option will
+  // fake `"PUT"` and `"DELETE"` requests via the `_method` parameter and set a
+  // `X-Http-Method-Override` header, will  encode the body as`application/x-www-form-urlencoded` 
+  // instead of `application/json` and will send the model in a param named `model`.
   Backbone.emulateHttp = false;
 
   // Backbone.Events
@@ -688,25 +690,41 @@
   // * Persist models via WebSockets instead of Ajax.
   //
   // Turn on `Backbone.emulateHttp` in order to send `PUT` and `DELETE` requests
-  // as `POST`, with an `_method` parameter containing the true HTTP method.
+  // as `POST`, with a `_method` parameter containing the true HTTP method,
+  // as well as all requests with the body as `application/x-www-form-urlencoded` instead of 
+  // `application/json` with the model in a param named `model`.
   // Useful when interfacing with server-side languages like **PHP** that make
   // it difficult to read the body of `PUT` requests.
   Backbone.sync = function(method, model, success, error) {
     var sendModel = method === 'create' || method === 'update';
-    var data = sendModel ? {model : JSON.stringify(model)} : {};
     var type = methodMap[method];
-    if (Backbone.emulateHttp && (type === 'PUT' || type === 'DELETE')) {
-      data._method = type;
-      type = 'POST';
-    }
-    $.ajax({
-      url       : getUrl(model),
-      type      : type,
-      data      : data,
-      dataType  : 'json',
-      success   : success,
-      error     : error
-    });
+    var ajaxParams = {};
+
+    if (Backbone.emulateHttp) {
+        ajaxParams.contentType = "application/x-www-form-urlencoded";
+        ajaxParams.processData = true;
+        ajaxParams.data = {};
+        if (sendModel) ajaxParams.data.model = model.toJSON();
+        if (type === 'PUT' || type === 'DELETE') {
+            ajaxParams.data._method = type;
+            type = 'POST';
+            ajaxParams.beforeSend = function(xhr) {
+                xhr.setRequestHeader("X-Http-Method-Override", "PUT");
+            }
+        }
+    } else {
+        ajaxParams.contentType = "application/json";
+        ajaxParams.processData = false;
+        ajaxParams.data = sendModel ? JSON.stringify(model.toJSON()) : {};
+    }   
+    
+    ajaxParams.url = getUrl(model);
+    ajaxParams.type = type;
+    ajaxParams.dataType = "json";
+    ajaxParams.success = success;
+    ajaxParams.error = error;
+
+    $.ajax(ajaxParams);
   };
 
   // Helpers

index.html

@@ -1232,10 +1232,10 @@ var othello = NYPL.create({
 
     <p>
       With the default implementation, when <b>Backbone.sync</b> sends up a request to save 
-      a model, its attributes will be passed, serialized as JSON, under the <tt>model</tt>
-      parameter. When returning a JSON response, send down the attributes of the
-      model that have been changed by the server, and need to be updated on the
-      client. When responding to a <tt>"read"</tt> request from a collection
+      a model, its attributes will be passed, serialized as JSON, and sent in the HTTP body
+      with content-type <tt>application/json</tt>. When returning a JSON response, 
+      send down the attributes of the  model that have been changed by the server, and need 
+      to be updated on the client. When responding to a <tt>"read"</tt> request from a collection
       (<a href="#Collection#fetch">Collection#fetch</a>), send down an array
       of model attribute objects.
     </p>
@@ -1252,21 +1252,23 @@ var othello = NYPL.create({
     </ul>
 
     <p>
-      If your web server makes it difficult to work with real <tt>PUT</tt> and
-      <tt>DELETE</tt> requests, you may choose to emulate them instead, using
-      HTTP <tt>POST</tt>, and passing them under the <tt>_method</tt> parameter
-      instead, by turning on <tt>Backbone.emulateHttp</tt>:
+      If you want to work with a legacy web server that doesn't support Backbones's
+      default JSON centric approach, you may choose to turn on <tt>Backbone.emulateHttp</tt>.
+      Setting this option will emulate <tt>PUT</tt> and <tt>DELETE</tt> requests with
+      a HTTP <tt>POST</tt>, and passing them under the <tt>_method</tt> parameter. Setting this option
+      will also send the model under a <tt>model</tt> param and use <tt>application/x-www-form-urlencoded</tt>
+      instead of the default <tt>application/json</tt> as the content-type for data sent. 
     </p>
 
 <pre>
-Backbone.emulateHttp = true;
+Backbone.emulateHTTP = true;
 
 model.save();  // Sends a POST to "/collection/id", with "_method=PUT"
 </pre>
 
     <p>
       As an example, a Rails handler responding to an <tt>"update"</tt> call from
-      <b>Backbone.sync</b> might look like this: <i>(In real code, never use
+      <tt>Backbone</tt> might look like this: <i>(In real code, never use
       </i><tt>update_attributes</tt><i> blindly, and always whitelist the attributes
       you allow to be changed.)</i>
     </p>
@@ -1557,7 +1559,7 @@ var DocumentView = Backbone.View.extend({
       as an option, which will be invoked if validation fails, overriding the
       <tt>"error"</tt> event.
       You can now tell backbone to use the <tt>_method</tt> hack instead of HTTP
-      methods by setting <tt>Backbone.emulateHttp = true</tt>.
+      methods by setting <tt>Backbone.emulateHTTP = true</tt>.
       Existing Model and Collection data is no longer sent up unnecessarily with
       <tt>GET</tt> and <tt>DELETE</tt> requests. Added a <tt>rake lint</tt> task.
       Backbone is now published as an <a href="http://npmjs.org">NPM</a> module.

test/sync.js

@@ -36,18 +36,19 @@ $(document).ready(function() {
     equals(lastRequest.url, '/library');
     equals(lastRequest.type, 'POST');
     equals(lastRequest.dataType, 'json');
-    var data = JSON.parse(lastRequest.data.model);
+    var data = JSON.parse(lastRequest.data);
     equals(data.title, 'The Tempest');
     equals(data.author, 'Bill Shakespeare');
     equals(data.length, 123);
   });
 
+
   test("sync: update", function() {
     library.first().save({id: '1-the-tempest', author: 'William Shakespeare'});
     equals(lastRequest.url, '/library/1-the-tempest');
     equals(lastRequest.type, 'PUT');
     equals(lastRequest.dataType, 'json');
-    var data = JSON.parse(lastRequest.data.model);
+    var data = JSON.parse(lastRequest.data);
     equals(data.id, '1-the-tempest');
     equals(data.title, 'The Tempest');
     equals(data.author, 'William Shakespeare');
@@ -61,11 +62,11 @@ $(document).ready(function() {
     equals(lastRequest.type, 'POST');
     equals(lastRequest.dataType, 'json');
     equals(lastRequest.data._method, 'PUT');
-    var data = JSON.parse(lastRequest.data.model);
+    var data = lastRequest.data.model;
     equals(data.id, '2-the-tempest');
-    equals(data.title, 'The Tempest');
     equals(data.author, 'Tim Shakespeare');
     equals(data.length, 123);
+    Backbone.emulateHttp = false;
   });
 
   test("sync: read model", function() {
@@ -76,7 +77,6 @@ $(document).ready(function() {
   });
 
   test("sync: destroy", function() {
-    Backbone.emulateHttp = false;
     library.first().destroy();
     equals(lastRequest.url, '/library/2-the-tempest');
     equals(lastRequest.type, 'DELETE');
@@ -89,6 +89,7 @@ $(document).ready(function() {
     equals(lastRequest.url, '/library/2-the-tempest');
     equals(lastRequest.type, 'POST');
     equals(JSON.stringify(lastRequest.data), '{"_method":"DELETE"}');
+   Backbone.emulateHttp = false;
   });
 
 });