Improve "Organization preferences"

The methods for retrieving and manipulating preferences have been
incorrectly placed within the `organizations` namespace. Now, they are
correctly placed within the `organization` namespace.

Author: amotl

grafana_client/api.py

@@ -66,7 +66,7 @@ def __init__(
         self.folder = Folder(self.client)
         self.health = Health(self.client)
         self.organization = Organization(self.client)
-        self.organizations = Organizations(self.client)
+        self.organizations = Organizations(self.client, self)
         self.search = Search(self.client)
         self.user = User(self.client)
         self.users = Users(self.client)

grafana_client/elements/organization.py

@@ -88,12 +88,63 @@ def delete_user_current_organization(self, user_id):
         r = self.client.DELETE(delete_user_current_organization_path)
         return r
 
+    def get_preferences(self):
+        """
+        Retrieve preferences of current organization.
+
+        :return:
+        """
+        update_preference = "/org/preferences"
+        r = self.client.GET(update_preference)
+        return r
+
+    def update_preferences(self, preferences: PersonalPreferences):
+        """
+        Update preferences of current organization 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 = "/org/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 organization.
+
+        From the `preferences` instance, only attributes with values `not None` will be submitted
+        and updated.
+
+        :param preferences:
+        :return:
+        """
+        update_preference = "/org/preferences"
+        data = preferences.asdict(filter_none=True)
+
+        r = self.client.PATCH(
+            update_preference,
+            json=data,
+        )
+        return r
+
 
 class Organizations(Base):
-    def __init__(self, client):
+    def __init__(self, client, api):
         super(Organizations, self).__init__(client)
         self.client = client
-        self.path = "/users"
+        self.api = api
 
     def update_organization(self, organization_id, organization):
         """
@@ -183,8 +234,8 @@ def organization_preference_get(self):
         """
         :return:
         """
-        warnings.warn("This method is deprecated, please use `get_preferences`", DeprecationWarning)
-        return self.get_preferences()
+        warnings.warn("This method is deprecated, please use `organization.get_preferences`", DeprecationWarning)
+        return self.api.organization.get_preferences()
 
     def organization_preference_update(self, theme="", home_dashboard_id=0, timezone="utc"):
         """
@@ -194,57 +245,6 @@ def organization_preference_update(self, theme="", home_dashboard_id=0, timezone
         :param timezone:
         :return:
         """
-        warnings.warn("This method is deprecated, please use `update_preferences`", DeprecationWarning)
+        warnings.warn("This method is deprecated, please use `organization.update_preferences`", DeprecationWarning)
         preferences = PersonalPreferences(theme=theme, homeDashboardId=home_dashboard_id, timezone=timezone)
-        return self.update_preferences(preferences)
-
-    def get_preferences(self):
-        """
-        Retrieve preferences of current organization.
-
-        :return:
-        """
-        update_preference = "/org/preferences"
-        r = self.client.GET(update_preference)
-        return r
-
-    def update_preferences(self, preferences: PersonalPreferences):
-        """
-        Update preferences of current organization 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 = "/org/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 organization.
-
-        From the `preferences` instance, only attributes with values `not None` will be submitted
-        and updated.
-
-        :param preferences:
-        :return:
-        """
-        update_preference = "/org/preferences"
-        data = preferences.asdict(filter_none=True)
-
-        r = self.client.PATCH(
-            update_preference,
-            json=data,
-        )
-        return r
+        return self.api.organization.update_preferences(preferences)

test/elements/test_organization.py

@@ -35,21 +35,21 @@ def test_organization_preference_update(self, m):
     def test_get_preferences(self, m):
         m.get("http://localhost/api/org/preferences", json={"theme": "", "homeDashboardId": 0, "timezone": ""})
 
-        result = self.grafana.organizations.get_preferences()
+        result = self.grafana.organization.get_preferences()
         self.assertEqual(result["homeDashboardId"], 0)
 
     @requests_mock.Mocker()
     def test_update_preferences(self, m):
         m.put("http://localhost/api/org/preferences", json={"message": "Preferences updated"})
-        preference = self.grafana.organizations.update_preferences(
+        preference = self.grafana.organization.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/org/preferences", json={"message": "Preferences updated"})
-        preference = self.grafana.organizations.patch_preferences(PersonalPreferences(homeDashboardUID="zgjG8dKVz"))
+        preference = self.grafana.organization.patch_preferences(PersonalPreferences(homeDashboardUID="zgjG8dKVz"))
         self.assertEqual(preference["message"], "Preferences updated")
 
     @requests_mock.Mocker()