better userlib with get_user_with_context method

tracim/lib/core/user.py

@@ -21,68 +21,44 @@ class UserApi(object):
     def _base_query(self):
         return self._session.query(User)
 
-    def _get_correct_user_type(
-            self,
-            user: User,
-            in_context: bool,
-    ) -> typing.Union[User, UserInContext]:
+    def get_user_with_context(self, user: User) -> UserInContext:
         """
-        Choose user type object depending on in_context bool.
-        :param user:
-        :param in_context:
-        :return: user as User or UserInContext if in_context is True
+        Return UserInContext object from User
         """
-        if in_context:
-            user = UserInContext(
-                user=user,
-                dbsession=self._session,
-                config=self._config,
-            )
+        user = UserInContext(
+            user=user,
+            dbsession=self._session,
+            config=self._config,
+        )
         return user
 
     # Getters
 
-    def get_one(
-            self,
-            user_id: int,
-            in_context: bool=False,
-    ) -> typing.Union[UserInContext, User]:
+    def get_one(self, user_id: int) -> User:
         """
         Get one user by user id
-        :param user_id:
-        :param in_context: Return User or UserInContext Object
-        :return: one user
         """
-        user = self._base_query().filter(User.user_id == user_id).one()
-        return self._get_correct_user_type(user, in_context)
+        return self._base_query().filter(User.user_id == user_id).one()
 
-    def get_one_by_email(
-            self,
-            email: str,
-            in_context: bool=False,
-    ) -> User:
+    def get_one_by_email(self, email: str) -> User:
         """
         Get one user by email
         :param email: Email of the user
-        :param in_context: Return User or UserInContext Object
         :return: one user
         """
-        user = self._base_query().filter(User.email == email).one()
-        return self._get_correct_user_type(user, in_context)
+        return self._base_query().filter(User.email == email).one()
 
     # FIXME - G.M - 24-04-2018 - Duplicate method with get_one.
-    def get_one_by_id(self, id: int, in_context=False) -> User:
-        return self.get_one(user_id=id, in_context=in_context)
+    def get_one_by_id(self, id: int) -> User:
+        return self.get_one(user_id=id)
 
-    def get_current(self, in_context: bool=False):
+    def get_current_user(self) -> User:
         """
         Get current_user
-        :param in_context:
-        :return:
         """
         if not self._user:
             raise UserNotExist()
-        return self._get_correct_user_type(self._user, in_context)
+        return self._user
 
     def get_all(self) -> typing.Iterable[User]:
         return self._session.query(User).order_by(User.display_name).all()
@@ -97,23 +73,18 @@ class UserApi(object):
         except:
             return False
 
-    def authenticate_user(self,
-                          email: str,
-                          password: str,
-                          in_context=False
-        ) -> typing.Union[User, UserInContext]:
+    def authenticate_user(self, email: str, password: str) -> User:
         """
         Authenticate user with email and password, raise AuthenticationFailed
         if uncorrect.
         :param email: email of the user
         :param password: cleartext password of the user
-        :param in_context:
         :return: User who was authenticated.
         """
         try:
             user = self.get_one_by_email(email)
             if user.validate_password(password):
-                return self._get_correct_user_type(user, in_context=in_context)
+                return user
             else:
                 raise BadUserPassword()
         except (BadUserPassword, NoResultFound):

tracim/tests/library/test_user_api.py

@@ -86,46 +86,36 @@ class TestUserApi(DefaultTest):
         one = api.get_one(u.user_id)
         eq_(u.user_id, one.user_id)
 
-    def test_unit__get_correct_user_type__ok__no_context(self):
+    def test_unit__get_user_with_context__nominal_case(self):
         user = User(email='admin@tracim.tracim')
         api = UserApi(
             current_user=None,
             session=self.session,
             config=self.config,
         )
-        new_user = api._get_correct_user_type(user, in_context=False)
-        assert isinstance(new_user, User)
-        assert user == new_user
-
-    def test_unit__get_correct_user_type__ok__with_context(self):
-        user = User(email='admin@tracim.tracim')
-        api = UserApi(
-            current_user=None,
-            session=self.session,
-            config=self.config,
-        )
-        new_user = api._get_correct_user_type(user, in_context=True)
+        new_user = api.get_user_with_context(user)
         assert isinstance(new_user, UserInContext)
-        assert user != new_user
         assert new_user.user == user
 
-    def test_unit__get_current__ok__nominal_case(self):
+    def test_unit__get_current_user_ok__nominal_case(self):
         user = User(email='admin@tracim.tracim')
         api = UserApi(
             current_user=user,
             session=self.session,
             config=self.config,
         )
-        assert api.get_current().email == 'admin@tracim.tracim'
+        new_user = api.get_current_user()
+        assert isinstance(new_user, User)
+        assert user == new_user
 
-    def test_unit__get_current__err__user_not_exist(self):
+    def test_unit__get_current_user__err__user_not_exist(self):
         api = UserApi(
             current_user=None,
             session=self.session,
             config=self.config,
         )
         with pytest.raises(UserNotExist):
-            api.get_current()
+            api.get_current_user()
 
     def test_unit__authenticate_user___ok__nominal_case(self):
         api = UserApi(

tracim/views/core_api/session_controller.py

@@ -62,7 +62,8 @@ class SessionController(Controller):
             session=request.dbsession,
             config=app_config,
         )
-        return uapi.get_current(in_context=True)
+        user = uapi.get_current_user()  # User
+        return uapi.get_user_with_context(user)
 
     def bind(self, configurator: Configurator):