Better session api spec (return 204)

tracim/tests/functional/test_session.py

@@ -1,12 +1,13 @@
 # coding=utf-8
+import pytest
+
 from tracim.tests import FunctionalTest
 
 
 class TestLogoutEndpoint(FunctionalTest):
 
     def test_logout(self):
-        res = self.testapp.get('/api/v2/sessions/logout', status=200)
-        assert res.json_body == {'message': 'ok'}
+        res = self.testapp.get('/api/v2/sessions/logout', status=204)
 
 
 class TestLoginEndpoint(FunctionalTest):
@@ -18,10 +19,9 @@ class TestLoginEndpoint(FunctionalTest):
         }
         res = self.testapp.get(
             '/api/v2/sessions/login',
-            status=200,
+            status=204,
             params=params
         )
-        assert res.json_body == {'message': 'ok'}
 
     def test_bad_password(self):
         params = {
@@ -51,7 +51,7 @@ class TestLoginEndpoint(FunctionalTest):
 
 class TestWhoamiEndpoint(FunctionalTest):
 
-    def test_login_ok(self):
+    def test_whoami_ok(self):
         self.testapp.authorization = (
             'Basic',
             (

tracim/views/core_api/schemas.py

@@ -38,5 +38,5 @@ class LoginOutputHeaders(marshmallow.Schema):
     expire_after = marshmallow.fields.String()
 
 
-class OkResponse(marshmallow.Schema):
-    message = marshmallow.fields.String(required=True)
+class NoContentSchema(marshmallow.Schema):
+    pass

tracim/views/core_api/session_controller.py

@@ -1,5 +1,9 @@
 # coding=utf-8
 import os
+from http.client import HTTPException
+
+from pyramid.httpexceptions import HTTPNoContent
+from pyramid.response import Response
 from sqlalchemy.orm.exc import NoResultFound
 
 from tracim import TracimRequest
@@ -9,7 +13,7 @@ from tracim.views.controllers import Controller
 from pyramid.config import Configurator
 
 from tracim.views import BASE_API_V2
-from tracim.views.core_api.schemas import UserSchema, OkResponse
+from tracim.views.core_api.schemas import UserSchema, NoContentSchema
 from tracim.views.core_api.schemas import LoginOutputHeaders
 from tracim.views.core_api.schemas import BasicAuthSchema
 from tracim.exceptions import NotAuthentificated, LoginFailed
@@ -28,7 +32,10 @@ class SessionController(Controller):
     @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())
+    @hapic.output_body(
+        NoContentSchema(),
+        default_http_code=HTTPStatus.NO_CONTENT
+    )
     def login(self, context, request: TracimRequest, hapic_data=None):
         """
         Logs user into the system
@@ -52,15 +59,19 @@ class SessionController(Controller):
         except NoResultFound:
             # User does not exist
             raise LoginFailed('Bad Credentials')
-        return {'message': 'ok'}
+        return
 
     @hapic.with_api_doc()
-    @hapic.output_body(OkResponse())
+    @hapic.output_body(
+        NoContentSchema(),
+        default_http_code=HTTPStatus.NO_CONTENT
+    )
     def logout(self, context, request: TracimRequest, hapic_data=None):
         """
         Logs out current logged in user session
         """
-        return {'message': 'ok'}
+
+        return
 
     @hapic.with_api_doc()
     @hapic.handle_exception(
@@ -69,7 +80,6 @@ class SessionController(Controller):
     )
     @hapic.output_body(
         UserSchema(),
-        default_http_code=HTTPStatus.OK,
     )
     def whoami(self, context, request: TracimRequest, hapic_data=None):
         """
@@ -88,7 +98,6 @@ class SessionController(Controller):
         configurator.add_view(
             self.login,
             route_name='login',
-            renderer='json'
         )
         # Logout
         configurator.add_route(
@@ -100,7 +109,6 @@ class SessionController(Controller):
         configurator.add_view(
             self.logout,
             route_name='logout',
-            renderer='json'
         )
         # Whoami
         configurator.add_route(
@@ -111,5 +119,4 @@ class SessionController(Controller):
         configurator.add_view(
             self.whoami,
             route_name='whoami',
-            renderer='json'
         )