Merge pull request #111 from mulesoft/chores/show-security-schema-describeBy

jcenturion · jcenturion · commit 608e6969ce43 · 2015-02-24T16:17:27.000-03:00
Chores/show security schema describe by
diff --git a/dist/examples/leagues.raml b/dist/examples/leagues.raml
@@ -37,16 +37,21 @@ securitySchemes:
         authorizationGrants: [ code, credentials, owner ]
         scopes:
           - "user"
-          - "user:email"
-          - "user:follow"
-          - "public_repo"
-          - "repo"
-          - "repo:status"
-          - "delete_repo"
-          - "notifications"
-          - "gist"
+          - "league"
+  - custom_scheme_1:
+      type: x-custom
+      describedBy:
+        headers:
+          auth:
+        queryParameters:
+          access_token:
+  - custom_scheme_2:
+      type: x-custom
+      describedBy:
+        headers:
+          auth:
 
-securedBy: [ basic, digest_auth, oauth_2_0 ]
+securedBy: [ basic, digest_auth, oauth_2_0, custom_scheme_1, custom_scheme_2 ]
 
 /teams:
   displayName: Teams
@@ -145,14 +150,16 @@ securedBy: [ basic, digest_auth, oauth_2_0 ]
   get:
     description: |
       *Obtain* information from a collection of teams simultaneously
+    headers:
+      header:
     queryParameters:
       city:
         description:
           Filter the list of teams by home city.
         type: string
         required: false
         default: BAR
-        example: Barcelona
+        example: BAR
     responses:
       200:
         body:
diff --git a/dist/scripts/api-console.js b/dist/scripts/api-console.js
@@ -381,6 +381,10 @@
           }
         }
 
+        function beautifyCustomSecuritySchemeName (name) {
+          return (name.charAt(0).toUpperCase() + name.slice(1)).replace(/_/g, ' ');
+        }
+
         $scope.readTraits = function (traits) {
           var list = [];
 
@@ -442,6 +446,18 @@
             type: 'Anonymous'
           };
 
+          Object.keys($scope.securitySchemes).map(function (key) {
+            var type = $scope.securitySchemes[key].type;
+
+            $scope.securitySchemes[key].name = type;
+            $scope.securitySchemes[key].id = type + '|' + key;
+
+            if (type === 'x-custom') {
+              $scope.securitySchemes[key].name = beautifyCustomSecuritySchemeName(key);
+              $scope.securitySchemes[key].id = type + '|' + key;
+            }
+          });
+
           /*jshint camelcase: false */
           // Digest Authentication is not supported
           delete $scope.securitySchemes.digest_auth;
@@ -913,6 +929,7 @@
       controller: function ($scope, $location, $anchorScroll) {
         $scope.markedOptions = RAML.Settings.marked;
         $scope.currentSchemeType = 'Anonymous';
+        $scope.currentScheme = 'Anonymous|anonymous';
         $scope.responseDetails = false;
 
         function completeAnimation (element) {
@@ -1172,6 +1189,64 @@
 
         $scope.context.forceRequest = false;
 
+        function cleanSchemeMetadata(collection, context) {
+          Object.keys(collection).map(function (key) {
+            if (collection[key][0].isFromSecurityScheme) {
+              delete collection[key];
+            }
+
+            if (context.plain[key].definitions[0].isFromSecurityScheme) {
+              delete context.plain[key];
+            }
+          });
+        }
+
+        function updateContextData (type, scheme, collection, context) {
+          var details         = $scope.securitySchemes[scheme].describedBy || {};
+          var securityHeaders = details[type] || {};
+
+          if (securityHeaders) {
+            Object.keys(securityHeaders).map(function (key) {
+              if (!securityHeaders[key]) {
+                securityHeaders[key] = {
+                  id: key,
+                  type: 'string'
+                };
+              }
+
+              securityHeaders[key].displayName             = key;
+              securityHeaders[key].isFromSecurityScheme    = true;
+              collection[key] = [securityHeaders[key]];
+
+              context.plain[key] = {
+                definitions: [securityHeaders[key]],
+                selected: securityHeaders[key].type
+              };
+              context.values[key] = [undefined];
+            });
+          }
+        }
+
+        $scope.securitySchemeChanged = function (scheme) {
+          var info            = scheme.split('|');
+          var type            = info[0];
+          var name            = info[1];
+
+          $scope.currentSchemeType = type;
+
+          cleanSchemeMetadata($scope.methodInfo.headers.plain, $scope.context.headers);
+          cleanSchemeMetadata($scope.methodInfo.queryParameters, $scope.context.queryParameters);
+
+          if (type === 'x-custom') {
+            if (!$scope.methodInfo.headers.plain) {
+              $scope.methodInfo.headers.plain = {};
+            }
+
+            updateContextData('headers', name, $scope.methodInfo.headers.plain, $scope.context.headers);
+            updateContextData('queryParameters', name, $scope.methodInfo.queryParameters, $scope.context.queryParameters);
+          }
+        };
+
         $scope.tryIt = function ($event) {
           $scope.requestOptions  = null;
           $scope.responseDetails = false;
@@ -1929,6 +2004,8 @@
         return new RAML.Client.AuthStrategies.Oauth2(scheme, credentials);
       case 'OAuth 1.0':
         return new RAML.Client.AuthStrategies.Oauth1(scheme, credentials);
+      case 'x-custom':
+        return RAML.Client.AuthStrategies.anonymous();
       default:
         throw new Error('Unknown authentication strategy: ' + scheme.type);
       }
@@ -5114,7 +5191,7 @@ angular.module('ramlConsoleApp').run(['$templateCache', function($templateCache)
 
   $templateCache.put('directives/raml-field.tpl.html',
     "<div>\n" +
-    "  <label for=\"{{param.id}}\" class=\"raml-console-sidebar-label\">{{param.displayName}} <a class=\"raml-console-sidebar-override\" ng-if=\"canOverride(param)\" ng-click=\"overrideField($event, param)\">Override</a> <span class=\"raml-console-side-bar-required-field\" ng-if=\"param.required\">*</span></label>\n" +
+    "  <label for=\"{{param.id}}\" class=\"raml-console-sidebar-label\">{{param.displayName}} <a class=\"raml-console-sidebar-override\" ng-if=\"canOverride(param)\" ng-click=\"overrideField($event, param)\">Override</a> <span class=\"raml-console-side-bar-required-field\" ng-if=\"param.required\">*</span><label ng-if=\"param.isFromSecurityScheme\" class=\"raml-console-sidebar-security-label\">from security scheme</label></label>\n" +
     "\n" +
     "  <span class=\"raml-console-sidebar-input-tooltip-container raml-console-sidebar-input-left\" ng-if=\"hasExampleValue(param)\">\n" +
     "    <button tabindex=\"-1\" class=\"raml-console-sidebar-input-reset\" ng-click=\"reset(param)\"><span class=\"raml-console-visuallyhidden\">Reset field</span></button>\n" +
@@ -5318,8 +5395,8 @@ angular.module('ramlConsoleApp').run(['$templateCache', function($templateCache)
     "            <div class=\"raml-console-sidebar-row raml-console-sidebar-securty\">\n" +
     "              <div class=\"raml-console-toggle-group raml-console-sidebar-toggle-group\">\n" +
     "                <label class=\"raml-console-sidebar-label\">Security Scheme</label>\n" +
-    "                <select class=\"raml-console-sidebar-input\" ng-model=\"currentSchemeType\" style=\"margin-bottom: 0;\">\n" +
-    "                 <option ng-repeat=\"(key, scheme) in securitySchemes\" value=\"{{scheme.type}}\" ng-selected=\"scheme.type=='Anonymous'\">{{scheme.type}}</option>\n" +
+    "                <select ng-change=\"securitySchemeChanged(currentScheme)\" class=\"raml-console-sidebar-input\" ng-model=\"currentScheme\" style=\"margin-bottom: 0;\">\n" +
+    "                 <option ng-repeat=\"(key, scheme) in securitySchemes\" value=\"{{scheme.id}}\" ng-selected=\"scheme.type=='Anonymous'\">{{scheme.name}}</option>\n" +
     "                </select>\n" +
     "              </div>\n" +
     "            </div>\n" +
diff --git a/dist/styles/api-console-dark-theme.css b/dist/styles/api-console-dark-theme.css
@@ -3238,6 +3238,15 @@ a.raml-console-resource-path-active {
   font-weight: 700;
 }
 
+.raml-console-sidebar-security-label {
+  display: inline;
+  float: right;
+  font-size: 11px;
+  font-weight: normal;
+  margin-right: 5px;
+  margin-top: 9px;
+}
+
 .raml-console-sidebar-input {
   display: block;
   width: 100%;
diff --git a/dist/styles/api-console-light-theme.css b/dist/styles/api-console-light-theme.css
@@ -3238,6 +3238,15 @@ a.raml-console-resource-path-active {
   font-weight: 700;
 }
 
+.raml-console-sidebar-security-label {
+  display: inline;
+  float: right;
+  font-size: 11px;
+  font-weight: normal;
+  margin-right: 5px;
+  margin-top: 9px;
+}
+
 .raml-console-sidebar-input {
   display: block;
   width: 100%;
diff --git a/src/app/directives/method-list.js b/src/app/directives/method-list.js
@@ -53,6 +53,10 @@
           }
         }
 
+        function beautifyCustomSecuritySchemeName (name) {
+          return (name.charAt(0).toUpperCase() + name.slice(1)).replace(/_/g, ' ');
+        }
+
         $scope.readTraits = function (traits) {
           var list = [];
 
@@ -114,6 +118,18 @@
             type: 'Anonymous'
           };
 
+          Object.keys($scope.securitySchemes).map(function (key) {
+            var type = $scope.securitySchemes[key].type;
+
+            $scope.securitySchemes[key].name = type;
+            $scope.securitySchemes[key].id = type + '|' + key;
+
+            if (type === 'x-custom') {
+              $scope.securitySchemes[key].name = beautifyCustomSecuritySchemeName(key);
+              $scope.securitySchemes[key].id = type + '|' + key;
+            }
+          });
+
           /*jshint camelcase: false */
           // Digest Authentication is not supported
           delete $scope.securitySchemes.digest_auth;
diff --git a/src/app/directives/raml-field.tpl.html b/src/app/directives/raml-field.tpl.html
@@ -1,5 +1,5 @@
 <div>
-  <label for="{{param.id}}" class="raml-console-sidebar-label">{{param.displayName}} <a class="raml-console-sidebar-override" ng-if="canOverride(param)" ng-click="overrideField($event, param)">Override</a> <span class="raml-console-side-bar-required-field" ng-if="param.required">*</span></label>
+  <label for="{{param.id}}" class="raml-console-sidebar-label">{{param.displayName}} <a class="raml-console-sidebar-override" ng-if="canOverride(param)" ng-click="overrideField($event, param)">Override</a> <span class="raml-console-side-bar-required-field" ng-if="param.required">*</span><label ng-if="param.isFromSecurityScheme" class="raml-console-sidebar-security-label">from security scheme</label></label>
 
   <span class="raml-console-sidebar-input-tooltip-container raml-console-sidebar-input-left" ng-if="hasExampleValue(param)">
     <button tabindex="-1" class="raml-console-sidebar-input-reset" ng-click="reset(param)"><span class="raml-console-visuallyhidden">Reset field</span></button>
diff --git a/src/app/directives/sidebar.js b/src/app/directives/sidebar.js
@@ -9,6 +9,7 @@
       controller: function ($scope, $location, $anchorScroll) {
         $scope.markedOptions = RAML.Settings.marked;
         $scope.currentSchemeType = 'Anonymous';
+        $scope.currentScheme = 'Anonymous|anonymous';
         $scope.responseDetails = false;
 
         function completeAnimation (element) {
@@ -268,6 +269,64 @@
 
         $scope.context.forceRequest = false;
 
+        function cleanSchemeMetadata(collection, context) {
+          Object.keys(collection).map(function (key) {
+            if (collection[key][0].isFromSecurityScheme) {
+              delete collection[key];
+            }
+
+            if (context.plain[key].definitions[0].isFromSecurityScheme) {
+              delete context.plain[key];
+            }
+          });
+        }
+
+        function updateContextData (type, scheme, collection, context) {
+          var details         = $scope.securitySchemes[scheme].describedBy || {};
+          var securityHeaders = details[type] || {};
+
+          if (securityHeaders) {
+            Object.keys(securityHeaders).map(function (key) {
+              if (!securityHeaders[key]) {
+                securityHeaders[key] = {
+                  id: key,
+                  type: 'string'
+                };
+              }
+
+              securityHeaders[key].displayName             = key;
+              securityHeaders[key].isFromSecurityScheme    = true;
+              collection[key] = [securityHeaders[key]];
+
+              context.plain[key] = {
+                definitions: [securityHeaders[key]],
+                selected: securityHeaders[key].type
+              };
+              context.values[key] = [undefined];
+            });
+          }
+        }
+
+        $scope.securitySchemeChanged = function (scheme) {
+          var info            = scheme.split('|');
+          var type            = info[0];
+          var name            = info[1];
+
+          $scope.currentSchemeType = type;
+
+          cleanSchemeMetadata($scope.methodInfo.headers.plain, $scope.context.headers);
+          cleanSchemeMetadata($scope.methodInfo.queryParameters, $scope.context.queryParameters);
+
+          if (type === 'x-custom') {
+            if (!$scope.methodInfo.headers.plain) {
+              $scope.methodInfo.headers.plain = {};
+            }
+
+            updateContextData('headers', name, $scope.methodInfo.headers.plain, $scope.context.headers);
+            updateContextData('queryParameters', name, $scope.methodInfo.queryParameters, $scope.context.queryParameters);
+          }
+        };
+
         $scope.tryIt = function ($event) {
           $scope.requestOptions  = null;
           $scope.responseDetails = false;
diff --git a/src/app/directives/sidebar.tpl.html b/src/app/directives/sidebar.tpl.html
@@ -26,8 +26,8 @@ <h4 class="raml-console-sidebar-subhead">Authentication</h4>
             <div class="raml-console-sidebar-row raml-console-sidebar-securty">
               <div class="raml-console-toggle-group raml-console-sidebar-toggle-group">
                 <label class="raml-console-sidebar-label">Security Scheme</label>
-                <select class="raml-console-sidebar-input" ng-model="currentSchemeType" style="margin-bottom: 0;">
-                 <option ng-repeat="(key, scheme) in securitySchemes" value="{{scheme.type}}" ng-selected="scheme.type=='Anonymous'">{{scheme.type}}</option>
+                <select ng-change="securitySchemeChanged(currentScheme)" class="raml-console-sidebar-input" ng-model="currentScheme" style="margin-bottom: 0;">
+                 <option ng-repeat="(key, scheme) in securitySchemes" value="{{scheme.id}}" ng-selected="scheme.type=='Anonymous'">{{scheme.name}}</option>
                 </select>
               </div>
             </div>
diff --git a/src/assets/examples/leagues.raml b/src/assets/examples/leagues.raml
@@ -37,16 +37,21 @@ securitySchemes:
         authorizationGrants: [ code, credentials, owner ]
         scopes:
           - "user"
-          - "user:email"
-          - "user:follow"
-          - "public_repo"
-          - "repo"
-          - "repo:status"
-          - "delete_repo"
-          - "notifications"
-          - "gist"
+          - "league"
+  - custom_scheme_1:
+      type: x-custom
+      describedBy:
+        headers:
+          auth:
+        queryParameters:
+          access_token:
+  - custom_scheme_2:
+      type: x-custom
+      describedBy:
+        headers:
+          auth:
 
-securedBy: [ basic, digest_auth, oauth_2_0 ]
+securedBy: [ basic, digest_auth, oauth_2_0, custom_scheme_1, custom_scheme_2 ]
 
 /teams:
   displayName: Teams
@@ -145,14 +150,16 @@ securedBy: [ basic, digest_auth, oauth_2_0 ]
   get:
     description: |
       *Obtain* information from a collection of teams simultaneously
+    headers:
+      header:
     queryParameters:
       city:
         description:
           Filter the list of teams by home city.
         type: string
         required: false
         default: BAR
-        example: Barcelona
+        example: BAR
     responses:
       200:
         body:
diff --git a/src/common/client/auth_strategies.js b/src/common/client/auth_strategies.js
@@ -14,6 +14,8 @@
         return new RAML.Client.AuthStrategies.Oauth2(scheme, credentials);
       case 'OAuth 1.0':
         return new RAML.Client.AuthStrategies.Oauth1(scheme, credentials);
+      case 'x-custom':
+        return RAML.Client.AuthStrategies.anonymous();
       default:
         throw new Error('Unknown authentication strategy: ' + scheme.type);
       }
diff --git a/src/scss/_sidebar.scss b/src/scss/_sidebar.scss

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,8 @@`
`14`	`14`	`return new RAML.Client.AuthStrategies.Oauth2(scheme, credentials);`
`15`	`15`	`case 'OAuth 1.0':`
`16`	`16`	`return new RAML.Client.AuthStrategies.Oauth1(scheme, credentials);`
	`17`	`+ case 'x-custom':`
	`18`	`+ return RAML.Client.AuthStrategies.anonymous();`
`17`	`19`	`default:`
`18`	`20`	`throw new Error('Unknown authentication strategy: ' + scheme.type);`
`19`	`21`	`}`