api

package

v0.0.0-...-7360598 Latest Latest Go to latest Published: Dec 13, 2022 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (
	ErrRankNonNumeric = errors.New("must be a number")
	ErrRankInvalid    = errors.New("must be a positive number")
)

func AucBotContext(r *http.Request) *model.AucBotContext

func NewBotHTTPRouter(apiConfig model.APIConfig, patch model.RecipeVersion, accessors *Accessors, abh *handlers.AucBot) http.Handler

NewBotHTTPRouter creates an instrumented router for serving http requests

func NewChiRouter(apiConfig model.APIConfig, patch model.RecipeVersion, accessors *Accessors, abh *handlers.AucBot) *chi.Mux

type Accessors struct {
	DbAccessor   *db.Accessor
	BnetAccessor *bnet.Accessor

	EnableValuationFunctions bool
}

Accessors holds data sources shared by all API routes

type AucbotMiddleware struct {
	R *render.Render
}

func (m *AucbotMiddleware) AucBotContext(generateCID bool, patch model.RecipeVersion) func(next http.Handler) http.Handler

AucBotContext adds the context object and requestID

func (m *AucbotMiddleware) BasicAuth(tokens model.HTTPAuth) func(next http.Handler) http.Handler

BasicAuth is middleware authenticating with basic auth

func (m *AucbotMiddleware) Realm(bnet *bnet.Accessor) func(next http.Handler) http.Handler

Realm extracts the realm from the path parameter

func (m *AucbotMiddleware) RequiredQueryParams(requiredParams ...string) func(next http.Handler) http.Handler

RequiredQueryParams denies requests that do not include the given query params

func (m *AucbotMiddleware) Session() func(next http.Handler) http.Handler

Session constructs a session from other context values

type Session struct {
	AucBotContext *model.AucBotContext
	RequestID     string
	RealmSlug     string
	Region        string
}

Session is an API layer implementation of Session

func (a Session) AccessTypeTag() model.AccessTypeTag

func (a Session) ChannelID() string

func (a Session) ChannelSessionID() string

func (a Session) Context() *model.AucBotContext

func (a Session) MessageID() string

func (a Session) SetToken(token string)

func (a Session) Token() string

func (a Session) UserSessionID() string

func (a Session) Username() string