Merge pull request #40 from inkhey/feature/autoref-compat

example/fake_api/bottle_api.py

@@ -51,6 +51,24 @@ class BottleController(object):
         }
 
     @hapic.with_api_doc()
+    @hapic.output_body(UserSchema(
+        many=True,
+        only=('id', 'username', 'display_name', 'company')
+    ))
+    def get_users2(self):
+        """
+        Obtain users list.
+        """
+        return [
+            {
+                'id': 4,
+                'username': 'some_user',
+                'display_name': 'Damien Accorsi',
+                'company': 'Algoo',
+            }
+        ]
+
+    @hapic.with_api_doc()
     @hapic.input_path(UserPathSchema())
     @hapic.output_body(UserSchema())
     def get_user(self, id, hapic_data: HapicData):
@@ -99,6 +117,7 @@ class BottleController(object):
     def bind(self, app:bottle.Bottle):
         app.route('/about', callback=self.about)
         app.route('/users', callback=self.get_users)
+        app.route('/users2', callback=self.get_users2)
         app.route('/users/<id>', callback=self.get_user)
         app.route('/users/', callback=self.add_user,  method='POST')
         app.route('/users/<id>', callback=self.del_user, method='DELETE')

example/fake_api/flask_api.py

@@ -49,6 +49,24 @@ class FlaskController(object):
         }
 
     @hapic.with_api_doc()
+    @hapic.output_body(UserSchema(
+        many=True,
+        only=('id', 'username', 'display_name', 'company')
+    ))
+    def get_users2(self):
+        """
+        Obtain users list.
+        """
+        return [
+            {
+                'id': 4,
+                'username': 'some_user',
+                'display_name': 'Damien Accorsi',
+                'company': 'Algoo',
+            }
+        ]
+
+    @hapic.with_api_doc()
     @hapic.input_path(UserPathSchema())
     @hapic.output_body(UserSchema())
     def get_user(self, id, hapic_data: HapicData):
@@ -104,6 +122,8 @@ class FlaskController(object):
                          view_func=self.about)
         app.add_url_rule('/users',
                          view_func=self.get_users)
+        app.add_url_rule('/users2',
+                         view_func=self.get_users2)
         app.add_url_rule('/users/<id>',
                          view_func=self.get_user)
         app.add_url_rule('/users/',
@@ -113,6 +133,7 @@ class FlaskController(object):
                          view_func=self.del_user,
                          methods=['DELETE'])
 
+
 if __name__ == "__main__":
     app = flask.Flask(__name__)
     controllers = FlaskController()

example/fake_api/pyramid_api.py

@@ -49,6 +49,24 @@ class PyramidController(object):
         }
 
     @hapic.with_api_doc()
+    @hapic.output_body(UserSchema(
+        many=True,
+        only=('id', 'username', 'display_name', 'company')
+    ))
+    def get_users2(self, context, request):
+        """
+        Obtain users list.
+        """
+        return [
+            {
+                'id': 4,
+                'username': 'some_user',
+                'display_name': 'Damien Accorsi',
+                'company': 'Algoo',
+            }
+        ]
+
+    @hapic.with_api_doc()
     @hapic.input_path(UserPathSchema())
     @hapic.output_body(UserSchema())
     def get_user(self, context, request, hapic_data: HapicData):
@@ -101,6 +119,9 @@ class PyramidController(object):
         configurator.add_route('get_users', '/users', request_method='GET')  # nopep8
         configurator.add_view(self.get_users, route_name='get_users', renderer='json')  # nopep8
 
+        configurator.add_route('get_users2', '/users2', request_method='GET')  # nopep8
+        configurator.add_view(self.get_users2, route_name='get_users2', renderer='json')  # nopep8
+
         configurator.add_route('get_user', '/users/{id}', request_method='GET')  # nopep8
         configurator.add_view(self.get_user, route_name='get_user', renderer='json')  # nopep8
 

hapic/doc.py

@@ -2,6 +2,7 @@
 import json
 
 import typing
+import marshmallow
 import yaml
 
 from apispec import APISpec
@@ -14,32 +15,48 @@ from hapic.decorator import DecoratedController
 from hapic.description import ControllerDescription
 
 
+def generate_schema_ref(spec:APISpec, schema: marshmallow.Schema) -> str:
+    schema_class = spec.schema_class_resolver(
+        spec,
+        schema
+    )
+    ref = {
+        '$ref': '#/definitions/{}'.format(
+            spec.schema_name_resolver(schema_class)
+        )
+    }
+    if schema.many:
+        ref = {
+            'type': 'array',
+            'items': ref
+        }
+    return ref
+
+
 def bottle_generate_operations(
     spec,
     route: RouteRepresentation,
     description: ControllerDescription,
 ):
     method_operations = dict()
-
-    # schema based
     if description.input_body:
-        schema_class = type(description.input_body.wrapper.processor.schema)
         method_operations.setdefault('parameters', []).append({
             'in': 'body',
             'name': 'body',
-            'schema': {
-                '$ref': '#/definitions/{}'.format(schema_class.__name__)
-            }
+            'schema': generate_schema_ref(
+                spec,
+                description.input_body.wrapper.processor.schema,
+            )
         })
 
     if description.output_body:
-        schema_class = type(description.output_body.wrapper.processor.schema)
         method_operations.setdefault('responses', {})\
             [int(description.output_body.wrapper.default_http_code)] = {
                 'description': str(int(description.output_body.wrapper.default_http_code)),  # nopep8
-                'schema': {
-                    '$ref': '#/definitions/{}'.format(schema_class.__name__)
-                }
+                'schema': generate_schema_ref(
+                    spec,
+                    description.output_body.wrapper.processor.schema,
+                )
             }
 
     if description.output_file:
@@ -58,13 +75,18 @@ def bottle_generate_operations(
                 [int(error.wrapper.http_code)] = {
                     'description': str(int(error.wrapper.http_code)),
                     'schema': {
-                        '$ref': '#/definitions/{}'.format(schema_class.__name__)  # nopep8
+                        '$ref': '#/definitions/{}'.format(
+                            spec.schema_name_resolver(schema_class)
+                        )
                     }
                 }
 
     # jsonschema based
     if description.input_path:
-        schema_class = type(description.input_path.wrapper.processor.schema)
+        schema_class = spec.schema_class_resolver(
+            spec,
+            description.input_path.wrapper.processor.schema
+        )
         # TODO: look schema2parameters ?
         jsonschema = schema2jsonschema(schema_class, spec=spec)
         for name, schema in jsonschema.get('properties', {}).items():
@@ -76,7 +98,10 @@ def bottle_generate_operations(
             })
 
     if description.input_query:
-        schema_class = type(description.input_query.wrapper.processor.schema)
+        schema_class = spec.schema_class_resolver(
+            spec,
+            description.input_query.wrapper.processor.schema
+        )
         jsonschema = schema2jsonschema(schema_class, spec=spec)
         for name, schema in jsonschema.get('properties', {}).items():
             method_operations.setdefault('parameters', []).append({
@@ -131,7 +156,8 @@ class DocGenerator(object):
             plugins=(
                 'apispec.ext.marshmallow',
             ),
-            schema_name_resolver=generate_schema_name,
+            auto_referencing=True,
+            schema_name_resolver=generate_schema_name
         )
 
         schemas = []
@@ -140,17 +166,20 @@ class DocGenerator(object):
             description = controller.description
 
             if description.input_body:
-                schemas.append(type(
+                schemas.append(spec.schema_class_resolver(
+                    spec,
                     description.input_body.wrapper.processor.schema
                 ))
 
             if description.input_forms:
-                schemas.append(type(
+                schemas.append(spec.schema_class_resolver(
+                    spec,
                     description.input_forms.wrapper.processor.schema
                 ))
 
             if description.output_body:
-                schemas.append(type(
+                schemas.append(spec.schema_class_resolver(
+                    spec,
                     description.output_body.wrapper.processor.schema
                 ))
 
@@ -159,7 +188,10 @@ class DocGenerator(object):
                     schemas.append(type(error.wrapper.error_builder))
 
         for schema in set(schemas):
-            spec.definition(schema.__name__, schema=schema)
+            spec.definition(
+                spec.schema_name_resolver(schema),
+                schema=schema
+            )
 
         # add views
         # with app.test_request_context():
@@ -230,5 +262,23 @@ class DocGenerator(object):
 
 
 # TODO BS 20171109: Must take care of already existing definition names
-def generate_schema_name(schema):
-    return schema.__name__
+def generate_schema_name(schema: marshmallow.Schema):
+    """
+    Return best candidate name for one schema cls or instance.
+    :param schema: instance or cls schema
+    :return: best schema name
+    """
+    if not isinstance(schema, type):
+        schema = type(schema)
+
+    if getattr(schema, '_schema_name', None):
+        if schema.opts.exclude:
+            schema_name = "{}_without".format(schema.__name__)
+            for elem in sorted(schema.opts.exclude):
+                schema_name="{}_{}".format(schema_name, elem)
+        else:
+            schema_name = schema._schema_name
+    else:
+        schema_name = schema.__name__
+
+    return schema_name

setup.py

@@ -9,7 +9,7 @@ here = path.abspath(path.dirname(__file__))
 
 install_requires = [
     'marshmallow >2.0.0,<3.0.0a1',
-    'apispec',
+    'apispec==0.35.0-algoo',
     'multidict'
 ]
 tests_require = [
@@ -94,8 +94,10 @@ setup(
     # "scripts" keyword. Entry points provide cross-platform support and allow
     # pip to create the appropriate form of executable for the target platform.
     entry_points={},
-
     setup_requires=[],
+    dependency_links=[
+        'git+https://github.com/algoo/apispec.git@hapic_apispec#egg=apispec-0.35.0-algoo'
+    ],
     tests_require=tests_require,
     include_package_data=True,
 )

tests/func/fake_api/common.py

@@ -1,4 +1,6 @@
 from collections import OrderedDict
+
+
 SWAGGER_DOC_API = {
  'definitions': {
      'AboutResponseSchema': {'properties': {
@@ -13,7 +15,7 @@ SWAGGER_DOC_API = {
                                         'minimum': 0,
                                         'type': 'integer'},
                             'items': {
-                                'items': {'$ref': '#/definitions/UserSchema'},
+                                'items': {'$ref': '#/definitions/UserSchema_without_email_address_first_name_last_name'},
                                 'type': 'array'},
                             'pagination': {'$ref': '#/definitions/PaginationSchema'}},
                          'required': ['item_nb'],
@@ -41,10 +43,27 @@ SWAGGER_DOC_API = {
                                  'id',
                                  'last_name',
                                  'username'],
-                    'type': 'object'}},
- 'info': {'description': 'just an example of hapic API',
-          'title': 'Fake API',
-          'version': '1.0.0'},
+                    'type': 'object'},
+    'UserSchema_without_id': {
+        'properties': {
+            'username': {'type': 'string'},
+            'display_name': {'type': 'string'},
+            'company': {'type': 'string'},
+            'last_name': {'type': 'string'},
+            'email_address': {'format': 'email', 'type': 'string'},
+            'first_name': {'type': 'string'}},
+        'required': ['company', 'display_name', 'email_address', 'first_name',
+                     'last_name', 'username'], 'type': 'object'},
+    'UserSchema_without_email_address_first_name_last_name': {
+        'properties': {
+            'username': {'type': 'string'},
+            'id': {'format': 'int32', 'type': 'integer'},
+            'company': {'type': 'string'},
+            'display_name': {'type': 'string'}},
+        'required': ['company', 'display_name', 'id', 'username'], 'type': 'object'
+    },
+    },
+ 'info': {'description': 'just an example of hapic API', 'title': 'Fake API', 'version': '1.0.0'},
  'parameters': {},
  'paths': OrderedDict(
      [('/about', {
@@ -83,10 +102,20 @@ SWAGGER_DOC_API = {
              'description': 'Add new user',
              'parameters': [{'in': 'body',
                              'name': 'body',
-                             'schema': {'$ref': '#/definitions/UserSchema'}}],
+                             'schema': {'$ref': '#/definitions/UserSchema_without_id'}}],
              'responses': {200: {
                  'description': '200',
-                 'schema': {'$ref': '#/definitions/UserSchema'}}}}})]),
+                 'schema': {'$ref': '#/definitions/UserSchema'}}}}}),
+      ( '/users2', {
+          'get': {
+              'description': 'Obtain users list.',
+              'responses': {200: {
+                  'description': '200',
+                  'schema': {'type': 'array',
+                             'items': {'$ref': '#/definitions/UserSchema_without_email_address_first_name_last_name'}
+                             }
+          }}}}
+        )]),
  'swagger': '2.0',
  'tags': []
 }

tests/func/fake_api/test_bottle.py

@@ -1,95 +0,0 @@
-from webtest import TestApp
-from bottle import Bottle
-
-from hapic.ext.bottle import BottleContext
-from example.fake_api.bottle_api import BottleController
-from tests.func.fake_api.common import SWAGGER_DOC_API
-from example.fake_api.bottle_api import hapic
-
-
-def test_func_bottle_fake_api():
-    bottle_app = Bottle()
-    controllers = BottleController()
-    controllers.bind(bottle_app)
-
-    hapic.set_context(BottleContext(bottle_app))
-    app = TestApp(bottle_app)
-    doc = hapic.generate_doc(
-        title='Fake API',
-        description='just an example of hapic API'
-    )
-
-    assert doc == SWAGGER_DOC_API
-    resp = app.get('/about')
-    assert resp.status_int == 200
-    assert resp.json == {'datetime': '2017-12-07T10:55:08.488996+00:00',
-                         'version': '1.2.3'}
-
-    resp = app.get('/users')
-    assert resp.status_int == 200
-    assert resp.json == {
-        'items':
-        [
-            {
-                'username': 'some_user',
-                'display_name': 'Damien Accorsi',
-                'company': 'Algoo', 'id': 4
-            }
-        ],
-        'pagination': {
-            'first_id': 0,
-            'last_id': 5,
-            'current_id': 0,
-        },
-        'item_nb': 1,
-    }
-
-    resp = app.get('/users/1')
-    assert resp.status_int == 200
-    assert resp.json == {
-        'last_name': 'Accorsi',
-        'username': 'some_user',
-        'first_name': 'Damien',
-        'id': 4,
-        'display_name': 'Damien Accorsi',
-        'email_address': 'some.user@hapic.com',
-        'company': 'Algoo'
-    }
-
-    resp = app.post('/users/', status='*')
-    assert resp.status_int == 400
-    assert resp.json == {
-        'code': None,
-        'details': {
-            'email_address': ['Missing data for required field.'],
-            'username': ['Missing data for required field.'],
-            'display_name': ['Missing data for required field.'],
-            'last_name': ['Missing data for required field.'],
-            'first_name': ['Missing data for required field.'],
-            'company': ['Missing data for required field.']},
-        'message': 'Validation error of input data'}
-
-    user = {
-        'email_address': 'some.user@hapic.com',
-        'username': 'some_user',
-        'display_name': 'Damien Accorsi',
-        'last_name': 'Accorsi',
-        'first_name': 'Damien',
-        'company': 'Algoo',
-    }
-
-    resp = app.post_json('/users/', user)
-    assert resp.status_int == 200
-    assert resp.json == {
-        'last_name': 'Accorsi',
-        'username': 'some_user',
-        'first_name': 'Damien',
-        'id': 4,
-        'display_name': 'Damien Accorsi',
-        'email_address': 'some.user@hapic.com',
-        'company': 'Algoo',
-    }
-
-    resp = app.delete('/users/1', status='*')
-    assert resp.status_int == 204
-

tests/func/fake_api/test_fake_api.py

@@ -0,0 +1,192 @@
+import pytest
+from flask import Flask
+from pyramid.config import Configurator
+from webtest import TestApp
+from bottle import Bottle
+
+from example.fake_api.flask_api import FlaskController
+from example.fake_api.pyramid_api import PyramidController
+from hapic.ext.bottle import BottleContext
+from example.fake_api.bottle_api import BottleController
+from hapic.ext.flask import FlaskContext
+from hapic.ext.pyramid import PyramidContext
+from tests.func.fake_api.common import SWAGGER_DOC_API
+
+
+def get_bottle_context():
+    from example.fake_api.bottle_api import hapic as h
+    bottle_app = Bottle()
+    h.reset_context()
+    h.set_context(BottleContext(bottle_app))
+    controllers = BottleController()
+    controllers.bind(bottle_app)
+    return {
+        'hapic': h,
+        'app': bottle_app,
+    }
+
+
+def get_flask_context():
+    from example.fake_api.flask_api import hapic as h
+    flask_app = Flask(__name__)
+    controllers = FlaskController()
+    controllers.bind(flask_app)
+    h.reset_context()
+    h.set_context(FlaskContext(flask_app))
+    return {
+        'hapic': h,
+        'app': flask_app,
+    }
+
+
+def get_pyramid_context():
+    from example.fake_api.pyramid_api import hapic as h
+    configurator = Configurator(autocommit=True)
+    controllers = PyramidController()
+    controllers.bind(configurator)
+    h.reset_context()
+    h.set_context(PyramidContext(configurator))
+    pyramid_app = configurator.make_wsgi_app()
+    return {
+        'hapic': h,
+        'app': pyramid_app,
+    }
+
+
+@pytest.mark.parametrize('context',
+                         [
+                             get_bottle_context(),
+                             get_flask_context(),
+                             get_pyramid_context()
+                         ])
+def test_func__test_fake_api_endpoints_ok__all_framework(context):
+    hapic = context['hapic']
+    app = context['app']
+    app = TestApp(app)
+    resp = app.get('/about')
+    assert resp.status_int == 200
+    assert resp.json == {'datetime': '2017-12-07T10:55:08.488996+00:00',
+                         'version': '1.2.3'}
+
+    resp = app.get('/users')
+    assert resp.status_int == 200
+    assert resp.json == {
+        'items':
+        [
+            {
+                'username': 'some_user',
+                'display_name': 'Damien Accorsi',
+                'company': 'Algoo', 'id': 4
+            }
+        ],
+        'pagination': {
+            'first_id': 0,
+            'last_id': 5,
+            'current_id': 0,
+        },
+        'item_nb': 1,
+    }
+
+    resp = app.get('/users2')
+    assert resp.status_int == 200
+    assert resp.json == [
+        {
+           'username': 'some_user',
+           'id': 4,
+           'display_name': 'Damien Accorsi',
+           'company': 'Algoo'
+        }
+    ]
+
+    resp = app.get('/users/1')
+    assert resp.status_int == 200
+    assert resp.json == {
+        'last_name': 'Accorsi',
+        'username': 'some_user',
+        'first_name': 'Damien',
+        'id': 4,
+        'display_name': 'Damien Accorsi',
+        'email_address': 'some.user@hapic.com',
+        'company': 'Algoo'
+    }
+
+    resp = app.post('/users/', status='*')
+    assert resp.status_int == 400
+    assert resp.json == {
+        'code': None,
+        'details': {
+            'email_address': ['Missing data for required field.'],
+            'username': ['Missing data for required field.'],
+            'display_name': ['Missing data for required field.'],
+            'last_name': ['Missing data for required field.'],
+            'first_name': ['Missing data for required field.'],
+            'company': ['Missing data for required field.']},
+        'message': 'Validation error of input data'}
+
+    user = {
+        'email_address': 'some.user@hapic.com',
+        'username': 'some_user',
+        'display_name': 'Damien Accorsi',
+        'last_name': 'Accorsi',
+        'first_name': 'Damien',
+        'company': 'Algoo',
+    }
+
+    resp = app.post_json('/users/', user)
+    assert resp.status_int == 200
+    assert resp.json == {
+        'last_name': 'Accorsi',
+        'username': 'some_user',
+        'first_name': 'Damien',
+        'id': 4,
+        'display_name': 'Damien Accorsi',
+        'email_address': 'some.user@hapic.com',
+        'company': 'Algoo',
+    }
+
+    resp = app.delete('/users/1', status='*')
+    assert resp.status_int == 204
+
+
+@pytest.mark.parametrize('context',
+                         [
+                             get_bottle_context(),
+                             get_flask_context(),
+                             get_pyramid_context()
+                         ])
+def test_func__test_fake_api_doc_ok__all_framework(context):
+    hapic = context['hapic']
+    app = context['app']
+    app = TestApp(app)
+    doc = hapic.generate_doc(
+        title='Fake API',
+        description='just an example of hapic API'
+    )
+
+    assert doc['info'] == SWAGGER_DOC_API['info']
+    assert doc['tags'] == SWAGGER_DOC_API['tags']
+    assert doc['swagger'] == SWAGGER_DOC_API['swagger']
+    assert doc['parameters'] == SWAGGER_DOC_API['parameters']
+    assert doc['paths']['/about'] == SWAGGER_DOC_API['paths']['/about']
+    assert doc['paths']['/users'] == SWAGGER_DOC_API['paths']['/users']
+    assert doc['paths']['/users/{id}'] == SWAGGER_DOC_API['paths']['/users/{id}']
+    assert doc['paths']['/users/'] == SWAGGER_DOC_API['paths']['/users/']
+    assert doc['paths']['/users2'] == SWAGGER_DOC_API['paths']['/users2']
+
+    assert doc['definitions']['AboutResponseSchema'] == \
+           SWAGGER_DOC_API['definitions']['AboutResponseSchema']
+    assert doc['definitions']['ListsUserSchema'] == \
+           SWAGGER_DOC_API['definitions']['ListsUserSchema']
+    assert doc['definitions']['NoContentSchema'] == \
+           SWAGGER_DOC_API['definitions']['NoContentSchema']
+    assert doc['definitions']['PaginationSchema'] == \
+           SWAGGER_DOC_API['definitions']['PaginationSchema']
+    assert doc['definitions']['UserSchema'] == \
+           SWAGGER_DOC_API['definitions']['UserSchema']
+    assert doc['definitions']['UserSchema'] == \
+           SWAGGER_DOC_API['definitions']['UserSchema']
+
+    assert doc['definitions']['UserSchema_without_id'] == \
+           SWAGGER_DOC_API['definitions']['UserSchema_without_id']
+    assert doc['definitions']['UserSchema_without_email_address_first_name_last_name'] == \
+           SWAGGER_DOC_API['definitions']['UserSchema_without_email_address_first_name_last_name']

tests/func/fake_api/test_flask.py

@@ -1,95 +0,0 @@
-from webtest import TestApp
-from hapic.ext.flask import FlaskContext
-from flask import Flask
-from example.fake_api.flask_api import FlaskController
-from example.fake_api.flask_api import hapic
-from tests.func.fake_api.common import SWAGGER_DOC_API
-
-
-def test_func_flask_fake_api():
-    flask_app = Flask(__name__)
-    controllers = FlaskController()
-    controllers.bind(flask_app)
-    hapic.set_context(FlaskContext(flask_app))
-    app = TestApp(flask_app)
-    doc =  hapic.generate_doc(
-        title='Fake API',
-        description='just an example of hapic API'
-    )
-
-    assert doc == SWAGGER_DOC_API
-    resp = app.get('/about', status='*')
-    assert resp.status_int == 200
-    assert resp.json == {'datetime': '2017-12-07T10:55:08.488996+00:00',
-                         'version': '1.2.3'}
-
-    resp = app.get('/users')
-    assert resp.status_int == 200
-    assert resp.json == {
-        'items':
-        [
-            {
-                'username': 'some_user',
-                'display_name': 'Damien Accorsi',
-                'company': 'Algoo', 'id': 4
-            }
-        ],
-        'pagination': {
-            'first_id': 0,
-            'last_id': 5,
-            'current_id': 0,
-        },
-        'item_nb': 1,
-    }
-
-    resp = app.get('/users/1')
-    assert resp.status_int == 200
-    assert resp.json == {
-        'last_name': 'Accorsi',
-        'username': 'some_user',
-        'first_name': 'Damien',
-        'id': 4,
-        'display_name': 'Damien Accorsi',
-        'email_address': 'some.user@hapic.com',
-        'company': 'Algoo'
-    }
-
-    resp = app.post('/users/', status='*')
-    assert resp.status_int == 400
-    assert resp.json == {
-        'code': None,
-        'details': {
-            'email_address': ['Missing data for required field.'],
-            'username': ['Missing data for required field.'],
-            'display_name': ['Missing data for required field.'],
-            'last_name': ['Missing data for required field.'],
-            'first_name': ['Missing data for required field.'],
-            'company': ['Missing data for required field.']},
-        'message': 'Validation error of input data'}
-
-    user = {
-        'email_address': 'some.user@hapic.com',
-        'username': 'some_user',
-        'display_name': 'Damien Accorsi',
-        'last_name': 'Accorsi',
-        'first_name': 'Damien',
-        'company': 'Algoo',
-    }
-
-    resp = app.post_json('/users/', user)
-    assert resp.status_int == 200
-    assert resp.json == {
-        'last_name': 'Accorsi',
-        'username': 'some_user',
-        'first_name': 'Damien',
-        'id': 4,
-        'display_name': 'Damien Accorsi',
-        'email_address': 'some.user@hapic.com',
-        'company': 'Algoo',
-    }
-    # INFO - G.M - 2017-12-07 - Warning due to Webtest check
-    # Webtest check content_type. Up to know flask_api return json as
-    # content_type with 204 NO CONTENT status code which return a warning in
-    # WebTest check.
-    resp = app.delete('/users/1', status='*')
-    assert resp.status_int == 204

tests/func/fake_api/test_pyramid.py

@@ -1,97 +0,0 @@
-from webtest import TestApp
-from pyramid.config import Configurator
-import hapic
-from hapic.ext.pyramid import PyramidContext
-from example.fake_api.pyramid_api import hapic
-from example.fake_api.pyramid_api import PyramidController
-from tests.func.fake_api.common import SWAGGER_DOC_API
-
-
-def test_func_pyramid_fake_api_doc():
-    configurator = Configurator(autocommit=True)
-    controllers = PyramidController()
-    controllers.bind(configurator)
-    hapic.set_context(PyramidContext(configurator))
-    app = TestApp(configurator.make_wsgi_app())
-    doc = hapic.generate_doc(
-        title='Fake API',
-        description='just an example of hapic API'
-    )
-
-    assert doc == SWAGGER_DOC_API
-    resp = app.get('/about')
-    assert resp.status_int == 200
-    assert resp.json == {'datetime': '2017-12-07T10:55:08.488996+00:00',
-                         'version': '1.2.3'}
-
-    resp = app.get('/users')
-    assert resp.status_int == 200
-    assert resp.json == {
-        'items':
-        [
-            {
-                'username': 'some_user',
-                'display_name': 'Damien Accorsi',
-                'company': 'Algoo', 'id': 4
-            }
-        ],
-        'pagination': {
-            'first_id': 0,
-            'last_id': 5,
-            'current_id': 0,
-        },
-        'item_nb': 1,
-    }
-
-    resp = app.get('/users/1')
-    assert resp.status_int == 200
-    assert resp.json == {
-        'last_name': 'Accorsi',
-        'username': 'some_user',
-        'first_name': 'Damien',
-        'id': 4,
-        'display_name': 'Damien Accorsi',
-        'email_address': 'some.user@hapic.com',
-        'company': 'Algoo'
-    }
-
-    resp = app.post('/users/', status='*')
-    assert resp.status_int == 400
-    assert resp.json == {
-        'code': None,
-        'details': {
-            'email_address': ['Missing data for required field.'],
-            'username': ['Missing data for required field.'],
-            'display_name': ['Missing data for required field.'],
-            'last_name': ['Missing data for required field.'],
-            'first_name': ['Missing data for required field.'],
-            'company': ['Missing data for required field.']},
-        'message': 'Validation error of input data'}
-
-    user = {
-        'email_address': 'some.user@hapic.com',
-        'username': 'some_user',
-        'display_name': 'Damien Accorsi',
-        'last_name': 'Accorsi',
-        'first_name': 'Damien',
-        'company': 'Algoo',
-    }
-
-    resp = app.post_json('/users/', user)
-    assert resp.status_int == 200
-    assert resp.json == {
-        'last_name': 'Accorsi',
-        'username': 'some_user',
-        'first_name': 'Damien',
-        'id': 4,
-        'display_name': 'Damien Accorsi',
-        'email_address': 'some.user@hapic.com',
-        'company': 'Algoo',
-    }
-
-    # INFO - G.M - 2017-12-07 - Test for delete desactivated(Webtest check fail)
-    # Webtest check content_type. Up to know pyramid_api return json as
-    # content_type with 204 NO CONTENT status code which return an error in
-    # WebTest check.
-    # resp = app.delete('/users/1', status='*')
-    # assert resp.status_int == 204

tests/func/test_doc.py

@@ -221,3 +221,154 @@ class TestDocGeneration(Base):
             .get('properties', {})\
             .get('category', {})\
             .get('enum')
+
+    def test_func__schema_in_doc__ok__nominal_case(self):
+        hapic = Hapic()
+        app = bottle.Bottle()
+        hapic.set_context(MyContext(app=app))
+
+        class MySchema(marshmallow.Schema):
+            name = marshmallow.fields.String(required=True)
+
+        @hapic.with_api_doc()
+        @hapic.input_body(MySchema())
+        def my_controller():
+            return {'name': 'test',}
+
+        app.route('/paper', method='POST', callback=my_controller)
+        doc = hapic.generate_doc()
+
+        assert doc.get('definitions', {}).get('MySchema', {})
+        schema_def = doc.get('definitions', {}).get('MySchema', {})
+        assert schema_def.get('properties', {}).get('name', {}).get('type')
+
+        assert doc.get('paths').get('/paper').get('post').get('parameters')[0]
+        schema_ref = doc.get('paths').get('/paper').get('post').get('parameters')[0]
+        assert schema_ref.get('in') == 'body'
+        assert schema_ref.get('name') == 'body'
+        assert schema_ref['schema']['$ref'] == '#/definitions/MySchema'
+
+    def test_func__schema_in_doc__ok__many_case(self):
+        hapic = Hapic()
+        app = bottle.Bottle()
+        hapic.set_context(MyContext(app=app))
+
+        class MySchema(marshmallow.Schema):
+            name = marshmallow.fields.String(required=True)
+
+        @hapic.with_api_doc()
+        @hapic.input_body(MySchema(many=True))
+        def my_controller():
+            return {'name': 'test'}
+
+        app.route('/paper', method='POST', callback=my_controller)
+        doc = hapic.generate_doc()
+
+        assert doc.get('definitions', {}).get('MySchema', {})
+        schema_def = doc.get('definitions', {}).get('MySchema', {})
+        assert schema_def.get('properties', {}).get('name', {}).get('type')
+
+        assert doc.get('paths').get('/paper').get('post').get('parameters')[0]
+        schema_ref = doc.get('paths').get('/paper').get('post').get('parameters')[0]
+        assert schema_ref.get('in') == 'body'
+        assert schema_ref.get('name') == 'body'
+        assert schema_ref['schema'] == {
+            'items': {'$ref': '#/definitions/MySchema'},
+            'type': 'array'
+        }
+
+    def test_func__schema_in_doc__ok__exclude_case(self):
+        hapic = Hapic()
+        app = bottle.Bottle()
+        hapic.set_context(MyContext(app=app))
+
+        class MySchema(marshmallow.Schema):
+            name = marshmallow.fields.String(required=True)
+            name2 = marshmallow.fields.String(required=True)
+
+        @hapic.with_api_doc()
+        @hapic.input_body(MySchema(exclude=('name2',)))
+        def my_controller():
+            return {'name': 'test',}
+
+        app.route('/paper', method='POST', callback=my_controller)
+        doc = hapic.generate_doc()
+
+        definitions = doc.get('definitions', {})
+        # TODO - G-M - Find better way to find our new schema
+        # Do Better test when we were able to set correctly schema name
+        # according to content
+        schema_name = None
+        for elem in definitions.keys():
+            if elem != 'MySchema':
+                schema_name = elem
+                break
+        assert schema_name
+        schema_def = definitions[schema_name]
+        assert schema_def.get('properties', {}).get('name', {}).get('type') == 'string'
+        assert doc.get('paths').get('/paper').get('post').get('parameters')[0]
+        schema_ref = doc.get('paths').get('/paper').get('post').get('parameters')[0]
+        assert schema_ref.get('in') == 'body'
+        assert schema_ref['schema']['$ref'] == '#/definitions/{}'.format(schema_name)
+
+        @hapic.with_api_doc()
+        @hapic.input_body(MySchema(only=('name',)))
+        def my_controller():
+            return {'name': 'test'}
+
+        app.route('/paper', method='POST', callback=my_controller)
+        doc = hapic.generate_doc()
+
+        # TODO - G-M - Find better way to find our new schema
+        # Do Better test when we were able to set correctly schema name
+        # according to content
+        definitions = doc.get('definitions', {})
+        schema_name = None
+        for elem in definitions.keys():
+            if elem != 'MySchema':
+                schema_name = elem
+                break
+        assert schema_name
+        schema_def = definitions[schema_name]
+        assert schema_def.get('properties', {}).get('name', {}).get('type') == 'string'
+        assert doc.get('paths').get('/paper').get('post').get('parameters')[0]
+        schema_ref = doc.get('paths').get('/paper').get('post').get('parameters')[0]
+        assert schema_ref.get('in') == 'body'
+        assert schema_ref['schema']['$ref'] == '#/definitions/{}'.format(schema_name)
+
+    def test_func__schema_in_doc__ok__many_and_exclude_case(self):
+        hapic = Hapic()
+        app = bottle.Bottle()
+        hapic.set_context(MyContext(app=app))
+
+        class MySchema(marshmallow.Schema):
+            name = marshmallow.fields.String(required=True)
+            name2 = marshmallow.fields.String(required=True)
+
+        @hapic.with_api_doc()
+        @hapic.input_body(MySchema(exclude=('name2',), many=True))
+        def my_controller():
+            return {'name': 'test',}
+
+        app.route('/paper', method='POST', callback=my_controller)
+        doc = hapic.generate_doc()
+
+        definitions = doc.get('definitions', {})
+        # TODO - G-M - Find better way to find our new schema
+        # Do Better test when we were able to set correctly schema name
+        # according to content
+        schema_name = None
+        for elem in definitions.keys():
+            if elem != 'MySchema':
+                schema_name = elem
+                break
+        assert schema_name
+        schema_def = definitions[schema_name]
+        assert schema_def.get('properties', {}).get('name', {}).get('type') == 'string'
+        assert doc.get('paths').get('/paper').get('post').get('parameters')[0]
+        schema_ref = doc.get('paths').get('/paper').get('post').get('parameters')[0]
+        assert schema_ref.get('in') == 'body'
+        assert schema_ref['schema'] == {
+            'items': {'$ref': '#/definitions/{}'.format(schema_name)},
+            'type': 'array'
+        }