More OAS tests and helpers!

Author: shockey

package.json

@@ -21,7 +21,7 @@
     "watch": "webpack --config webpack.config.js --watch --progress",
     "test": "npm run just-test && npm run lint",
     "just-test": "NODE_ENV=test node ./node_modules/.bin/_mocha --recursive --compilers js:babel-core/register",
-    "test:watch": "npm run test -- -w",
+    "test:watch": "npm run just-test -- -w",
     "lint": "eslint src/ test/",
     "deps-license": "license-checker --production --csv --out $npm_package_config_deps_check_dir/licenses.csv && license-checker --development --csv --out $npm_package_config_deps_check_dir/licenses-dev.csv",
     "deps-size": "webpack -p --config webpack.check.js --json | webpack-bundle-size-analyzer >| $npm_package_config_deps_check_dir/sizes.txt",

src/helpers.js

@@ -5,6 +5,25 @@ const escapeString = (str) => {
   return str.replace(/[^\w]/gi, '_')
 }
 
+// Spec version detection
+export function isOAS3(spec) {
+  const oasVersion = spec.openapi
+  if (!oasVersion) {
+    return false
+  }
+
+  return oasVersion.startsWith('3.0.0')
+}
+
+export function isSwagger2(spec) {
+  const swaggerVersion = spec.swagger
+  if (!swaggerVersion) {
+    return false
+  }
+
+  return swaggerVersion.startsWith('2')
+}
+
 // Strategy for determining operationId
 export function opId(operation, pathName, method = '') {
   const idWithoutWhitespace = (operation.operationId || '').replace(/\s/g, '')

test/execute.js

@@ -803,7 +803,9 @@ describe('execute', () => {
       })
     })
 
-    it('should NOT stringify the body, if provided with a javascript object (execute alone should do that, allowing us to modify the object in a clean way)', function () {
+    it('should NOT stringify the body, if provided with a javascript object', function () {
+      // execute alone should do that, allowing us to modify the object in a clean way)
+
       // Given
       const spec = {
         host: 'swagger.io',
@@ -825,63 +827,6 @@ describe('execute', () => {
     })
   })
 
-describe.only("buildRequest for OpenAPI 3.0", function () {
-  it('should build a request for the given operationId', function () {
-    // Given
-    const spec = {
-      openapi: "3.0.0",
-      paths: {
-        '/one': {
-          get: {
-            operationId: 'getMe'
-          }
-        }
-      }
-    }
-
-    // when
-    const req = buildRequest({spec, operationId: 'getMe'})
-
-    expect(req).toEqual({
-      method: 'GET',
-      url: '/one',
-      credentials: 'same-origin',
-      headers: {},
-    })
-  })
-
-  it('should build a request for the given operationId with a server provided', function () {
-    // Given
-    const spec = {
-      openapi: '3.0.0',
-      servers: [
-        {
-          url: 'http://petstore.swagger.io/v2',
-          name: 'Petstore'
-        }
-      ],
-      paths: {
-        '/one': {
-          get: {
-            operationId: 'getMe'
-          }
-        }
-      }
-    }
-
-    // when
-    const req = buildRequest({spec, operationId: 'getMe'})
-
-    expect(req).toEqual({
-      method: 'GET',
-      url: 'http://petstore.swagger.io/v2/one',
-      credentials: 'same-origin',
-      headers: {},
-    })
-  })
-
-
-})
 
   // Note: this is to handle requestContentType and responseContentType
   // although more might end up using it.

test/oas3/client.js

@@ -0,0 +1,112 @@
+import expect from 'expect'
+import http from 'http'
+import url from 'url'
+import path from 'path'
+import fs from 'fs'
+
+import Swagger from '../../src/index'
+
+describe('http - OpenAPI Specification 3.0', () => {
+  let server
+  before(function () {
+    server = http.createServer(function (req, res) {
+      const accept = req.headers.accept
+      let contentType
+      const uri = url.parse(req.url).pathname
+      const filename = path.join('test', 'oas3', 'data', uri)
+
+      if (filename.indexOf('.yaml') > 0) {
+        contentType = 'application/yaml'
+      }
+      else {
+        contentType = 'application/json'
+      }
+
+      if (typeof accept !== 'undefined') {
+        if (accept === 'invalid') {
+          res.writeHead(500)
+          res.end()
+          return
+        }
+
+        if (accept.indexOf('application/json') >= 0) {
+          contentType = accept
+          res.setHeader('Content-Type', contentType)
+        }
+        if (filename.indexOf('.yaml') > 0) {
+          res.setHeader('Content-Type', 'application/yaml')
+        }
+      }
+
+      fs.exists(filename, function (exists) {
+        if (exists) {
+          const fileStream = fs.createReadStream(filename)
+          res.setHeader('Access-Control-Allow-Origin', '*')
+          res.writeHead(200, contentType)
+          fileStream.pipe(res)
+        }
+        else {
+          res.writeHead(404, {'Content-Type': 'text/plain'})
+          res.write('404 Not Found\n')
+          res.end()
+        }
+      })
+    }).listen(8000)
+  })
+
+  after(function () {
+    server.close()
+  })
+
+  afterEach(function () {
+  })
+
+  it('should get the petstore api and build it', (done) => {
+    Swagger('http://localhost:8000/petstore-oas3.yaml')
+      .then((client) => {
+        expect(client).toExist()
+
+        // we have 3 tags
+        expect(Object.keys(client.apis).length).toBe(1)
+
+        // the pet tag exists
+        expect(client.apis.pets).toExist()
+
+        // the get pet operation
+        expect(client.apis.pets.getPetById).toExist()
+
+        done()
+      })
+      .catch(e => done (e))
+  })
+
+  /**
+   * See https://github.com/swagger-api/swagger-js/issues/1005
+   */
+  it('should get a pet from the petstore', (done) => {
+    Swagger('http://localhost:8000/petstore-oas3.yaml')
+      .then((client) => {
+        client.apis.pets.getPetById({petId: -1})
+          .then((data) => {
+            done()
+          })
+          .catch((err) => {
+            done(err)
+          })
+      })
+      .catch(e => done (e))
+  })
+
+  /**
+   * See https://github.com/swagger-api/swagger-js/issues/1002
+   */
+  it('should return an error when a spec doesnt exist', (done) => {
+    Swagger('http://localhost:8000/not-real.yaml')
+      .then((client) => {
+        done('expected an error')
+      })
+      .catch((error) => {
+        done()
+      })
+  })
+})