httpclient

Documentation

Overview

httpclient/client.go

The `http_client` package provides a configurable HTTP client tailored for interacting with specific APIs.

It supports different authentication methods, including "bearer" and "oauth". The client is designed with a focus on concurrency management, structured error handling, and flexible configuration options. The package offers a default timeout, custom backoff strategies, dynamic rate limiting, and detailed logging capabilities. The main `Client` structure encapsulates all necessary components, like the baseURL, authentication details, and an embedded standard HTTP client.

httpclient/client_configuration.go Description: This file contains functions to load and validate configuration values from a JSON file or environment variables.

headers/headers.go

httpmethod/httpmethod.go

httpclient/integration.go

httpclient/request.go

httpclient/utility.go

Index

• Constants
• func CheckDeprecationHeader(resp *http.Response, log logger.Logger)
• func IsIdempotentHTTPMethod(method string) bool
• func SetDefaultValuesClientConfig(config *ClientConfig)
• type APIIntegration
• type Client
  • func BuildClient(config ClientConfig, populateDefaultValues bool, log logger.Logger) (*Client, error)
  • func (c *Client) DoMultiPartRequest(method, endpoint string, files map[string][]string, ...) (*http.Response, error)
  • func (c *Client) DoRequest(method, endpoint string, body, out interface{}) (*http.Response, error)
• type ClientConfig
  • func LoadConfigFromEnv() (*ClientConfig, error)
  • func LoadConfigFromFile(filepath string) (*ClientConfig, error)
• type UploadState

Constants

const (
	DefaultLogLevelString              = "LogLevelInfo"
	DefaultLogOutputFormatString       = "pretty"
	DefaultLogConsoleSeparator         = "	"
	DefaultLogExportPath               = "/defaultlogs"
	DefaultMaxRetryAttempts            = 3
	DefaultMaxConcurrentRequests       = 1
	DefaultExportLogs                  = false
	DefaultHideSensitiveData           = false
	DefaultEnableDynamicRateLimiting   = false
	DefaultCustomTimeout               = 5 * time.Second
	DefaultTokenRefreshBufferPeriod    = 2 * time.Minute
	DefaultTotalRetryDuration          = 5 * time.Minute
	DefaultFollowRedirects             = false
	DefaultMaxRedirects                = 5
	DefaultEnableConcurrencyManagement = false
)

const ConfigFileExtension = ".json"

Functions

func CheckDeprecationHeader

func CheckDeprecationHeader(resp *http.Response, log logger.Logger)

CheckDeprecationHeader checks the response headers for the Deprecation header and logs a warning if present.

func IsIdempotentHTTPMethod

func IsIdempotentHTTPMethod(method string) bool

IsIdempotentHTTPMethod checks if the given HTTP method is idempotent.

func SetDefaultValuesClientConfig

func SetDefaultValuesClientConfig(config *ClientConfig)

SetDefaultValuesClientConfig sets default values for the client configuration. Ensuring that all fields have a valid or minimum value.

Types

type APIIntegration

type APIIntegration interface {
	GetFQDN() string
	ConstructURL(endpoint string) string
	GetAuthMethodDescriptor() string
	CheckRefreshToken() error
	PrepRequestParamsAndAuth(req *http.Request) error
	PrepRequestBody(body interface{}, method string, endpoint string) ([]byte, error)
	MarshalMultipartRequest(fields map[string]string, files map[string]string) ([]byte, string, error)
	GetSessionCookies() ([]*http.Cookie, error)
}

APIIntegration is an interface that defines the methods required for an API integration. These are obtained from go-api-http-client-integrations. The methods defined in this interface are used by the HTTP client to authenticate and prepare requests for the API.

type Client

type Client struct {
	AuthToken       string
	AuthTokenExpiry time.Time
	Logger          logger.Logger
	Concurrency     *concurrency.ConcurrencyHandler
	Integration     *APIIntegration
	// contains filtered or unexported fields
}

Master struct/object

func BuildClient

func BuildClient(config ClientConfig, populateDefaultValues bool, log logger.Logger) (*Client, error)

BuildClient creates a new HTTP client with the provided configuration.

func (*Client) DoMultiPartRequest

func (c *Client) DoMultiPartRequest(method, endpoint string, files map[string][]string, formDataFields map[string]string, fileContentTypes map[string]string, formDataPartHeaders map[string]http.Header, out interface{}) (*http.Response, error)

Example: var result MyResponseType resp, err := client.DoMultiPartRequest("POST", "/api/upload", files, formDataFields, fileContentTypes, formDataPartHeaders, &result)

if err != nil {
    // Handle error
}

// Use `result` or `resp` as needed

func (*Client) DoRequest

func (c *Client) DoRequest(method, endpoint string, body, out interface{}) (*http.Response, error)

type ClientConfig

type ClientConfig struct {
	Integration                 APIIntegration
	HideSensitiveData           bool
	CustomCookies               []*http.Cookie
	MaxRetryAttempts            int
	MaxConcurrentRequests       int
	EnableDynamicRateLimiting   bool
	CustomTimeout               time.Duration
	TokenRefreshBufferPeriod    time.Duration
	TotalRetryDuration          time.Duration // TODO do we need this now it's in the integration?
	FollowRedirects             bool
	MaxRedirects                int
	EnableConcurrencyManagement bool
}

Options/Variables for Client

func LoadConfigFromEnv

func LoadConfigFromEnv() (*ClientConfig, error)

LoadConfigFromEnv loads HTTP client configuration settings from environment variables. If any environment variables are not set, the default values defined in the constants are used instead.

func LoadConfigFromFile

func LoadConfigFromFile(filepath string) (*ClientConfig, error)

LoadConfigFromFile loads http client configuration settings from a JSON file.

type UploadState

type UploadState struct {
	LastUploadedByte int64
	sync.Mutex
}

UploadState represents the state of an upload operation, including the last uploaded byte. This struct is used to track the progress of file uploads for resumable uploads and to resume uploads from the last uploaded byte.