gitlab

Documentation

Index

• func IsForbidden(err error) bool
• func IsNotFound(err error) bool
• func IsUnauthorized(err error) bool
• type Client
  • func NewClient(backend *url.URL, authSecret []byte, opts ...ClientOption) *Client
  • func (c *Client) Do(ctx context.Context, opts ...DoOption) error
• type ClientError
  • func (e ClientError) Error() string
• type ClientInterface
• type ClientOption
  • func WithCorrelationClientName(clientName string) ClientOption
  • func WithLogger(log *zap.Logger) ClientOption
  • func WithRateLimiter(limiter httpz.Limiter) ClientOption
  • func WithRetryConfig(retryConfig RetryConfig) ClientOption
  • func WithTLSConfig(tlsConfig *tls.Config) ClientOption
  • func WithTracer(tracer opentracing.Tracer) ClientOption
  • func WithUserAgent(userAgent string) ClientOption
• type DoOption
  • func WithAgentToken(agentToken api.AgentToken) DoOption
  • func WithHeader(header http.Header) DoOption
  • func WithJWT(withJWT bool) DoOption
  • func WithJobToken(jobToken string) DoOption
  • func WithJsonRequestBody(body interface{}) DoOption
  • func WithMethod(method string) DoOption
  • func WithPath(path string) DoOption
  • func WithQuery(query url.Values) DoOption
  • func WithRequestBody(body io.Reader, contentType string) DoOption
  • func WithResponseHandler(handler ResponseHandler) DoOption
  • func WithoutRetries() DoOption
• type GitalyInfo
  • func (g *GitalyInfo) ToGitalyInfo() api.GitalyInfo
• type GitalyRepository
  • func (r *GitalyRepository) ToProtoRepository() *gitalypb.Repository
• type HTTPClient
• type ResponseHandler
  • func JsonResponseHandler(response interface{}) ResponseHandler
  • func NakedResponseHandler(response **http.Response) ResponseHandler
  • func NoContentResponseHandler() ResponseHandler
• type ResponseHandlerStruct
  • func (r ResponseHandlerStruct) Accept() string
  • func (r ResponseHandlerStruct) Handle(resp *http.Response, err error) error
• type RetryConfig

Functions

func IsForbidden

func IsForbidden(err error) bool

func IsNotFound

func IsNotFound(err error) bool

func IsUnauthorized

func IsUnauthorized(err error) bool

Types

type Client

type Client struct {
	Backend           *url.URL
	HTTPClient        HTTPClient
	HTTPClientNoRetry HTTPClient
	AuthSecret        []byte
	UserAgent         string
}

func NewClient

func NewClient(backend *url.URL, authSecret []byte, opts ...ClientOption) *Client

func (*Client) Do

func (c *Client) Do(ctx context.Context, opts ...DoOption) error

type ClientError

type ClientError struct {
	StatusCode int
}

func (ClientError) Error

func (e ClientError) Error() string

type ClientInterface

type ClientInterface interface {
	Do(ctx context.Context, opts ...DoOption) error
}

type ClientOption

type ClientOption func(*clientConfig)

ClientOption to configure the client.

func WithCorrelationClientName

func WithCorrelationClientName(clientName string) ClientOption

WithCorrelationClientName configures the X-GitLab-Client-Name header on the http client.

func WithLogger

func WithLogger(log *zap.Logger) ClientOption

WithLogger sets the log to use.

func WithRateLimiter

func WithRateLimiter(limiter httpz.Limiter) ClientOption

WithRateLimiter sets the rate limiter to use.

func WithRetryConfig

func WithRetryConfig(retryConfig RetryConfig) ClientOption

WithRetryConfig configures retry behavior.

func WithTLSConfig

func WithTLSConfig(tlsConfig *tls.Config) ClientOption

WithTLSConfig sets the TLS config to use.

func WithTracer

func WithTracer(tracer opentracing.Tracer) ClientOption

WithTracer sets a custom tracer to be used, otherwise the opentracing.GlobalTracer is used.

func WithUserAgent

func WithUserAgent(userAgent string) ClientOption

WithUserAgent configures the User-Agent header on the http client.

type DoOption

type DoOption func(*doConfig) error

DoOption to configure the Do call of the client.

func WithAgentToken

func WithAgentToken(agentToken api.AgentToken) DoOption

func WithHeader

func WithHeader(header http.Header) DoOption

func WithJWT

func WithJWT(withJWT bool) DoOption

func WithJobToken

func WithJobToken(jobToken string) DoOption

func WithJsonRequestBody

func WithJsonRequestBody(body interface{}) DoOption

func WithMethod

func WithMethod(method string) DoOption

func WithPath

func WithPath(path string) DoOption

func WithQuery

func WithQuery(query url.Values) DoOption

func WithRequestBody

func WithRequestBody(body io.Reader, contentType string) DoOption

WithRequestBody sets the request body and HTTP Content-Type header if contentType is not empty.

func WithResponseHandler

func WithResponseHandler(handler ResponseHandler) DoOption

func WithoutRetries

func WithoutRetries() DoOption

type GitalyInfo

type GitalyInfo struct {
	Address  string            `json:"address"`
	Token    string            `json:"token"`
	Features map[string]string `json:"features"`
}

func (*GitalyInfo) ToGitalyInfo

func (g *GitalyInfo) ToGitalyInfo() api.GitalyInfo

type GitalyRepository

type GitalyRepository struct {
	StorageName   string `json:"storage_name"`
	RelativePath  string `json:"relative_path"`
	GlRepository  string `json:"gl_repository"`
	GlProjectPath string `json:"gl_project_path"`
}

func (*GitalyRepository) ToProtoRepository

func (r *GitalyRepository) ToProtoRepository() *gitalypb.Repository

type HTTPClient

type HTTPClient interface {
	Do(*retryablehttp.Request) (*http.Response, error)
}

type ResponseHandler

type ResponseHandler interface {
	// Handle is invoked with HTTP client's response and error values.
	Handle(*http.Response, error) error
	// Accept returns the value to send in the Accept HTTP header.
	// Empty string means no value should be sent.
	Accept() string
}

func JsonResponseHandler

func JsonResponseHandler(response interface{}) ResponseHandler

func NakedResponseHandler

func NakedResponseHandler(response **http.Response) ResponseHandler

func NoContentResponseHandler

func NoContentResponseHandler() ResponseHandler

NoContentResponseHandler can be used when no response is expected or response must be discarded.

type ResponseHandlerStruct

type ResponseHandlerStruct struct {
	AcceptHeader string
	HandleFunc   func(*http.Response, error) error
}

func (ResponseHandlerStruct) Accept

func (r ResponseHandlerStruct) Accept() string

func (ResponseHandlerStruct) Handle

func (r ResponseHandlerStruct) Handle(resp *http.Response, err error) error

type RetryConfig

type RetryConfig struct {
	// Logger instance. Can be either retryablehttp.Logger or retryablehttp.LeveledLogger
	Logger interface{}

	RetryWaitMin time.Duration // Minimum time to wait
	RetryWaitMax time.Duration // Maximum time to wait
	RetryMax     int           // Maximum number of retries

	// RequestLogHook allows a user-supplied function to be called
	// before each retry.
	RequestLogHook retryablehttp.RequestLogHook

	// ResponseLogHook allows a user-supplied function to be called
	// with the response from each HTTP request executed.
	ResponseLogHook retryablehttp.ResponseLogHook

	// CheckRetry specifies the policy for handling retries, and is called
	// after each request. The default policy is retryablehttp.DefaultRetryPolicy.
	CheckRetry retryablehttp.CheckRetry

	// Backoff specifies the policy for how long to wait between retries.
	// retryablehttp.DefaultBackoff is used by default.
	Backoff retryablehttp.Backoff
}