storage

type Devices interface {
	New(ctx context.Context, userID string, d models.Device) (string, error)
	OfUser(ctx context.Context, userID string) ([]models.Device, error)
	Read(ctx context.Context, id string) (*models.Device, error)
	All(ctx context.Context) ([]models.Device, error)
	Remove(ctx context.Context, id string) error
}

type Factory interface {
	Users() Users
	Devices() Devices
	TwoFactor() TwoFactor
}

type OnlineUsers interface {
	// All returns slice of online users identifiers.
	All(ctx context.Context) ([]string, error)

	// Update pushes new list with IDs of online users.
	// Old identifiers will be replaced.
	Update(ctx context.Context, ids []string) error

	// IsOnline return true if user with given ID is currently online.
	IsOnline(ctx context.Context, id string) (bool, error)
}

type Status interface {
	// OnlineUsers returns number of people being
	// currently online.
	OnlineUsers(ctx context.Context) (int, error)

	// SetOnlineUsers ovewrites number of people being
	// currently online.
	SetOnlineUsers(ctx context.Context, number int) error

	// UnknownDevices returns number of unknown devices
	// connected to the network.
	UnknownDevices(ctx context.Context) (int, error)

	// SetUnknownDevices overwrites number of unknown devices
	// connected to the network.
	SetUnknownDevices(ctx context.Context, number int) error
}

type StatusTx interface {
	// DevicesStatus accepts function that manipulates number of
	// unknown devices and online users in single safe transaction.
	DevicesStatus(context.Context, func(context.Context, Status) error) error
}

type TwoFactor interface {
	// Get returns two factor methods for user with given user ID.
	Get(ctx context.Context, userID string) (*models.TwoFactor, error)

	// Updates apply given function to two factor methods of user
	// with given user ID.
	Update(ctx context.Context, userID string, f func(*models.TwoFactor) error) error

	// Remove deletes all two factor methods of user with given
	// user ID. You can still use Update method after all to start
	// adding more methods.
	Remove(ctx context.Context, userID string) error
}

type UpdateStatusesArgs struct {
	Addresses          []net.HardwareAddr
	DevicesStorage     Devices
	OnlineUsersStorage OnlineUsers
	Counters           StatusTx
}

type UserAdapter struct {
	OnlineUsersStorage OnlineUsers
}

type UserEntry struct {
	// ID unique to every user.
	ID string

	// Nickname represents name that will be exposed to public,
	// to inform people who is in the hackerspace.
	Nickname string

	// HashedPassword with bcrypt algorithm.
	HashedPassword []byte

	// Private is flag for enabling private-mode that hides
	// user activity from others.
	Private bool
}

type Users interface {
	// New stores given user data in database and returns
	// assigned id.
	New(ctx context.Context, u UserEntry) (string, error)
	Read(ctx context.Context, id string) (*UserEntry, error)
	All(ctx context.Context) ([]UserEntry, error)
	Remove(ctx context.Context, id string) error
	Update(ctx context.Context, id string, f func(*UserEntry) error) error
}