Merge branch 'master' into feature/licensing

Author: DaniilGlazkoTR

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.2
+current_version = 0.1.3
 tag = True
 tag_name = {new_version}
 commit = True
@@ -9,4 +9,3 @@ serialize =
 	{major}.{minor}.{patch}
 
 [bumpversion:file:openapi_schema_validator/__init__.py]
-

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [p1c2u]

.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Publish python packages
+
+on:
+  workflow_dispatch:
+  release:
+    types:
+    - created
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [2.7, 3.6]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build
+      run: python setup.py sdist bdist_wheel
+    - name: Publish wheel
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: twine upload dist/*.whl
+    - name: Publish source
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: twine upload dist/*.tar.gz || true

.github/workflows/python-test.yml

@@ -0,0 +1,33 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Test python code
+
+on:
+  push:
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [2.7, 3.5, 3.6, 3.7, 3.8, 3.9]
+      fail-fast: false
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install -r requirements_dev.txt
+        pip install -e .
+    - name: Test
+      run: python setup.py test
+    - name: Upload coverage
+      uses: codecov/codecov-action@v1

.travis.yml

@@ -6,8 +6,8 @@ matrix:
   - python: 3.5
   - python: 3.6
   - python: 3.7
-    dist: xenial
-    sudo: true
+  - python: 3.8
+  - python: 3.9
   - python: nightly
   - python: pypy3
   allow_failures:
@@ -23,11 +23,3 @@ script:
 - python setup.py test
 after_success:
 - codecov
-deploy:
-  provider: pypi
-  user: p1c2u
-  password:
-    secure: mQCKjaqTpkDhTRCSZtdt5d3tOs/d1vc8PDAna5Gr5prMbosq5stG3HdTK3qK5AbfNghclFYZH726zD2i4LdBWmHoA50TJn6mud3k0Byt+fEpnFIHgb8B2hhOQiiG/LxO1X+oRQI+2NL6TQagxJZzSArqaY4p83RAoLNjlf8LpgQu6qjERFkxMaSCrDfDWJ8MBFINMiZ5ZCq3NF8Rclaesv7HKAaYc8591grjouR8FBoVIPG7EWCZP8lp4CVEz6XlBZV8DDmUuhIhqWRkf6jS1zMbd0fUB7iKh2vHDHSWx9kGsxSRCqISDy3ywVUcee6O5M06RwzlpDSML+vuBHYvr8KX5LWSoaOcZfRNjGYIv437t+81Bl1d34GogI/Abm8WxG92KYt5+//6bKk7byck76ZLvuxV/lPtLjg0Caya9zVk/SE0GEa5N+Da04SHJqML88dS9ImbKchOnP1nUb/oUFA8SADFaMonxLbqe2k+PTLymZVTv0apPpiDXKpUF0K1+1WdggDRyr9WFhoBB7KYme6uQLLi78vmDo4gZzG+NvPYoux/VVsbm+upZdqRFL1jX8GGYMu/VbFwN3EHCAH3b6kFZFijZuTgCsIGvMfU2j/tJpLGUJLN8uLJlN88PqPxU4iz7lVKRU29hLwnCWY9yjPdTCZn0gdcZuosv6leNlc=
-  distributions: sdist bdist_wheel
-  on:
-    tags: true

README.rst

@@ -43,7 +43,7 @@ Simple usage
 
 .. code-block:: python
 
-   from openapi_schema_validator import OAS30Validator, oas30_format_checker
+   from openapi_schema_validator import validate
 
    # A sample schema
    schema = {
@@ -61,20 +61,36 @@ Simple usage
                "minimum": 0,
                "nullable": True,
            },
+           "birth-date": {
+               "type": "string",
+               "format": "date",
+           }
        },
        "additionalProperties": False,
    }
 
-   validator = OAS30Validator(schema)
    # If no exception is raised by validate(), the instance is valid.
-   validator.validate({"name": "John", "age": 23})
+   validate({"name": "John", "age": 23}, schema)
 
-   validator.validate({"name": "John", "city": "London"})
+   validate({"name": "John", "city": "London"}, schema)
 
    Traceback (most recent call last):
        ...
    ValidationError: Additional properties are not allowed ('city' was unexpected)
 
+You can also check format for primitive types
+
+.. code-block:: python
+
+   from openapi_schema_validator import oas30_format_checker
+
+   validate({"name": "John", "birth-date": "-12"}, schema, format_checker=oas30_format_checker)
+
+   Traceback (most recent call last):
+       ...
+   ValidationError: '-12' is not a 'date'
+
+
 Related projects
 ################
 * `openapi-core <https://github.com/p1c2u/openapi-core>`__

openapi_schema_validator/__init__.py

@@ -1,11 +1,12 @@
 # -*- coding: utf-8 -*-
 from openapi_schema_validator._format import oas30_format_checker
+from openapi_schema_validator.shortcuts import validate
 from openapi_schema_validator.validators import OAS30Validator
 
 __author__ = 'Artur Maciag'
 __email__ = '[email protected]'
-__version__ = '0.1.2'
+__version__ = '0.1.3'
 __url__ = 'https://github.com/p1c2u/openapi-schema-validator'
 __license__ = 'BSD 3-Clause License'
 
-__all__ = ['OAS30Validator', 'oas30_format_checker']
+__all__ = ['validate', 'OAS30Validator', 'oas30_format_checker']

openapi_schema_validator/_format.py

@@ -90,7 +90,7 @@ def is_uuid(instance):
     if isinstance(instance, binary_type):
         instance = instance.decode()
 
-    return text_type(UUID(instance)) == instance
+    return text_type(UUID(instance)).lower() == instance.lower()
 
 
 def is_password(instance):

openapi_schema_validator/_validators.py

@@ -72,15 +72,15 @@ def readOnly(validator, ro, instance, schema):
         return
 
     yield ValidationError(
-        "Tried to write read-only proparty with %s" % (instance))
+        "Tried to write read-only property with %s" % (instance))
 
 
 def writeOnly(validator, wo, instance, schema):
     if not validator.read or not wo:
         return
 
     yield ValidationError(
-        "Tried to read write-only proparty with %s" % (instance))
+        "Tried to read write-only property with %s" % (instance))
 
 
 def not_implemented(validator, value, instance, schema):

openapi_schema_validator/shortcuts.py

@@ -0,0 +1,11 @@
+from jsonschema.exceptions import best_match
+
+from openapi_schema_validator.validators import OAS30Validator
+
+
+def validate(instance, schema, cls=OAS30Validator, *args, **kwargs):
+    cls.check_schema(schema)
+    validator = cls(schema, *args, **kwargs)
+    error = best_match(validator.iter_errors(instance))
+    if error is not None:
+        raise error

setup.cfg

@@ -1,5 +1,6 @@
 [metadata]
 name = openapi-schema-validator
+description = OpenAPI schema validation for Python
 long_description = file: README.rst
 long-description-content-type = text/x-rst; charset=UTF-8
 keywords = openapi, swagger, schema
@@ -12,6 +13,8 @@ classifiers =
     Programming Language :: Python :: 3.5
     Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
     Topic :: Software Development :: Libraries
 
 [options]
@@ -24,7 +27,7 @@ setup_requires =
     setuptools
 install_requires =
     isodate
-    jsonschema
+    jsonschema>=3.0.0
     six
     strict_rfc3339
 tests_require =

tests/integration/test_validators.py

@@ -72,3 +72,15 @@ def test_string_format_datetime_isodate(self, value):
         result = validator.validate(value)
 
         assert result is None
+
+    @pytest.mark.parametrize('value', [
+        'f50ec0b7-f960-400d-91f0-c42a6d44e3d0',
+        'F50EC0B7-F960-400D-91F0-C42A6D44E3D0',
+    ])
+    def test_string_uuid(self, value):
+        schema = {"type": 'string', "format": 'uuid'}
+        validator = OAS30Validator(schema, format_checker=oas30_format_checker)
+
+        result = validator.validate(value)
+
+        assert result is None