WIP

README.md

@@ -22,7 +22,7 @@ The OpenAPI Specification has undergone 5 revisions since initial creation in 20
 
 Swagger UI Version | Release Date | OpenAPI Spec compatibility | Notes
 ------------------ | ------------ | -------------------------- | -----
-3.14.0 | 2018-04-27 | 2.0, 3.0 | [tag v3.14.0](https://github.com/swagger-api/swagger-ui/tree/v3.14.0)
+3.13.5 | 2018-04-20 | 2.0, 3.0 | [tag v3.13.5](https://github.com/swagger-api/swagger-ui/tree/v3.13.5)
 3.0.21 | 2017-07-26 | 2.0 | [tag v3.0.21](https://github.com/swagger-api/swagger-ui/tree/v3.0.21)
 2.2.10 | 2017-01-04 | 1.1, 1.2, 2.0 | [tag v2.2.10](https://github.com/swagger-api/swagger-ui/tree/v2.2.10)
 2.1.5 | 2016-07-20 | 1.1, 1.2, 2.0 | [tag v2.1.5](https://github.com/swagger-api/swagger-ui/tree/v2.1.5)

dev-helpers/dev.yaml

@@ -0,0 +1,81 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Brentertainment OAuth2 Test Server
+  description: >
+    The server does not support CORS (yet?), so you need to take the strange step of disabling Same-Origin Policy in your browser.
+    [Here](https://www.thepolyglotdeveloper.com/2014/08/bypass-cors-errors-testing-apis-locally/) are some instructions.
+  license:
+    name: MIT
+servers:
+  - url: http://brentertainment.com/oauth2/lockdin/
+paths:
+  /resource:
+    get:
+      description: Protected resource
+      security:
+      - oauth2AuthorizationCode: ["resource"]
+      - oauth2Implicit: ["resource"]
+      - oauth2Password: ["resource"]
+      - oauth2ClientCredentials: ["resource"]
+      - oauth2Multiflow: ["resource"]
+      responses:
+        200:
+          description: the only response
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: string
+components:
+  securitySchemes:
+    oauth2AuthorizationCode:
+      type: oauth2
+      flows:
+        authorizationCode:
+          authorizationUrl: "http://brentertainment.com/oauth2/lockdin/authorize"
+          tokenUrl: "http://brentertainment.com/oauth2/lockdin/token"
+          scopes:
+            resource: our only scope
+    oauth2Implicit:
+      type: oauth2
+      flows:
+        implicit:
+          authorizationUrl: "http://brentertainment.com/oauth2/lockdin/authorize"
+          scopes:
+            resource: our only scope
+    oauth2Password:
+      type: oauth2
+      flows:
+        password:
+          tokenUrl: "http://brentertainment.com/oauth2/lockdin/token"
+          scopes:
+            resource: our only scope
+    oauth2ClientCredentials:
+      type: oauth2
+      flows:
+        clientCredentials:
+          tokenUrl: "http://brentertainment.com/oauth2/lockdin/token"
+          scopes:
+            resource: our only scope
+    oauth2Multiflow:
+      type: oauth2
+      flows:
+        clientCredentials:
+          tokenUrl: "http://brentertainment.com/oauth2/lockdin/token"
+          scopes:
+            resource: our only scope
+        password:
+          tokenUrl: "http://brentertainment.com/oauth2/lockdin/token"
+          scopes:
+            resource: our only scope
+        implicit:
+          authorizationUrl: "http://brentertainment.com/oauth2/lockdin/authorize"
+          scopes:
+            resource: our only scope
+        authorizationCode:
+          authorizationUrl: "http://brentertainment.com/oauth2/lockdin/authorize"
+          tokenUrl: "http://brentertainment.com/oauth2/lockdin/token"
+          scopes:
+            resource: our only scope

package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-ui",
-  "version": "3.14.0",
+  "version": "3.13.6",
   "main": "dist/swagger-ui.js",
   "repository": "git@github.com:swagger-api/swagger-ui.git",
   "contributors": [

src/core/components/auth/auths.jsx

@@ -99,10 +99,13 @@ export default class Auths extends React.Component {
             {
               definitions.filter( schema => schema.get("type") === "oauth2")
                 .map( (schema, name) =>{
-                  return (<div key={ name }>
+                  const { flow } = schema
+                  const key = [name, flow].join("__").slice(0, -2)
+                  return (<div key={ key }>
                     <Oauth2 authorized={ authorized }
                             schema={ schema }
-                            name={ name } />
+                            authId={ key }
+                            name={ key || schema.get("name") || name } />
                   </div>)
                 }
                 ).toArray()

src/core/components/auth/oauth2.jsx

@@ -47,11 +47,11 @@ export default class Oauth2 extends React.Component {
   }
 
   authorize =() => {
-    let { authActions, errActions, getConfigs, authSelectors } = this.props
+    let { authActions, errActions, getConfigs, authSelectors, authId } = this.props
     let configs = getConfigs()
     let authConfigs = authSelectors.getConfigs()
 
-    errActions.clear({authId: name,type: "auth", source: "auth"})
+    errActions.clear({authId: authId ,type: "auth", source: "auth"})
     oauth2Authorize({auth: this.state, authActions, errActions, configs, authConfigs })
   }
 
@@ -79,15 +79,15 @@ export default class Oauth2 extends React.Component {
 
   logout =(e) => {
     e.preventDefault()
-    let { authActions, errActions, name } = this.props
+    let { authActions, errActions, authId } = this.props
 
-    errActions.clear({authId: name, type: "auth", source: "auth"})
-    authActions.logout([ name ])
+    errActions.clear({authId: authId, type: "auth", source: "auth"})
+    authActions.logout([ authId ])
   }
 
   render() {
     let {
-      schema, getComponent, authSelectors, errSelectors, name, specSelectors
+      schema, getComponent, authSelectors, errSelectors, name, authId, specSelectors
     } = this.props
     const Input = getComponent("Input")
     const Row = getComponent("Row")
@@ -107,9 +107,9 @@ export default class Oauth2 extends React.Component {
 
     let flow = schema.get("flow")
     let scopes = schema.get("allowedScopes") || schema.get("scopes")
-    let authorizedAuth = authSelectors.authorized().get(name)
+    let authorizedAuth = authSelectors.authorized().get(authId)
     let isAuthorized = !!authorizedAuth
-    let errors = errSelectors.allErrors().filter( err => err.get("authId") === name)
+    let errors = errSelectors.allErrors().filter( err => err.get("authId") === authId)
     let isValid = !errors.filter( err => err.get("source") === "validation").size
     let description = schema.get("description")
 

src/core/index.js

@@ -173,12 +173,7 @@ module.exports = function SwaggerUI(opts) {
 
   let configUrl = queryConfig.config || constructorConfig.configUrl
 
-  if (!configUrl || !system.specActions.getConfigByUrl || system.specActions.getConfigByUrl && !system.specActions.getConfigByUrl({
-    url: configUrl,
-    loadRemoteConfig: true,
-    requestInterceptor: constructorConfig.requestInterceptor,
-    responseInterceptor: constructorConfig.responseInterceptor,
-  }, downloadSpec)) {
+  if (!configUrl || !system.specActions.getConfigByUrl || system.specActions.getConfigByUrl && !system.specActions.getConfigByUrl(configUrl, downloadSpec)) {
     return downloadSpec()
   }
 

src/core/plugins/configs/spec-actions.js

@@ -1,14 +1,23 @@
 import { parseYamlConfig } from "./helpers"
 
-export const downloadConfig = (req) => (system) => {
-  const {fn: { fetch }} = system
-
+export const downloadConfig = (url) => ({fn: { fetch }, getConfigs}) => {
+  const { requestInterceptor, responseInterceptor } = getConfigs()
+  let req = { url }
+  if(requestInterceptor) {
+    req = requestInterceptor(req)
+  }
   return fetch(req)
+    .then(res => {
+      if(res) {
+        return responseInterceptor(res)
+      }
+      return res
+    })
 }
 
-export const getConfigByUrl = (req, cb)=> ({ specActions }) => {
-  if (req) {
-    return specActions.downloadConfig(req).then(next, next)
+export const getConfigByUrl = (configUrl, cb)=> ({ specActions }) => {
+  if (configUrl) {
+    return specActions.downloadConfig(configUrl).then(next, next)
   }
 
   function next(res) {
@@ -16,7 +25,7 @@ export const getConfigByUrl = (req, cb)=> ({ specActions }) => {
       specActions.updateLoadingStatus("failedConfig")
       specActions.updateLoadingStatus("failedConfig")
       specActions.updateUrl("")
-      console.error(res.statusText + " " + req.url)
+      console.error(res.statusText + " " + configUrl)
       cb(null)
     } else {
       cb(parseYamlConfig(res.text))

src/core/plugins/oas3/auth-extensions/wrap-selectors.js

@@ -33,6 +33,7 @@ export const definitionsToAuthorize = onlyOAS3(createSelector(
           definition.get("flows").entrySeq().forEach(([flowKey, flowVal]) => {
             let translatedDef = fromJS({
               flow: flowKey,
+              name: defName,
               authorizationUrl: flowVal.get("authorizationUrl"),
               tokenUrl: flowVal.get("tokenUrl"),
               scopes: flowVal.get("scopes"),
@@ -40,7 +41,7 @@ export const definitionsToAuthorize = onlyOAS3(createSelector(
             })
 
             list = list.push(new Map({
-              [defName]: translatedDef.filter((v) => {
+              [`${defName}__${flowKey}`]: translatedDef.filter((v) => {
                 // filter out unset values, sometimes `authorizationUrl`
                 // and `tokenUrl` come out as `undefined` in the data
                 return v !== undefined

test/core/plugins/configs/actions.js

@@ -5,23 +5,80 @@ import { downloadConfig } from "corePlugins/configs/spec-actions"
 describe("configs plugin - actions", () => {
 
   describe("downloadConfig", () => {
-    it("should call the system fetch helper with a provided request", () => {
+    it("should call the system fetch helper with a provided url", () => {
       const fetchSpy = createSpy(async () => {}).andCallThrough()
       const system = {
         fn: {
           fetch: fetchSpy
+        },
+        getConfigs() {
+          return {}
         }
       }
 
-      const req = {
-        url: "http://swagger.io/one",
-        requestInterceptor: a => a,
-        responseInterceptor: a => a,
+      const url = "http://swagger.io/one"
+
+      downloadConfig(url)(system)
+
+      expect(fetchSpy).toHaveBeenCalledWith({
+        url: url
+      })
+    })
+    it("should allow the globally configured requestInterceptor to modify the request", () => {
+      const fetchSpy = createSpy(async () => {}).andCallThrough()
+      const requestInterceptorSpy = createSpy((req) => {
+        req.url = "http://swagger.io/two"
+        return req
+      }).andCallThrough()
+      const system = {
+        fn: {
+          fetch: fetchSpy
+        },
+        getConfigs() {
+          return {
+            requestInterceptor: requestInterceptorSpy
+          }
+        }
       }
 
-      downloadConfig(req)(system)
+      const url = "http://swagger.io/one"
 
-      expect(fetchSpy).toHaveBeenCalledWith(req)
+      downloadConfig(url)(system)
+
+      expect(fetchSpy).toHaveBeenCalledWith({
+        url: "http://swagger.io/two"
+      })
+    })
+    it("should allow the globally configured responseInterceptor to modify the response", async () => {
+      const fetchSpy = createSpy(async (req) => {
+        return {
+          url: req.url,
+          ok: true
+        }
+      }).andCallThrough()
+      const responseInterceptorSpy = createSpy((res) => {
+        res.url = "http://swagger.io/two"
+        return res
+      }).andCallThrough()
+      const system = {
+        fn: {
+          fetch: fetchSpy
+        },
+        getConfigs() {
+          return {
+            responseInterceptor: responseInterceptorSpy
+          }
+        }
+      }
+
+      const url = "http://swagger.io/one"
+
+      const res = await downloadConfig(url)(system)
+
+      expect(res).toEqual({
+        url: "http://swagger.io/two",
+        ok: true
+      })
     })
   })
 })