Add methods for interacting with org preferences API (and a small bug fix) (#102)

* add additional fields to type Preferences

Signed-off-by: Mike Ball <[email protected]>

* move preferences types to their own file

Signed-off-by: Mike Ball <[email protected]>

* add methods for interacting with org prefs API

Signed-off-by: Mike Ball <[email protected]>

* remove TODO comment from Preferences

Signed-off-by: Mike Ball <[email protected]>

* Update org_preferences.go

Co-authored-by: Leandro López <[email protected]>

Signed-off-by: Mike Ball <[email protected]>
Co-authored-by: Leandro López <[email protected]>

Author: mdb

org_preferences.go

@@ -0,0 +1,51 @@
+package gapi
+
+import (
+	"bytes"
+	"encoding/json"
+)
+
+// UpdateOrgPreferencesResponse represents the response to a request
+// updating Grafana org preferences.
+type UpdateOrgPreferencesResponse struct {
+	Message string `json:"message"`
+}
+
+// OrgPreferences fetches org preferences.
+func (c *Client) OrgPreferences() (Preferences, error) {
+	var prefs Preferences
+	err := c.request("GET", "/api/org/preferences", nil, nil, &prefs)
+	return prefs, err
+}
+
+// UpdateOrgPreferences updates only those org preferences specified in the passed Preferences, without impacting others.
+func (c *Client) UpdateOrgPreferences(p Preferences) (UpdateOrgPreferencesResponse, error) {
+	var resp UpdateOrgPreferencesResponse
+	data, err := json.Marshal(p)
+	if err != nil {
+		return resp, err
+	}
+
+	err = c.request("PATCH", "/api/org/preferences", nil, bytes.NewBuffer(data), &resp)
+	if err != nil {
+		return resp, err
+	}
+
+	return resp, err
+}
+
+// UpdateAllOrgPreferences overrwrites all org preferences with the passed Preferences.
+func (c *Client) UpdateAllOrgPreferences(p Preferences) (UpdateOrgPreferencesResponse, error) {
+	var resp UpdateOrgPreferencesResponse
+	data, err := json.Marshal(p)
+	if err != nil {
+		return resp, err
+	}
+
+	err = c.request("PUT", "/api/org/preferences", nil, bytes.NewBuffer(data), &resp)
+	if err != nil {
+		return resp, err
+	}
+
+	return resp, err
+}

org_preferences_test.go

@@ -0,0 +1,59 @@
+package gapi
+
+import (
+	"testing"
+)
+
+const (
+	getOrgPreferencesJSON    = `{"theme": "foo","homeDashboardId": 0,"timezone": "","weekStart": "","navbar": {"savedItems": null},"queryHistory": {"homeTab": ""}}`
+	updateOrgPreferencesJSON = `{"message":"Preferences updated"}`
+)
+
+func TestOrgPreferences(t *testing.T) {
+	server, client := gapiTestTools(t, 200, getOrgPreferencesJSON)
+	defer server.Close()
+
+	resp, err := client.OrgPreferences()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	expected := "foo"
+	if resp.Theme != expected {
+		t.Errorf("Expected org preferences theme '%s'; got '%s'", expected, resp.Theme)
+	}
+}
+
+func TestUpdateOrgPreferences(t *testing.T) {
+	server, client := gapiTestTools(t, 200, updateOrgPreferencesJSON)
+	defer server.Close()
+
+	resp, err := client.UpdateOrgPreferences(Preferences{
+		Theme: "foo",
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	expected := "Preferences updated"
+	if resp.Message != expected {
+		t.Errorf("Expected org preferences message '%s'; got '%s'", expected, resp.Message)
+	}
+}
+
+func TestUpdateAllOrgPreference(t *testing.T) {
+	server, client := gapiTestTools(t, 200, updateOrgPreferencesJSON)
+	defer server.Close()
+
+	resp, err := client.UpdateAllOrgPreferences(Preferences{
+		Theme: "foo",
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	expected := "Preferences updated"
+	if resp.Message != expected {
+		t.Errorf("Expected org preferences message '%s'; got '%s'", expected, resp.Message)
+	}
+}

preferences.go

@@ -0,0 +1,31 @@
+package gapi
+
+// NavLink represents a Grafana nav link.
+type NavLink struct {
+	ID     string `json:"id,omitempty"`
+	Text   string `json:"text,omitempty"`
+	URL    string `json:"url,omitempty"`
+	Target string `json:"target,omitempty"`
+}
+
+// NavbarPreference represents a Grafana navbar preference.
+type NavbarPreference struct {
+	SavedItems []NavLink `json:"savedItems"`
+}
+
+// QueryHistoryPreference represents a Grafana query history preference.
+type QueryHistoryPreference struct {
+	HomeTab string `json:"homeTab"`
+}
+
+// Preferences represents Grafana preferences.
+type Preferences struct {
+	Theme            string                 `json:"theme"`
+	HomeDashboardID  int64                  `json:"homeDashboardId"`
+	HomeDashboardUID string                 `json:"homeDashboardUID,omitempty"`
+	Timezone         string                 `json:"timezone,omitempty"`
+	WeekStart        string                 `json:"weekStart,omitempty"`
+	Locale           string                 `json:"locale,omitempty"`
+	Navbar           NavbarPreference       `json:"navbar,omitempty"`
+	QueryHistory     QueryHistoryPreference `json:"queryHistory,omitempty"`
+}

team.go

@@ -38,13 +38,6 @@ type TeamMember struct {
 	Permission int64  `json:"permission,omitempty"`
 }
 
-// Preferences represents Grafana preferences.
-type Preferences struct {
-	Theme           string `json:"theme"`
-	HomeDashboardID int64  `json:"homeDashboardID"`
-	Timezone        string `json:"timezone"`
-}
-
 // SearchTeam searches Grafana teams and returns the results.
 func (c *Client) SearchTeam(query string) (*SearchTeam, error) {
 	var result SearchTeam