updates for displays of response samples

coldbox-modules · Mar 18, 2016 · 5aea603 · 5aea603
1 parent 7229943
commit 5aea603
Show file tree

Hide file tree

Showing 19 changed files with 245 additions and 47 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -14,6 +14,15 @@ module.exports = function(grunt) {
             jsModel: {
             	files: ['includes/jsdev/models/*.js'],
             	tasks: ['uglify:modelJS']
+            },
+
+            jsGlobals: {
+            	files: [
+            		'includes/jsdev/app.js',
+            		'includes/jsdev/globals.js',
+            		'includes/jsdev/udf.js'
+            	],
+            	tasks: ['requirejs:compile','uglify:viewJS','uglify:modelJS']
             }
 		},
 		sass: {

diff --git a/includes/jsdev/udf.js b/includes/jsdev/udf.js
@@ -11,6 +11,31 @@ function openRemoteModal( url, params ){
     $remoteModal.modal( "show" );
 }
 
+function formatAPIExample( example, mimetype ){
+    switch( mimetype ){
+        case "application/xml":
+        case "text/xml":
+        case "xml":
+
+            return escapeHtml( formatXML(example) );
+
+        case "application/json":
+        case "application/jsonp":
+        case "application/jsont":
+            if( typeof( example ) === 'object' ){
+                return formatJSONRaw( JSON.stringify( example ) ).trim();
+            } else {
+                return formatJSONRaw( example ).trim();
+            }
+        default:
+            if( typeof( example ) === 'object' || typeof( example ) === 'array' ){
+                return formatJSONRaw( JSON.stringify( example ) ).trim();
+            } else {
+                return example;
+            }
+    }
+}
+
 function formatJSON( id ){
     $( "#" + id ).val( formatJSONRaw( $( "#" + id ).val() ) ); 
 }
@@ -32,6 +57,53 @@ function formatJSONRaw( jsonData ){
     }
 }
 
+function formatXML(xml) {
+    var formatted = '';
+    var reg = /(>)(<)(\/*)/g;
+    xml = xml.replace(reg, '$1\r\n$2$3');
+    var pad = 0;
+    $.each(xml.split('\r\n'), function(index, node) {
+        var indent = 0;
+        if (node.match( /.+<\/\w[^>]*>$/ )) {
+            indent = 0;
+        } else if (node.match( /^<\/\w/ )) {
+            if (pad != 0) {
+                pad -= 1;
+            }
+        } else if (node.match( /^<\w[^>]*[^\/]>.*$/ )) {
+            indent = 1;
+        } else {
+            indent = 0;
+        }
+
+        var padding = '';
+        for (var i = 0; i < pad; i++) {
+            padding += '  ';
+        }
+
+        formatted += padding + node + '\r\n';
+        pad += indent;
+    });
+
+    return formatted.trim();
+}
+
+
+ var entityMap = {
+    "&": "&amp;",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': '&quot;',
+    "'": '&#39;',
+    "/": '&#x2F;'
+};
+
+function escapeHtml(string) {
+    return String(string).replace(/[&<>"'\/]/g, function (s) {
+      return entityMap[s];
+    });
+}
+
 function toggleResource(id){
     var $div = $( "#resource_" + id );
     $div.slideToggle();

diff --git a/includes/jsdev/views/export.html.js b/includes/jsdev/views/export.html.js
@@ -56,8 +56,6 @@ define([
             * ----------------------------------------------
             */
             ,setupDefaults:function(){
-            	console.log( Messenger );
-            	//this.Messenger = new Messenger();
 
                 return this;
             }

diff --git a/includes/jsdev/views/relax.relaxer.js b/includes/jsdev/views/relax.relaxer.js
@@ -211,7 +211,6 @@ define([
 			    var index = $("#requestHistory").val();
 			    if( index != "null" ){
 			        var item = reqHistory[index].DATA;
-			        //console.log(item);
 
 			        $("#advancedSettings").slideDown();
 			        // main options

diff --git a/includes/jsdev/views/widgets/sidebar.js b/includes/jsdev/views/widgets/sidebar.js
@@ -100,8 +100,6 @@ define([
             ,onSelectAPI: function( e ){
                 var _this = this;
                 var $select = $( e.currentTarget );
-                console.log( $select.length );
-                console.log( $select.val() );
                 var selectedAPI = $select.val();
                 _this.ViewModel.set( 'id', selectedAPI );
                 _this.View.renderLoaderMessage();

diff --git a/modules/relax/ModuleConfig.cfc b/modules/relax/ModuleConfig.cfc
@@ -146,7 +146,7 @@ component{
 		// Default Config Structure
 		configStruct.relax = {
 			APILocation 	= "#moduleMapping#.models.resources",
-			defaultAPI 		= "petstore",
+			defaultAPI 		= "myapi",
 			maxHistory		= 10,
 			sessionsEnabled	= getApplicationMetadata().sessionManagement
 		};

diff --git a/modules/relax/includes/js/models/RelaxAPI.js b/modules/relax/includes/js/models/RelaxAPI.js
@@ -1,4 +1,4 @@
-/*! Copyright 2016 - Ortus Solutions (Compiled: 14-03-2016) */
+/*! Copyright 2016 - Ortus Solutions (Compiled: 18-03-2016) */
 define([ "Backbone" ], function(Backbone) {
     "use strict";
     var Model = Backbone.Model.extend({

diff --git a/modules/relax/includes/js/udf.js b/modules/relax/includes/js/udf.js
@@ -11,6 +11,31 @@ function openRemoteModal( url, params ){
     $remoteModal.modal( "show" );
 }
 
+function formatAPIExample( example, mimetype ){
+    switch( mimetype ){
+        case "application/xml":
+        case "text/xml":
+        case "xml":
+
+            return escapeHtml( formatXML(example) );
+
+        case "application/json":
+        case "application/jsonp":
+        case "application/jsont":
+            if( typeof( example ) === 'object' ){
+                return formatJSONRaw( JSON.stringify( example ) ).trim();
+            } else {
+                return formatJSONRaw( example ).trim();
+            }
+        default:
+            if( typeof( example ) === 'object' || typeof( example ) === 'array' ){
+                return formatJSONRaw( JSON.stringify( example ) ).trim();
+            } else {
+                return example;
+            }
+    }
+}
+
 function formatJSON( id ){
     $( "#" + id ).val( formatJSONRaw( $( "#" + id ).val() ) ); 
 }
@@ -32,6 +57,53 @@ function formatJSONRaw( jsonData ){
     }
 }
 
+function formatXML(xml) {
+    var formatted = '';
+    var reg = /(>)(<)(\/*)/g;
+    xml = xml.replace(reg, '$1\r\n$2$3');
+    var pad = 0;
+    $.each(xml.split('\r\n'), function(index, node) {
+        var indent = 0;
+        if (node.match( /.+<\/\w[^>]*>$/ )) {
+            indent = 0;
+        } else if (node.match( /^<\/\w/ )) {
+            if (pad != 0) {
+                pad -= 1;
+            }
+        } else if (node.match( /^<\w[^>]*[^\/]>.*$/ )) {
+            indent = 1;
+        } else {
+            indent = 0;
+        }
+
+        var padding = '';
+        for (var i = 0; i < pad; i++) {
+            padding += '  ';
+        }
+
+        formatted += padding + node + '\r\n';
+        pad += indent;
+    });
+
+    return formatted.trim();
+}
+
+
+ var entityMap = {
+    "&": "&amp;",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': '&quot;',
+    "'": '&#39;',
+    "/": '&#x2F;'
+};
+
+function escapeHtml(string) {
+    return String(string).replace(/[&<>"'\/]/g, function (s) {
+      return entityMap[s];
+    });
+}
+
 function toggleResource(id){
     var $div = $( "#resource_" + id );
     $div.slideToggle();

diff --git a/modules/relax/includes/js/views/export.html.js b/modules/relax/includes/js/views/export.html.js
@@ -1,4 +1,4 @@
-/*! Copyright 2016 - Ortus Solutions (Compiled: 15-03-2016) */
+/*! Copyright 2016 - Ortus Solutions (Compiled: 18-03-2016) */
 define([ "Backbone", "clipboard", "messenger", "views/home.index" ], function(Backbone, Clipboard, Messenger, APIView) {
     "use strict";
     var View = Backbone.View.extend({
@@ -20,7 +20,6 @@ define([ "Backbone", "clipboard", "messenger", "views/home.index" ], function(Ba
             return this;
         },
         setupDefaults: function() {
-            console.log(Messenger);
             return this;
         },
         render: function() {

diff --git a/modules/relax/includes/js/views/home.index.js b/modules/relax/includes/js/views/home.index.js
@@ -1,4 +1,4 @@
-/*! Copyright 2016 - Ortus Solutions (Compiled: 15-03-2016) */
+/*! Copyright 2016 - Ortus Solutions (Compiled: 18-03-2016) */
 define([ "Backbone", "views/widgets/relaxer", "views/widgets/sidebar", "models/RelaxAPI" ], function(Backbone, Relaxer, SidebarWidget, APIModel) {
     "use strict";
     var View = Backbone.View.extend({

diff --git a/modules/relax/includes/js/views/home.openapidocs.js b/modules/relax/includes/js/views/home.openapidocs.js
@@ -1,4 +1,4 @@
-/*! Copyright 2016 - Ortus Solutions (Compiled: 15-03-2016) */
+/*! Copyright 2016 - Ortus Solutions (Compiled: 18-03-2016) */
 define([ "Backbone" ], function(Backbone) {
     "use strict";
     var View = Backbone.View.extend({

diff --git a/modules/relax/includes/js/views/relax.relaxer.js b/modules/relax/includes/js/views/relax.relaxer.js
@@ -1,4 +1,4 @@
-/*! Copyright 2016 - Ortus Solutions (Compiled: 15-03-2016) */
+/*! Copyright 2016 - Ortus Solutions (Compiled: 18-03-2016) */
 define([ "Backbone", "views/widgets/relaxer", "models/RelaxAPI" ], function(Backbone, RelaxerWidget, APIModel) {
     "use strict";
     var View = Backbone.View.extend({

diff --git a/modules/relax/includes/js/views/widgets/relaxer.js b/modules/relax/includes/js/views/widgets/relaxer.js
@@ -1,4 +1,4 @@
-/*! Copyright 2016 - Ortus Solutions (Compiled: 15-03-2016) */
+/*! Copyright 2016 - Ortus Solutions (Compiled: 18-03-2016) */
 define([ "Backbone" ], function(Backbone) {
     "use strict";
     var View = Backbone.View.extend({

diff --git a/modules/relax/includes/js/views/widgets/sidebar.js b/modules/relax/includes/js/views/widgets/sidebar.js
@@ -1,4 +1,4 @@
-/*! Copyright 2016 - Ortus Solutions (Compiled: 15-03-2016) */
+/*! Copyright 2016 - Ortus Solutions (Compiled: 18-03-2016) */
 define([ "Backbone", "models/RelaxAPI" ], function(Backbone, APIModel) {
     "use strict";
     var View = Backbone.View.extend({
@@ -55,8 +55,6 @@ define([ "Backbone", "models/RelaxAPI" ], function(Backbone, APIModel) {
         onSelectAPI: function(e) {
             var _this = this;
             var $select = $(e.currentTarget);
-            console.log($select.length);
-            console.log($select.val());
             var selectedAPI = $select.val();
             _this.ViewModel.set("id", selectedAPI);
             _this.View.renderLoaderMessage();

diff --git a/modules/relax/layouts/inc/HTMLHead.cfm b/modules/relax/layouts/inc/HTMLHead.cfm
@@ -24,14 +24,12 @@
     <link href='//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,900,300italic,400italic,600italic,700italic,900italic' rel='stylesheet' type='text/css'>
     <link href='//fonts.googleapis.com/css?family=Open+Sans:400,700' rel='stylesheet' type='text/css'>
 
-    <!-- Feature detection -->
-    <script src="#prc.root#/includes/js/modernizr.js"></script>
-
     <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
     <!--[if lt IE 9]>
     <script src="#prc.root#/includes/js/html5shiv.js"></script>
     <script src="#prc.root#/includes/js/respond.min.js"></script>
     <![endif]-->
+
     <cfoutput>
         <!--- <cfdump var="#event#" abort> --->
     <script type="application/javascript">

diff --git a/modules/relax/views/apidoc/_template/method.html b/modules/relax/views/apidoc/_template/method.html
@@ -36,25 +36,30 @@ <h4 class="panel-subtitle text-primary">Parameters:</h4>
 				<hr>
 			<% } %>
 
-			<h4 class="panel-subtitle text-primary">Responses:</h4>
-			<% 
-			_.each( _.keys(method.responses), function( responseKey ){ 
-				if( !isNaN( responseKey ) || responseKey === 'default' ){
-			%>
-				<%= responseTemplate( 
-					{
-						"resourceId": method["x-resourceId"] ,
-						"path":key,
-						"key":responseKey,
-						"response":method.responses[ responseKey ]
-					} 
-				) %>
-
-			<% 
-				}
-
-			}); 
-			%>
+			<% if( _.keys( method.responses ).length ) { %>
+
+				<h4 class="panel-subtitle text-primary">Responses:</h4>
+				<% 
+				_.each( _.keys(method.responses), function( responseKey ){ 
+					if( !isNaN( responseKey ) || responseKey === 'default' ){
+				%>
+					<%= responseTemplate( 
+						{
+							"resourceId": method["x-resourceId"] ,
+							"path":key,
+							"key":responseKey,
+							"response":method.responses[ responseKey ]
+						} 
+					) %>
+
+				<% 
+					}
+
+				}); 
+				%>
+
+			<% } %>
+
 
 		</div>
 	</div>