httpclient

README

Basic http client in go

This repo provides a basic http client in go.

Documentation

Index

• Constants
• func CreateQueryPlugins(paramKV ...string) []plugin.Plugin
• func SetAccessToken(accessToken string) plugin.Plugin
• func SetAccessTokenE(accessToken string) (plugin.Plugin, error)
• type Client
  • func New(addrAPI string, reqTimeout time.Duration, ...) (*Client, error)
  • func NewBasicAuthClient(addrAPI string, reqTimeout time.Duration, username, password string) (*Client, error)
  • func NewBearerAuthClient(addrAPI string, reqTimeout time.Duration, tokenProvider func() (string, error)) (*Client, error)
  • func (c *Client) Delete(plugins ...plugin.Plugin) error
  • func (c *Client) Get(data any, plugins ...plugin.Plugin) error
  • func (c *Client) Post(data any, plugins ...plugin.Plugin) (string, error)
  • func (c *Client) Put(plugins ...plugin.Plugin) error
• type HTTPError
  • func (e HTTPError) Error() string
  • func (e HTTPError) ErrorMessage() string
  • func (e HTTPError) IsError() bool
  • func (e HTTPError) IsErrorFromClient() bool
  • func (e HTTPError) IsErrorFromServer() bool
  • func (e HTTPError) IsSuccess() bool
  • func (e HTTPError) Status() int
• type MultiRealmTokenClient
  • func NewMultiRealmTokenClient(addrAPI string, reqTimeout time.Duration, tokenProvider OidcTokenProvider) (*MultiRealmTokenClient, error)
  • func (mrtc *MultiRealmTokenClient) Delete(plugins ...plugin.Plugin) error
  • func (mrtc *MultiRealmTokenClient) ForRealm(realm string) RestClient
  • func (mrtc *MultiRealmTokenClient) Get(data any, plugins ...plugin.Plugin) error
  • func (mrtc *MultiRealmTokenClient) Post(data any, plugins ...plugin.Plugin) (string, error)
  • func (mrtc *MultiRealmTokenClient) Put(plugins ...plugin.Plugin) error
• type OidcTokenProvider
• type RestClient
• type Token

Constants

const (
	MsgErrCannotObtain              = "cannotObtain"
	MsgErrCannotGetIssuer           = "cannotGetIssuer"
	MsgErrCannotParse               = "cannotParse"
	MsgErrUnkownHTTPContentType     = "unkownHTTPContentType"
	MsgErrUnknownResponseStatusCode = "unknownResponseStatusCode"

	PrmTokenProviderURL = "tokenProviderURL"
	PrmAPIURL           = "APIURL"
	PrmTokenMsg         = "token"
	PrmResponse         = "response"
)

Constants for error management

Functions

func CreateQueryPlugins

func CreateQueryPlugins(paramKV ...string) []plugin.Plugin

CreateQueryPlugins create query parameters with the key values paramKV.

func SetAccessToken

func SetAccessToken(accessToken string) plugin.Plugin

SetAccessToken creates a plugin to set an access token which is a valid token

func SetAccessTokenE

func SetAccessTokenE(accessToken string) (plugin.Plugin, error)

SetAccessTokenE creates a plugin to set an access token

Types

type Client

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

Client is the HTTP client.

func New

func New(addrAPI string, reqTimeout time.Duration, reqUpdaters ...func(*gentleman.Request) (*gentleman.Request, error)) (*Client, error)

New returns a keycloak client.

func NewBasicAuthClient

func NewBasicAuthClient(addrAPI string, reqTimeout time.Duration, username, password string) (*Client, error)

NewBasicAuthClient creates a new HTTP client using a basic authentication

func NewBearerAuthClient

func NewBearerAuthClient(addrAPI string, reqTimeout time.Duration, tokenProvider func() (string, error)) (*Client, error)

NewBearerAuthClient creates a new HTTP client using a bearer authentication

func (*Client) Delete

func (c *Client) Delete(plugins ...plugin.Plugin) error

Delete is a HTTP DELETE method

func (*Client) Get

func (c *Client) Get(data any, plugins ...plugin.Plugin) error

Get is a HTTP GET method.

func (*Client) Post

func (c *Client) Post(data any, plugins ...plugin.Plugin) (string, error)

Post is a HTTP POST method

func (*Client) Put

func (c *Client) Put(plugins ...plugin.Plugin) error

Put is a HTTP PUT method

type HTTPError

type HTTPError struct {
	StatusCode int
	Message    string
}

HTTPError is returned when an error occured while contacting the keycloak instance.

func (HTTPError) Error

func (e HTTPError) Error() string

func (HTTPError) ErrorMessage

func (e HTTPError) ErrorMessage() string

ErrorMessage returns the HTTP error message

func (HTTPError) IsError

func (e HTTPError) IsError() bool

IsError is true when HTTP request failed

func (HTTPError) IsErrorFromClient

func (e HTTPError) IsErrorFromClient() bool

IsErrorFromClient is true when HTTP request failed and the cause was related to the client request

func (HTTPError) IsErrorFromServer

func (e HTTPError) IsErrorFromServer() bool

IsErrorFromServer is true when HTTP request failed and the cause was related to the HTTP server

func (HTTPError) IsSuccess

func (e HTTPError) IsSuccess() bool

IsSuccess is true when HTTP status code is 2xx or 3xx

func (HTTPError) Status

func (e HTTPError) Status() int

Status returns the HTTP status code

type MultiRealmTokenClient

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

MultiRealmTokenClient struct

func NewMultiRealmTokenClient

func NewMultiRealmTokenClient(addrAPI string, reqTimeout time.Duration, tokenProvider OidcTokenProvider) (*MultiRealmTokenClient, error)

NewMultiRealmTokenClient creates a MultiRealmTokenClient instance

func (*MultiRealmTokenClient) Delete

func (mrtc *MultiRealmTokenClient) Delete(plugins ...plugin.Plugin) error

Delete is a HTTP DELETE method

func (*MultiRealmTokenClient) ForRealm

func (mrtc *MultiRealmTokenClient) ForRealm(realm string) RestClient

ForRealm returns a realm-specific RestClient

func (*MultiRealmTokenClient) Get

func (mrtc *MultiRealmTokenClient) Get(data any, plugins ...plugin.Plugin) error

Get is a HTTP GET method.

func (*MultiRealmTokenClient) Post

func (mrtc *MultiRealmTokenClient) Post(data any, plugins ...plugin.Plugin) (string, error)

Post is a HTTP POST method

func (*MultiRealmTokenClient) Put

func (mrtc *MultiRealmTokenClient) Put(plugins ...plugin.Plugin) error

Put is a HTTP PUT method

type OidcTokenProvider

type OidcTokenProvider interface {
	ProvideToken(ctx context.Context) (string, error)
	ProvideTokenForRealm(ctx context.Context, realm string) (string, error)
}

OidcTokenProvider provides OIDC tokens

type RestClient

type RestClient interface {
	Get(data any, plugins ...plugin.Plugin) error
	Post(data any, plugins ...plugin.Plugin) (string, error)
	Delete(plugins ...plugin.Plugin) error
	Put(plugins ...plugin.Plugin) error
}

RestClient interface

type Token

type Token struct {
	Issuer         string `json:"iss,omitempty"`
	Subject        string `json:"sub,omitempty"`
	ExpirationTime int64  `json:"exp,omitempty"`
	NotBefore      int64  `json:"nbf,omitempty"`
	IssuedAt       int64  `json:"iat,omitempty"`
	ID             string `json:"jti,omitempty"`
	Username       string `json:"preferred_username,omitempty"`
	// contains filtered or unexported fields
}

Token is JWT token. We need to define our own structure as the library define aud as a string but it can also be a string array. To fix this issue, we remove aud as we do not use it here.