api

Documentation

Index

• func CreateSessionHandlerFunc(sessionCache Cache) http.HandlerFunc
• func DeleteAllSessionsHandlerFunc(cache Cache) http.HandlerFunc
• func GetByEmailSessionHandlerFunc(sessionCache Cache, getVarsFunc GetVarsFunc) http.HandlerFunc
• func GetByIDSessionHandlerFunc(sessionCache Cache, getVarsFunc GetVarsFunc) http.HandlerFunc
• type API
  • func Setup(ctx context.Context, r *mux.Router, permissions AuthHandler, cache Cache) *API
  • func (*API) Close(ctx context.Context) error
• type AuthHandler
• type Cache
• type GetVarsFunc
• type SessionUpdater

Functions

func CreateSessionHandlerFunc

func CreateSessionHandlerFunc(sessionCache Cache) http.HandlerFunc

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

func DeleteAllSessionsHandlerFunc

func DeleteAllSessionsHandlerFunc(cache Cache) http.HandlerFunc

func GetByEmailSessionHandlerFunc

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

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

Types

type API

type API struct {
	Router *mux.Router
}

API provides a struct to wrap the api around

func Setup

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

func (*API) Close

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

type AuthHandler

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

AuthHandler interface for adding auth to endpoints

type Cache

type Cache cache.SessionCache

type GetVarsFunc

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

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

SessionUpdater interface for updating a session