Fix issue with security schemes and libraries

mulesoft · May 12, 2016 · 7e6403c · 7e6403c
1 parent 5ca5b6d
commit 7e6403c
Show file tree

Hide file tree

Showing 8 changed files with 156 additions and 10 deletions.
diff --git a/dist/examples/libraries/security.raml b/dist/examples/libraries/security.raml
@@ -0,0 +1,19 @@
+#%RAML 1.0 Library
+
+securitySchemes:
+  oauth_2_0:
+    type: OAuth 2.0
+    describedBy:
+      headers:
+        Authorization:
+          type: string
+      queryParameters:
+        access_token:
+          type: string
+      responses:
+        404:
+          description: Unauthorized
+    settings:
+      authorizationUri: https://acme.com/login/oauth/authorize
+      accessTokenUri: https://acme.com/login/oauth/access_token
+      authorizationGrants: [ authorization_code ]
diff --git a/dist/examples/library-security.raml b/dist/examples/library-security.raml
@@ -0,0 +1,12 @@
+#%RAML 1.0
+title: API with Library
+version: 1
+
+baseUri: http://localhost
+
+uses:
+  security: libraries/security.raml
+
+/test:
+  securedBy: [security.oauth_2_0]
+  post:
diff --git a/dist/scripts/api-console.js b/dist/scripts/api-console.js
@@ -1203,9 +1203,16 @@
           delete $scope.types;
           delete $rootScope.types;
 
-          inspectRaml(raml);
-
           $timeout(function () {
+            var securitySchemes = raml.securitySchemes ? angular.copy(raml.securitySchemes) : [];
+            var librarySecuritySchemes = getSecuritySchemes();
+
+            if (securitySchemes || librarySecuritySchemes) {
+              raml.securitySchemes = securitySchemes.concat(librarySecuritySchemes);
+            }
+
+            inspectRaml(raml);
+
             var types = raml.types ? angular.copy(raml.types) : [];
             var libraryTypes = getLibraryTypes();
 
@@ -1293,6 +1300,26 @@
 
             return result;
           }
+
+          function getSecuritySchemes() {
+            var result = [];
+            if (raml.uses) {
+              Object.keys(raml.uses).forEach(function (usesKey) {
+                var usesSecuritySchemes = raml.uses[usesKey].securitySchemes;
+                if (usesSecuritySchemes) {
+                  usesSecuritySchemes.forEach(function (aScheme) {
+                    Object.keys(aScheme).forEach(function (schemaKey) {
+                      var tempSchema = {};
+                      tempSchema[usesKey + '.' + schemaKey] = aScheme[schemaKey];
+                      result.push(tempSchema);
+                    });
+                  });
+                }
+              });
+            }
+
+            return result;
+          }
         });
       })();
 
@@ -2873,9 +2900,23 @@
         ];
 
         /* jshint camelcase: false */
-        var authorizationGrants = $scope.$parent.securitySchemes.oauth_2_0.settings.authorizationGrants;
+        $scope.getOAuth2Settings = function () {
+          var result;
+          for (var securitySchemesKey in $scope.$parent.securitySchemes) {
+            if ($scope.$parent.securitySchemes.hasOwnProperty(securitySchemesKey)) {
+              if ($scope.$parent.securitySchemes[securitySchemesKey].type === 'OAuth 2.0') {
+                result = $scope.$parent.securitySchemes[securitySchemesKey].settings;
+                break;
+              }
+            }
+          }
+          return result;
+        };
+
+        var oauth2Settings = $scope.getOAuth2Settings();
+        var authorizationGrants = oauth2Settings.authorizationGrants;
 
-        $scope.scopes = $scope.$parent.securitySchemes.oauth_2_0.settings.scopes;
+        $scope.scopes = oauth2Settings.scopes;
         $scope.credentials.scopes = {};
 
         if (authorizationGrants) {
@@ -2890,6 +2931,7 @@
     };
   };
 
+
   angular.module('RAML.Security')
     .directive('oauth2', RAML.Security.oauth2);
 })();
@@ -6472,7 +6514,7 @@ angular.module('ramlConsoleApp').run(['$templateCache', function($templateCache)
     "        <h4 class=\"raml-console-resource-heading-a\">Responses</h4>\n" +
     "\n" +
     "        <div class=\"raml-console-resource-param\" ng-repeat=\"(code, info) in documentationSchemeSelected.describedBy.responses\">\n" +
-    "          <h4 class=\"raml-console-resource-param-heading\">{{code}}</h4>\n" +
+    "          <h4 class=\"raml-console-resource-param-heading\">{{info.code}}</h4>\n" +
     "          <p markdown=\"info.description\" class=\"raml-console-marked-content\"></p>\n" +
     "        </div>\n" +
     "      </section>\n" +

diff --git a/src/app/directives/documentation.tpl.html b/src/app/directives/documentation.tpl.html
@@ -52,7 +52,7 @@ <h4 class="raml-console-resource-heading-a">Query Parameters</h4>
         <h4 class="raml-console-resource-heading-a">Responses</h4>
 
         <div class="raml-console-resource-param" ng-repeat="(code, info) in documentationSchemeSelected.describedBy.responses">
-          <h4 class="raml-console-resource-param-heading">{{code}}</h4>
+          <h4 class="raml-console-resource-param-heading">{{info.code}}</h4>
           <p markdown="info.description" class="raml-console-marked-content"></p>
         </div>
       </section>

diff --git a/src/app/directives/raml-console.js b/src/app/directives/raml-console.js
@@ -62,9 +62,16 @@
           delete $scope.types;
           delete $rootScope.types;
 
-          inspectRaml(raml);
-
           $timeout(function () {
+            var securitySchemes = raml.securitySchemes ? angular.copy(raml.securitySchemes) : [];
+            var librarySecuritySchemes = getSecuritySchemes();
+
+            if (securitySchemes || librarySecuritySchemes) {
+              raml.securitySchemes = securitySchemes.concat(librarySecuritySchemes);
+            }
+
+            inspectRaml(raml);
+
             var types = raml.types ? angular.copy(raml.types) : [];
             var libraryTypes = getLibraryTypes();
 
@@ -152,6 +159,26 @@
 
             return result;
           }
+
+          function getSecuritySchemes() {
+            var result = [];
+            if (raml.uses) {
+              Object.keys(raml.uses).forEach(function (usesKey) {
+                var usesSecuritySchemes = raml.uses[usesKey].securitySchemes;
+                if (usesSecuritySchemes) {
+                  usesSecuritySchemes.forEach(function (aScheme) {
+                    Object.keys(aScheme).forEach(function (schemaKey) {
+                      var tempSchema = {};
+                      tempSchema[usesKey + '.' + schemaKey] = aScheme[schemaKey];
+                      result.push(tempSchema);
+                    });
+                  });
+                }
+              });
+            }
+
+            return result;
+          }
         });
       })();
 

diff --git a/src/app/security/oauth2.js b/src/app/security/oauth2.js
@@ -55,9 +55,23 @@
         ];
 
         /* jshint camelcase: false */
-        var authorizationGrants = $scope.$parent.securitySchemes.oauth_2_0.settings.authorizationGrants;
+        $scope.getOAuth2Settings = function () {
+          var result;
+          for (var securitySchemesKey in $scope.$parent.securitySchemes) {
+            if ($scope.$parent.securitySchemes.hasOwnProperty(securitySchemesKey)) {
+              if ($scope.$parent.securitySchemes[securitySchemesKey].type === 'OAuth 2.0') {
+                result = $scope.$parent.securitySchemes[securitySchemesKey].settings;
+                break;
+              }
+            }
+          }
+          return result;
+        };
 
-        $scope.scopes = $scope.$parent.securitySchemes.oauth_2_0.settings.scopes;
+        var oauth2Settings = $scope.getOAuth2Settings();
+        var authorizationGrants = oauth2Settings.authorizationGrants;
+
+        $scope.scopes = oauth2Settings.scopes;
         $scope.credentials.scopes = {};
 
         if (authorizationGrants) {
@@ -72,6 +86,7 @@
     };
   };
 
+
   angular.module('RAML.Security')
     .directive('oauth2', RAML.Security.oauth2);
 })();
diff --git a/src/assets/examples/libraries/security.raml b/src/assets/examples/libraries/security.raml
@@ -0,0 +1,19 @@
+#%RAML 1.0 Library
+
+securitySchemes:
+  oauth_2_0:
+    type: OAuth 2.0
+    describedBy:
+      headers:
+        Authorization:
+          type: string
+      queryParameters:
+        access_token:
+          type: string
+      responses:
+        404:
+          description: Unauthorized
+    settings:
+      authorizationUri: https://acme.com/login/oauth/authorize
+      accessTokenUri: https://acme.com/login/oauth/access_token
+      authorizationGrants: [ authorization_code ]
diff --git a/src/assets/examples/library-security.raml b/src/assets/examples/library-security.raml
@@ -0,0 +1,12 @@
+#%RAML 1.0
+title: API with Library
+version: 1
+
+baseUri: http://localhost
+
+uses:
+  security: libraries/security.raml
+
+/test:
+  securedBy: [security.oauth_2_0]
+  post: