Add Api to get bill status

Author: AchoArnold

README.md

@@ -30,6 +30,7 @@ import "github.com/NdoleStudio/flutterwave-go"
 - [BILLS](#bills)
     - `POST /bills/`: Create a bill payment
     - `GET /bill-items/{item_code}/validate`: Validate services like DSTV smartcard number, Meter number etc.
+    - `GET /bills/{reference}`: Get the verbose status of a bill payment
 
 ## Usage
 
@@ -101,6 +102,19 @@ if err != nil {
 log.Println(response.Status) // success
 ```
 
+#### Get verbose status of a bill payment
+
+`GET /bills/{reference}`: get the verbose status of a bill purchase
+
+```go
+response, _, err := flutterwaveClient.Bills.GetStatusVerbose(context.Background(), "9300049404444")
+
+if err != nil {
+    log.Fatal(err)
+}
+
+log.Println(response.Status) // success
+```
 
 ## Testing
 

bills_service.go

@@ -57,3 +57,25 @@ func (service *billsService) Validate(ctx context.Context, itemCode string, bill
 
 	return &data, response, nil
 }
+
+// GetStatusVerbose gets the verbose status of a bill payment.
+//
+// API Docs: https://developer.flutterwave.com/reference/get-status-of-a-bill-payment
+func (service *billsService) GetStatusVerbose(ctx context.Context, transactionReference string) (*BillsStatusVerboseResponse, *Response, error) {
+	request, err := service.client.newRequest(ctx, http.MethodGet, "/v3/bills/"+transactionReference, map[string]int{"verbose": 1})
+	if err != nil {
+		return nil, nil, err
+	}
+
+	response, err := service.client.do(request)
+	if err != nil {
+		return nil, response, err
+	}
+
+	var data BillsStatusVerboseResponse
+	if err = json.Unmarshal(*response.Body, &data); err != nil {
+		return nil, response, err
+	}
+
+	return &data, response, nil
+}

bills_service_models.go

@@ -1,5 +1,7 @@
 package flutterwave
 
+import "time"
+
 // BillsCreatePaymentRequest is data needed to creat a payment
 type BillsCreatePaymentRequest struct {
 	Country    string `json:"country"`
@@ -24,6 +26,11 @@ type BillsCreatePaymentResponse struct {
 	} `json:"data"`
 }
 
+// IsSuccessfull determines if the bill payment was successfull
+func (response BillsCreatePaymentResponse) IsSuccessfull() bool {
+	return response.Status == "success" && response.Data.TxRef != ""
+}
+
 // BillsValidateResponse is the response after validating a bill service
 type BillsValidateResponse struct {
 	Status  string `json:"status"`
@@ -42,3 +49,34 @@ type BillsValidateResponse struct {
 		Minimum         int         `json:"minimum"`
 	} `json:"data"`
 }
+
+// IsSuccessfull determines if the bill validation was successfull
+func (response BillsValidateResponse) IsSuccessfull() bool {
+	return response.Status == "success" && response.Data.Customer != ""
+}
+
+// BillsStatusVerboseResponse is the verbose response of a bill payment
+type BillsStatusVerboseResponse struct {
+	Status  string `json:"status"`
+	Message string `json:"message"`
+	Data    struct {
+		Currency        string      `json:"currency"`
+		CustomerID      string      `json:"customer_id"`
+		Frequency       string      `json:"frequency"`
+		Amount          string      `json:"amount"`
+		Product         string      `json:"product"`
+		ProductName     string      `json:"product_name"`
+		Commission      int         `json:"commission"`
+		TransactionDate time.Time   `json:"transaction_date"`
+		Country         string      `json:"country"`
+		TxRef           string      `json:"tx_ref"`
+		Extra           interface{} `json:"extra"`
+		ProductDetails  string      `json:"product_details"`
+		Status          string      `json:"status"`
+	} `json:"data"`
+}
+
+// IsSuccessfull determines if the transaction was successfull
+func (response BillsStatusVerboseResponse) IsSuccessfull() bool {
+	return response.Data.Status == "successful" && response.Data.TxRef != ""
+}

bills_service_test.go

@@ -4,9 +4,11 @@ import (
 	"context"
 	"net/http"
 	"testing"
+	"time"
 
 	"github.com/NdoleStudio/flutterwave-go/internal/helpers"
 	"github.com/NdoleStudio/flutterwave-go/internal/stubs"
+	"github.com/araddon/dateparse"
 	"github.com/google/uuid"
 	"github.com/stretchr/testify/assert"
 )
@@ -52,6 +54,7 @@ func TestBillsService_CreatePayment(t *testing.T) {
 	}, data)
 
 	assert.Equal(t, http.StatusOK, response.HTTPResponse.StatusCode)
+	assert.True(t, data.IsSuccessfull())
 
 	// Teardown
 	server.Close()
@@ -102,6 +105,65 @@ func TestBillsService_Validate(t *testing.T) {
 	}, data)
 
 	assert.Equal(t, http.StatusOK, response.HTTPResponse.StatusCode)
+	assert.True(t, data.IsSuccessfull())
+
+	// Teardown
+	server.Close()
+}
+
+func TestBillsService_GetStatusVerbose(t *testing.T) {
+	// Setup
+	t.Parallel()
+
+	// Arrange
+	server := helpers.MakeTestServer(http.StatusOK, stubs.BillsGetStatusVerboseResponse())
+	client := New(WithBaseURL(server.URL))
+
+	// Act
+	data, response, err := client.Bills.GetStatusVerbose(context.Background(), "9300049404444")
+
+	// Assert
+	assert.Nil(t, err)
+
+	transactionDate, err := dateparse.ParseAny("2020-03-11T20:19:21.27Z")
+	assert.Nil(t, err)
+
+	assert.Equal(t, &BillsStatusVerboseResponse{
+		Status:  "success",
+		Message: "Bill status fetch successful",
+		Data: struct {
+			Currency        string      `json:"currency"`
+			CustomerID      string      `json:"customer_id"`
+			Frequency       string      `json:"frequency"`
+			Amount          string      `json:"amount"`
+			Product         string      `json:"product"`
+			ProductName     string      `json:"product_name"`
+			Commission      int         `json:"commission"`
+			TransactionDate time.Time   `json:"transaction_date"`
+			Country         string      `json:"country"`
+			TxRef           string      `json:"tx_ref"`
+			Extra           interface{} `json:"extra"`
+			ProductDetails  string      `json:"product_details"`
+			Status          string      `json:"status"`
+		}{
+			"NGN",
+			"+23490803840303",
+			"One Time",
+			"500.0000",
+			"AIRTIME",
+			"9MOBILE",
+			10,
+			transactionDate,
+			"NG",
+			"CF-FLYAPI-20200311081921359990",
+			nil,
+			"FLY-API-NG-AIRTIME-9MOBILE",
+			"successful",
+		},
+	}, data)
+
+	assert.Equal(t, http.StatusOK, response.HTTPResponse.StatusCode)
+	assert.True(t, data.IsSuccessfull())
 
 	// Teardown
 	server.Close()

go.mod

@@ -3,6 +3,7 @@ module github.com/NdoleStudio/flutterwave-go
 go 1.17
 
 require (
+	github.com/araddon/dateparse v0.0.0-20210429162001-6b43995a97de
 	github.com/google/uuid v1.3.0
 	github.com/stretchr/testify v1.7.0
 )

go.sum

@@ -1,9 +1,14 @@
+github.com/araddon/dateparse v0.0.0-20210429162001-6b43995a97de h1:FxWPpzIjnTlhPwqqXc4/vE0f7GvRjuAsbW+HOIe8KnA=
+github.com/araddon/dateparse v0.0.0-20210429162001-6b43995a97de/go.mod h1:DCaWoUhZrYW9p1lxo/cm8EmUOOzAPSEZNGF2DK1dJgw=
 github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I=
 github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/mattn/go-runewidth v0.0.10/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
+github.com/scylladb/termtables v0.0.0-20191203121021-c4c0b6d42ff4/go.mod h1:C1a7PQSMz9NShzorzCiG2fk9+xuCgLkPeCvMHYR2OWg=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=

internal/stubs/api_responses.go

@@ -39,3 +39,28 @@ func BillsValidateDstvResponse() string {
 	}
 `
 }
+
+// BillsGetStatusVerboseResponse is a dummy response of a verbose bill status
+func BillsGetStatusVerboseResponse() string {
+	return `
+	{
+		"status": "success",
+		"message": "Bill status fetch successful",
+		"data": {
+			"currency": "NGN",
+			"customer_id": "+23490803840303",
+			"frequency": "One Time",
+			"amount": "500.0000",
+			"product": "AIRTIME",
+			"product_name": "9MOBILE",
+			"commission": 10,
+			"transaction_date": "2020-03-11T20:19:21.27Z",
+			"country": "NG",
+			"tx_ref": "CF-FLYAPI-20200311081921359990",
+			"extra": null,
+			"product_details": "FLY-API-NG-AIRTIME-9MOBILE",
+			"status": "successful"
+		}
+	}
+`
+}