Merge pull request #1 from p1c2u/initial

Initial version

Author: p1c2u

.travis.yml

@@ -0,0 +1,34 @@
+language: python
+sudo: false
+matrix:
+  include:
+  - python: 2.7
+  - python: 3.2
+  - python: 3.3
+  - python: 3.4
+  - python: 3.5
+  - python: 3.6
+  - python: nightly
+  - python: pypy
+  - python: pypy3
+  allow_failures:
+  - python: 3.2
+  - python: nightly
+before_install:
+- if [[ $TRAVIS_PYTHON_VERSION == '3.2' ]]; then pip install 'coverage<4.0.0'; fi
+- pip install codecov
+install:
+- pip install -e .
+- pip install -r requirements_dev.txt
+script:
+- python setup.py test
+after_success:
+- codecov
+deploy:
+  provider: pypi
+  user: p1c2u
+  password:
+    secure: iZWZuDMIWyFtJf5cLDPwA82d7DVi+/8yBQJVowctJwkioz4PEZBrf4N7cKyFc7JlhsS0/gqPJ9nw1FBqHwlTFwikpCYjudcfVijzibwKBbTbYTbTY1xEYiv+2/Q2UGoGjGmf2qdqM9SBaQwvax+KgMO6e4I4vrX4cm3kMx4LHt0Z2ArORlhZ0oKxyi6azcFiZYwlOlp31PuV0iNpBkroBf+gQ20S35hD+GIm1U6D4zqkN0HmZ0LxlpZLXsHZ0FrEE57KU06RowWfkAFBkGjMBjr+phiZ/XRe88SFaiB3HVZaJm+ZPTJKnxryuGt5th54Q10DKLZ3KUien33saBYVziamHZ8ZYS01ztahEhqLKlQVB1e+p1M8mYXKVodqLgytOsddixIBmibq2rDJmLSPwro8RBwLhLdGZdRsH2kii06OQxPrzlUrOwtErozxvdNjS47hwjJ4ZVm4ZGcnOXZut4qwkiEEUMWUd54V+zDNnRxOf+hi/mEx3u8CmkV26XFJ7WHpr/E1T9XHuRh7YVP8MXrM3gjoL86g1swalpH/QBjf0UaF2BlTvWJ3j52uThH7MFUlCBgpYer1giJayyNjFw4+qUVMCyByD87V7x6/3glA7t4Kh0LiMq0Zo23PPbhuJOmJmDy6GTtjkXZEJ6XnNPV9+VR8LApmppevBDKafgA=
+  distributions: sdist bdist_wheel
+  on:
+    tags: true

MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include requirements.txt
+include requirements_dev.txt
+include openapi_spec_validator/resources/schemas/v3.0.0/*

README.md

@@ -1,2 +1,46 @@
-# openapi-spec-validator
-OpenAPI Spec validator
+# OpenAPI Spec validator
+
+[![Build Status](https://travis-ci.org/p1c2u/openapi-spec-validator.svg?branch=master)](https://travis-ci.org/p1c2u/openapi-spec-validator)
+
+## About
+
+OpenAPI Spec Validator is a Python library that validates OpenAPI Specs against the [OpenAPI 3.0.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md) specification. The validator aims to check for full compliance with the Specification.
+
+## Installation
+
+    $ pip install openapi-spec-validator
+
+## Usage
+
+Validate spec:
+
+```python
+
+from openapi_spec_validator import validate_spec
+
+validate_spec(spec)
+```
+
+You can also validate spec from url:
+
+```python
+
+from openapi_spec_validator import validate_spec_url
+
+validate_spec_url('http://example.com/openapi.json')
+```
+
+If you want to iterate through validation errors:
+
+```python
+
+from openapi_spec_validator import openapi_v3_validator_factory
+
+validator = openapi_v3_validator_factory.create(spec)
+errors_iterator = validator.iter_errors(spec)
+```
+
+## License
+
+Copyright (c) 2017, Artur Maciag, All rights reserved.
+Apache v2

openapi_spec_validator/__init__.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+from openapi_spec_validator.shortcuts import (
+    validate_spec_factory, validate_spec_url_factory,
+)
+from openapi_spec_validator.handlers import UrlHandler
+from openapi_spec_validator.schemas import get_openapi_schema
+from openapi_spec_validator.factories import JSONSpecValidatorFactory
+
+__author__ = 'Artur Maciąg'
+__email__ = '[email protected]'
+__version__ = '0.0.1'
+__url__ = 'https://github.com/p1c2u/openapi_spec_validator'
+__license__ = 'Apache License, Version 2.0'
+
+__all__ = ['openapi_v3_validator', 'validate_spec', 'validate_spec_url']
+
+default_handlers = {
+    '<all_urls>': UrlHandler('http', 'https', 'file'),
+    'http': UrlHandler('http'),
+    'https': UrlHandler('https'),
+    'file': UrlHandler('file'),
+}
+schema_v3, schema_v3_url = get_openapi_schema('3.0.0')
+openapi_v3_validator_factory = JSONSpecValidatorFactory(
+    schema_v3, schema_v3_url,
+    resolver_handlers=default_handlers,
+)
+# shortcuts
+validate_spec = validate_spec_factory(
+    openapi_v3_validator_factory.create)
+validate_spec_url = validate_spec_url_factory(
+    openapi_v3_validator_factory.create, default_handlers)

openapi_spec_validator/decorators.py

@@ -0,0 +1,42 @@
+"""OpenAPI spec validator decorators module."""
+import logging
+
+from openapi_spec_validator.managers import VisitingManager
+
+log = logging.getLogger(__name__)
+
+
+class DerefValidatorDecorator:
+    """Dereferences instance if it is a $ref before passing it for validation.
+
+    :param instance_resolver: Resolves refs in the openapi service spec
+    """
+    def __init__(self, instance_resolver):
+        self.instance_resolver = instance_resolver
+        self.visiting = VisitingManager()
+
+    def __call__(self, func):
+        def wrapped(validator, schema_element, instance, schema):
+            if not isinstance(instance, dict) or '$ref' not in instance:
+                return func(validator, schema_element, instance, schema)
+
+            ref = instance['$ref']
+
+            # ref already visited
+            if ref in self.visiting:
+                return
+
+            self._attach_scope(instance)
+            with self.visiting.visit(ref):
+                with self.instance_resolver.resolving(ref) as target:
+                    return func(validator, schema_element, target, schema)
+
+        return wrapped
+
+    def _attach_scope(self, instance):
+        log.debug('Attaching x-scope to %s', instance)
+        if 'x-scope' in instance:
+            log.debug('Ref %s already has scope attached', instance['$ref'])
+            return
+
+        instance['x-scope'] = list(self.instance_resolver._scopes_stack)

openapi_spec_validator/factories.py

@@ -0,0 +1,73 @@
+"""OpenAPI spec validator factories module."""
+from jsonschema import validators
+from jsonschema.validators import Draft4Validator, RefResolver
+
+from openapi_spec_validator.generators import (
+    SpecValidatorsGeneratorFactory,
+)
+
+
+class Draft4ExtendedValidatorFactory(Draft4Validator):
+    """Draft4Validator with extra validators factory that follows $refs
+    in the schema being validated."""
+
+    @classmethod
+    def from_resolver(cls, spec_resolver):
+        """Creates a customized Draft4ExtendedValidator.
+
+        :param spec_resolver: resolver for the spec
+        :type resolver: :class:`jsonschema.RefResolver`
+        """
+        spec_validators = cls._get_spec_validators(spec_resolver)
+        return validators.extend(Draft4Validator, spec_validators)
+
+    @classmethod
+    def _get_spec_validators(cls, spec_resolver):
+        generator = SpecValidatorsGeneratorFactory.from_spec_resolver(
+            spec_resolver)
+        return dict(list(generator))
+
+
+class JSONSpecValidatorFactory:
+    """
+    Json documents validator factory against a json schema.
+
+    :param schema: schema for validation.
+    :param schema_url: schema base uri.
+    """
+
+    schema_validator_class = Draft4Validator
+    spec_validator_factory = Draft4ExtendedValidatorFactory
+
+    def __init__(self, schema, schema_url='', resolver_handlers=None):
+        self.schema = schema
+        self.schema_url = schema_url
+        self.resolver_handlers = resolver_handlers or ()
+
+        self.schema_validator_class.check_schema(self.schema)
+
+    @property
+    def schema_resolver(self):
+        return self._get_resolver(self.schema_url, self.schema)
+
+    def create(self, spec, spec_url=''):
+        """Creates json documents validator from spec.
+        :param spec: json document in the form of a list or dict.
+        :param spec_url: base uri to use when creating a
+            RefResolver for the passed in spec_dict.
+
+        :return: RefResolver for spec with cached remote $refs used during
+            validation.
+        :rtype: :class:`jsonschema.RefResolver`
+        """
+        spec_resolver = self._get_resolver(spec_url, spec)
+
+        validator_cls = self.spec_validator_factory.from_resolver(
+            spec_resolver)
+
+        return validator_cls(
+            self.schema, resolver=self.schema_resolver)
+
+    def _get_resolver(self, base_uri, referrer):
+        return RefResolver(
+            base_uri, referrer, handlers=self.resolver_handlers)

openapi_spec_validator/generators.py

@@ -0,0 +1,42 @@
+"""OpenAPI spec validator generators module."""
+import logging
+
+from six import iteritems
+from jsonschema import _validators
+
+from openapi_spec_validator.decorators import DerefValidatorDecorator
+
+log = logging.getLogger(__name__)
+
+
+class SpecValidatorsGeneratorFactory:
+    """Generator factory for customized validators that follows $refs
+    in the schema being validated.
+    """
+
+    validators = {
+        '$ref': _validators.ref,
+        'properties': _validators.properties_draft4,
+        'additionalProperties': _validators.additionalProperties,
+        'patternProperties': _validators.patternProperties,
+        'type': _validators.type_draft4,
+        'dependencies': _validators.dependencies,
+        'required': _validators.required_draft4,
+        'minProperties': _validators.minProperties_draft4,
+        'maxProperties': _validators.maxProperties_draft4,
+        'allOf': _validators.allOf_draft4,
+        'oneOf': _validators.oneOf_draft4,
+        'anyOf': _validators.anyOf_draft4,
+        'not': _validators.not_draft4,
+    }
+
+    @classmethod
+    def from_spec_resolver(cls, spec_resolver):
+        """Creates validators generator for the spec resolver.
+
+        :param spec_resolver: resolver for the spec
+        :type instance_resolver: :class:`jsonschema.RefResolver`
+        """
+        deref = DerefValidatorDecorator(spec_resolver)
+        for key, validator_callable in iteritems(cls.validators):
+            yield key, deref(validator_callable)

openapi_spec_validator/handlers.py

@@ -0,0 +1,19 @@
+"""OpenAPI spec validator handlers module."""
+import contextlib
+
+from six.moves.urllib.parse import urlparse
+from six.moves.urllib.request import urlopen
+from yaml import safe_load
+
+
+class UrlHandler:
+    """OpenAPI spec validator URL scheme handler."""
+
+    def __init__(self, *allowed_schemes):
+        self.allowed_schemes = allowed_schemes
+
+    def __call__(self, url, timeout=1):
+        assert urlparse(url).scheme in self.allowed_schemes
+
+        with contextlib.closing(urlopen(url, timeout=timeout)) as fh:
+            return safe_load(fh)

openapi_spec_validator/managers.py

@@ -0,0 +1,19 @@
+"""OpenAPI spec validator managers module."""
+from contextlib import contextmanager
+
+
+class VisitingManager(dict):
+    """Visiting manager. Mark keys which being visited."""
+
+    @contextmanager
+    def visit(self, key):
+        """Visits key and marks as visited.
+        Support context manager interface.
+
+        :param key: key being visited.
+        """
+        self[key] = key
+        try:
+            yield key
+        finally:
+            del self[key]