Merge pull request #39 from baloo/baloo/api-keys

Add support for calling API Key endpoints. Take 2

Author: julienduchesne

api_key.go

@@ -0,0 +1,67 @@
+package gapi
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"net/url"
+	"strconv"
+	"time"
+)
+
+type CreateAPIKeyRequest struct {
+	Name          string `json:"name"`
+	Role          string `json:"role"`
+	SecondsToLive int64  `json:"secondsToLive,omitempty"`
+}
+
+type CreateAPIKeyResponse struct {
+	// ID field only returned after Grafana v7.
+	ID   int64  `json:"id,omitempty"`
+	Name string `json:"name"`
+	Key  string `json:"key"`
+}
+
+type GetAPIKeysResponse struct {
+	ID         int64     `json:"id"`
+	Name       string    `json:"name"`
+	Role       string    `json:"role"`
+	Expiration time.Time `json:"expiration,omitempty"`
+}
+
+type DeleteAPIKeyResponse struct {
+	Message string `json:"message"`
+}
+
+// CreateAPIKey creates a new Grafana API key.
+func (c *Client) CreateAPIKey(request CreateAPIKeyRequest) (CreateAPIKeyResponse, error) {
+	response := CreateAPIKeyResponse{}
+
+	data, err := json.Marshal(request)
+	if err != nil {
+		return response, err
+	}
+
+	err = c.request("POST", "/api/auth/keys", nil, bytes.NewBuffer(data), &response)
+	return response, err
+}
+
+// GetAPIKeys retrieves a list of all API keys.
+func (c *Client) GetAPIKeys(includeExpired bool) ([]*GetAPIKeysResponse, error) {
+	response := make([]*GetAPIKeysResponse, 0)
+
+	query := url.Values{}
+	query.Add("includeExpired", strconv.FormatBool(includeExpired))
+
+	err := c.request("GET", "/api/auth/keys", query, nil, &response)
+	return response, err
+}
+
+// DeleteAPIKey deletes the Grafana API key with the specified ID.
+func (c *Client) DeleteAPIKey(id int64) (DeleteAPIKeyResponse, error) {
+	response := DeleteAPIKeyResponse{}
+
+	path := fmt.Sprintf("/api/auth/keys/%d", id)
+	err := c.request("DELETE", path, nil, nil, &response)
+	return response, err
+}

api_key_test.go

@@ -0,0 +1,68 @@
+package gapi
+
+import (
+	"testing"
+
+	"github.com/gobs/pretty"
+)
+
+const (
+	createAPIKeyJSON = `{"name":"key-name", "key":"mock-api-key"}`
+	deleteAPIKeyJSON = `{"message":"API key deleted"}`
+
+	getAPIKeysJSON = `[
+		{
+			"id": 1,
+			"name": "key-name-2",
+			"role": "Viewer"
+		},
+		{
+			"id": 2,
+			"name": "key-name-2",
+			"role": "Admin",
+			"expiration": "2021-10-30T10:52:03+03:00"
+		}
+	]`
+)
+
+func TestCreateAPIKey(t *testing.T) {
+	server, client := gapiTestTools(t, 200, createAPIKeyJSON)
+	defer server.Close()
+
+	req := CreateAPIKeyRequest{
+		Name:          "key-name",
+		Role:          "Viewer",
+		SecondsToLive: 0,
+	}
+
+	res, err := client.CreateAPIKey(req)
+	if err != nil {
+		t.Error(err)
+	}
+
+	t.Log(pretty.PrettyFormat(res))
+}
+
+func TestDeleteAPIKey(t *testing.T) {
+	server, client := gapiTestTools(t, 200, deleteAPIKeyJSON)
+	defer server.Close()
+
+	res, err := client.DeleteAPIKey(int64(1))
+	if err != nil {
+		t.Error(err)
+	}
+
+	t.Log(pretty.PrettyFormat(res))
+}
+
+func TestGetAPIKeys(t *testing.T) {
+	server, client := gapiTestTools(t, 200, getAPIKeysJSON)
+	defer server.Close()
+
+	res, err := client.GetAPIKeys(true)
+	if err != nil {
+		t.Error(err)
+	}
+
+	t.Log(pretty.PrettyFormat(res))
+}