Release v0.9.0

SECURITY.MD

@@ -0,0 +1,7 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+To securely report a vulnerability, please [Contact us!](mailto:[email protected]?subject=[GitHub]_Vulnerability!).
+
+<!-- E26CADE3-DF7C-4FF8-A30A-4DD2F28E06BF -->

insrequester/README.md

@@ -65,6 +65,16 @@ timeoutSeconds := 30
 requester.WithTimeout(timeoutSeconds) // this timeout overrides the default timeout
 ```
 
+#### Default Headers
+For applying default headers to all requests, you can use the WithDefaultHeaders method:
+
+```go
+headers := insrequester.Headers{{"Authorization": "Bearer token"}}
+requester.WithHeaders(headers)
+```
+It should be noted that you can still override these default headers by providing the same header in the request entity.
+
+
 ### Loading Middlewares
 After configuring the desired resilience features, load the configured middlewares using the Load method:
 

insrequester/requester.go

@@ -39,12 +39,15 @@ type Requester interface {
 	WithRetry(config RetryConfig) *Request
 	WithCircuitbreaker(config CircuitBreakerConfig) *Request
 	WithTimeout(timeoutSeconds int) *Request
+	WithHeaders(headers Headers) *Request
 	Load() *Request
 }
 
+type Headers []map[string]interface{}
+
 // RequestEntity contains required information for sending http request.
 type RequestEntity struct {
-	Headers  []map[string]interface{}
+	Headers  Headers
 	Endpoint string
 	Body     []byte
 }
@@ -53,6 +56,7 @@ type Request struct {
 	timeout     int
 	runner      goresilience.Runner
 	middlewares []goresilience.Middleware
+	headers     Headers
 }
 
 // Get sends HTTP get request to the given endpoint and returns *http.Response and an error.
@@ -95,6 +99,7 @@ func (r *Request) sendRequest(httpMethod string, re RequestEntity) (*http.Respon
 		}
 
 		req.Close = true
+		re.Headers = append(r.headers, re.Headers...) // RequestEntity headers will override Requester level headers.
 		re.applyHeadersToRequest(req)
 
 		res, outerErr = (&http.Client{Timeout: time.Duration(r.timeout) * time.Second}).Do(req)
@@ -197,6 +202,11 @@ func (r *Request) WithTimeout(timeoutSeconds int) *Request {
 	return r
 }
 
+func (r *Request) WithHeaders(headers Headers) *Request {
+	r.headers = headers
+	return r
+}
+
 func (r *Request) Load() *Request {
 	r.runner = goresilience.RunnerChain(r.middlewares...)
 	return r

insrequester/requester_test.go

@@ -68,4 +68,48 @@ func TestRequest_Get(t *testing.T) {
 		_, err = r.Get(req)
 		assert.ErrorIs(t, err, errors.ErrCircuitOpen)
 	})
+
+	t.Run("it_should_apply_headers_properly", func(t *testing.T) {
+		var receivedUserAgent string
+		ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			receivedUserAgent = r.Header.Get("User-Agent")
+			w.WriteHeader(http.StatusOK)
+			_, _ = w.Write([]byte(`{"status": "OK"}`))
+		}))
+
+		defer ts.Close()
+
+		userAgent := "test-user-agent"
+		r := NewRequester().WithHeaders(Headers{{"User-Agent": userAgent}})
+		res, err := r.Get(RequestEntity{Endpoint: ts.URL})
+
+		assert.NoError(t, err)
+		assert.Equal(t, receivedUserAgent, userAgent)
+		assert.Equal(t, http.StatusOK, res.StatusCode)
+	})
+
+	t.Run("it_should_override_Requester_level_header_if_RequestEntity_headers_set", func(t *testing.T) {
+		var receivedUserAgent string
+		ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			receivedUserAgent = r.Header.Get("User-Agent")
+			w.WriteHeader(http.StatusOK)
+			_, _ = w.Write([]byte(`{"status": "OK"}`))
+		}))
+
+		defer ts.Close()
+
+		oldUserAgent := "old-user-agent"
+		r := NewRequester().WithHeaders(Headers{{"User-Agent": oldUserAgent}})
+
+		newUserAgent := "new-user-agent"
+		req := RequestEntity{
+			Endpoint: ts.URL,
+			Headers:  Headers{{"User-Agent": newUserAgent}},
+		}
+		res, err := r.Get(req)
+
+		assert.NoError(t, err)
+		assert.Equal(t, receivedUserAgent, newUserAgent)
+		assert.Equal(t, http.StatusOK, res.StatusCode)
+	})
 }