Updated documentation

enzolutions · enzolutions · commit 46a6d340b2e1 · 2014-12-23T12:12:43.000-06:00
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**
 
+- [Usage](#usage)
 - [Bower install](#bower-install)
   - [Bower command](#bower-command)
   - [Include as dependencie](#include-as-dependencie)
@@ -11,25 +12,98 @@
       - [Auth](#auth)
     - [Drupal 7](#drupal-7)
 - [ToDo](#todo)
-- [Usage](#usage)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-Backbone.Drupal is a standalone plugin to connect Marionette JS and Backbone JS applications with Drupal 7/8
+Backbone.Drupal is a standalone plugin to connect Marionette JS and Backbone JS applications with Drupal 7/8 to execute [RESTful](http://en.wikipedia.org/wiki/Representational_state_transfer) States to elaborate operation GET, POST, DELETE etc.
 
 Originally Inspired in JS files from Drupal 7 Module <a href="https://drupal.org/project/backbone" target="_blank">https://drupal.org/project/backbone</a>
 
-### Bower install
+# Usage
+
+Check **test/index.html** for Drupal 8 example and **indexd7.html** for  Drupal 7 example.
+
+Before to test in Drupal 8 be sure the REST Resource Content for methods Get, Post, Update , Delete and Patch has json as format and Basic Auth as Authentication method.
+
+You can the contributed module [Rest UI](https://www.drupal.org/project/restui) I recommend use the git version until Drupal 8 get his first official release.
+
+Your configuration must look similar to following image.
+
+![REST UI Content](https://raw.githubusercontent.com/enzolutions/backbone.drupal/master/images/backbone.drupal_drupal8_restui_content_resource.png "REST UI Content")
+
+## Code Sample
+````
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>Backbone Drupal Library</title>
+  </head>
+  <body>
+    <script src="./jquery.js"></script>
+    <script src="./underscore.js"></script>
+    <script src="./backbone.js"></script>
+    <script src="./backbone.drupal.js"></script>
+    <script src="./backbone.drupal.services.js"></script>
+    <script>
+      $(function() {
+        // Set API Information
+        Backbone.Drupal.restEndpoint = {
+          root: 'http://onthisday/api',
+          dataType: '.json'
+        };
+        // Define auth object, set crossDomain if is necessary
+        var Auth = new Backbone.Drupal.Auth({crossDomain: true});
+        // Request executed in sync mode
+        // If status is token further ajax will use the proper token
+        var auth_status =  = Auth.login('admin', 'admin');
+
+        if(auth_status) {
+
+          // Check user retrieve
+
+          var User = new Backbone.Drupal.Models.User({uid: 1});
+          User.fetch({
+            success: function (user) {
+              // Check information retrived, could be used directly in a template
+              console.log(user.attributes.mail);
+            }
+          });
+
+          //  Check users retrive
+
+          var Users = new Backbone.Drupal.Collections.UserIndex();
+          Users.fetch({
+            success: function (users) {
+              // Check information retrived, could be used directly in a template
+              console.log(users.models[0].attributes.uri);
+            }
+          });
+        } else {
+          alert('Auth Error');
+        }
+      });
+
+    </script>
+
+  </body>
+</html>
+
+````
+
+Note: This plugin could be used with <a href="requirejs.org" target="_blank">RequireJS</a>.
+
+# Bower install
 
 If you are using <a target="_blank" href="http://bower.io/">Bower</a> you can download Backbone.drupal following this instructions
 
-#### Bower command
+## Bower command
 
 ```
 $ bower install backbone.drupal
 ```
 
-#### Include as dependencie
+## Include as dependencie
 
 If your application has a list of bower dependencies, you can include as dependency as shown below.
 
@@ -46,13 +120,13 @@ Check the releases section to verify the latest version.
 
 ```
 
-### Features
+# Features
 
-####Cross-origin
+##Cross-origin
 
 Enable to have Drupal as Backend in a Domain backend.com and the Backbone/Marionette App in other domain frontend.com.
 
-##### Drupal 8
+### Drupal 8
 
 Because the mode https://www.drupal.org/project/cors doesn't have a version for Drupal 8 yet and Drupal Core still doesn't have a solution for that I did a <a href="https://www.drupal.org/files/issues/core-cors-headers-1869548-26.patch">patch</a> for .htacces to enable CORS request using jQuery documented in issue # https://www.drupal.org/node/1869548#comment-9120317
 
@@ -85,7 +159,7 @@ When issues https://www.drupal.org/node/1869548 and https://www.drupal.org/node/
 
 More information at http://enable-cors.org/server_apache.html
 
-###### Auth
+#### Auth
 
 Drupal 8 doesn't implement yet the end point /user/login to enable remote login, this method in Drupal allow validate the credentials and request a CRS Token to be used in further request.
 
@@ -95,7 +169,7 @@ When function Auth is called the credentials are not validated, they are just en
 
 Remember the credentials travel to your backend server **encoded** NOT **encrypted** for tha reason you **MUST** use a SSL certificate in your backend site to protect your users.
 
-##### Drupal 7
+### Drupal 7
 
 In your Drupal Server you must setup <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS" target="_blank">HTTP Access Control</a> to enable connection, below an example.
 
@@ -133,75 +207,10 @@ var Property = Backbone.Drupal.Models.Node.extend({
 
 **REST**: Integration with Services Server type REST
 
-### ToDo
+# ToDo
 
 <ul>
   <li>Implement Collections for Taxonomies and Search</li>
   <li>Create integration with module Restws in Drupal 7</li>
   <li>Test Drupal 8 POST method and Views integrations.</li>
 </ul>
-
-### Usage
-
-Check **test/index.html** for Drupal 8 example and **indexd7.html** for  Drupal 7 example.
-
-````
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8">
-    <title>Backbone Drupal Library</title>
-  </head>
-  <body>
-    <script src="./jquery.js"></script>
-    <script src="./underscore.js"></script>
-    <script src="./backbone.js"></script>
-    <script src="./backbone.drupal.js"></script>
-    <script src="./backbone.drupal.services.js"></script>
-    <script>
-      $(function() {
-        // Set API Information
-        Backbone.Drupal.restEndpoint = {
-          root: 'http://onthisday/api',
-          dataType: '.json'
-        };
-        // Define auth object, set crossDomain if is necessary
-        var Auth = new Backbone.Drupal.Auth({crossDomain: true});
-        // Request executed in sync mode
-        // If status is token further ajax will use the proper token
-        var auth_status =  = Auth.login('admin', 'admin');
-
-        if(auth_status) {
-
-          // Check user retrieve
-
-          var User = new Backbone.Drupal.Models.User({uid: 1});
-          User.fetch({
-            success: function (user) {
-              // Check information retrived, could be used directly in a template
-              console.log(user.attributes.mail);
-            }
-          });
-
-          //  Check users retrive
-
-          var Users = new Backbone.Drupal.Collections.UserIndex();
-          Users.fetch({
-            success: function (users) {
-              // Check information retrived, could be used directly in a template
-              console.log(users.models[0].attributes.uri);
-            }
-          });
-        } else {
-          alert('Auth Error');
-        }
-      });
-
-    </script>
-
-  </body>
-</html>
-
-````
-
-Note: This plugin could be used with <a href="requirejs.org" target="_blank">RequireJS</a>.
diff --git a/backbone.drupal.js b/backbone.drupal.js
@@ -74,7 +74,6 @@ Backbone.Drupal.Auth = (function(Backbone, $, _){
           // Define specific parametres to be used in all future request.
           $.ajaxSetup(settings);
 
-          console.log(btoa(username + ':' + password));
           status=true;
         }
         else if(attributes.drupal8 === false) {
diff --git a/images/backbone.drupal_drupal8_restui_content_resource.png b/images/backbone.drupal_drupal8_restui_content_resource.png
diff --git a/test/index.html b/test/index.html
@@ -33,6 +33,7 @@
         User.fetch({
           success: function (user) {
             // Check information retrived, could be used directly in a template
+            console.log(user.attributes);
             console.log(user.attributes.mail[0].value);
           }
         });

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,6 @@ Backbone.Drupal.Auth = (function(Backbone, $, _){`
`74`	`74`	`// Define specific parametres to be used in all future request.`
`75`	`75`	`$.ajaxSetup(settings);`
`76`	`76`
`77`		`- console.log(btoa(username + ':' + password));`
`78`	`77`	`status=true;`
`79`	`78`	`}`
`80`	`79`	`else if(attributes.drupal8 === false) {`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@`
`33`	`33`	`User.fetch({`
`34`	`34`	`success: function (user) {`
`35`	`35`	`// Check information retrived, could be used directly in a template`
	`36`	`+ console.log(user.attributes);`
`36`	`37`	`console.log(user.attributes.mail[0].value);`
`37`	`38`	`}`
`38`	`39`	`});`