vsec

type AuthLevel int

type Group struct {
	OID   bson.ObjectId `json:"_id" bson:"_id"`
	Name  string        `json:"name" bson:"name"`
	Users []string      `json:"users" bson:"users"`
}

type User struct {
	OID         bson.ObjectId `json:"_id" bson:"_id,omitempty"`
	ID          string        `json:"id" bson:"id"`
	Email       string        `json:"email" bson:"email"`
	Auth        AuthLevel     `json:"auth" bson:"auth"`
	FirstName   string        `json:"firstName" bson:"firstName"`
	LastName    string        `json:"lastName" bson:"lastName"`
	Title       string        `json:"title" bson:"title"`
	FullName    string        `json:"fullName" bson:"fullName"`
	State       UserState     `json:"state" bson:"state"`
	VerID       string        `json:"verID" bson:"verID"`
	PwdExpiry   time.Time     `json:"pwdExpiry" bson:"pwdExpiry"`
	Created     time.Time     `json:"created" bson:"created"`
	Modified    time.Time     `json:"modified" bson:"modified"`
	VerfiedDate time.Time     `json:"verified" bson:"verified"`
	Props       bson.M        `json:"props" bson:"props"`
}

type UserState string

type UserStorage interface {
	//CreateUser - creates user in database
	CreateUser(user *User) (err error)

	//UpdateUser - updates user in database
	UpdateUser(user *User) (err error)

	//DeleteUser - deletes user with given user ID
	DeleteUser(userID string) (err error)

	//GetUser - gets details of the user corresponding to ID
	GetUser(userID string) (user *User, err error)

	//GetAllUsers - gets all users based on offset and limit
	GetUsers(offset int,
		limit int,
		filter *vcmn.Filter) (users []*User, err error)

	//GetCount - gives the number of user selected by given filter
	GetCount(filter *vcmn.Filter) (count int, err error)

	//GetUsersWithCount - gives a list of users paged with total count
	GetUsersWithCount(offset int,
		limit int,
		filter *vcmn.Filter) (total int, users []*User, err error)

	//ResetPassword - sets password of a unauthenticated user
	ResetPassword(userID, oldPwd, newPwd string) (err error)

	//SetPassword - sets password of a already authenticated user, old password
	//is not required
	SetPassword(userID, newPwd string) (err error)

	//ValidateUser - validates user ID and password
	ValidateUser(userID, password string) (err error)

	//GetUserAuthLevel - gets user authorization level
	GetUserAuthLevel(userID string) (level AuthLevel, err error)

	//CreateSuperUser - creates the first super user for the application
	CreateSuperUser(user *User, password string) (err error)

	//SetUserState - sets state of an user account
	SetUserState(userID string, state UserState) (err error)

	//VerifyUser - sets state of an user account to verified based on userID
	//and verification ID
	VerifyUser(userID, verID string) (err error)

	//CreateIndices - creates mongoDB indeces for tables used for user management
	CreateIndices() (err error)

	//CleanData - cleans user management related data from database
	CleanData() (err error)

	//UpdateProfile - updates user details - this should be used when user
	//logged in is updating own user account
	UpdateProfile(user *User) (err error)
}