Merge pull request #17 from algoo/develop

example_a.py

@@ -118,7 +118,7 @@ controllers.bind(app)
 # print(yaml.dump(ss, default_flow_style=False))
 # time.sleep(1)
 
-hapic.set_context(hapic.ext.bottle.bottle_context)
+hapic.set_context(hapic.ext.bottle.BottleContext())
 print(json.dumps(hapic.generate_doc(app)))
 
 app.run(host='localhost', port=8080, debug=True)

hapic/decorator.py

@@ -4,6 +4,7 @@ import typing
 from http import HTTPStatus
 
 # TODO BS 20171010: bottle specific !  # see #5
+import marshmallow
 from bottle import HTTPResponse
 
 from hapic.data import HapicData
@@ -338,11 +339,13 @@ class ExceptionHandlerControllerWrapper(ControllerWrapper):
         self,
         handled_exception_class: typing.Type[Exception],
         context: typing.Union[ContextInterface, typing.Callable[[], ContextInterface]],  # nopep8
+        schema: marshmallow.Schema,
         http_code: HTTPStatus=HTTPStatus.INTERNAL_SERVER_ERROR,
     ) -> None:
         self.handled_exception_class = handled_exception_class
         self._context = context
         self.http_code = http_code
+        self.schema = schema
 
     @property
     def context(self) -> ContextInterface:
@@ -363,16 +366,17 @@ class ExceptionHandlerControllerWrapper(ControllerWrapper):
                 func_kwargs,
             )
         except self.handled_exception_class as exc:
-            # TODO: error_dict configurable name, see #4
-            # TODO: Who assume error structure ? We have to rethink it, see #4
-            error_dict = {
-                'error_message': str(exc),
+            # TODO: "error_detail" attribute name should be configurable
+            # TODO BS 20171013: use overrideable mechanism, error object given
+            #  to schema ? see #15
+            raw_response = {
+                'message': str(exc),
+                'code': None,
+                'detail': getattr(exc, 'error_detail', {}),
             }
-            if hasattr(exc, 'error_dict'):
-                error_dict.update(exc.error_dict)
 
             error_response = self.context.get_response(
-                error_dict,
+                raw_response,
                 self.http_code,
             )
             return error_response

hapic/doc.py

@@ -76,9 +76,13 @@ def bottle_generate_operations(
 
     if description.errors:
         for error in description.errors:
+            schema_class = type(error.wrapper.schema)
             method_operations.setdefault('responses', {})\
                 [int(error.wrapper.http_code)] = {
                     'description': str(error.wrapper.http_code),
+                    'schema': {
+                        '$ref': '#/definitions/{}'.format(schema_class.__name__)  # nopep8
+                    }
                 }
 
     # jsonschema based
@@ -155,6 +159,10 @@ class DocGenerator(object):
                     description.output_body.wrapper.processor.schema
                 ))
 
+            if description.errors:
+                for error in description.errors:
+                    schemas.append(type(error.wrapper.schema))
+
         for schema in set(schemas):
             spec.definition(schema.__name__, schema=schema)
 

hapic/hapic.py

@@ -31,18 +31,20 @@ from hapic.processor import ProcessorInterface
 from hapic.processor import MarshmallowInputProcessor
 from hapic.processor import MarshmallowOutputProcessor
 
-# TODO: Gérer les cas ou c'est une liste la réponse (items, item_nb), see #12
-# TODO: Confusion nommage body/json/forms, see #13
 
-# _waiting = {}
-# _endpoints = {}
 class ErrorResponseSchema(marshmallow.Schema):
-    error_message = marshmallow.fields.String(required=True)
-    error_details = marshmallow.fields.Dict(required=True)
+    message = marshmallow.fields.String(required=True)
+    details = marshmallow.fields.Dict(required=False, missing={})
+    code = marshmallow.fields.Raw(missing=None)
+
 
 _default_global_error_schema = ErrorResponseSchema()
 
 
+# TODO: Gérer les cas ou c'est une liste la réponse (items, item_nb), see #12
+# TODO: Confusion nommage body/json/forms, see #13
+
+
 class Hapic(object):
     def __init__(self):
         self._buffer = DecorationBuffer()
@@ -277,7 +279,9 @@ class Hapic(object):
         decoration = ExceptionHandlerControllerWrapper(
             handled_exception_class,
             context,
-            http_code,
+            # TODO BS 20171013: Permit schema overriding, see #15
+            schema=_default_global_error_schema,
+            http_code=http_code,
         )
 
         def decorator(func):

setup.py

@@ -23,7 +23,7 @@ setup(
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version='0.0.3.4',
+    version='0.0.4',
 
     description='HTTP api input/output manager',
     # long_description=long_description,