glclient

Documentation

Index

• Variables
• func DefaultBaseURL() string
• func New(cfg *Config) (*gitlab.Client, error)
• type BaseURLFlag
  • func (f *BaseURLFlag) Set(s string) error
  • func (f *BaseURLFlag) String() string
  • func (*BaseURLFlag) Type() string
• type Config
  • func ConfigFromFlags(ctx context.Context, fs *pflag.FlagSet) (*Config, error)
  • func ConfigFromRequest(r *http.Request, serverConfig ServerConfig) (*Config, error)
• type ServerConfig

Variables

var (
	// ErrInvalidScheme is returned when GitLab URL doesn't use HTTPS.
	ErrInvalidScheme = errors.New("GITLAB_URL must use https scheme")
	// ErrConfig is returned when configuration is invalid.
	ErrConfig = errors.New("invalid OAuth configuration")
	// ErrFlagNotFound is returned when a flag is not found.
	ErrFlagNotFound = errors.New("flag not found")
)

Functions

func DefaultBaseURL

func DefaultBaseURL() string

DefaultBaseURL returns the default GitLab URL or the URL specified by the GITLAB_URL environment variable.

func New

func New(cfg *Config) (*gitlab.Client, error)

New creates a GitLab client with proper validation and security checks.

Types

type BaseURLFlag

type BaseURLFlag url.URL

BaseURLFlag wraps a string to implement the `pflag.Value` interface. This type provides an implementation to customize the behavior of `--base-url` in the `cobra.Command` command-line interface.

func (*BaseURLFlag) Set

func (f *BaseURLFlag) Set(s string) error

Set sets the value of the flag. The value is sanitized by removing any trailing slashes and the `/api/v4` path from the end of the string. If the string is empty, it is set to the default base URL.

func (*BaseURLFlag) String

func (f *BaseURLFlag) String() string

func (*BaseURLFlag) Type

func (*BaseURLFlag) Type() string

type Config

type Config struct {
	AuthSource gitlab.AuthSource
	BaseURL    string // Optional
	ClientID   string

	AuthOAuth bool
	AuthPAT   bool
}

func ConfigFromFlags

func ConfigFromFlags(ctx context.Context, fs *pflag.FlagSet) (*Config, error)

ConfigFromFlags creates a new configuration by based on the provided flag set. GitLab tokens are determined from the environment or file system.

func ConfigFromRequest

func ConfigFromRequest(r *http.Request, serverConfig ServerConfig) (*Config, error)

ConfigFromRequest reads configuration from an HTTP request. It looks for the 'Private-Token' headers to set the access token.

type ServerConfig

type ServerConfig struct {
	BaseURL string

	AuthOAuth bool
	AuthPAT   bool
}

ServerConfig represents the server-side configuration.