refactor view using hapic + add temporary example_api

setup.py

@@ -23,6 +23,8 @@ requires = [
     'filedepot',
     'babel',
     'alembic',
+    'hapic',
+    'marshmallow',
 ]
 
 tests_require = [

tracim/__init__.py

@@ -1,15 +1,43 @@
 # -*- coding: utf-8 -*-
+import json
+import time
+
 from pyramid.config import Configurator
+from hapic.ext.pyramid import PyramidContext
+
+from tracim.extensions import hapic
 from tracim.config import RequestWithCFG
+from tracim.views.example_api.example_api_controller import ExampleApiController
+from tracim.views.default.default_controller import DefaultController
 
 
 def main(global_config, **settings):
     """ This function returns a Pyramid WSGI application.
     """
-    config = Configurator(settings=settings)
-    config.include('pyramid_jinja2')
-    config.include('.models')
-    config.include('.routes')
-    config.set_request_factory(RequestWithCFG)
-    config.scan()
-    return config.make_wsgi_app()
+    configurator = Configurator(settings=settings, autocommit=True)
+    # Pyramids "plugin" include.
+    configurator.include('pyramid_jinja2')
+    # Add SqlAlchemy DB
+    configurator.include('.models')
+    # Override default request
+    configurator.set_request_factory(RequestWithCFG)
+    # set Hapic
+    hapic.set_context(PyramidContext(configurator))
+    # Add controllers
+    default_controllers = DefaultController()
+    default_controllers.bind(configurator)
+    example_api_controllers = ExampleApiController()
+    example_api_controllers.bind(configurator)
+
+    time.sleep(1)
+    s = json.dumps(
+        hapic.generate_doc(
+            title='Fake API',
+            description='just an example of hapic API'
+        )
+    )
+    time.sleep(1)
+    # print swagger doc
+    print(s)
+    time.sleep(1)
+    return configurator.make_wsgi_app()

tracim/config.py

@@ -3,18 +3,15 @@ from urllib.parse import urlparse
 from paste.deploy.converters import asbool
 from tracim.lib.utils.logger import logger
 from depot.manager import DepotManager
-
 from pyramid.request import Request
 
-
 class RequestWithCFG(Request):
 
     def app_config(self):
         cfg = CFG(self.registry.settings)
-        cfg.configure_filedepot()
+        #cfg.configure_filedepot()
         return cfg
 
-
 class CFG(object):
     """Object used for easy access to config file parameters."""
 

tracim/extensions.py

@@ -0,0 +1,3 @@
+from hapic import Hapic
+
+hapic = Hapic()

tracim/routes.py

@@ -1,4 +0,0 @@
-# -*- coding: utf-8 -*-
-def includeme(config):
-    config.add_static_view('static', 'static', cache_max_age=3600)
-    config.add_route('home', '/')

tracim/views/controllers.py

@@ -0,0 +1,7 @@
+from pyramid.config import Configurator
+
+
+class Controller(object):
+
+    def bind(self, configurator: Configurator):
+        raise NotImplementedError()

tracim/views/default.py

@@ -1,41 +0,0 @@
-# -*- coding: utf-8 -*-
-# TODO - G.M - 29-03-2018 - [Cleanup] Drop this file
-from pyramid.response import Response
-from pyramid.view import view_config
-
-from sqlalchemy.exc import DBAPIError
-from ..models import Content
-
-
-@view_config(route_name='home', renderer='../templates/mytemplate.jinja2')
-def test_config(request):
-    try:
-        project = request.app_config().WEBSITE_TITLE
-    except Exception as e:
-        return Response(e, content_type='text/plain', status=500)
-    return {'project': project}
-
-# @view_config(route_name='home', renderer='../templates/mytemplate.jinja2')
-# def my_view(request):
-#     try:#         query = request.dbsession.query(MyModel)
-#         one = query.filter(MyModel.name == 'one').first()
-#     except DBAPIError:
-#         return Response(db_err_msg, content_type='text/plain', status=500)
-#    return {'one': one, 'project': 'tracim'}
-
-
-db_err_msg = """\
-Pyramid is having a problem using your SQL database.  The problem
-might be caused by one of the following things:
-
-1.  You may need to run the "initialize_tracim_db" script
-    to initialize your database tables.  Check your virtual
-    environment's "bin" directory for this script and try to run it.
-
-2.  Your database server may not be running.  Check that the
-    database server referred to by the "sqlalchemy.url" setting in
-    your "development.ini" file is running.
-
-After you fix the problem, please restart the Pyramid application to
-try it again.
-"""

tracim/views/default/default_controller.py

@@ -0,0 +1,36 @@
+# coding=utf-8
+from tracim.views.controllers import Controller
+from pyramid.config import Configurator
+from pyramid.response import Response
+from pyramid.exceptions import NotFound
+
+
+class DefaultController(Controller):
+
+    @classmethod
+    def notfound_view(cls, request):
+        request.response.status = 404
+        return {}
+
+    @classmethod
+    def test_config(cls, request):
+        try:
+            project = request.app_config().WEBSITE_TITLE
+        except Exception as e:
+            return Response(e, content_type='text/plain', status=500)
+        return {'project': project}
+
+    def bind(self, configurator: Configurator):
+        configurator.add_static_view('static', 'static', cache_max_age=3600)
+        configurator.add_view(
+            self.notfound_view,
+            renderer='tracim:templates/404.jinja2',
+            context=NotFound,
+        )
+
+        configurator.add_route('test_config', '/')
+        configurator.add_view(
+            self.test_config,
+            route_name='test_config',
+            renderer='tracim:templates/mytemplate.jinja2',
+        )

tracim/views/example_api/__init__.py

@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-

tracim/views/example_api/example_api_controller.py

@@ -0,0 +1,109 @@
+# -*- coding: utf-8 -*-
+from datetime import datetime
+
+from pyramid.config import Configurator
+
+from hapic.data import HapicData
+
+from tracim.extensions import hapic
+from tracim.views.controllers import Controller
+from tracim.views.example_api.schema import *
+
+
+class ExampleApiController(Controller):
+
+    @hapic.with_api_doc()
+    @hapic.output_body(AboutResponseSchema())
+    def about(self, context, request):
+        """
+        General information about this API.
+        """
+        return {
+            'version': '1.2.3',
+            'datetime': datetime(2017, 12, 7, 10, 55, 8, 488996),
+        }
+
+    @hapic.with_api_doc()
+    @hapic.output_body(ListsUserSchema())
+    def get_users(self, context, request):
+        """
+        Obtain users list.
+        """
+        return {
+            'item_nb': 1,
+            'items': [
+                {
+                    'id': 4,
+                    'username': 'some_user',
+                    'display_name': 'Damien Accorsi',
+                    'company': 'Algoo',
+                },
+            ],
+            'pagination': {
+                'first_id': 0,
+                'last_id': 5,
+                'current_id': 0,
+            }
+        }
+
+    @hapic.with_api_doc()
+    @hapic.input_path(UserPathSchema())
+    @hapic.output_body(UserSchema())
+    def get_user(self, context, request, hapic_data: HapicData):
+        """
+        Obtain one user
+        """
+        return {
+             'id': 4,
+             'username': 'some_user',
+             'email_address': 'some.user@hapic.com',
+             'first_name': 'Damien',
+             'last_name': 'Accorsi',
+             'display_name': 'Damien Accorsi',
+             'company': 'Algoo',
+        }
+
+    @hapic.with_api_doc()
+    # TODO - G.M - 2017-12-5 - Support input_forms ?
+    # TODO - G.M - 2017-12-5 - Support exclude, only ?
+    @hapic.input_body(UserSchema(exclude=('id',)))
+    @hapic.output_body(UserSchema())
+    def add_user(self, context, request, hapic_data: HapicData):
+        """
+        Add new user
+        """
+        return {
+             'id': 4,
+             'username': 'some_user',
+             'email_address': 'some.user@hapic.com',
+             'first_name': 'Damien',
+             'last_name': 'Accorsi',
+             'display_name': 'Damien Accorsi',
+             'company': 'Algoo',
+        }
+
+    @hapic.with_api_doc()
+    @hapic.output_body(NoContentSchema(),
+                       default_http_code=204)
+    @hapic.input_path(UserPathSchema())
+    def del_user(self, context, request, hapic_data: HapicData):
+        """
+        delete user
+        """
+        return NoContentSchema()
+
+    def bind(self, configurator: Configurator):
+        configurator.add_route('about', '/about', request_method='GET')
+        configurator.add_view(self.about, route_name='about', renderer='json')
+
+        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_user', '/users/{id}', request_method='GET')  # nopep8
+        configurator.add_view(self.get_user, route_name='get_user', renderer='json')  # nopep8
+
+        configurator.add_route('add_user', '/users/', request_method='POST')  # nopep8
+        configurator.add_view(self.add_user, route_name='add_user', renderer='json')  # nopep8
+
+        configurator.add_route('del_user', '/users/{id}', request_method='DELETE')  # nopep8
+        configurator.add_view(self.del_user, route_name='del_user', renderer='json')  # nopep8

tracim/views/example_api/schema.py

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+import marshmallow
+
+
+class NoContentSchema(marshmallow.Schema):
+    pass
+
+
+class AboutResponseSchema(marshmallow.Schema):
+    version = marshmallow.fields.String(required=True,)
+    datetime = marshmallow.fields.DateTime(required=True)
+
+
+class UserPathSchema(marshmallow.Schema):
+    id = marshmallow.fields.Int(
+        required=True,
+        validate=marshmallow.validate.Range(min=1),
+    )
+
+
+class UserSchema(marshmallow.Schema):
+    id = marshmallow.fields.Int(required=True)
+    username = marshmallow.fields.String(
+        required=True,
+        validate = marshmallow.validate.Regexp(regex='[\w-]+'),
+    )
+    email_address = marshmallow.fields.Email(required=True)
+    first_name = marshmallow.fields.String(required=True)
+    last_name = marshmallow.fields.String(required=True)
+    display_name = marshmallow.fields.String(required=True)
+    company = marshmallow.fields.String(required=True)
+
+
+class PaginationSchema(marshmallow.Schema):
+    first_id = marshmallow.fields.Int(required=True)
+    last_id = marshmallow.fields.Int(required=True)
+    current_id = marshmallow.fields.Int(required=True)
+
+
+class ListsUserSchema(marshmallow.Schema):
+    item_nb = marshmallow.fields.Int(
+        required=True,
+        validate=marshmallow.validate.Range(min=0)
+    )
+    items = marshmallow.fields.Nested(
+        UserSchema,
+        many=True,
+        only=['id', 'username', 'display_name', 'company']
+    )
+    # TODO - G.M - 2017-12-05 - Fix nested schema import into doc !
+    # Can't add doc for nested Schema properly
+    # When schema item isn't added through their own method
+    # Ex : Pagination Schema doesn't work here but UserSchema is ok.
+    pagination = marshmallow.fields.Nested(
+        PaginationSchema
+    )

tracim/views/notfound.py

@@ -1,8 +0,0 @@
-# -*- coding: utf-8 -*-
-from pyramid.view import notfound_view_config
-# TODO - G.M - 29-03-2018 - [Cleanup] Drop this file
-
-@notfound_view_config(renderer='../templates/404.jinja2')
-def notfound_view(request):
-    request.response.status = 404
-    return {}