Merge pull request #28 from Molaryy/feat(billing)/add-billing-route

feat(invoices): add billing invoices in client handler

Author: olegy89

pkg/fixtures/invoices/get_response.json

@@ -0,0 +1,12 @@
+{
+    "id": "9qzw9Hj4",
+    "number": 843071,
+    "parent_id": null,
+    "status": "paid",
+    "date": "2024-06-23",
+    "type": "invoice",
+    "total_due": 11.90,
+    "currency": "EUR",
+    "csv_url": "url",
+    "pdf_url": "url"
+}

pkg/invoices.go

@@ -0,0 +1,53 @@
+package serverscom
+
+import (
+	"context"
+	"encoding/json"
+)
+
+const (
+	invoicesListPath = "/billing/invoices"
+
+	InvoicePath = "/billing/invoices/%s"
+)
+
+// BilligService is an interface for interfacing with Billing Invoices endpoints
+// API documentation:
+// https://developers.servers.com/api-documentation/v1/#tag/Invoice
+type InvoiceService interface {
+	// Primary collection
+	Collection() Collection[InvoiceList]
+
+	// Generic operations
+	GetBillingInvoice(ctx context.Context, id string) (*Invoice, error)
+}
+
+// InvoiceHandler handles operations around hosts
+type InvoiceHandler struct {
+	client *Client
+}
+
+// Collection builds a new Collection[InvoiceList] interface
+func (h *InvoiceHandler) Collection() Collection[InvoiceList] {
+	return NewCollection[InvoiceList](h.client, invoicesListPath)
+}
+
+// GetBillingInvoice returns an invoice
+// Endpoint: https://developers.servers.com/api-documentation/v1/#tag/Invoice/operation/GetAnInvoice
+func (h *InvoiceHandler) GetBillingInvoice(ctx context.Context, id string) (*Invoice, error) {
+	url := h.client.buildURL(InvoicePath, []interface{}{id}...)
+
+	body, err := h.client.buildAndExecRequest(ctx, "GET", url, nil)
+
+	if err != nil {
+		return nil, err
+	}
+
+	invoice := new(Invoice)
+
+	if err := json.Unmarshal(body, &invoice); err != nil {
+		return nil, err
+	}
+
+	return invoice, nil
+}

pkg/invoices_test.go

@@ -0,0 +1,63 @@
+package serverscom
+
+import (
+	"context"
+	. "github.com/onsi/gomega"
+	"testing"
+)
+
+func TestInvoicesCollection(t *testing.T) {
+	g := NewGomegaWithT(t)
+
+	ts, client := newFakeServer().
+		WithRequestPath("/billing/invoices").
+		WithRequestMethod("GET").
+		WithResponseBodyStubInline(`[]`).
+		WithResponseCode(200).
+		Build()
+
+	defer ts.Close()
+
+	collection := client.Invoices.Collection()
+
+	ctx := context.TODO()
+
+	list, err := collection.List(ctx)
+
+	g.Expect(err).To(BeNil())
+	g.Expect(list).To(BeEmpty())
+	g.Expect(collection.HasNextPage()).To(Equal(false))
+	g.Expect(collection.HasPreviousPage()).To(Equal(false))
+	g.Expect(collection.HasFirstPage()).To(Equal(false))
+	g.Expect(collection.HasLastPage()).To(Equal(false))
+}
+
+func TestGetInvoice(t *testing.T) {
+	g := NewGomegaWithT(t)
+
+	ts, client := newFakeServer().
+		WithRequestPath("/billing/invoices/9qzw9Hj4").
+		WithRequestMethod("GET").
+		WithResponseBodyStubFile("fixtures/invoices/get_response.json").
+		WithResponseCode(200).
+		Build()
+
+	defer ts.Close()
+
+	ctx := context.TODO()
+
+	invoice, err := client.Invoices.GetBillingInvoice(ctx, "9qzw9Hj4")
+
+	g.Expect(err).To(BeNil())
+	g.Expect(invoice).ToNot(BeNil())
+	g.Expect(invoice.ID).To(Equal("9qzw9Hj4"))
+	g.Expect(invoice.Number).To(Equal(int64(843071)))
+	g.Expect(invoice.ParentID).To(BeNil())
+	g.Expect(invoice.Status).To(Equal("paid"))
+	g.Expect(invoice.Date).To(Equal("2024-06-23"))
+	g.Expect(invoice.Type).To(Equal("invoice"))
+	g.Expect(invoice.TotalDue).To(Equal(11.90))
+	g.Expect(invoice.Currency).To(Equal("EUR"))
+	g.Expect(invoice.CsvUrl).To(Equal("url"))
+	g.Expect(invoice.PdfUrl).To(Equal("url"))
+}

pkg/serverscom.go

@@ -40,6 +40,8 @@ type Client struct {
 
 	KubernetesClusters KubernetesClustersService
 
+	Invoices InvoiceService
+
 	client *resty.Client
 }
 
@@ -98,6 +100,7 @@ func (cli *Client) configureResources() {
 	cli.CloudBlockStorageBackups = &CloudBlockStorageBackupsHandler{cli}
 	cli.CloudBlockStorageVolumes = &CloudBlockStorageVolumesHandler{cli}
 	cli.KubernetesClusters = &KubernetesClustersHandler{cli}
+	cli.Invoices = &InvoiceHandler{cli}
 }
 
 func (cli *Client) buildURL(path string, values ...interface{}) string {

pkg/types.go

@@ -976,7 +976,6 @@ type KubernetesCluster struct {
 }
 
 // KubernetesClusterNode represents Kubernetes cluster node
-
 type KubernetesClusterNode struct {
 	ID                 string            `json:"id"`
 	Number             int64             `json:"number"`
@@ -998,3 +997,29 @@ type KubernetesClusterNode struct {
 type KubernetesClusterUpdateInput struct {
 	Labels map[string]string `json:"labels,omitempty"`
 }
+
+// InvoiceList represents invoices list
+type InvoiceList struct {
+	ID       string  `json:"id"`
+	Number   int64   `json:"number"`
+	ParentID *string `json:"parent_id"`
+	Status   string  `json:"status"`
+	Date     string  `json:"date"`
+	Type     string  `json:"type"`
+	TotalDue float64 `json:"total_due"`
+	Currency string  `json:"currency"`
+}
+
+// Invoice represents an invoice
+type Invoice struct {
+	ID       string  `json:"id"`
+	Number   int64   `json:"number"`
+	ParentID *string `json:"parent_id"`
+	Status   string  `json:"status"`
+	Date     string  `json:"date"`
+	Type     string  `json:"type"`
+	TotalDue float64 `json:"total_due"`
+	Currency string  `json:"currency"`
+	CsvUrl   string  `json:"csv_url"`
+	PdfUrl   string  `json:"pdf_url"`
+}