Configure HttpClient, added context parameter to all methods (#37)

Context is needed to limit time of execution of a method. Previously, context was passed to structure and it was stored inside structure which is a bad practice. Now we need to pass context to function, which is a best practice

Author: diPhantxm

README.md

@@ -36,7 +36,8 @@ func main() {
 	client := ozon.NewClient("my-client-id", "my-api-key")
 
 	// Send request with parameters
-	resp, err := client.Products().GetProductDetails(&ozon.GetProductDetailsParams{
+	ctx, _ := context.WithTimeout(context.Background(), testTimeout)
+resp, err := client.Products().GetProductDetails(&ozon.GetProductDetailsParams{
 		ProductId: 123456789,
 	})
 	if err != nil || resp.StatusCode != http.StatusOK {

client.go

@@ -15,36 +15,33 @@ type HttpClient interface {
 
 type Client struct {
 	baseUrl string
-	ctx     context.Context
 	Options map[string]string
 
 	client HttpClient
 }
 
-func NewClient(baseUrl string, opts map[string]string) *Client {
+func NewClient(client HttpClient, baseUrl string, opts map[string]string) *Client {
 	return &Client{
 		Options: opts,
-		ctx:     context.Background(),
-		client:  http.DefaultClient,
+		client:  client,
 		baseUrl: baseUrl,
 	}
 }
 
 func NewMockClient(handler http.HandlerFunc) *Client {
 	return &Client{
-		ctx:    context.Background(),
 		client: NewMockHttpClient(handler),
 	}
 }
 
-func (c Client) newRequest(method string, url string, body interface{}) (*http.Request, error) {
+func (c Client) newRequest(ctx context.Context, method string, url string, body interface{}) (*http.Request, error) {
 	bodyJson, err := json.Marshal(body)
 	if err != nil {
 		return nil, err
 	}
 
 	url = c.baseUrl + url
-	req, err := http.NewRequestWithContext(c.ctx, method, url, bytes.NewBuffer(bodyJson))
+	req, err := http.NewRequestWithContext(ctx, method, url, bytes.NewBuffer(bodyJson))
 	if err != nil {
 		return nil, err
 	}
@@ -56,8 +53,8 @@ func (c Client) newRequest(method string, url string, body interface{}) (*http.R
 	return req, nil
 }
 
-func (c Client) Request(method string, path string, req, resp interface{}, options map[string]string) (*Response, error) {
-	httpReq, err := c.newRequest(method, path, req)
+func (c Client) Request(ctx context.Context, method string, path string, req, resp interface{}, options map[string]string) (*Response, error) {
+	httpReq, err := c.newRequest(ctx, method, path, req)
 	if err != nil {
 		return nil, err
 	}

client_test.go

@@ -1,8 +1,14 @@
 package core
 
 import (
+	"context"
 	"net/http"
 	"testing"
+	"time"
+)
+
+const (
+	testTimeout = 5 * time.Second
 )
 
 type TestRequestRequest struct {
@@ -55,7 +61,8 @@ func TestRequest(t *testing.T) {
 		c := NewMockClient(NewMockHttpHandler(test.statusCode, test.response, test.headers))
 
 		respStruct := &TestRequestResponse{}
-		resp, err := c.Request(http.MethodPost, "/", test.params, respStruct, nil)
+		ctx, _ := context.WithTimeout(context.Background(), testTimeout)
+		resp, err := c.Request(ctx, http.MethodPost, "/", test.params, respStruct, nil)
 
 		if err != nil {
 			t.Error(err)

ozon/analytics.go

@@ -1,6 +1,7 @@
 package ozon
 
 import (
+	"context"
 	"net/http"
 	"time"
 
@@ -94,12 +95,12 @@ type GetAnalyticsDataResultDimension struct {
 }
 
 // Specify the period and metrics that are required. The response will contain analytical data grouped by the `dimensions` parameter.
-func (c Analytics) GetAnalyticsData(params *GetAnalyticsDataParams) (*GetAnalyticsDataResponse, error) {
+func (c Analytics) GetAnalyticsData(ctx context.Context, params *GetAnalyticsDataParams) (*GetAnalyticsDataResponse, error) {
 	url := "/v1/analytics/data"
 
 	resp := &GetAnalyticsDataResponse{}
 
-	response, err := c.client.Request(http.MethodPost, url, params, resp, nil)
+	response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
 	if err != nil {
 		return nil, err
 	}
@@ -157,12 +158,12 @@ type GetStocksOnWarehousesResultRow struct {
 }
 
 // Report on stocks and products movement at Ozon warehouses
-func (c Analytics) GetStocksOnWarehouses(params *GetStocksOnWarehousesParams) (*GetStocksOnWarehousesResponse, error) {
+func (c Analytics) GetStocksOnWarehouses(ctx context.Context, params *GetStocksOnWarehousesParams) (*GetStocksOnWarehousesResponse, error) {
 	url := "/v2/analytics/stock_on_warehouses"
 
 	resp := &GetStocksOnWarehousesResponse{}
 
-	response, err := c.client.Request(http.MethodPost, url, params, resp, nil)
+	response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
 	if err != nil {
 		return nil, err
 	}

ozon/analytics_test.go

@@ -1,6 +1,7 @@
 package ozon
 
 import (
+	"context"
 	"net/http"
 	"testing"
 
@@ -59,7 +60,8 @@ func TestGetAnalyticsData(t *testing.T) {
 	for _, test := range tests {
 		c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
 
-		resp, err := c.Analytics().GetAnalyticsData(test.params)
+		ctx, _ := context.WithTimeout(context.Background(), testTimeout)
+		resp, err := c.Analytics().GetAnalyticsData(ctx, test.params)
 		if err != nil {
 			t.Error(err)
 		}
@@ -119,7 +121,8 @@ func TestGetStocksOnWarehouses(t *testing.T) {
 	for _, test := range tests {
 		c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
 
-		resp, err := c.Analytics().GetStocksOnWarehouses(test.params)
+		ctx, _ := context.WithTimeout(context.Background(), testTimeout)
+		resp, err := c.Analytics().GetStocksOnWarehouses(ctx, test.params)
 		if err != nil {
 			t.Error(err)
 		}

ozon/brands.go

@@ -1,6 +1,7 @@
 package ozon
 
 import (
+	"context"
 	"net/http"
 
 	core "github.com/diphantxm/ozon-api-client"
@@ -44,12 +45,12 @@ type ListCertifiedBrandsResultCertificate struct {
 }
 
 // List of certified brands
-func (c Brands) List(params *ListCertifiedBrandsParams) (*ListCertifiedBrandsResponse, error) {
+func (c Brands) List(ctx context.Context, params *ListCertifiedBrandsParams) (*ListCertifiedBrandsResponse, error) {
 	url := "/v1/brand/company-certification/list"
 
 	resp := &ListCertifiedBrandsResponse{}
 
-	response, err := c.client.Request(http.MethodPost, url, params, resp, nil)
+	response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
 	if err != nil {
 		return nil, err
 	}

ozon/brands_test.go

@@ -1,6 +1,7 @@
 package ozon
 
 import (
+	"context"
 	"net/http"
 	"testing"
 
@@ -52,7 +53,8 @@ func TestListCertifiedBrands(t *testing.T) {
 	for _, test := range tests {
 		c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
 
-		resp, err := c.Brands().List(test.params)
+		ctx, _ := context.WithTimeout(context.Background(), testTimeout)
+		resp, err := c.Brands().List(ctx, test.params)
 		if err != nil {
 			t.Error(err)
 		}

ozon/cancellations.go

@@ -1,6 +1,7 @@
 package ozon
 
 import (
+	"context"
 	"net/http"
 	"time"
 
@@ -81,12 +82,12 @@ type CancellationInfoState struct {
 }
 
 // Method for getting information about a rFBS cancellation request
-func (c Cancellations) GetInfo(params *GetCancellationInfoParams) (*GetCancellationInfoResponse, error) {
+func (c Cancellations) GetInfo(ctx context.Context, params *GetCancellationInfoParams) (*GetCancellationInfoResponse, error) {
 	url := "/v1/delivery-method/list"
 
 	resp := &GetCancellationInfoResponse{}
 
-	response, err := c.client.Request(http.MethodPost, url, params, resp, nil)
+	response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
 	if err != nil {
 		return nil, err
 	}
@@ -153,12 +154,12 @@ type ListCancellationResponseCounters struct {
 }
 
 // Method for getting a list of rFBS cancellation requests
-func (c Cancellations) List(params *ListCancellationsParams) (*ListCancellationsResponse, error) {
+func (c Cancellations) List(ctx context.Context, params *ListCancellationsParams) (*ListCancellationsResponse, error) {
 	url := "/v1/conditional-cancellation/list"
 
 	resp := &ListCancellationsResponse{}
 
-	response, err := c.client.Request(http.MethodPost, url, params, resp, nil)
+	response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
 	if err != nil {
 		return nil, err
 	}
@@ -181,12 +182,12 @@ type ApproveRejectCancellationsResponse struct {
 
 // The method allows to approve an rFBS cancellation request in the ON_APPROVAL status.
 // The order will be canceled and the money will be returned to the customer
-func (c Cancellations) Approve(params *ApproveRejectCancellationsParams) (*ApproveRejectCancellationsResponse, error) {
+func (c Cancellations) Approve(ctx context.Context, params *ApproveRejectCancellationsParams) (*ApproveRejectCancellationsResponse, error) {
 	url := "/v1/conditional-cancellation/approve"
 
 	resp := &ApproveRejectCancellationsResponse{}
 
-	response, err := c.client.Request(http.MethodPost, url, params, resp, nil)
+	response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
 	if err != nil {
 		return nil, err
 	}
@@ -198,12 +199,12 @@ func (c Cancellations) Approve(params *ApproveRejectCancellationsParams) (*Appro
 // The method allows to reject an rFBS cancellation request in the ON_APPROVAL status. Explain your decision in the comment parameter.
 //
 // The order will remain in the same status and must be delivered to the customer
-func (c Cancellations) Reject(params *ApproveRejectCancellationsParams) (*ApproveRejectCancellationsResponse, error) {
+func (c Cancellations) Reject(ctx context.Context, params *ApproveRejectCancellationsParams) (*ApproveRejectCancellationsResponse, error) {
 	url := "/v1/conditional-cancellation/reject"
 
 	resp := &ApproveRejectCancellationsResponse{}
 
-	response, err := c.client.Request(http.MethodPost, url, params, resp, nil)
+	response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
 	if err != nil {
 		return nil, err
 	}

ozon/cancellations_test.go

@@ -1,6 +1,7 @@
 package ozon
 
 import (
+	"context"
 	"net/http"
 	"testing"
 
@@ -62,7 +63,8 @@ func TestGetCancellationInfo(t *testing.T) {
 	for _, test := range tests {
 		c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
 
-		resp, err := c.Cancellations().GetInfo(test.params)
+		ctx, _ := context.WithTimeout(context.Background(), testTimeout)
+		resp, err := c.Cancellations().GetInfo(ctx, test.params)
 		if err != nil {
 			t.Error(err)
 		}
@@ -171,7 +173,8 @@ func TestListCancellations(t *testing.T) {
 	for _, test := range tests {
 		c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
 
-		resp, err := c.Cancellations().List(test.params)
+		ctx, _ := context.WithTimeout(context.Background(), testTimeout)
+		resp, err := c.Cancellations().List(ctx, test.params)
 		if err != nil {
 			t.Error(err)
 		}
@@ -215,7 +218,8 @@ func TestApproveCancellations(t *testing.T) {
 	for _, test := range tests {
 		c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
 
-		resp, err := c.Cancellations().Approve(test.params)
+		ctx, _ := context.WithTimeout(context.Background(), testTimeout)
+		resp, err := c.Cancellations().Approve(ctx, test.params)
 		if err != nil {
 			t.Error(err)
 		}
@@ -259,7 +263,8 @@ func TestRejectCancellations(t *testing.T) {
 	for _, test := range tests {
 		c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers))
 
-		resp, err := c.Cancellations().Reject(test.params)
+		ctx, _ := context.WithTimeout(context.Background(), testTimeout)
+		resp, err := c.Cancellations().Reject(ctx, test.params)
 		if err != nil {
 			t.Error(err)
 		}

ozon/categories.go

@@ -1,6 +1,7 @@
 package ozon
 
 import (
+	"context"
 	"net/http"
 
 	core "github.com/diphantxm/ozon-api-client"
@@ -40,12 +41,12 @@ type GetProductTreeResult struct {
 // New products can be created in the last level categories only.
 // This means that you need to match these particular categories with the categories of your site.
 // It is not possible to create categories by user request
-func (c Categories) Tree(params *GetProductTreeParams) (*GetProductTreeResponse, error) {
+func (c Categories) Tree(ctx context.Context, params *GetProductTreeParams) (*GetProductTreeResponse, error) {
 	url := "/v2/category/tree"
 
 	resp := &GetProductTreeResponse{}
 
-	response, err := c.client.Request(http.MethodPost, url, params, resp, nil)
+	response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
 	if err != nil {
 		return nil, err
 	}
@@ -134,12 +135,12 @@ type GetCategoryAttributesResultAttribute struct {
 // You can check whether the attribute has a nested directory by the `dictionary_id` parameter.
 // The 0 value means there is no directory. If the value is different, then there are directories.
 // You can get them using the `/v2/category/attribute/values` method
-func (c Categories) Attributes(params *GetCategoryAttributesParams) (*GetCategoryAttributesResponse, error) {
+func (c Categories) Attributes(ctx context.Context, params *GetCategoryAttributesParams) (*GetCategoryAttributesResponse, error) {
 	url := "/v3/category/attribute"
 
 	resp := &GetCategoryAttributesResponse{}
 
-	response, err := c.client.Request(http.MethodPost, url, params, resp, nil)
+	response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
 	if err != nil {
 		return nil, err
 	}
@@ -187,12 +188,12 @@ type GetAttributeDictionaryResult struct {
 
 // You can use the `/v3/category/attribute` method to check if an attribute has a nested directory.
 // If there are directories, get them using this method
-func (c Categories) AttributesDictionary(params *GetAttributeDictionaryParams) (*GetAttributeDictionaryResponse, error) {
+func (c Categories) AttributesDictionary(ctx context.Context, params *GetAttributeDictionaryParams) (*GetAttributeDictionaryResponse, error) {
 	url := "/v2/category/attribute/values"
 
 	resp := &GetAttributeDictionaryResponse{}
 
-	response, err := c.client.Request(http.MethodPost, url, params, resp, nil)
+	response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil)
 	if err != nil {
 		return nil, err
 	}