Merge pull request #7 from mikunn/6-throw-on-invalid-type

Throw on invalid type

Author: mikunn

README.md

@@ -120,7 +120,7 @@ If set to `true` and `x-patternProperties` property is present, change `x-patter
 
 Provide a function to handle pattern properties and set `supportPatternProperties` to take effect. The function takes the schema where `x-patternProperties` is defined on the root level. At this point `x-patternProperties` is changed to `patternProperties`. It must return the modified schema.
 
-If the handler is not provided, the default handler is used. If `additionalProperties` is set and is an object, the default handler sets it to false if the `additionaProperties` object has deep equality with a pattern object inside `patternProperties`. This is because we might want to define `additionalProperties` in OpenAPI spec file, but want to validate against a pattern. The pattern would turn out to be useless if `additionalProperties` of the same structure were allowed. Create you own handler to override this functionality.
+If the handler is not provided, the default handler is used. If `additionalProperties` is set and is an object, the default handler sets it to false if the `additionalProperties` object has deep equality with a pattern object inside `patternProperties`. This is because we might want to define `additionalProperties` in OpenAPI spec file, but want to validate against a pattern. The pattern would turn out to be useless if `additionalProperties` of the same structure were allowed. Create you own handler to override this functionality.
 
-See `test/pattern_properties.js` for examples how this works.
+See `test/pattern_properties.test.js` for examples how this works.
 

index.js

@@ -2,6 +2,13 @@ var deepEqual = require('deep-equal');
 
 module.exports = convert;
 
+function InvalidTypeError(message) {
+	this.name = 'InvalidTypeError';
+	this.message = message;
+}
+
+InvalidTypeError.prototype = new Error();
+
 function convert(schema, options) {
 	var notSupported = [
 		'nullable', 'discriminator', 'readOnly',
@@ -78,6 +85,7 @@ function convertSchema(schema, options) {
 
 	}
 
+	validateType(schema.type);
 	schema = convertTypes(schema, options);
 
 	if (typeof schema['x-patternProperties'] === 'object'
@@ -119,6 +127,14 @@ function convertProperties(properties, options) {
 	return props;
 }
 
+function validateType(type) {
+	var validTypes = ['integer', 'number', 'string', 'boolean', 'object', 'array'];
+
+	if (validTypes.indexOf(type) < 0 && type !== undefined) {
+		throw new InvalidTypeError('Type "' + type + '" is not a valid type');
+	}
+}
+
 function convertTypes(schema, options) {
 	var toDateTime = options.dateToDateTime;
 

package.json

@@ -4,7 +4,7 @@
   "description": "Converts OpenAPI Schema Object to JSON Schema",
   "main": "index.js",
   "scripts": {
-    "test": "./node_modules/.bin/tape test/**/*.js | ./node_modules/.bin/tap-spec"
+    "test": "./node_modules/.bin/tape test/**/*.test.js | ./node_modules/.bin/tap-spec"
   },
   "repository": "github:mikunn/openapi-schema-to-json-schema",
   "author": "Mika Kunnas",

test/clone_schema.js renamed to test/clone_schema.test.js

@@ -1,6 +1,5 @@
-var fs = require('fs')
-	,	join = require('path').join
-	, test = require('tape')
+var test = require('tape')
+	, getSchema = require('./helpers').getSchema
 	, convert = require('../')
 ;
 
@@ -35,7 +34,3 @@ test('converting complex schema in place', function(assert) {
 	assert.deepEqual(result, expected, 'converted');
 });
 
-function getSchema(file) {
-	var path = join(__dirname, 'schemas', file);
-	return JSON.parse(fs.readFileSync(path));
-}

test/combination_keywords.js renamed to test/combination_keywords.test.js

@@ -0,0 +1,12 @@
+var fs = require('fs')
+	,	join = require('path').join
+;
+
+module.exports = {
+	getSchema: getSchema
+};
+
+function getSchema(file) {
+	var path = join(__dirname, 'schemas', file);
+	return JSON.parse(fs.readFileSync(path));
+}

test/complex_schemas.js renamed to test/complex_schemas.test.js

@@ -0,0 +1,52 @@
+var test = require('tape')
+	, getSchema = require('./helpers').getSchema
+	, convert = require('../')
+;
+
+test('invalid types', function(assert) {
+	var schema, msg;
+
+	assert.plan(3);
+
+	schema = {
+		type: 'dateTime'
+	};
+
+	msg = 'dateTime is invalid type';
+	assert.throws(function() { convert(schema); }, /InvalidTypeError/, msg);
+
+	schema = {
+		type: 'foo'
+	};
+
+	msg = 'foo is invalid type';
+	assert.throws(function() { convert(schema); }, /InvalidTypeError/, msg);
+
+	schema = getSchema('schema-2-invalid-type.json');
+
+	msg = 'invalid type inside complex schema';
+	assert.throws(function() { convert(schema); }, /InvalidTypeError.*invalidtype/, msg);
+});
+
+test('valid types', function(assert) {
+	var types = ['integer', 'number', 'string', 'boolean', 'object', 'array'];
+
+	assert.plan(types.length);
+
+	types.forEach(function(type) {
+		var schema, result, expected;
+
+		schema = {
+			type: type
+		};
+
+		result = convert(schema);
+
+		expected = {
+			$schema: 'http://json-schema.org/draft-04/schema#',
+			type: type,
+		};
+
+		assert.deepEqual(result, expected, type + ' ok');
+	});
+});