Merge pull request #875 from python-gitlab/feat/status-api

max-wittig · web-flow · commit b7f33429c75e · 2019-09-05T09:00:56.000+02:00
feat(user): add status api
diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst
@@ -250,6 +250,43 @@ Delete an SSH key for a user::
     # or
     key.delete()
 
+Status
+======
+
+References
+----------
+
+You can manipulate the status for the current user and you can read the status of other users.
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.CurrentUserStatus`
+  + :class:`gitlab.v4.objects.CurrentUserStatusManager`
+  + :attr:`gitlab.v4.objects.CurrentUser.status`
+  + :class:`gitlab.v4.objects.UserStatus`
+  + :class:`gitlab.v4.objects.UserStatusManager`
+  + :attr:`gitlab.v4.objects.User.status`
+
+* GitLab API: https://docs.gitlab.com/ce/api/users.html#user-status
+
+Examples
+--------
+
+Get current user status::
+
+    status = user.status.get()
+
+Update the status for the current user::
+
+    status = user.status.get()
+    status.message = "message"
+    status.emoji = "thumbsup"
+    status.save()
+
+Get the status of other users::
+
+    gl.users.get(1).status.get()
+
 Emails
 ======
 
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
@@ -128,6 +128,17 @@ class UserActivities(RESTObject):
     _id_attr = "username"
 
 
+class UserStatus(RESTObject):
+    _id_attr = None
+    _short_print_attr = "message"
+
+
+class UserStatusManager(GetWithoutIdMixin, RESTManager):
+    _path = "/users/%(user_id)s/status"
+    _obj_cls = UserStatus
+    _from_parent_attrs = {"user_id": "id"}
+
+
 class UserActivitiesManager(ListMixin, RESTManager):
     _path = "/user/activities"
     _obj_cls = UserActivities
@@ -186,6 +197,16 @@ class UserKeyManager(ListMixin, CreateMixin, DeleteMixin, RESTManager):
     _create_attrs = (("title", "key"), tuple())
 
 
+class UserStatus(RESTObject):
+    pass
+
+
+class UserStatusManager(GetWithoutIdMixin, RESTManager):
+    _path = "/users/%(user_id)s/status"
+    _obj_cls = UserStatus
+    _from_parent_attrs = {"user_id": "id"}
+
+
 class UserImpersonationToken(ObjectDeleteMixin, RESTObject):
     pass
 
@@ -272,6 +293,7 @@ class User(SaveMixin, ObjectDeleteMixin, RESTObject):
         ("impersonationtokens", "UserImpersonationTokenManager"),
         ("keys", "UserKeyManager"),
         ("projects", "UserProjectManager"),
+        ("status", "UserStatusManager"),
     )
 
     @cli.register_custom_action("User")
@@ -330,6 +352,7 @@ class UserManager(CRUDMixin, RESTManager):
         "external",
         "search",
         "custom_attributes",
+        "status",
     )
     _create_attrs = (
         tuple(),
@@ -410,10 +433,22 @@ class CurrentUserKeyManager(RetrieveMixin, CreateMixin, DeleteMixin, RESTManager
     _create_attrs = (("title", "key"), tuple())
 
 
+class CurrentUserStatus(SaveMixin, RESTObject):
+    _id_attr = None
+    _short_print_attr = "message"
+
+
+class CurrentUserStatusManager(GetWithoutIdMixin, UpdateMixin, RESTManager):
+    _path = "/user/status"
+    _obj_cls = CurrentUserStatus
+    _update_attrs = (tuple(), ("emoji", "message"))
+
+
 class CurrentUser(RESTObject):
     _id_attr = None
     _short_print_attr = "username"
     _managers = (
+        ("status", "CurrentUserStatusManager"),
         ("emails", "CurrentUserEmailManager"),
         ("gpgkeys", "CurrentUserGPGKeyManager"),
         ("keys", "CurrentUserKeyManager"),
diff --git a/tools/python_test_v4.py b/tools/python_test_v4.py
@@ -911,3 +911,14 @@
 release_test_project.releases.delete(release_tag_name)
 assert len(release_test_project.releases.list()) == 0
 release_test_project.delete()
+
+# status
+message = "Test"
+emoji = "thumbsup"
+status = gl.user.status.get()
+status.message = message
+status.emoji = emoji
+status.save()
+new_status = gl.user.status.get()
+assert new_status.message == message
+assert new_status.emoji == emoji
