userbase

type Action string

type Actions []Action

type AuthProvider interface {
	AuthenticateRequest(w http.ResponseWriter, r *http.Request) (handled bool, modified *http.Request)
}

type AuthUser struct {
	RID     string            `json:"real-id"`
	EID     string            `json:"enjin-id"`
	Name    string            `json:"name"`
	Email   string            `json:"email"`
	Image   string            `json:"image"`
	Origin  string            `json:"origin"`
	Context beContext.Context `json:"context"`
}

type AuthUserApi interface {
	RequireApiUser(next http.Handler) http.Handler
	RequireUserCan(action Action) func(next http.Handler) http.Handler
}

type AuthUserManager interface {
	// NewAuthUser constructs a new AuthUser instance and saves it to the
	// userbase
	NewAuthUser(eid, name, email, picture, audience string, attributes map[string]interface{}) (user *AuthUser, err error)

	// SetAuthUser writes the given User to the system
	SetAuthUser(user *AuthUser) (err error)

	// RemoveAuthUser deletes a user from the system
	RemoveAuthUser(eid string) (err error)
}

type AuthUserProvider interface {
	// AuthUserPresent returns true if a user with the EID given is present
	AuthUserPresent(eid string) (present bool)

	// GetAuthUser returns the user by user.EID
	GetAuthUser(eid string) (user *AuthUser, err error)
}

type Group string

type Groups []Group

type GroupsManager interface {
	// GetGroupActions returns the list of actions associated with group
	GetGroupActions(group Group) (actions Actions)

	// UpdateGroup appends the given actions to the group, creating the group
	// if non exists
	UpdateGroup(group Group, actions ...Action) (err error)

	// RemoveGroup deletes the given group from the system. Does not delete any
	// fallback groups
	RemoveGroup(group Group) (err error)

	// AddUserToGroup adds a user to the list of groups given
	AddUserToGroup(eid string, groups ...Group) (err error)

	// RemoveUserFromGroup removes a user from each of the given groups
	RemoveUserFromGroup(eid string, groups ...Group) (err error)
}

type GroupsProvider interface {
	// IsUserInGroup returns true if the user is in the given group
	IsUserInGroup(eid string, group Group) (present bool)

	// GetUserGroups returns the user's list of groups
	GetUserGroups(eid string) (groups Groups)
}

type Manager interface {
	AuthUserProvider
	AuthUserManager
	UserProvider
	UserManager
	GroupsProvider
	GroupsManager
}

type SecretsProvider interface {
	// GetUserSecret returns the user's password hash, returns "" if the user
	// secret is not found
	GetUserSecret(id string) (hash string)
}

type User struct {
	page.Page
	AuthUser

	Origin string `json:"origin"`

	Groups  Groups  `json:"-"`
	Actions Actions `json:"-"`
}

type UserActionsProvider interface {
	UserActions() (list Actions)
}

type UserManager interface {
	// NewUser constructs a new User instance and adds it to the userbase
	NewUser(au *AuthUser) (user *User, err error)

	// SetUser writes the given User to the system
	SetUser(user *User) (err error)

	// RemoveUser deletes a user from the system
	RemoveUser(eid string) (err error)
}

type UserProvider interface {
	// GetUser returns the user by enjin ID
	GetUser(eid string) (user *User, err error)
}

type UsersManager interface {
	UserProvider
	UserManager
}