Add support for "User preferences", based on PersonalPreferences model

Author: amotl

grafana_client/elements/user.py

@@ -1,3 +1,4 @@
+from ..model import PersonalPreferences
 from .base import Base
 
 
@@ -172,3 +173,54 @@ def unstar_actual_user_dashboard(self, dashboard_id):
         unstar_dashboard = "/user/stars/dashboard/%s" % dashboard_id
         r = self.client.DELETE(unstar_dashboard)
         return r
+
+    def get_preferences(self):
+        """
+        Retrieve preferences of current user.
+
+        :return:
+        """
+        update_preference = "/user/preferences"
+        r = self.client.GET(update_preference)
+        return r
+
+    def update_preferences(self, preferences: PersonalPreferences):
+        """
+        Update preferences of current user as a whole.
+
+        From the `preferences` instance, only attributes with values `not None` will be submitted.
+        However, Grafana will reset all undefined attributes to its internal defaults.
+
+        If you want to update specific preference attributes, without touching the others,
+        please use the `patch_preferences` method.
+
+        :param preferences:
+        :return:
+        """
+        update_preference = "/user/preferences"
+        data = preferences.asdict(filter_none=True)
+
+        r = self.client.PUT(
+            update_preference,
+            json=data,
+        )
+        return r
+
+    def patch_preferences(self, preferences: PersonalPreferences):
+        """
+        Update specific preferences of current user.
+
+        From the `preferences` instance, only attributes with values `not None` will be submitted
+        and updated.
+
+        :param preferences:
+        :return:
+        """
+        update_preference = "/user/preferences"
+        data = preferences.asdict(filter_none=True)
+
+        r = self.client.PATCH(
+            update_preference,
+            json=data,
+        )
+        return r

test/elements/test_user.py

@@ -3,6 +3,7 @@
 import requests_mock
 
 from grafana_client import GrafanaApi
+from grafana_client.model import PersonalPreferences
 
 
 class UsersTestCase(unittest.TestCase):
@@ -169,3 +170,24 @@ def test_unstar_actual_user_dashboard(self, m):
         )
         result = self.grafana.user.unstar_actual_user_dashboard("987vb7t33")
         self.assertEqual(result, {})
+
+    @requests_mock.Mocker()
+    def test_get_preferences(self, m):
+        m.get("http://localhost/api/user/preferences", json={"theme": "", "homeDashboardId": 0, "timezone": ""})
+
+        result = self.grafana.user.get_preferences()
+        self.assertEqual(result["homeDashboardId"], 0)
+
+    @requests_mock.Mocker()
+    def test_update_preferences(self, m):
+        m.put("http://localhost/api/user/preferences", json={"message": "Preferences updated"})
+        preference = self.grafana.user.update_preferences(
+            PersonalPreferences(theme="", homeDashboardId=999, timezone="utc")
+        )
+        self.assertEqual(preference["message"], "Preferences updated")
+
+    @requests_mock.Mocker()
+    def test_patch_preferences(self, m):
+        m.patch("http://localhost/api/user/preferences", json={"message": "Preferences updated"})
+        preference = self.grafana.user.patch_preferences(PersonalPreferences(homeDashboardUID="zgjG8dKVz"))
+        self.assertEqual(preference["message"], "Preferences updated")