Merge pull request #4 from neymarjimoh/chore/context

add ctx propagation on all lib functions

README.md

@@ -30,6 +30,9 @@ func main() {
 	// Create an instance of FastOtp
 	client := fastotp.NewFastOTP(apiKey)
 
+	// Create context for library functions
+	ctx := context.Background()
+
 	// Define OTP generation payload
 	payload := fastotp.GenerateOTPPayload{
     Delivery: OtpDelivery{
@@ -42,7 +45,7 @@ func main() {
 	}
 
 	// Generate OTP
-	otp, err := client.GenerateOTP(payload)
+	otp, err := client.GenerateOTP(ctx, payload)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -51,9 +54,10 @@ func main() {
 
   // Validate OTP
   otp, err = client.ValidateOTP(
+	 ctx,
      ValidateOTPPayload{
         Identifier: "user123",
-        Token: "123456"
+        Token: "123456",
     }
   )
 	if err != nil {

fastotp.go

@@ -1,6 +1,7 @@
 package fastotp
 
 import (
+	"context"
 	"encoding/json"
 	"fmt"
 	"net/http"
@@ -62,8 +63,8 @@ func NewFastOTP(apiKey string) *FastOtp {
 	return &FastOtp{APIKey: &apiKey, BaseURL: BaseURL}
 }
 
-func (f *FastOtp) GenerateOTP(payload GenerateOTPPayload) (*OTP, error) {
-	cl := httpclient.NewAPIClient(f.BaseURL, *f.APIKey)
+func (f *FastOtp) GenerateOTP(ctx context.Context, payload GenerateOTPPayload) (*OTP, error) {
+	cl := httpclient.NewAPIClient(f.BaseURL, *f.APIKey, ctx)
 	resp, err := cl.Post("/generate", payload)
 	if err != nil {
 		return nil, err
@@ -91,8 +92,8 @@ func (f *FastOtp) GenerateOTP(payload GenerateOTPPayload) (*OTP, error) {
 	return &otpResponse.OTP, nil
 }
 
-func (f *FastOtp) ValidateOTP(payload ValidateOTPPayload) (*OTP, error) {
-	cl := httpclient.NewAPIClient(f.BaseURL, *f.APIKey)
+func (f *FastOtp) ValidateOTP(ctx context.Context, payload ValidateOTPPayload) (*OTP, error) {
+	cl := httpclient.NewAPIClient(f.BaseURL, *f.APIKey, ctx)
 	resp, err := cl.Post("/validate", payload)
 	if err != nil {
 		return nil, err
@@ -120,8 +121,8 @@ func (f *FastOtp) ValidateOTP(payload ValidateOTPPayload) (*OTP, error) {
 	return &otpResponse.OTP, nil
 }
 
-func (f *FastOtp) GetOtp(id string) (*OTP, error) {
-	cl := httpclient.NewAPIClient(f.BaseURL, *f.APIKey)
+func (f *FastOtp) GetOtp(ctx context.Context, id string) (*OTP, error) {
+	cl := httpclient.NewAPIClient(f.BaseURL, *f.APIKey, ctx)
 	resp, err := cl.Get(id)
 	if err != nil {
 		fmt.Println("got here")

fastotp_test.go

@@ -1,6 +1,7 @@
 package fastotp
 
 import (
+	"context"
 	"fmt"
 	"io"
 	"net/http"
@@ -55,7 +56,8 @@ func TestGenerateOTP(t *testing.T) {
 		Validity:    120,
 	}
 
-	otp, err := fastOtp.GenerateOTP(payload)
+	ctx := context.Background()
+	otp, err := fastOtp.GenerateOTP(ctx, payload)
 	if err != nil {
 		t.Errorf("Unexpected error: %v", err)
 	}
@@ -109,7 +111,8 @@ func TestValidateOTP(t *testing.T) {
 		Token:      "123456",
 	}
 
-	otp, err := fastOtp.ValidateOTP(payload)
+	ctx := context.Background()
+	otp, err := fastOtp.ValidateOTP(ctx, payload)
 	if err != nil {
 		t.Errorf("Unexpected error: %v", err)
 	}

lib/http.go

@@ -2,59 +2,62 @@ package httpclient
 
 import (
 	"bytes"
+	"context"
 	"encoding/json"
 	"fmt"
 	"net/http"
 )
 
 // APIClient is a wrapper for making HTTP requests to the fastotp API.
 type APIClient struct {
-	BaseURL string
-	APIKey  string
+	baseURL string
+	apiKey  string
+	ctx     context.Context
 }
 
 // NewAPIClient creates a new instance of APIClient.
-func NewAPIClient(baseURL, apiKey string) *APIClient {
+func NewAPIClient(baseURL, apiKey string, ctx context.Context) *APIClient {
 	return &APIClient{
-		BaseURL: baseURL,
-		APIKey:  apiKey,
+		baseURL: baseURL,
+		apiKey:  apiKey,
+		ctx:     ctx,
 	}
 }
 
 // Post sends a POST request to the specified endpoint with the given payload.
 func (c *APIClient) Post(endpoint string, payload interface{}) (*http.Response, error) {
-	url := c.BaseURL + endpoint
+	url := c.baseURL + endpoint
 
 	// Convert payload to JSON
 	payloadBytes, err := json.Marshal(payload)
 	if err != nil {
 		return nil, err
 	}
 
-	req, err := http.NewRequest(http.MethodPost, url, bytes.NewBuffer(payloadBytes))
+	req, err := http.NewRequestWithContext(c.ctx, http.MethodPost, url, bytes.NewBuffer(payloadBytes))
 	if err != nil {
 		return nil, err
 	}
 
 	req.Header.Set("Content-Type", "application/json")
-	req.Header.Set("x-api-key", c.APIKey)
+	req.Header.Set("x-api-key", c.apiKey)
 
 	client := http.DefaultClient
 	return client.Do(req)
 }
 
 // Get sends a GET request to the specified endpoint, appending id as a path parameter
 func (c *APIClient) Get(id string) (*http.Response, error) {
-	url := fmt.Sprintf("%s/%s", c.BaseURL, id)
+	url := fmt.Sprintf("%s/%s", c.baseURL, id)
 	fmt.Println(url)
 
-	req, err := http.NewRequest(http.MethodGet, url, nil)
+	req, err := http.NewRequestWithContext(c.ctx, http.MethodGet, url, nil)
 	if err != nil {
 		return nil, err
 	}
 
 	req.Header.Set("Content-Type", "application/json")
-	req.Header.Set("x-api-key", c.APIKey)
+	req.Header.Set("x-api-key", c.apiKey)
 
 	client := http.DefaultClient
 	return client.Do(req)