httpc

README

httpc

This repository contains an net/http client wrapper that handles authentication and can be configured with rate limiting, retries and Open Telemetry instrumentation.

Example client setup

cfg := &httpc.Config{
    BaseUrl:        "google.com",
    Timeout:        10,
    RetryEnabled:   true,
    TlsConfig: &tls.Config{
        InsecureSkipVerify: false,
        MinVersion:         tls.VersionTLS12,
    },
}

client, err := httpc.NewClient(ctx, cfg)
if err != nil {
    // handle error
}

GET Request

var response Response
resp, err := client.Get(ctx, "/resource", nil, &response)
if err != nil {
    // handle error
}
defer resp.Body.Close()

POST Request

var response Response
resp, err := client.Post(ctx, "/resource", bytes.NewReader(body), nil, &response)
if err != nil {
    // handle error
}
defer resp.Body.Close()

Documentation

Index

• Constants
• type Client
  • func NewClient(ctx context.Context, cfg *Config, opts ...ClientOpt) (*Client, error)
  • func (c *Client) Delete(ctx context.Context, resource string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) Get(ctx context.Context, resource string, headers map[string]string) (*http.Response, error)
  • func (c *Client) Patch(ctx context.Context, resource string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) Post(ctx context.Context, resource string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) Put(ctx context.Context, resource string, body io.Reader, ...) (*http.Response, error)
  • func (c *Client) Stream(ctx context.Context, method string, resource string, body io.Reader, ...) (io.Reader, error)
• type ClientOpt
  • func WithCredentials(ctx context.Context, id string, secret string, baseUrl string, resource string, ...) ClientOpt
  • func WithCustomClient(client *http.Client) ClientOpt
  • func WithDefaultHeaders(headers map[string]string) ClientOpt
  • func WithRateLimiter(rateLimit int) ClientOpt
• type Config
• type ErrCopy
  • func (e *ErrCopy) Error() string
• type ErrDecode
  • func (e *ErrDecode) Error() string
• type ErrInvalidResource
  • func (e *ErrInvalidResource) Error() string
• type ErrNewRequest
  • func (e *ErrNewRequest) Error() string
• type ErrRateLimit
  • func (e *ErrRateLimit) Error() string
• type ErrRequest
  • func (e *ErrRequest) Error() string
• type ErrRetryCopy
  • func (e *ErrRetryCopy) Error() string
• type ErrStatusCode
  • func (e *ErrStatusCode) Error() string
• type RetryTransport
  • func NewRetryTransport(transport *http.Transport, maxRetry int) (*RetryTransport, error)
  • func (t *RetryTransport) RoundTrip(req *http.Request) (*http.Response, error)

Constants

const (
	Kib int64
	Mib
	Gib
)

const (
	DefaultTimeout       int   = 10
	DefaultReadByteLimit int64 = 15 * Mib

	MaxRateLimitKeys int = 65536
	MaxIdleConns     int = 100
	MaxConnsPerHost  int = 100
)

const (
	DefaultRetryMax int = 3
)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(ctx context.Context, cfg *Config, opts ...ClientOpt) (*Client, error)

NewClient creates a new Client

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, resource string, body io.Reader, headers map[string]string, decoded interface{}) (*http.Response, error)

Delete makes a DELETE request to the supplied endpoint and returns the response. If a struct pointer is supplied, the response body will be decoded into it

func (*Client) Get

func (c *Client) Get(ctx context.Context, resource string, headers map[string]string) (*http.Response, error)

Get makes a GET request to the supplied endpoint and returns the response.

func (*Client) Patch

func (c *Client) Patch(ctx context.Context, resource string, body io.Reader, headers map[string]string, decoded interface{}) (*http.Response, error)

Patch makes a PATCH request to the supplied endpoint and returns the response. If a struct pointer is supplied, the response body will be decoded into it

func (*Client) Post

func (c *Client) Post(ctx context.Context, resource string, body io.Reader, headers map[string]string, decoded interface{}) (*http.Response, error)

Post makes a POST request to the supplied endpoint and returns the response. If a struct pointer is supplied, the response body will be decoded into it

func (*Client) Put

func (c *Client) Put(ctx context.Context, resource string, body io.Reader, headers map[string]string, decoded interface{}) (*http.Response, error)

Put makes a PUT request to the supplied endpoint and returns the response. If a struct pointer is supplied, the response body will be decoded into it

func (*Client) Stream

func (c *Client) Stream(ctx context.Context, method string, resource string, body io.Reader, headers map[string]string) (io.Reader, error)

Stream makes a request to the supplied endpoint and pipes the response body to the returned io.Reader

type ClientOpt

type ClientOpt func(c *Client) error

func WithCredentials

func WithCredentials(ctx context.Context, id string, secret string, baseUrl string, resource string, scopes ...string) ClientOpt

WithCredentials sets up oauth2 and replaces the default http client

func WithCustomClient

func WithCustomClient(client *http.Client) ClientOpt

WithCustomClient replaces the default http client with the supplied one

func WithDefaultHeaders

func WithDefaultHeaders(headers map[string]string) ClientOpt

WithDefaultHeaders adds default headers to the client

func WithRateLimiter

func WithRateLimiter(rateLimit int) ClientOpt

WithRateLimiter configures a rate limiter with the supplied limit (per minute)

type Config

type Config struct {
	TlsConfig     *tls.Config
	BaseUrl       string
	Timeout       int
	OTelEnabled   bool
	RetryEnabled  bool
	RetryLimit    int
	ReadByteLimit int64
}

type ErrCopy

type ErrCopy struct {
	// contains filtered or unexported fields
}

func (*ErrCopy) Error

func (e *ErrCopy) Error() string

type ErrDecode

type ErrDecode struct {
	// contains filtered or unexported fields
}

func (*ErrDecode) Error

func (e *ErrDecode) Error() string

type ErrInvalidResource

type ErrInvalidResource struct {
	// contains filtered or unexported fields
}

func (*ErrInvalidResource) Error

func (e *ErrInvalidResource) Error() string

type ErrNewRequest

type ErrNewRequest struct {
	// contains filtered or unexported fields
}

func (*ErrNewRequest) Error

func (e *ErrNewRequest) Error() string

type ErrRateLimit

type ErrRateLimit struct {
	// contains filtered or unexported fields
}

func (*ErrRateLimit) Error

func (e *ErrRateLimit) Error() string

type ErrRequest

type ErrRequest struct {
	// contains filtered or unexported fields
}

func (*ErrRequest) Error

func (e *ErrRequest) Error() string

type ErrRetryCopy

type ErrRetryCopy struct {
	// contains filtered or unexported fields
}

func (*ErrRetryCopy) Error

func (e *ErrRetryCopy) Error() string

type ErrStatusCode

type ErrStatusCode struct {
	// contains filtered or unexported fields
}

func (*ErrStatusCode) Error

func (e *ErrStatusCode) Error() string

type RetryTransport

type RetryTransport struct {
	// contains filtered or unexported fields
}

func NewRetryTransport

func NewRetryTransport(transport *http.Transport, maxRetry int) (*RetryTransport, error)

NewRetryTransport wraps the supplied http transport with a retryable implementation

func (*RetryTransport) RoundTrip

func (t *RetryTransport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip implements the http.RoundTripper interface with retries