WIP Session Related method of Tracim v2 API

tracim/__init__.py

@@ -13,7 +13,8 @@ from tracim.lib.utils.authentification import basic_auth_check_credentials
 from tracim.lib.utils.authentification import BASIC_AUTH_WEBUI_REALM
 from tracim.lib.utils.authorization import AcceptAllAuthorizationPolicy
 from tracim.lib.utils.authorization import TRACIM_DEFAULT_PERM
-from tracim.views.example_api.example_api_controller import ExampleApiController
+from tracim.views.core_api.session_controller import SessionController
+#from tracim.views.example_api.example_api_controller import ExampleApiController
 from tracim.views.default.default_controller import DefaultController
 
 
@@ -48,15 +49,17 @@ def main(global_config, **settings):
     # Add controllers
     default_controllers = DefaultController()
     default_controllers.bind(configurator)
-    example_api_controllers = ExampleApiController()
-    example_api_controllers.bind(configurator)
-
+    #example_api_controllers = ExampleApiController()
+    #example_api_controllers.bind(configurator)
+    session_api = SessionController()
+    session_api.bind(configurator)
     # TODO - G.M - 09-04-2018 - Enable swagger ui doc
     # time.sleep(1)
     # s = json.dumps(
     #     hapic.generate_doc(
-    #         title='Fake API',
-    #         description='just an example of hapic API'
+    #         title='Tracim v2 API',
+    #         description='API of Tracim v2',
+    #
     #     )
     # )
     # time.sleep(1)

tracim/exceptions.py

@@ -83,3 +83,7 @@ class ImmutableAttribute(TracimException):
 
 class DigestAuthNotImplemented(Exception):
     pass
+
+
+class LoginFailed(TracimException):
+    pass

tracim/views/core_api/schemas.py

@@ -0,0 +1,36 @@
+# coding=utf-8
+import marshmallow
+
+
+class ProfileSchema(marshmallow.Schema):
+    id = marshmallow.fields.Int(dump_only=True, required=True)
+    name = marshmallow.fields.String()
+
+
+class UserSchema(marshmallow.Schema):
+    user_id = marshmallow.fields.Int(dump_only=True, required=True)
+    email = marshmallow.fields.Email(required=True)
+    display_name = marshmallow.fields.String()
+    created = marshmallow.fields.DateTime(format='iso8601')
+    is_active = marshmallow.fields.Bool()
+    # TODO - G.M - 17-04-2018 - Restrict timezone values
+    timezone = marshmallow.fields.String()
+    # TODO - G.M - 17-04-2018 - check this, relative url allowed ?
+    caldav_url = marshmallow.fields.Url(relative=True)
+    profile = marshmallow.fields.Nested(
+        ProfileSchema,
+        many=False,
+    )
+
+
+class BasicAuthSchema(marshmallow.Schema):
+    email = marshmallow.fields.Email(required=True)
+    password = marshmallow.fields.String(required=True, load_only=True)
+
+
+class LoginOutputHeaders(marshmallow.Schema):
+    expire_after = marshmallow.fields.String()
+
+
+class OkResponse(marshmallow.Schema):
+    message = marshmallow.fields.String(required=True)

tracim/views/core_api/session_controller.py

@@ -0,0 +1,114 @@
+# coding=utf-8
+from sqlalchemy.orm.exc import NoResultFound
+
+from tracim import TracimRequest
+from tracim.extensions import hapic
+from tracim.lib.core.user import UserApi
+from tracim.views.controllers import Controller
+from pyramid.config import Configurator
+
+from tracim.views.core_api.schemas import UserSchema, OkResponse
+from tracim.views.core_api.schemas import LoginOutputHeaders
+from tracim.views.core_api.schemas import BasicAuthSchema
+from tracim.exceptions import NotAuthentificated, LoginFailed
+
+try:  # Python 3.5+
+    from http import HTTPStatus
+except ImportError:
+    from http import client as HTTPStatus
+
+
+class SessionController(Controller):
+
+    @hapic.with_api_doc()
+    @hapic.input_headers(LoginOutputHeaders())
+    @hapic.input_query(BasicAuthSchema())
+    @hapic.handle_exception(LoginFailed, http_code=HTTPStatus.BAD_REQUEST)
+    # TODO - G.M - 17-04-2018 - fix output header ?
+    # @hapic.output_headers()
+    @hapic.output_body(OkResponse())
+    def login(self, context, request: TracimRequest, hapic_data=None):
+        """
+        Logs user into the system
+        """
+        email = request.params['email']
+        password = request.params['password']
+        if not (email and password):
+            raise Exception
+        app_config = request.registry.settings['CFG']
+        try:
+            uapi = UserApi(
+                None,
+                session=request.dbsession,
+                config=app_config,
+            )
+            user = uapi.get_one_by_email(email)
+            valid_password = user.validate_password(password)
+            if not valid_password:
+                # Bad password
+                raise LoginFailed('Bad Credentials')
+        except NoResultFound:
+            # User does not exist
+            raise LoginFailed('Bad Credentials')
+        return {'message': 'ok'}
+
+    @hapic.with_api_doc()
+    @hapic.output_body(OkResponse())
+    def logout(self, context, request: TracimRequest, hapic_data=None):
+        """
+        Logs out current logged in user session
+        """
+        return {'message': 'ok'}
+
+    @hapic.with_api_doc()
+    @hapic.handle_exception(
+        NotAuthentificated,
+        http_code=HTTPStatus.UNAUTHORIZED
+    )
+    @hapic.output_body(
+        UserSchema(),
+        default_http_code=HTTPStatus.OK,
+    )
+    def whoami(self, context, request: TracimRequest, hapic_data=None):
+        """
+        Return current logged in user or 401
+        """
+        return request.current_user
+
+    def bind(self, configurator: Configurator):
+
+        # Login
+        configurator.add_route(
+            'login',
+            '/sessions/login',
+            request_method='GET'
+        )
+        configurator.add_view(
+            self.login,
+            route_name='login',
+            renderer='json'
+        )
+        # Logout
+        configurator.add_route(
+            'logout',
+            '/sessions/logout',
+            request_method='GET'
+        )
+
+        configurator.add_view(
+            self.logout,
+            route_name='logout',
+            renderer='json'
+
+        )
+        # Whoami
+        configurator.add_route(
+            'whoami',
+            '/sessions/whoami',
+            request_method='GET'
+        )
+        configurator.add_view(
+            self.whoami,
+            route_name='whoami',
+            renderer='json'
+        )