session

type AllSessions struct {
	CurrentSession *Session
	OtherSessions  SessionCollection
}

type Auther interface {
	// APIKeyAuth implements the authorization logic for the APIKey security scheme.
	APIKeyAuth(ctx context.Context, key string, schema *security.APIKeyScheme) (context.Context, error)
	// JWTAuth implements the authorization logic for the JWT security scheme.
	JWTAuth(ctx context.Context, token string, schema *security.JWTScheme) (context.Context, error)
}

type CleanLoginTokenPayload struct {
	Authorization *string
	XSession      *string
	APIKey        *string
}

type CleanMergeTokenPayload struct {
	Authorization *string
	XSession      *string
	APIKey        *string
}

type CleanSessionsPayload struct {
	Authorization *string
	XSession      *string
	APIKey        *string
}

type Client struct {
	RefreshEndpoint         goa.Endpoint
	LogoutEndpoint          goa.Endpoint
	LogoutOtherEndpoint     goa.Endpoint
	LogoutSpecificEndpoint  goa.Endpoint
	GetSessionsEndpoint     goa.Endpoint
	RedeemTokenEndpoint     goa.Endpoint
	CleanSessionsEndpoint   goa.Endpoint
	CleanLoginTokenEndpoint goa.Endpoint
	CleanMergeTokenEndpoint goa.Endpoint
}

type Endpoints struct {
	Refresh         goa.Endpoint
	Logout          goa.Endpoint
	LogoutOther     goa.Endpoint
	LogoutSpecific  goa.Endpoint
	GetSessions     goa.Endpoint
	RedeemToken     goa.Endpoint
	CleanSessions   goa.Endpoint
	CleanLoginToken goa.Endpoint
	CleanMergeToken goa.Endpoint
}

type GetSessionsPayload struct {
	Authorization *string
	XSession      *string
	APIKey        *string
}

type LogoutOtherPayload struct {
	Authorization *string
	XSession      *string
	APIKey        *string
}

type LogoutPayload struct {
	Authorization *string
	XSession      *string
	APIKey        *string
}

type LogoutSpecificPayload struct {
	SessionID     *string
	Authorization *string
	XSession      *string
	APIKey        *string
}

type RedeemTokenPayload struct {
	// A merge token for merging into an account
	Token     string
	UserAgent *string
	APIKey    *string
}

type RedeemTokenResult struct {
	Authorization *string
	XSession      *string
}

type RefreshPayload struct {
	XSession *string
	APIKey   *string
}

type RefreshResult struct {
	Authorization *string
	XSession      *string
}

type Service interface {
	// Take a user's session token and refresh it, also returns a new
	// authentication token
	Refresh(context.Context, *RefreshPayload) (res *RefreshResult, err error)
	// Takes a user's auth token, and logs-out the session associated with it
	Logout(context.Context, *LogoutPayload) (err error)
	// Logout all sessions for the current user except their current session
	LogoutOther(context.Context, *LogoutOtherPayload) (err error)
	// Logout of a specific session
	LogoutSpecific(context.Context, *LogoutSpecificPayload) (err error)
	// Gets all of the sessions that are associated with the currently logged in
	// user
	GetSessions(context.Context, *GetSessionsPayload) (res *AllSessions, err error)
	// Redeems a login token for credentials
	RedeemToken(context.Context, *RedeemTokenPayload) (res *RedeemTokenResult, err error)
	// Deletes all the sessions that have expired
	CleanSessions(context.Context, *CleanSessionsPayload) (err error)
	// Cleans old login tokens from the database
	CleanLoginToken(context.Context, *CleanLoginTokenPayload) (err error)
	// Cleans old account merge tokens from the database
	CleanMergeToken(context.Context, *CleanMergeTokenPayload) (err error)
}

type Session struct {
	// Unique unchanging session ID
	ID string
	// ID of the user this session is for
	UserID string
	// Time that this session was last used
	LastUsed string
	// The browser and browser version connected with this session
	Browser string
	// The OS of the system where this session was used
	Os string
	// The last IP address where this session was used
	IP string
	// A humanReadable string describing the last known location of the session
	Location string
	// The latitude of the last known location of the session
	Latitude string
	// The longitude of the last known location of the session
	Longitude string
	// Whether the session was from a mobile device
	IsMobile bool
	// The URL of the Google map to show the location, suitable for using in an img
	// tag
	MapURL string
}

type SessionCollection []*Session