Merge pull request #29 from vulncheck-oss/28-backups-list

Issue #28 - List Backups Endpoint

Author: tcampbPPU

backups.go

@@ -0,0 +1,39 @@
+package sdk
+
+import (
+	"encoding/json"
+	"fmt"
+)
+
+type BackupsMeta struct {
+	Name        string `json:"name"`
+	Description string `json:"description"`
+	Href        string `json:"href"`
+}
+
+type BackupsResponse struct {
+	Benchmark float64       `json:"_benchmark"`
+	Data      []BackupsMeta `json:"data"`
+}
+
+// GetBackups https://docs.vulncheck.com/api/backups
+func (c *Client) GetBackups() (responseJSON *BackupsResponse, err error) {
+
+	resp, err := c.Request("GET", "/v3/backup")
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+	_ = json.NewDecoder(resp.Body).Decode(&responseJSON)
+	return responseJSON, nil
+}
+
+// Strings representation of the response
+func (r BackupsResponse) String() string {
+	return fmt.Sprintf("Benchmark: %v\nData: %v\n", r.Benchmark, r.Data)
+}
+
+// GetData - Returns the data from the response
+func (r BackupsResponse) GetData() []BackupsMeta {
+	return r.Data
+}

backups_test.go

@@ -0,0 +1,57 @@
+package sdk
+
+import (
+	"encoding/json"
+	"fmt"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGetBackups(t *testing.T) {
+	req := httptest.NewRequest("GET", "/backup", nil)
+	w := httptest.NewRecorder()
+
+	mockJson := `{"_benchmark":0.02508,"data":[{"name":"a10","description":"A10 Networks Security Advisories","href":"https://api.vulncheck.com/v3/index/a10"}]}`
+
+	handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprintln(w, mockJson)
+	})
+
+	handler.ServeHTTP(w, req)
+
+	resp := w.Result()
+
+	assert.Equal(t, 200, resp.StatusCode)
+
+	body, _ := io.ReadAll(resp.Body)
+
+	var backupResp BackupsResponse
+	err := json.Unmarshal(body, &backupResp)
+	if err != nil {
+		t.Error("error unmarshalling response")
+	}
+
+	t.Run("indexes response is parsed", func(t *testing.T) {
+		assert.Equal(t, "a10", backupResp.Data[0].Name)
+	})
+}
+
+// LIVE TESTS - these tests require a valid token to run
+// func TestGetBackupsLive(t *testing.T) {
+// 	t.Run("GetBackups", func(t *testing.T) {
+// 		client := Connect("", "")
+
+// 		data, err := client.GetBackups()
+// 		if err != nil {
+// 			t.Errorf("Error: %v", err)
+// 		}
+
+// 		if data == nil {
+// 			t.Errorf("Expected a string, got %v", data)
+// 		}
+// 	})
+// }