holyapi

Documentation

Overview

Package holyapi provides client for interacting with other Holyheld services over HTTP

Index

• func ExtractUserAgent(ctx context.Context) string
• func ExtractVia(ctx context.Context) string
• func ProvideUserAgent(ua string) func(http.Handler) http.Handler
• func ProvideVia(pseudonym string) func(http.Handler) http.Handler
• type Client
  • func NewClient(baseURL holder.Holder[string], opts ...Option) *Client
  • func (c *Client) Request(ctx context.Context, method string, path string, header http.Header, body any, ...) (int, error)
  • func (c *Client) RequestWithOptions(ctx context.Context, method string, path string, body any, successResponse any, ...) (int, error)
  • func (c *Client) RequestWithRetry(ctx context.Context, method string, path string, header http.Header, body any, ...) (int, error)
• type NonContractResponseError
  • func NewNonContractResponseError(status int, cause error) *NonContractResponseError
  • func (e *NonContractResponseError) Error() string
  • func (e *NonContractResponseError) Is(target error) bool
  • func (e *NonContractResponseError) LogValue() slog.Value
  • func (e *NonContractResponseError) Unwrap() error
• type Option
  • func WithClient(c *http.Client) Option
• type ResponseError
  • func (r *ResponseError) Error() string
  • func (r *ResponseError) LogValue() slog.Value
• type ResponseMeta
• type ResponseSuccess
• type Status
• type UnexpectedError
  • func NewUnexpectedError(status int, cause *ResponseError) *UnexpectedError
  • func (e *UnexpectedError) Error() string
  • func (e *UnexpectedError) Is(target error) bool
  • func (e *UnexpectedError) LogValue() slog.Value
  • func (e *UnexpectedError) Unwrap() error
• type UnexpectedStatusError
  • func NewUnexpectedStatusError(status int) *UnexpectedStatusError
  • func (e *UnexpectedStatusError) Error() string
  • func (e *UnexpectedStatusError) LogValue() slog.Value

Functions

func ExtractUserAgent

func ExtractUserAgent(ctx context.Context) string

func ExtractVia

func ExtractVia(ctx context.Context) string

func ProvideUserAgent

func ProvideUserAgent(ua string) func(http.Handler) http.Handler

func ProvideVia

func ProvideVia(pseudonym string) func(http.Handler) http.Handler

Types

type Client

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

func NewClient

func NewClient(baseURL holder.Holder[string], opts ...Option) *Client

func (*Client) Request

func (c *Client) Request(
	ctx context.Context,
	method string,
	path string,
	header http.Header,
	body any,
	successResponse any,
) (int, error)

func (*Client) RequestWithOptions

func (c *Client) RequestWithOptions(
	ctx context.Context,
	method string,
	path string,
	body any,
	successResponse any,
	opts ...rest.RequestOption,
) (int, error)

func (*Client) RequestWithRetry

func (c *Client) RequestWithRetry(
	ctx context.Context,
	method string,
	path string,
	header http.Header,
	body any,
	successResponse any,
	retries int,
	checkRetry retryablehttp.CheckRetry,
) (int, error)

type NonContractResponseError

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

func NewNonContractResponseError

func NewNonContractResponseError(status int, cause error) *NonContractResponseError

func (*NonContractResponseError) Error

func (e *NonContractResponseError) Error() string

func (*NonContractResponseError) Is

func (e *NonContractResponseError) Is(target error) bool

func (*NonContractResponseError) LogValue

func (e *NonContractResponseError) LogValue() slog.Value

func (*NonContractResponseError) Unwrap

func (e *NonContractResponseError) Unwrap() error

type Option

type Option func(*Client)

func WithClient

func WithClient(c *http.Client) Option

type ResponseError

type ResponseError struct {
	Status           Status          `json:"status"`
	ErrorDescription string          `json:"error"`
	ErrorCode        string          `json:"errorCode"`
	Payload          json.RawMessage `json:"payload,omitempty"`
	Meta             ResponseMeta    `json:"-"`
}

func (*ResponseError) Error

func (r *ResponseError) Error() string

func (*ResponseError) LogValue

func (r *ResponseError) LogValue() slog.Value

type ResponseMeta

type ResponseMeta struct {
	URL    string `json:"url"`
	Method string `json:"method"`
	Status int    `json:"status"`
}

type ResponseSuccess

type ResponseSuccess struct {
	Status  Status `json:"status"`
	Payload any    `json:"payload,omitempty"`
}

type Status

type Status string

const (
	StatusOK    Status = "ok"
	StatusError Status = "error"
)

type UnexpectedError

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

func NewUnexpectedError

func NewUnexpectedError(status int, cause *ResponseError) *UnexpectedError

func (*UnexpectedError) Error

func (e *UnexpectedError) Error() string

func (*UnexpectedError) Is

func (e *UnexpectedError) Is(target error) bool

func (*UnexpectedError) LogValue

func (e *UnexpectedError) LogValue() slog.Value

func (*UnexpectedError) Unwrap

func (e *UnexpectedError) Unwrap() error

type UnexpectedStatusError

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

func NewUnexpectedStatusError

func NewUnexpectedStatusError(status int) *UnexpectedStatusError

func (*UnexpectedStatusError) Error

func (e *UnexpectedStatusError) Error() string

func (*UnexpectedStatusError) LogValue

func (e *UnexpectedStatusError) LogValue() slog.Value