apix

Documentation

Overview

Package apix provide API-related helpers.

Package apix is a generated GoMock package.

Package apix is a generated GoMock package.

Index

• Variables
• func FromContext(ctx Ctx) (remoteIP, methodName string, auth dom.Auth)
• type AccessToken
  • func AccessTokenFromContext(ctx Ctx) (accessToken AccessToken)
  • func (s AccessToken) Format(f fmt.State, c rune)
  • func (s AccessToken) MarshalJSON() ([]byte, error)
  • func (s AccessToken) MarshalText() ([]byte, error)
• type Authn
  • func NewAuthnClient(ctx Ctx, reg *prometheus.Registry, service string, ca *x509.CertPool, ...) (Authn, error)
• type Ctx
  • func GRPCNewContext(ctx Ctx, fullMethod string, authn Authn) (_ Ctx, auth dom.Auth, err error)
• type JSONRPC2Ctx
  • func (c *JSONRPC2Ctx) NewContext(authn Authn, service string) (ctx Ctx, log *structlog.Logger, methodName string, auth dom.Auth, err error)
• type MockAuthn
  • func NewMockAuthn(ctrl *gomock.Controller) *MockAuthn
  • func (m *MockAuthn) Authenticate(arg0 Ctx, arg1 AccessToken) (dom.Auth, error)
  • func (m *MockAuthn) EXPECT() *MockAuthnMockRecorder
• type MockAuthnMockRecorder
  • func (mr *MockAuthnMockRecorder) Authenticate(arg0, arg1 interface{}) *gomock.Call
• type MockUserAgent
  • func NewMockUserAgent(ctrl *gomock.Controller) *MockUserAgent
  • func (m *MockUserAgent) Do(ctx Ctx, req *http.Request, skip int) (*http.Response, []byte, error)
  • func (m *MockUserAgent) EXPECT() *MockUserAgentMockRecorder
  • func (m *MockUserAgent) Log(ctx Ctx, resp *http.Response, body []byte)
• type MockUserAgentMockRecorder
  • func (mr *MockUserAgentMockRecorder) Do(ctx, req, skip interface{}) *gomock.Call
  • func (mr *MockUserAgentMockRecorder) Log(ctx, resp, body interface{}) *gomock.Call
• type UserAgent
  • func NewUserAgent(cfg UserAgentConfig) UserAgent
• type UserAgentConfig

Variables

var (
	ErrAccessTokenInvalid = errors.New("invalid AccessToken")
)

Errors.

Functions

func FromContext

func FromContext(ctx Ctx) (remoteIP, methodName string, auth dom.Auth)

FromContext returns values describing request stored in ctx, if any.

Types

type AccessToken

type AccessToken string

AccessToken is an access token.

func AccessTokenFromContext

func AccessTokenFromContext(ctx Ctx) (accessToken AccessToken)

AccessTokenFromContext returns AccessToken stored in ctx, if any.

func (AccessToken) Format

func (s AccessToken) Format(f fmt.State, c rune)

Format wraps sensitive.String.

func (AccessToken) MarshalJSON

func (s AccessToken) MarshalJSON() ([]byte, error)

MarshalJSON wraps sensitive.String.

func (AccessToken) MarshalText

func (s AccessToken) MarshalText() ([]byte, error)

MarshalText wraps sensitive.String.

type Authn

type Authn interface {
	// Authenticate validates AccessToken and returns corresponding
	// Auth. If validation fails returns zero Auth with error.
	//
	// Errors: ErrAccessTokenInvalid.
	Authenticate(Ctx, AccessToken) (dom.Auth, error)
}

Authn validates AccessToken.

func NewAuthnClient

func NewAuthnClient(
	ctx Ctx,
	reg *prometheus.Registry,
	service string,
	ca *x509.CertPool,
	addr string,
) (Authn, error)

NewAuthnClient returns Authn implementation using gRPC AuthIntSvc at addr.

type Ctx

type Ctx = context.Context

func GRPCNewContext

func GRPCNewContext(ctx Ctx, fullMethod string, authn Authn) (_ Ctx, auth dom.Auth, err error)

GRPCNewContext returns a new context.Context that carries values describing this request without any deadline, plus result of authn.Authenticate.

type JSONRPC2Ctx

type JSONRPC2Ctx struct {
	AccessToken string
	jsonrpc2.Ctx
}

JSONRPC2Ctx describe JSON-RPC 2.0 Ctx param used by all API methods.

func (*JSONRPC2Ctx) NewContext

func (c *JSONRPC2Ctx) NewContext(
	authn Authn,
	service string,
) (
	ctx Ctx,
	log *structlog.Logger,
	methodName string,
	auth dom.Auth,
	err error,
)

NewContext returns a new context.Context that carries values describing this request without any deadline, plus some of the values.

type MockAuthn

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

MockAuthn is a mock of Authn interface.

func NewMockAuthn

func NewMockAuthn(ctrl *gomock.Controller) *MockAuthn

NewMockAuthn creates a new mock instance.

func (*MockAuthn) Authenticate

func (m *MockAuthn) Authenticate(arg0 Ctx, arg1 AccessToken) (dom.Auth, error)

Authenticate mocks base method.

func (*MockAuthn) EXPECT

func (m *MockAuthn) EXPECT() *MockAuthnMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

type MockAuthnMockRecorder

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

MockAuthnMockRecorder is the mock recorder for MockAuthn.

func (*MockAuthnMockRecorder) Authenticate

func (mr *MockAuthnMockRecorder) Authenticate(arg0, arg1 interface{}) *gomock.Call

Authenticate indicates an expected call of Authenticate.

type MockUserAgent

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

MockUserAgent is a mock of UserAgent interface.

func NewMockUserAgent

func NewMockUserAgent(ctrl *gomock.Controller) *MockUserAgent

NewMockUserAgent creates a new mock instance.

func (*MockUserAgent) Do

func (m *MockUserAgent) Do(ctx Ctx, req *http.Request, skip int) (*http.Response, []byte, error)

Do mocks base method.

func (*MockUserAgent) EXPECT

func (m *MockUserAgent) EXPECT() *MockUserAgentMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockUserAgent) Log

func (m *MockUserAgent) Log(ctx Ctx, resp *http.Response, body []byte)

Log mocks base method.

type MockUserAgentMockRecorder

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

MockUserAgentMockRecorder is the mock recorder for MockUserAgent.

func (*MockUserAgentMockRecorder) Do

func (mr *MockUserAgentMockRecorder) Do(ctx, req, skip interface{}) *gomock.Call

Do indicates an expected call of Do.

func (*MockUserAgentMockRecorder) Log

func (mr *MockUserAgentMockRecorder) Log(ctx, resp, body interface{}) *gomock.Call

Log indicates an expected call of Log.

type UserAgent

type UserAgent interface {
	// Do sends an HTTP request and returns an HTTP response.
	// It returns body for convenience - it's same as can be read from resp.Body.
	// It saves body to file if log level is Debug and cfg.Debug and cfg.DumpDir is set.
	// Returned resp.Body doesn't needs to be closed.
	Do(ctx Ctx, req *http.Request, skip int) (_ *http.Response, body []byte, _ error)
	// Log resp (both HTTP request and response).
	// It does nothing if cfg.Debug is false.
	Log(ctx Ctx, resp *http.Response, body []byte)
}

UserAgent is a convenience wrapper for http.Client, suitable for fetching small responses (because it reads full response in memory).

func NewUserAgent

func NewUserAgent(cfg UserAgentConfig) UserAgent

NewUserAgent creates and returns new UserAgent.

type UserAgentConfig

type UserAgentConfig struct {
	Timeout     time.Duration // Default: 30s.
	MaxBodySize int           // Default: 1MB.
	Debug       bool          // Log response.
	DumpDir     string        // If not empty and Debug - dump response body to files in this dir.
}

UserAgentConfig contains configuration for UserAgent.