Merge pull request #25 from tracim/feature/734_add_lang_to_user

backend/tracim_backend/lib/core/user.py

             email: str=None,
             password: str=None,
             timezone: str=None,
+            lang: str=None,
             groups: typing.Optional[typing.List[Group]]=None,
             do_save=True,
     ) -> User:
         if timezone is not None:
             user.timezone = timezone
 
+        if lang is not None:
+            user.lang = lang
+
         if groups is not None:
             # INFO - G.M - 2018-07-18 - Delete old groups
             for group in user.groups:
         password: str = None,
         name: str = None,
         timezone: str = '',
+        lang: str= None,
         groups=[],
         do_save: bool=True,
         do_notify: bool=True,
             email=email,
             password=password,
             timezone=timezone,
+            lang=lang,
             do_save=False,
         )
         if do_notify:

backend/tracim_backend/migration/versions/a143b60aad61_add_lang_to_user.py

+"""add lang to user
+
+Revision ID: a143b60aad61
+Revises: 78b52ca39419
+Create Date: 2018-08-20 10:17:14.859250
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = 'a143b60aad61'
+down_revision = '78b52ca39419'
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('users', sa.Column('lang', sa.Unicode(length=3), nullable=True))  # nopep8
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('users', 'lang')
+    # ### end Alembic commands ###

backend/tracim_backend/models/auth.py

     is_active = Column(Boolean, default=True, nullable=False)
     is_deleted = Column(Boolean, default=False, nullable=False, server_default=sqlalchemy.sql.expression.literal(False))
     imported_from = Column(Unicode(32), nullable=True)
+    # timezone as tz database format
     timezone = Column(Unicode(255), nullable=False, server_default='')
+    # lang in iso639 format
+    lang = Column(Unicode(3), nullable=True, default=None)
     # TODO - G.M - 04-04-2018 - [auth] Check if this is already needed
     # with new auth system
     auth_token = Column(Unicode(255))

backend/tracim_backend/models/context_models.py

     """
     Just some user infos
     """
-    def __init__(self, timezone: str, public_name: str) -> None:
+    def __init__(self, timezone: str, public_name: str, lang: str) -> None:
         self.timezone = timezone
         self.public_name = public_name
+        self.lang = lang
 
 
 class UserProfile(object):
             public_name: str = None,
             timezone: str = None,
             profile: str = None,
+            lang: str = None,
             email_notification: bool = True,
     ) -> None:
         self.email = email
         self.password = password or password_generator()
         self.public_name = public_name or None
         self.timezone = timezone or ''
+        self.lang = lang or None
         self.profile = profile or Group.TIM_USER_GROUPNAME
         self.email_notification = email_notification
 
         return self.user.timezone
 
     @property
+    def lang(self) -> str:
+        return self.user.lang
+
+    @property
     def profile(self) -> Profile:
         return self.user.profile.name
 

backend/tracim_backend/tests/functional/test_session.py

         assert res.json_body['profile'] == 'administrators'
         assert res.json_body['caldav_url'] is None
         assert res.json_body['avatar_url'] is None
+        assert res.json_body['lang'] is None
 
     def test_api__try_whoami_enpoint__err_401__user_is_not_active(self):
         dbsession = get_tm_session(self.session_factory, transaction.manager)
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='en',
             do_save=True,
             do_notify=False,
         )

backend/tracim_backend/tests/functional/test_user.py

             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
         assert res['public_name'] == 'bob'
         assert res['timezone'] == 'Europe/Paris'
         assert res['is_deleted'] is False
+        assert res['lang'] == 'fr'
 
     def test_api__get_user__ok_200__user_itself(self):
         dbsession = get_tm_session(self.session_factory, transaction.manager)
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob2',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             'password': 'mysuperpassword',
             'profile': 'users',
             'timezone': 'Europe/Paris',
+            'lang': 'fr',
             'public_name': 'test user',
             'email_notification': False,
         }
         assert res['email'] == 'test@test.test'
         assert res['public_name'] == 'test user'
         assert res['timezone'] == 'Europe/Paris'
-
+        assert res['lang'] == 'fr'
         dbsession = get_tm_session(self.session_factory, transaction.manager)
         admin = dbsession.query(models.User) \
             .filter(models.User.email == 'admin@admin.admin') \
         assert res['email'] == 'test@test.test'
         assert res['public_name'] == 'test'
         assert res['timezone'] == ''
+        assert res['lang'] is None
 
         dbsession = get_tm_session(self.session_factory, transaction.manager)
         admin = dbsession.query(models.User) \
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             'password': 'mysuperpassword',
             'profile': 'users',
             'timezone': 'Europe/Paris',
+            'lang': 'fr',
             'public_name': 'test user',
             'email_notification': False,
         }
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             'profile': 'users',
             'timezone': 'Europe/Paris',
             'public_name': 'test user',
+            'lang': 'fr',
             'email_notification': False,
         }
         res = self.testapp.post_json(
             'profile': 'users',
             'timezone': 'Europe/Paris',
             'public_name': 'test user',
+            'lang': 'fr',
             'email_notification': True,
         }
         res = self.testapp.post_json(
         assert res['email'] == 'test@test.test'
         assert res['public_name'] == 'test user'
         assert res['timezone'] == 'Europe/Paris'
+        assert res['lang'] == 'fr'
 
         dbsession = get_tm_session(self.session_factory, transaction.manager)
         admin = dbsession.query(models.User) \
         assert res['email'] == 'test@test.test'
         assert res['public_name'] == 'test'
         assert res['timezone'] == ''
+        assert res['lang'] == None
 
         dbsession = get_tm_session(self.session_factory, transaction.manager)
         admin = dbsession.query(models.User) \
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob2',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob2',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob2',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob2',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob3',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob2',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             password='pass',
             name='bob',
             groups=groups,
+            lang='fr',
             timezone='Europe/Paris',
             do_save=True,
             do_notify=False,
             name='bob2',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
         assert res['user_id'] == user_id
         assert res['public_name'] == 'bob'
         assert res['timezone'] == 'Europe/Paris'
+        assert res['lang'] == 'fr'
         # Set params
         params = {
             'public_name': 'updated',
             'timezone': 'Europe/London',
+            'lang': 'en',
         }
         self.testapp.put_json(
             '/api/v2/users/{}'.format(user_id),
         assert res['user_id'] == user_id
         assert res['public_name'] == 'updated'
         assert res['timezone'] == 'Europe/London'
+        assert res['lang'] == 'en'
 
     def test_api__set_user_info__ok_200__user_itself(self):
         dbsession = get_tm_session(self.session_factory, transaction.manager)
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
         assert res['user_id'] == user_id
         assert res['public_name'] == 'bob'
         assert res['timezone'] == 'Europe/Paris'
+        assert res['lang'] == 'fr'
         # Set params
         params = {
             'public_name': 'updated',
             'timezone': 'Europe/London',
+            'lang' : 'en',
         }
         self.testapp.put_json(
             '/api/v2/users/{}'.format(user_id),
         assert res['user_id'] == user_id
         assert res['public_name'] == 'updated'
         assert res['timezone'] == 'Europe/London'
+        assert res['lang'] == 'en'
 
     def test_api__set_user_email__err_403__other_normal_user(self):
         dbsession = get_tm_session(self.session_factory, transaction.manager)
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='test',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
         params = {
             'public_name': 'updated',
             'timezone': 'Europe/London',
+            'lang': 'en'
         }
         self.testapp.put_json(
             '/api/v2/users/{}'.format(user_id),
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='test',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='test2',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='test2',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )
             name='bob',
             groups=groups,
             timezone='Europe/Paris',
+            lang='fr',
             do_save=True,
             do_notify=False,
         )

backend/tracim_backend/tests/library/test_user_api.py

             password='pass',
             name='bob',
             timezone='+2',
+            lang='en',
             do_save=True,
             do_notify=False,
         )
         assert u.validate_password('pass')
         assert u.display_name == 'bob'
         assert u.timezone == '+2'
+        assert u.lang == 'en'
 
     def test_unit__user_with_email_exists__ok__nominal_case(self):
         api = UserApi(

backend/tracim_backend/views/core_api/schemas.py

     )
     # TODO - G.M - 17-04-2018 - Restrict timezone values
     timezone = marshmallow.fields.String(
+        description="Timezone as tz database format",
         example="Europe/Paris",
     )
     # TODO - G.M - 17-04-2018 - check this, relative url allowed ?
         validate=OneOf(Profile._NAME),
         example='managers',
     )
+    lang = marshmallow.fields.String(
+        description="User langage in iso639 format",
+        example='en',
+        required=False,
+        validate=Length(min=2, max=3),
+        allow_none=True,
+        default=None,
+    )
 
     class Meta:
         description = 'User account of Tracim'
 
 class UserInfosSchema(marshmallow.Schema):
     timezone = marshmallow.fields.String(
+        description="Timezone as tz database format",
         example="Europe/Paris",
         required=True,
     )
         example='Suri Cate',
         required=True,
     )
+    lang = marshmallow.fields.String(
+        description="User langage in iso639 format",
+        example='en',
+        required=True,
+        validate=Length(min=2, max=3),
+        allow_none=True,
+        default=None,
+    )
 
     @post_load
     def create_user_info_object(self, data):
         default=Group.TIM_USER_GROUPNAME
     )
     timezone = marshmallow.fields.String(
+        description="Timezone as tz database format",
         example="Europe/Paris",
         required=False,
         default=''
         required=False,
         default=None,
     )
+    lang = marshmallow.fields.String(
+        description="User langage in iso639 format",
+        example='en',
+        required=False,
+        validate=Length(min=2, max=3),
+        allow_none=True,
+        default=None,
+    )
     email_notification = marshmallow.fields.Bool(
         example=True,
         required=False,

backend/tracim_backend/views/core_api/user_controller.py

             request.candidate_user,
             name=hapic_data.body.public_name,
             timezone=hapic_data.body.timezone,
+            lang=hapic_data.body.lang,
             do_save=True
         )
         return uapi.get_user_with_context(user)
             email=hapic_data.body.email,
             password=hapic_data.body.password,
             timezone=hapic_data.body.timezone,
+            lang=hapic_data.body.lang,
             name=hapic_data.body.public_name,
             do_notify=hapic_data.body.email_notification,
             groups=groups,