RAML - Swagger url support in converter.

.gitignore

@@ -5,5 +5,4 @@ test/data/temp.json
 temp.json
 .idea
 .DS_Store
-*.iml
 /npm-debug.log

.npmignore

@@ -0,0 +1,11 @@
+node_modules
+coverage
+example/target
+test/data/temp.json
+temp.json
+.idea
+.DS_Store
+/npm-debug.log
+
+site
+test

README.md

@@ -4,8 +4,8 @@ This package helps to convert between different API specifications. It was origi
 
 ## Supported Conversions (beta)
 
-- OAS (Swagger 2.0) -> RAML 1.0: [Complete Functional Specification](https://docs.google.com/a/tekgenesis.com/document/d/1LNDz9XrkfkPYILZwpgVytNs4WmLvNga81Ua4jdUWltk/pub)
-- RAML 1.0 -> OAS (Swagger 2.0): [Complete Functional Specification](https://docs.google.com/a/tekgenesis.com/document/d/1UzRyR_46oc3bEyWoo3ONzfI7wWIH5LCVFxtJZLlvykY/pub)
+- OAS (Swagger 2.0) -> RAML 1.0: [Complete Functional Specification](https://docs.google.com/a/tekgenesis.com/document/d/1LNDz9XrkfkPYILZwpgVytNs4WmLvNga81Ua4jdUWltk/view)
+- RAML 1.0 -> OAS (Swagger 2.0): [Complete Functional Specification](https://docs.google.com/a/tekgenesis.com/document/d/1UzRyR_46oc3bEyWoo3ONzfI7wWIH5LCVFxtJZLlvykY/view)
 - RAML 0.8 -> OAS (Swagger 2.0)
 - RAML 0.8 -> RAML 1.0
 
@@ -86,7 +86,9 @@ swaggerToRaml.convertData(mySwaggerString).then(function(raml) {
 
 ```js
 var options = {
-    validate: false, // Parse the output to check that its a valid document
+    validate: false, // Parse both input and output to check that its a valid document
+    validateImport: false, // Only validate input
+    validateExport: false, // Only validate output
     format: 'yaml', // Output format: json (default for OAS) or yaml (default for RAML)
     fs: { ... } // Use a custom file system solver (not yet available)
 };

lib/bin/converter.js

@@ -3,11 +3,13 @@ const program = require('commander')
 const util = require('./util')
 const formats = require('../formats')
 const specConverter = require('../../index')
+const urlHelper = require('../../lib/utils/url')
 
 let from = formats.AUTO
 let to = formats.RAML10
 let validate = false
 let file = undefined
+let options = {'validate': validate}
 
 program
   .arguments('<file>')
@@ -32,7 +34,24 @@ program
 
 if (typeof file === 'undefined') util.exit('File path required. See --help.')
 
+if (urlHelper.isURL(file)) {
+  options['httpResolver'] = {
+    getResource: function(path){
+      return {'errorMessage': 'Method not allowed for URL ' + path + ' , only getResourceAsync'};
+    },
+    getResourceAsync: function(path){
+      return new Promise(function(resolve, reject){
+        urlHelper.get(path).then(function(response){
+          resolve({content: response});
+        }).catch(function(error) {
+          reject({'errorMessage':'Error getting ' + path, 'error': error});
+        });
+      });
+    }
+  };
+}
+
 const converter = new specConverter.Converter(from, to)
-converter.convertFile(file, {validate: validate}).then(result =>
+converter.convertFile(file, options).then(result =>
   console.log(util.stringify(result))
 ).catch(util.exit)

lib/bin/download-apiguru-apis.js

@@ -3,7 +3,7 @@ const slugify = require('slugify')
 const util = require('./util')
 const urlHelper = require('../../lib/utils/url')
 
-const baseDir = __dirname + '/../../test/data/apis-guru/swagger'
+const baseDir = __dirname + '../../../test/data/apis-guru/swagger'
 const baseUrl = 'https://api.apis.guru/v2/specs/'
 
 urlHelper.get('https://api.apis.guru/v2/list.json').then((body) => {

lib/bin/raml-parser.js

@@ -4,49 +4,58 @@ const parser = require('raml-1-parser')
 const util = require('./util')
 
 let expand = true
+let mode = '0'
 let file = undefined
 
 program
   .arguments('<file>')
   .option('-e, --expand <expand>', 'whether to expand (default) or not')
+  .option('-m, --mode <mode>', 'Mode 0 (default): reject on errors. Mode 1: get errors from json.')
   .action(f => {
     file = f
     if (typeof program.expand !== 'undefined')
       expand = program.expand
+    if (typeof program.mode !== 'undefined')
+      mode = program.mode
   })
   .parse(process.argv)
 
 if (typeof file === 'undefined') util.exit('File path required. See --help.')
 
-parser.loadApi(file, {
-  attributeDefaults: false, 
-  rejectOnErrors: true
-}).then((api) => {
-  if (expand && api.expand) api = api.expand(true)
-  const json = api.toJSON({serializeMetadata: false});
-  console.log(util.stringify(json))
-}).catch(util.exit)
-
-/* Using json:
-parser.loadApi(file, {
-  attributeDefaults: false,
-  rejectOnErrors: false
-}).then((api) => {
-
-  if (expand && api.expand) api = api.expand(true)
-
-  const json = api.toJSON({
-    serializeMetadata: false,
-    dumpSchemaContents: false,
-    rootNodeDetails: true
-  });
-
-  if (json.errors && json.errors.length)
-    console.error(util.stringify(json.errors))
-  else 
-    console.log(util.stringify(json.specification))
-
-}).catch((errors) => {
-  console.error(util.stringify(errors))
-})
-*/
+switch (mode) {
+  case '1':
+    parser.loadApi(file, {
+      attributeDefaults: false,
+      rejectOnErrors: false
+    }).then((api) => {
+      if (expand && api.expand) api = api.expand(true)
+
+      const json = api.toJSON({
+        serializeMetadata: false,
+        dumpSchemaContents: false,
+        rootNodeDetails: true
+      });
+
+      if (json.errors && json.errors.length)
+        util.exit(json.errors)
+      else
+        console.log(util.stringify(json.specification))
+
+    }).catch(util.exit)
+    break;
+  default:
+    parser.loadApi(file, {
+      attributeDefaults: false,
+      rejectOnErrors: true
+    }).then((api) => {
+      if (expand && api.expand) api = api.expand(true)
+
+      const json = api.toJSON({
+        serializeMetadata: false
+      });
+
+      console.log(util.stringify(json))
+
+    }).catch(util.exit)
+    break;
+}

lib/entities/endpoint.js

@@ -160,7 +160,7 @@ class Endpoint {
 	}
 
 	set SLData(data) {
-		for (let key in data) {
+		for (const key in data) {
 			if (!data.hasOwnProperty(key)) continue;
 			this[key] = data[key];
 		}

lib/entities/environment.js

@@ -109,14 +109,6 @@ class Environment {
 	// 	this.securitySchemes[key] = securityScheme;
 	// };
 
-	loadSLData(envData) {
-		for (let key in envData) {
-			if (!envData.hasOwnProperty(key)) continue;
-			//direct map supported keys
-			this[key] = envData[key];
-		}
-	}
-
 	toJSON() {
 		return {
 			groups: this.resourcesOrder

lib/entities/project.js

@@ -122,10 +122,6 @@ class Project {
 		this.savedEntries.push(savedEntry);
 	}
 
-	loadSLData(slData) {
-		this.Description = slData.description;
-	}
-
 	addPathParamRef(path, paramName) {
 		this.pathParamsRef[path] = paramName;
 	}

lib/entities/schema.js

@@ -3,18 +3,6 @@ class Schema {
 		this.name = '';
 		this.namespace = namespace;
 		this.definition = '';
-		this.example = '';
-		this.summary = '';
-		this.description = '';
-		this.public = true;
-	}
-
-	get Id() {
-		return this._id;
-	}
-
-	set Id(id) {
-		this._id = id;
 	}
 
 	get Name() {
@@ -36,42 +24,6 @@ class Schema {
 	get Definition() {
 		return this.definition;
 	}
-
-	get Example() {
-		return this.example;
-	}
-
-	set SLData(schemaData) {
-		let sd = schemaData || {};
-		this.name = sd.name || '';
-		this.definition = sd.definition || {};
-		this.example = sd.example || {};
-		this._id = sd._id;
-	}
-
-	get Summary() {
-		return this.summary || '';
-	}
-
-	set Summary(summary) {
-		this.summary = summary;
-	}
-
-	get Description() {
-		return this.description;
-	}
-
-	set Description(desc) {
-		this.description = desc;
-	}
-
-	get Public() {
-		return this.public;
-	}
-
-	set Public(p) {
-		this.public = p;
-	}
 }
 
 module.exports = Schema;

lib/entities/swagger/definition.js

@@ -4,9 +4,11 @@ class SwaggerDefinition {
 		this.swagger = '2.0';
 		this.info = {
 			'version': '',
-			'title': title,
-			'description': description
+			'title': title
 		};
+		if (description) {
+			this.info['description'] = description;
+		}
 		this.host = '';
 		this.basePath = '';
 		this.schemes = [];
@@ -16,7 +18,6 @@ class SwaggerDefinition {
 		this.paths = {};
 		this.parameters = {};
 		this.responses = [];
-		this.definitions = {};
 	}
 
 	set BasePath(basePath) {

lib/entities/swagger/method.js

@@ -17,48 +17,6 @@ class Method {
 		this.responses = this.method.responses || this.methodResolved.responses;
 		this.security = this.method.security || this.methodResolved.security;
 	}
-
-	get Summary() {
-		return this.summary;
-	}
-
-	get Tags() {
-		return this.tags;
-	}
-
-	get Description() {
-		return this.description;
-	}
-
-	get Deprecated() {
-		return this.deprecated;
-	}
-
-	// get OperationId() { return this.operationId; };
-	get ExternalDocs() {
-		return this.externalDocs;
-	}
-
-	// get Schemes() { return this.schemes; };
-	get Parameters() {
-		return this.parameters;
-	}
-
-	get Consumes() {
-		return this.consumes;
-	}
-
-	get Produces() {
-		return this.produces;
-	}
-
-	get Responses() {
-		return this.responses;
-	}
-
-	get Security() {
-		return this.security;
-	}
 }
 
 module.exports = Method;