api

package

v1.1.0 Latest Latest Go to latest Published: Feb 16, 2021 License: MIT Imports: 10 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.

This section is empty.

func CreateSessionHandlerFunc(sessionCache Cache) http.HandlerFunc

CreateSessionHandlerFunc returns HTTP HandlerFunc for handling POST requests to create sessions.

func DeleteAllSessionsHandlerFunc(cache Cache) http.HandlerFunc

func GetByEmailSessionHandlerFunc(sessionCache Cache, getVarsFunc GetVarsFunc) http.HandlerFunc

GetByEmailSessionHandlerFunc returns a HTTP HandlerFunc that attempts to retrieve an existing session by Email from the cache

func GetByIDSessionHandlerFunc(sessionCache Cache, getVarsFunc GetVarsFunc) http.HandlerFunc

GetByIDSessionHandlerFunc returns a HTTP HandlerFunc that attempts to retrieve an existing session by ID from the cache

type API struct {
	Router *mux.Router
}

API provides a struct to wrap the api around

func Setup(ctx context.Context, r *mux.Router, permissions AuthHandler, cache Cache) *API

func (*API) Close(ctx context.Context) error

type AuthHandler interface {
	Require(required auth.Permissions, handler http.HandlerFunc) http.HandlerFunc
}

AuthHandler interface for adding auth to endpoints

type Cache cache.SessionCache

type GetVarsFunc func(r *http.Request) map[string]string

GetVarsFunc is a helper function that returns a map of request variables and parameters

type SessionUpdater interface {
	Update(email string) (*session.Session, error)
}

SessionUpdater interface for updating a session

Path	Synopsis
mock