apib2swagger 1.12.0 → 1.14.1

package/test/output/OpenAPI3_responses.ref.json

@@ -0,0 +1,245 @@
+{
+    "openapi": "3.0.3",
+    "info": {
+        "title": "",
+        "version": "1.0.0",
+        "description": ""
+    },
+    "servers": [
+        {
+          "url": "https://www.testhost.com"
+        }
+    ],
+    "paths": {
+        "/some/resource": {
+            "get": {
+                "responses": {
+                    "200": {
+                        "description": "Array schema",
+                        "headers": {
+                            "X-My-Message-Header": {
+                                "schema": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "oneOf": [
+                                        {
+                                            "type": "object",
+                                            "properties": {
+                                                "message": {
+                                                    "type": "string",
+                                                    "description": "This is the message description "
+                                                }
+                                            }
+                                        },
+                                        {
+                                            "type": "object",
+                                            "properties": {
+                                                "other": {
+                                                    "type": "string",
+                                                    "description": "This is the message description "
+                                                }
+                                            }
+                                        },
+                                        {
+                                            "type": "array",
+                                            "items": {
+                                                "type": "object",
+                                                "properties": {
+                                                    "message": {
+                                                        "type": "string",
+                                                        "description": "This is the message description "
+                                                    }
+                                                }
+                                            }
+                                        }
+                                    ]
+                                },
+                                "examples": {
+                                    "example1": {
+                                        "value": {
+                                            "message": "Hello World!"
+                                        }
+                                    },
+                                    "example2": {
+                                        "value": {
+                                            "other": "Hello World!"
+                                        }
+                                    },
+                                    "example3": {
+                                        "value": {
+                                            "other": "Hello World!"
+                                        }
+                                    },
+                                    "example4": {
+                                        "value": [
+                                            {
+                                                "message": "Hello World!"
+                                            }
+                                        ]
+                                    }
+                                }
+                            }
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "headers": {},
+                        "content": {
+                            "application/json": {
+                                "example": {
+                                    "message": "Invalid data"
+                                }
+                            }
+                        }
+                    }
+                },
+                "summary": "Some resource",
+                "operationId": "Some resource",
+                "description": "",
+                "tags": [],
+                "parameters": []
+            },
+            "post": {
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "headers": {
+                            "X-My-Message-Header": {
+                                "schema": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "object",
+                                    "properties": {
+                                        "message": {
+                                            "type": "string",
+                                            "description": "This is the message description "
+                                        }
+                                    }
+                                },
+                                "examples": {
+                                    "example1": {
+                                        "value": {
+                                            "message": "Hello World!"
+                                        }
+                                    },
+                                    "example2": {
+                                        "value": {
+                                            "message": "Hello World!"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "summary": "Some resource",
+                "operationId": "Some resource",
+                "description": "",
+                "tags": [],
+                "parameters": []
+            }
+        },
+        "/test/attributes": {
+            "get": {
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "headers": {},
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "oneOf": [
+                                        {
+                                            "$ref": "#/components/schemas/Message"
+                                        },
+                                        {
+                                            "$ref": "#/components/schemas/OtherMessage"
+                                        }
+                                    ]
+                                },
+                                "examples": {
+                                    "example1": {
+                                        "value": {
+                                            "message": "Hello World!"
+                                        }
+                                    },
+                                    "example2": {
+                                        "value": {
+                                            "message": "Hello World2"
+                                        }
+                                    },
+                                    "example3": {
+                                        "value": {
+                                            "otherMessage": "Hello World!"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "summary": "Some resource",
+                "operationId": "Some resource",
+                "description": "",
+                "tags": [],
+                "parameters": []
+            }
+        },
+        "/message": {
+            "get": {
+                "responses": {
+                    "200": {
+                        "description": "Unparsable schema should fall back to Attributes",
+                        "headers": {},
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/Message"
+                                },
+                                "example": {
+                                    "message": ""
+                                }
+                            }
+                        }
+                    }
+                },
+                "summary": "Message",
+                "operationId": "Message",
+                "description": "",
+                "tags": [],
+                "parameters": []
+            }
+        }
+    },
+    "components": {
+        "schemas":{
+            "Message": {
+                "type": "object",
+                "properties": {
+                    "message": {
+                        "type": "string"
+                    }
+                }
+            },
+            "OtherMessage": {
+                "type": "object",
+                "properties": {
+                    "otherMessage": {
+                        "type": "string"
+                    }
+                }
+            }
+        }
+    },
+    "tags": []
+}

package/test/output/schema_without_body.json

@@ -0,0 +1,52 @@
+{
+    "swagger": "2.0",
+    "info": {
+        "title": "",
+        "version": "",
+        "description": ""
+    },
+    "paths": {
+        "/some/resource": {
+            "post": {
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "headers": {},
+                        "examples": {
+                            "text/plain": ""
+                        }
+                    }
+                },
+                "summary": "Some resource",
+                "operationId": "Some resource",
+                "description": "",
+                "tags": [],
+                "parameters": [
+                    {
+                        "name": "body",
+                        "in": "body",
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "prop1": {
+                                    "type": "string"
+                                }
+                            },
+                            "required": [
+                                "prop1"
+                            ]
+                        }
+                    }
+                ],
+                "produces": [
+                    "text/plain"
+                ]
+            }
+        }
+    },
+    "definitions": {
+        "Some resource": {}
+    },
+    "securityDefinitions": {},
+    "tags": []
+}

package/test/output/schema_without_body.ref.json

@@ -0,0 +1,52 @@
+{
+    "swagger": "2.0",
+    "info": {
+        "title": "",
+        "version": "",
+        "description": ""
+    },
+    "paths": {
+        "/some/resource": {
+            "post": {
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "headers": {},
+                        "examples": {
+                            "text/plain": ""
+                        }
+                    }
+                },
+                "summary": "Some resource",
+                "operationId": "Some resource",
+                "description": "",
+                "tags": [],
+                "parameters": [
+                    {
+                        "name": "body",
+                        "in": "body",
+                        "schema": {
+                            "type": "object",
+                            "properties": {
+                                "prop1": {
+                                    "type": "string"
+                                }
+                            },
+                            "required": [
+                                "prop1"
+                            ]
+                        }
+                    }
+                ],
+                "produces": [
+                    "text/plain"
+                ]
+            }
+        }
+    },
+    "definitions": {
+        "Some resource": {}
+    },
+    "securityDefinitions": {},
+    "tags": []
+}

package/test/test.js

@@ -4,6 +4,14 @@ var assert = require("assert"),
     apib2swagger = require("../index.js"),
     tv4 = require('tv4');
 
+const swaggerSchema = JSON.parse(fs.readFileSync('test/swagger_20_schema.json'));
+const openAPI3Schema = JSON.parse(fs.readFileSync('test/openAPI_30_schema.json'))
+const meta_schema = JSON.parse(fs.readFileSync('test/meta_schema.json'));
+
+tv4.addSchema('http://json-schema.org/draft-04/schema', meta_schema);
+tv4.addSchema('https://spec.openapis.org/oas/3.0/schema/2021-09-28', openAPI3Schema);
+tv4.addSchema('http://swagger.io/v2/schema.json', swaggerSchema);
+      
 var remote = 'https://raw.githubusercontent.com/apiaryio/api-blueprint/format-1A9/examples/',
     localInput = 'test/input/',
     localOutput = 'test/output/',
@@ -38,8 +46,16 @@ var remote = 'https://raw.githubusercontent.com/apiaryio/api-blueprint/format-1A
         'Issue-#36.md',
         'Issue-#38.md',
         'Issue-#49.md',
+        'Issue-#57.md',
         'apiblueprint_uber.md',
-        'apiblueprint_valid_simple.md'
+        'apiblueprint_valid_simple.md',
+        'schema_without_body.md',
+        'OpenAPI3_responses.md',
+        'OpenAPI3_requests.md',
+        'OpenAPI3_headers.md',
+        'OpenAPI3_includes.md',
+        'OpenAPI3_attributes.md',
+        'OpenAPI3_Issue-#58.md'
     ];
 
 var fetch = function (file) {
@@ -79,6 +95,7 @@ const checkResultByFile = (result, file, originalExtension, newExtension) => {
         var f = fs.readFileSync(localOutput + file.replace(originalExtension, newExtension));
         var expected_answer = JSON.parse(f);
         assert.deepEqual(result.swagger, expected_answer);
+        const schema = file.includes('OpenAPI3') ? openAPI3Schema : swaggerSchema
         var validation_result = tv4.validateResult(result.swagger, schema);
         if (validation_result.error) {
             console.log(validation_result);
@@ -95,16 +112,16 @@ describe("apib2swagger", function () {
             return Promise.all(files.map(fetch));
         });
 
-        schema = JSON.parse(fs.readFileSync('test/swagger_20_schema.json'));
-        tv4.addSchema('http://swagger.io/v2/schema.json', schema);
-        meta_schema = JSON.parse(fs.readFileSync('test/meta_schema.json'));
-        tv4.addSchema('http://json-schema.org/draft-04/schema', meta_schema);
-
         files.concat(includedFiles).forEach(function (file) {
+            const options = {}
+            if (file.includes('OpenAPI3')){
+                options.openApi3 = true
+            }
+
             it(file, function (done) {
                 this.timeout(10000); // 10s
                 var apib = fs.readFileSync(localInput + file, "utf-8").replace(/\r/g, '');
-                apib2swagger.convert(apib, function (error, result) {
+                apib2swagger.convert(apib, options, function (error, result) {
                     if (error) {
                         return done(error);
                     }
@@ -117,7 +134,7 @@ describe("apib2swagger", function () {
             it(file + ' (--prefer-reference)', function (done) {
                 this.timeout(10000); // 10s
                 var apib = fs.readFileSync(localInput + file, "utf-8").replace(/\r/g, '');
-                apib2swagger.convert(apib, { preferReference: true }, function (error, result) {
+                apib2swagger.convert(apib, { ...options, preferReference: true }, function (error, result) {
                     if (error) {
                         return done(error);
                     }
@@ -140,7 +157,7 @@ describe("apib2swagger", function () {
                         return done(error);
                     }
                     assert.equal(result.swagger.info.version, test.output);
-                    var validation_result = tv4.validateResult(result.swagger, schema);
+                    var validation_result = tv4.validateResult(result.swagger, swaggerSchema);
                     if (validation_result.error) {
                         console.log(validation_result);
                     }

package/test/util.test.js

@@ -0,0 +1,151 @@
+const { hasFileRef, normalizeIncludes, getRefFromInclude, getAbsolutePath } = require('../src/util')
+const assert = require('assert')
+const sinon = require('sinon')
+const fs = require('fs')
+
+describe('util', () => {
+    describe('hasFileRef', () => {
+        it('should return true when include is present - has spaces', () => {
+            const result = hasFileRef('<!-- include(test.json) -->')
+            assert.equal(result, true)
+        })
+
+        it('should return true when include is present - lack of spaces', () => {
+            const result = hasFileRef('<!--include(test.json)-->')
+            assert.equal(result, true)
+        })
+
+        it('should return false when include is not present', () => {
+            const result = hasFileRef('test.json')
+            assert.equal(result, false)
+        })
+    });
+
+    describe('normalizeIncludes', () => {
+        it('should not affect contents before or after the include', () => {
+            const result = normalizeIncludes('12345<!-- include: path/to/file.json -->6789')
+            assert.equal(result, '12345<!-- include(path/to/file.json) -->6789')
+        })
+        
+        it('should work with different input syntaxes', () => {
+            const inputSyntaxes = [
+                '<!-- include: path/to/file.json -->',
+                '<!-- include:path/to/file.json-->',
+                '<!-- include(path/to/file.json)-->',
+                '<!-- include (path/to/file.json) -->',
+                '<!-- include ( path/to/file.json ) -->',
+                '<!-- include  (  path/to/file.json  )  -->',
+                '<!-- include (path/to/file.json -->',
+            ]
+            inputSyntaxes.forEach(str => {
+                const result = normalizeIncludes(str)
+                assert.equal(result, '<!-- include(path/to/file.json) -->')
+            })
+        })
+
+        it('should work with multiple includes', () => {
+            const result = normalizeIncludes(`
+                1234<!-- include: path/to/file.json -->5678
+                1111<!-- include(path/to/file.json)-->2222
+            `)
+            assert.equal(result, `
+                1234<!-- include(path/to/file.json) -->5678
+                1111<!-- include(path/to/file.json) -->2222
+            `)
+        })
+
+        it('should allow parens in file name', () => {
+            const result = normalizeIncludes('<!-- include: path/to/file(test).json -->')
+            assert.equal(result, '<!-- include(path/to/file(test).json) -->')
+        })
+    });
+
+    describe('getRefFromInclude', () => {
+        it('should work with different input stynaxes', () => {
+            const inputSyntaxes = [
+                '<!-- include: path/to/file.json -->',
+                '<!-- include:path/to/file.json-->',
+                '<!-- include(path/to/file.json)-->',
+                '<!-- include (path/to/file.json) -->',
+                '<!-- include ( path/to/file.json ) -->',
+                '<!-- include (path/to/file.json -->',
+            ]
+            inputSyntaxes.forEach(str => {
+                const result = getRefFromInclude(str)
+                assert.deepEqual(result, { $ref: 'path/to/file.json' })
+            })
+        }) 
+
+        it('should allow parens in file name', () => {
+            const result = getRefFromInclude('<!-- include: path/to/file(test).json -->')
+            assert.deepEqual(result, { $ref: 'path/to/file(test).json' })
+        })
+
+        it('should throw an error if the syntax does not match a supported syntax', () => {
+            assert.throws(() => {
+                getRefFromInclude('<!-- include[path/to/file(test).json] -->')
+            })
+        })
+    });
+
+    describe('getAbsolutePath', () => {
+        const existsSync = sinon.stub(fs, 'existsSync')
+        const cwdStub = sinon.stub(process, 'cwd')
+        afterEach(() => {
+            existsSync.reset()
+            cwdStub.reset()
+        })
+
+        it('should return the path to the give source directory if the file exists', () => {
+            existsSync.returns(true)
+            const result = getAbsolutePath({ ['source-dir']: '~/source/dir/' }, '/file.json')
+            assert.equal(result, '~/source/dir/file.json')
+        })
+
+        it('should return the correct path when source is not given and execution path file exists', () => {
+            cwdStub.returns('~/cwd/dir/')
+            existsSync.returns(true)
+
+            const result = getAbsolutePath({}, '/file.json')
+            assert.equal(result, '~/cwd/dir/file.json')
+        })
+
+        it('should return the correct path when source path does not exist and execution path file exists', () => {
+            cwdStub.returns('~/cwd/dir/2/')
+            existsSync.onCall(0).returns(false)
+            existsSync.onCall(1).returns(true)
+
+            const result = getAbsolutePath({ ['source-dir']: '~/source/dir/' }, '/file.json')
+            assert.equal(result, '~/cwd/dir/2/file.json')
+        }) 
+
+        it('should return input path when other options do not exist and input path file exists', () => {
+            cwdStub.returns('~/cwd/dir/')
+            existsSync.onCall(0).returns(false)
+            existsSync.onCall(1).returns(false)
+            existsSync.onCall(2).returns(true)
+
+            const options = {
+                ['source-dir']: '~/source/dir/',
+                input: '~/input/api.md'
+            }
+            const result = getAbsolutePath(options, '/file.json')
+            assert.equal(result, '~/input/file.json')
+        })
+
+        it('should return null if the file does not exist at any of the paths', () => {
+            cwdStub.returns('~/cwd/dir/')
+            existsSync.onCall(0).returns(false)
+            existsSync.onCall(1).returns(false)
+            existsSync.onCall(2).returns(false)
+            existsSync.onCall(3).returns(true)
+
+            const options = {
+                ['source-dir']: '~/source/dir/',
+                input: '~/input/api.md'
+            }
+            const result = getAbsolutePath(options, '/file.json')
+            assert.equal(result, null)
+        })
+    })
+})

package/.npmignore

@@ -1,35 +0,0 @@
-# Logs
-logs
-*.log
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
-# Commenting this out is preferred by some people, see
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
-node_modules
-
-# Users Environment Variables
-.lock-wscript
-
-# Swagger server
-swagger-ui-master/*
-swagger-ui-master.tar.gz
-
-# IDE
-.vscode