uhttp

package
v0.2.31 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 13, 2024 License: Apache-2.0 Imports: 33 Imported by: 80

Documentation

Index

Constants

View Source 
const (
	ContentType = "Content-Type"
)

Variables

This section is empty.

Functions

func CreateCacheKey added in v0.2.15 

func CreateCacheKey(req *http.Request) (string, error)

CreateCacheKey generates a cache key based on the request URL, query parameters, and headers. The key is a SHA-256 hash of the normalized URL path, sorted query parameters, and relevant headers.

func IsJSONContentType added in v0.2.21 

func IsJSONContentType(contentType string) bool

func IsXMLContentType added in v0.2.21 

func IsXMLContentType(contentType string) bool

func NewClient 

func NewClient(ctx context.Context, options ...Option) (*http.Client, error)

NewClient creates a new HTTP client that uses the given context and options to create a new transport layer.

func WrapErrorsWithRateLimitInfo added in v0.2.29 

func WrapErrorsWithRateLimitInfo(preferredCode codes.Code, resp *http.Response, errs ...error) error

Types

type AuthCredentials added in v0.1.23 

type AuthCredentials interface {
	GetClient(ctx context.Context, options ...Option) (*http.Client, error)
}

type BaseHttpClient added in v0.1.24 

type BaseHttpClient struct {
	HttpClient *http.Client
	// contains filtered or unexported fields
}

func NewBaseHttpClient added in v0.1.25 

func NewBaseHttpClient(httpClient *http.Client) *BaseHttpClient

func NewBaseHttpClientWithContext added in v0.2.15 

func NewBaseHttpClientWithContext(ctx context.Context, httpClient *http.Client) (*BaseHttpClient, error)

func (*BaseHttpClient) Do added in v0.1.24 

func (c *BaseHttpClient) Do(req *http.Request, options ...DoOption) (*http.Response, error)

func (*BaseHttpClient) NewRequest added in v0.1.24 

func (c *BaseHttpClient) NewRequest(ctx context.Context, method string, url *url.URL, options ...RequestOption) (*http.Request, error)

type BasicAuth added in v0.1.23 

type BasicAuth struct {
	Username string
	Password string
}

func NewBasicAuth added in v0.1.23 

func NewBasicAuth(username, password string) *BasicAuth

func (*BasicAuth) GetClient added in v0.1.23 

func (b *BasicAuth) GetClient(ctx context.Context, options ...Option) (*http.Client, error)

type BearerAuth added in v0.1.23 

type BearerAuth struct {
	Token string
}

func NewBearerAuth added in v0.1.23 

func NewBearerAuth(token string) *BearerAuth

func (*BearerAuth) GetClient added in v0.1.23 

func (b *BearerAuth) GetClient(ctx context.Context, options ...Option) (*http.Client, error)

type CacheConfig added in v0.2.15 

type CacheConfig struct {
	LogDebug     bool
	CacheTTL     int32
	CacheMaxSize int
	DisableCache bool
}

type ContextKey added in v0.2.15 

type ContextKey struct{}

type CreateJWTConfig added in v0.1.23 

type CreateJWTConfig func(credentials []byte, scopes ...string) (*jwt.Config, error)

type DoOption added in v0.1.24 

type DoOption func(resp *WrapperResponse) error

func WithErrorResponse added in v0.1.27 

func WithErrorResponse(resource ErrorResponse) DoOption

func WithJSONResponse added in v0.1.24 

func WithJSONResponse(response interface{}) DoOption

WithJSONResponse is a wrapper that marshals the returned response body into the provided shape. If the API should return an empty JSON body (i.e. HTTP status code 204 No Content), then pass a `nil` to `response`.

func WithRatelimitData added in v0.1.27 

func WithRatelimitData(resource *v2.RateLimitDescription) DoOption

func WithResponse added in v0.1.32 

func WithResponse(response interface{}) DoOption

func WithXMLResponse added in v0.1.28 

func WithXMLResponse(response interface{}) DoOption

type ErrorResponse added in v0.1.27 

type ErrorResponse interface {
	Message() string
}

type GoCache added in v0.2.15 

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

func NewGoCache added in v0.2.15 

func NewGoCache(ctx context.Context, cfg CacheConfig) (GoCache, error)

func (*GoCache) Clear added in v0.2.15 

func (g *GoCache) Clear() error

func (*GoCache) Delete added in v0.2.15 

func (g *GoCache) Delete(key string) error

func (*GoCache) Get added in v0.2.15 

func (g *GoCache) Get(key string) (*http.Response, error)

func (*GoCache) Has added in v0.2.15 

func (g *GoCache) Has(key string) bool

func (*GoCache) Set added in v0.2.15 

func (g *GoCache) Set(key string, value *http.Response) error

func (*GoCache) Statistics added in v0.2.15 

func (g *GoCache) Statistics() bigCache.Stats

type HttpClient added in v0.1.24 

type HttpClient interface {
	HttpClient() *http.Client
	Do(req *http.Request, options ...DoOption) (*http.Response, error)
	NewRequest(ctx context.Context, method string, url *url.URL, options ...RequestOption) (*http.Request, error)
}

type NoAuth added in v0.1.23 

type NoAuth struct{}

func (*NoAuth) GetClient added in v0.1.23 

func (n *NoAuth) GetClient(ctx context.Context, options ...Option) (*http.Client, error)

type OAuth2ClientCredentials added in v0.1.23 

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

func NewOAuth2ClientCredentials added in v0.1.23 

func NewOAuth2ClientCredentials(clientId, clientSecret string, tokenURL *url.URL, scopes []string) *OAuth2ClientCredentials

func (*OAuth2ClientCredentials) GetClient added in v0.1.23 

func (o *OAuth2ClientCredentials) GetClient(ctx context.Context, options ...Option) (*http.Client, error)

type OAuth2JWT added in v0.1.23 

type OAuth2JWT struct {
	Credentials     []byte
	Scopes          []string
	CreateJWTConfig CreateJWTConfig
}

func NewOAuth2JWT added in v0.1.23 

func NewOAuth2JWT(credentials []byte, scopes []string, createfn CreateJWTConfig) *OAuth2JWT

func (*OAuth2JWT) GetClient added in v0.1.23 

func (o *OAuth2JWT) GetClient(ctx context.Context, options ...Option) (*http.Client, error)

type OAuth2RefreshToken added in v0.1.34 

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

func NewOAuth2RefreshToken added in v0.1.34 

func NewOAuth2RefreshToken(clientID, clientSecret, redirectURI, tokenURL, accessToken, refreshToken string, scopes []string) *OAuth2RefreshToken

func (*OAuth2RefreshToken) GetClient added in v0.1.34 

func (o *OAuth2RefreshToken) GetClient(ctx context.Context, options ...Option) (*http.Client, error)

type Option 

type Option interface {
	Apply(*Transport)
}

func WithLogger 

func WithLogger(log bool, logger *zap.Logger) Option

WithLogger sets a logger options to the transport layer.

func WithTLSClientConfig 

func WithTLSClientConfig(tlsConfig *tls.Config) Option

WithTLSClientConfig returns an Option that sets the TLS client configuration. `tlsConfig` is a structure that is used to configure a TLS client or server.

func WithUserAgent 

func WithUserAgent(userAgent string) Option

WithUserAgent sets a user agent option to the transport layer.

type RequestOption added in v0.1.24 

type RequestOption func() (io.ReadWriter, map[string]string, error)

func WithAccept added in v0.2.13 

func WithAccept(value string) RequestOption

func WithAcceptJSONHeader added in v0.1.24 

func WithAcceptJSONHeader() RequestOption

func WithAcceptVndJSONHeader added in v0.2.13 

func WithAcceptVndJSONHeader() RequestOption

func WithAcceptXMLHeader added in v0.1.28 

func WithAcceptXMLHeader() RequestOption

func WithContentType added in v0.2.13 

func WithContentType(ctype string) RequestOption

func WithContentTypeFormHeader added in v0.2.13 

func WithContentTypeFormHeader() RequestOption

func WithContentTypeJSONHeader added in v0.1.24 

func WithContentTypeJSONHeader() RequestOption

func WithContentTypeVndHeader added in v0.2.13 

func WithContentTypeVndHeader() RequestOption

func WithFormBody added in v0.2.13 

func WithFormBody(body string) RequestOption

func WithHeader added in v0.1.33 

func WithHeader(key, value string) RequestOption

func WithJSONBody added in v0.1.24 

func WithJSONBody(body interface{}) RequestOption

type Transport 

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

func NewTransport 

func NewTransport(ctx context.Context, options ...Option) (*Transport, error)

NewTransport creates a new Transport, applies the options, and then cycles the transport.

func (*Transport) RoundTrip 

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

type WrapperResponse added in v0.1.27 

type WrapperResponse struct {
	Header     http.Header
	Body       []byte
	Status     string
	StatusCode int
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.