users

Documentation

Index

• type Handle
• type Module
  • func (m *Module) ErrorHandler(rw http.ResponseWriter, req *http.Request, err error)
  • func (m *Module) Init(c *service.Config)
  • func (m *Module) MustWithAuth(delegate Handle) Handle

Types

type Handle

type Handle func(rw http.ResponseWriter, req *http.Request, par httprouter.Params) error

Handle is similar to httprouter.Handle, except it returns an error which can be handled separately.

type Module

type Module struct {
	Auth     *users.Module
	Sessions *session.Module
	Config   *config.Module
	Router   *router.Module
	DB       *db.Module
	Logger   *logger.Module

	// todo: make these pluggable?
	DBAuth    *databaseauth.Module
	TokenAuth *tokenauth.Module
}

Module users is a largely a wrapper around nagax/users/databaseauth to enable user logins.

func (*Module) ErrorHandler

func (m *Module) ErrorHandler(rw http.ResponseWriter, req *http.Request, err error)

ErrorHandler to handle auth errors. todo: return more fine-grained error codes.

func (*Module) Init

func (m *Module) Init(c *service.Config)

Init implements service.Init

func (*Module) MustWithAuth

func (m *Module) MustWithAuth(delegate Handle) Handle

MustWithAuth wraps a Handle function and requires a logged in user. The new handler will authenticate using the auth module, creating another wrapper for the original function to make it compatible with http.HandlerFunc (while ensuring it closes over httprouter.Params).