mirror of
https://github.com/correl/openapi-core.git
synced 2024-12-29 11:09:25 +00:00
Wrapper restructure
This commit is contained in:
parent
bd1b0117a4
commit
9b05d7b271
9 changed files with 153 additions and 146 deletions
|
@ -1,142 +0,0 @@
|
||||||
"""OpenAPI core wrappers module"""
|
|
||||||
import warnings
|
|
||||||
|
|
||||||
from six.moves.urllib.parse import urljoin
|
|
||||||
from werkzeug.datastructures import ImmutableMultiDict
|
|
||||||
|
|
||||||
|
|
||||||
class BaseOpenAPIRequest(object):
|
|
||||||
|
|
||||||
host_url = NotImplemented
|
|
||||||
path = NotImplemented
|
|
||||||
path_pattern = NotImplemented
|
|
||||||
method = NotImplemented
|
|
||||||
|
|
||||||
parameters = NotImplemented
|
|
||||||
body = NotImplemented
|
|
||||||
|
|
||||||
mimetype = NotImplemented
|
|
||||||
|
|
||||||
@property
|
|
||||||
def full_url_pattern(self):
|
|
||||||
return urljoin(self.host_url, self.path_pattern)
|
|
||||||
|
|
||||||
def get_body(self, spec):
|
|
||||||
warnings.warn(
|
|
||||||
"`get_body` method is deprecated. "
|
|
||||||
"Use RequestValidator instead.",
|
|
||||||
DeprecationWarning,
|
|
||||||
)
|
|
||||||
# backward compatibility
|
|
||||||
from openapi_core.shortcuts import validate_body
|
|
||||||
return validate_body(spec, self, wrapper_class=None)
|
|
||||||
|
|
||||||
def get_parameters(self, spec):
|
|
||||||
warnings.warn(
|
|
||||||
"`get_parameters` method is deprecated. "
|
|
||||||
"Use RequestValidator instead.",
|
|
||||||
DeprecationWarning,
|
|
||||||
)
|
|
||||||
# backward compatibility
|
|
||||||
from openapi_core.shortcuts import validate_parameters
|
|
||||||
return validate_parameters(spec, self, wrapper_class=None)
|
|
||||||
|
|
||||||
|
|
||||||
class MockRequest(BaseOpenAPIRequest):
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self, host_url, method, path, path_pattern=None, args=None,
|
|
||||||
view_args=None, headers=None, cookies=None, data=None,
|
|
||||||
mimetype='application/json'):
|
|
||||||
self.host_url = host_url
|
|
||||||
self.path = path
|
|
||||||
self.path_pattern = path_pattern or path
|
|
||||||
self.method = method.lower()
|
|
||||||
|
|
||||||
self.parameters = {
|
|
||||||
'path': view_args or {},
|
|
||||||
'query': ImmutableMultiDict(args or []),
|
|
||||||
'header': headers or {},
|
|
||||||
'cookie': cookies or {},
|
|
||||||
}
|
|
||||||
|
|
||||||
self.body = data or ''
|
|
||||||
|
|
||||||
self.mimetype = mimetype
|
|
||||||
|
|
||||||
|
|
||||||
class FlaskOpenAPIRequest(BaseOpenAPIRequest):
|
|
||||||
|
|
||||||
def __init__(self, request):
|
|
||||||
self.request = request
|
|
||||||
|
|
||||||
@property
|
|
||||||
def host_url(self):
|
|
||||||
return self.request.host_url
|
|
||||||
|
|
||||||
@property
|
|
||||||
def path(self):
|
|
||||||
return self.request.path
|
|
||||||
|
|
||||||
@property
|
|
||||||
def method(self):
|
|
||||||
return self.request.method.lower()
|
|
||||||
|
|
||||||
@property
|
|
||||||
def path_pattern(self):
|
|
||||||
if self.request.url_rule is None:
|
|
||||||
return self.path
|
|
||||||
|
|
||||||
return self.request.url_rule.rule
|
|
||||||
|
|
||||||
@property
|
|
||||||
def parameters(self):
|
|
||||||
return {
|
|
||||||
'path': self.request.view_args,
|
|
||||||
'query': self.request.args,
|
|
||||||
'headers': self.request.headers,
|
|
||||||
'cookies': self.request.cookies,
|
|
||||||
}
|
|
||||||
|
|
||||||
@property
|
|
||||||
def body(self):
|
|
||||||
return self.request.data
|
|
||||||
|
|
||||||
@property
|
|
||||||
def mimetype(self):
|
|
||||||
return self.request.mimetype
|
|
||||||
|
|
||||||
|
|
||||||
class BaseOpenAPIResponse(object):
|
|
||||||
|
|
||||||
body = NotImplemented
|
|
||||||
status_code = NotImplemented
|
|
||||||
|
|
||||||
mimetype = NotImplemented
|
|
||||||
|
|
||||||
|
|
||||||
class MockResponse(BaseOpenAPIRequest):
|
|
||||||
|
|
||||||
def __init__(self, data, status_code=200, mimetype='application/json'):
|
|
||||||
self.data = data
|
|
||||||
|
|
||||||
self.status_code = status_code
|
|
||||||
self.mimetype = mimetype
|
|
||||||
|
|
||||||
|
|
||||||
class FlaskOpenAPIResponse(BaseOpenAPIResponse):
|
|
||||||
|
|
||||||
def __init__(self, response):
|
|
||||||
self.response = response
|
|
||||||
|
|
||||||
@property
|
|
||||||
def data(self):
|
|
||||||
return self.response.data
|
|
||||||
|
|
||||||
@property
|
|
||||||
def status_code(self):
|
|
||||||
return self.response._status_code
|
|
||||||
|
|
||||||
@property
|
|
||||||
def mimetype(self):
|
|
||||||
return self.response.mimetype
|
|
0
openapi_core/wrappers/__init__.py
Normal file
0
openapi_core/wrappers/__init__.py
Normal file
49
openapi_core/wrappers/base.py
Normal file
49
openapi_core/wrappers/base.py
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
"""OpenAPI core wrappers module"""
|
||||||
|
import warnings
|
||||||
|
|
||||||
|
from six.moves.urllib.parse import urljoin
|
||||||
|
|
||||||
|
|
||||||
|
class BaseOpenAPIRequest(object):
|
||||||
|
|
||||||
|
host_url = NotImplemented
|
||||||
|
path = NotImplemented
|
||||||
|
path_pattern = NotImplemented
|
||||||
|
method = NotImplemented
|
||||||
|
|
||||||
|
parameters = NotImplemented
|
||||||
|
body = NotImplemented
|
||||||
|
|
||||||
|
mimetype = NotImplemented
|
||||||
|
|
||||||
|
@property
|
||||||
|
def full_url_pattern(self):
|
||||||
|
return urljoin(self.host_url, self.path_pattern)
|
||||||
|
|
||||||
|
def get_body(self, spec):
|
||||||
|
warnings.warn(
|
||||||
|
"`get_body` method is deprecated. "
|
||||||
|
"Use RequestValidator instead.",
|
||||||
|
DeprecationWarning,
|
||||||
|
)
|
||||||
|
# backward compatibility
|
||||||
|
from openapi_core.shortcuts import validate_body
|
||||||
|
return validate_body(spec, self, wrapper_class=None)
|
||||||
|
|
||||||
|
def get_parameters(self, spec):
|
||||||
|
warnings.warn(
|
||||||
|
"`get_parameters` method is deprecated. "
|
||||||
|
"Use RequestValidator instead.",
|
||||||
|
DeprecationWarning,
|
||||||
|
)
|
||||||
|
# backward compatibility
|
||||||
|
from openapi_core.shortcuts import validate_parameters
|
||||||
|
return validate_parameters(spec, self, wrapper_class=None)
|
||||||
|
|
||||||
|
|
||||||
|
class BaseOpenAPIResponse(object):
|
||||||
|
|
||||||
|
body = NotImplemented
|
||||||
|
status_code = NotImplemented
|
||||||
|
|
||||||
|
mimetype = NotImplemented
|
62
openapi_core/wrappers/flask.py
Normal file
62
openapi_core/wrappers/flask.py
Normal file
|
@ -0,0 +1,62 @@
|
||||||
|
"""OpenAPI core wrappers module"""
|
||||||
|
from openapi_core.wrappers.base import BaseOpenAPIRequest, BaseOpenAPIResponse
|
||||||
|
|
||||||
|
|
||||||
|
class FlaskOpenAPIRequest(BaseOpenAPIRequest):
|
||||||
|
|
||||||
|
def __init__(self, request):
|
||||||
|
self.request = request
|
||||||
|
|
||||||
|
@property
|
||||||
|
def host_url(self):
|
||||||
|
return self.request.host_url
|
||||||
|
|
||||||
|
@property
|
||||||
|
def path(self):
|
||||||
|
return self.request.path
|
||||||
|
|
||||||
|
@property
|
||||||
|
def method(self):
|
||||||
|
return self.request.method.lower()
|
||||||
|
|
||||||
|
@property
|
||||||
|
def path_pattern(self):
|
||||||
|
if self.request.url_rule is None:
|
||||||
|
return self.path
|
||||||
|
|
||||||
|
return self.request.url_rule.rule
|
||||||
|
|
||||||
|
@property
|
||||||
|
def parameters(self):
|
||||||
|
return {
|
||||||
|
'path': self.request.view_args,
|
||||||
|
'query': self.request.args,
|
||||||
|
'headers': self.request.headers,
|
||||||
|
'cookies': self.request.cookies,
|
||||||
|
}
|
||||||
|
|
||||||
|
@property
|
||||||
|
def body(self):
|
||||||
|
return self.request.data
|
||||||
|
|
||||||
|
@property
|
||||||
|
def mimetype(self):
|
||||||
|
return self.request.mimetype
|
||||||
|
|
||||||
|
|
||||||
|
class FlaskOpenAPIResponse(BaseOpenAPIResponse):
|
||||||
|
|
||||||
|
def __init__(self, response):
|
||||||
|
self.response = response
|
||||||
|
|
||||||
|
@property
|
||||||
|
def data(self):
|
||||||
|
return self.response.data
|
||||||
|
|
||||||
|
@property
|
||||||
|
def status_code(self):
|
||||||
|
return self.response._status_code
|
||||||
|
|
||||||
|
@property
|
||||||
|
def mimetype(self):
|
||||||
|
return self.response.mimetype
|
36
openapi_core/wrappers/mock.py
Normal file
36
openapi_core/wrappers/mock.py
Normal file
|
@ -0,0 +1,36 @@
|
||||||
|
"""OpenAPI core wrappers module"""
|
||||||
|
from werkzeug.datastructures import ImmutableMultiDict
|
||||||
|
|
||||||
|
from openapi_core.wrappers.base import BaseOpenAPIRequest, BaseOpenAPIResponse
|
||||||
|
|
||||||
|
|
||||||
|
class MockRequest(BaseOpenAPIRequest):
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self, host_url, method, path, path_pattern=None, args=None,
|
||||||
|
view_args=None, headers=None, cookies=None, data=None,
|
||||||
|
mimetype='application/json'):
|
||||||
|
self.host_url = host_url
|
||||||
|
self.path = path
|
||||||
|
self.path_pattern = path_pattern or path
|
||||||
|
self.method = method.lower()
|
||||||
|
|
||||||
|
self.parameters = {
|
||||||
|
'path': view_args or {},
|
||||||
|
'query': ImmutableMultiDict(args or []),
|
||||||
|
'header': headers or {},
|
||||||
|
'cookie': cookies or {},
|
||||||
|
}
|
||||||
|
|
||||||
|
self.body = data or ''
|
||||||
|
|
||||||
|
self.mimetype = mimetype
|
||||||
|
|
||||||
|
|
||||||
|
class MockResponse(BaseOpenAPIResponse):
|
||||||
|
|
||||||
|
def __init__(self, data, status_code=200, mimetype='application/json'):
|
||||||
|
self.data = data
|
||||||
|
|
||||||
|
self.status_code = status_code
|
||||||
|
self.mimetype = mimetype
|
|
@ -3,7 +3,7 @@ import pytest
|
||||||
from openapi_core.exceptions import InvalidOperation
|
from openapi_core.exceptions import InvalidOperation
|
||||||
from openapi_core.shortcuts import create_spec
|
from openapi_core.shortcuts import create_spec
|
||||||
from openapi_core.validation.request.validators import RequestValidator
|
from openapi_core.validation.request.validators import RequestValidator
|
||||||
from openapi_core.wrappers import MockRequest
|
from openapi_core.wrappers.mock import MockRequest
|
||||||
|
|
||||||
|
|
||||||
class TestMinimal(object):
|
class TestMinimal(object):
|
||||||
|
|
|
@ -18,7 +18,7 @@ from openapi_core.schema.servers.models import Server, ServerVariable
|
||||||
from openapi_core.shortcuts import create_spec
|
from openapi_core.shortcuts import create_spec
|
||||||
from openapi_core.validation.request.validators import RequestValidator
|
from openapi_core.validation.request.validators import RequestValidator
|
||||||
from openapi_core.validation.response.validators import ResponseValidator
|
from openapi_core.validation.response.validators import ResponseValidator
|
||||||
from openapi_core.wrappers import MockRequest, MockResponse
|
from openapi_core.wrappers.mock import MockRequest, MockResponse
|
||||||
|
|
||||||
|
|
||||||
class TestPetstore(object):
|
class TestPetstore(object):
|
||||||
|
|
|
@ -9,7 +9,7 @@ from openapi_core.exceptions import (
|
||||||
from openapi_core.shortcuts import create_spec
|
from openapi_core.shortcuts import create_spec
|
||||||
from openapi_core.validation.request.validators import RequestValidator
|
from openapi_core.validation.request.validators import RequestValidator
|
||||||
from openapi_core.validation.response.validators import ResponseValidator
|
from openapi_core.validation.response.validators import ResponseValidator
|
||||||
from openapi_core.wrappers import MockRequest, MockResponse
|
from openapi_core.wrappers.mock import MockRequest, MockResponse
|
||||||
|
|
||||||
|
|
||||||
class TestRequestValidator(object):
|
class TestRequestValidator(object):
|
||||||
|
|
|
@ -5,7 +5,9 @@ from werkzeug.datastructures import EnvironHeaders, ImmutableMultiDict
|
||||||
from werkzeug.routing import Map, Rule, Subdomain
|
from werkzeug.routing import Map, Rule, Subdomain
|
||||||
from werkzeug.test import create_environ
|
from werkzeug.test import create_environ
|
||||||
|
|
||||||
from openapi_core.wrappers import FlaskOpenAPIRequest, FlaskOpenAPIResponse
|
from openapi_core.wrappers.flask import (
|
||||||
|
FlaskOpenAPIRequest, FlaskOpenAPIResponse,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class TestFlaskOpenAPIRequest(object):
|
class TestFlaskOpenAPIRequest(object):
|
||||||
|
|
Loading…
Reference in a new issue