auth

type Credentials interface {
	GetProtocol() string
	GetIdentifier() string
	GetPassword() string
	GetHost() string
	GetPort() string
}

type Endpoints struct {
	Login          string `json:"login"`
	Logout         string `json:"logout"`
	Profile        string `json:"profile"`
	ForgetPassword string `json:"forget_password"`
	Register       string `json:"register"`
}

type Options struct {
	AuthKey     string `json:"auth_key"`
	GuardianLib string `json:"guardian_lib"`
}

type Provider interface {
	// Name returns the name of provider
	Name() string

	// Options returns the provider options
	Options() *Options

	// SetOptions sets the provider options
	SetOptions(options *Options)

	// Endpoints returns the provider endpoints
	Endpoints() *Endpoints

	// SetEndpoints sets the provider endpoints
	SetEndpoints(endpoints *Endpoints)

	// Session returns a Session
	Session(req *http.Request) (Session, error)
}

type ProviderFn func() Provider

type Providers map[string]Provider

type Session interface {
	// User returns the user info
	User() *User

	// IsAllowed returns whether user can perform an action
	IsAllowed(action string) bool
}

type User struct {
	RawData   map[string]interface{} `json:"raw_data"`
	Provider  string                 `json:"provider"` // Provider name
	Token     string                 `json:"-"`        // :sensitive:
	UserID    string                 `json:"user_id"`
	Username  string                 `json:"username"`
	Email     string                 `json:"email"`
	AvatarURL string                 `json:"avatar_url"`
	FirstName string                 `json:"first_name"`
	LastName  string                 `json:"last_name"`
	Location  string                 `json:"location"`
	Types     []string               `json:"types"`   // `Roles` for some Providers
	Actions   []string               `json:"actions"` // `Permissions` for some Providers
}