cloud

type Attributes = sparks.Params

type AuthToken interface {
	// ID returns the token identifier
	ID() string

	// ClientID returns the OAuth client identity
	ClientID() string

	// Username() returns the user for the token or empty if no user is associated
	Username() string

	// ExpiresAt returns the token expiration time
	ExpiresAt() int64

	// Scope returns the scopes the token has
	Scope() []string

	// Returns the token use, i.e. access, identity, etc.
	Use() string

	// Claims returns the token claims
	Claims() Claims

	// String returns the string value of the token as a signed JWT
	String() string

	// Retunrs a context from the token
	Context(context.Context) context.Context
}

type Claims = Params

type ContextKey string

type NewFunc func(params Params) (Provider, error)

type ObjectProvider interface {
	// OpenObjectStore store returns an object store with the given name and parameter
	OpenObjectStore(name string, params Params) (ObjectStore, error)
}

type ObjectStore interface {
	// GetObject returns an io.Reader that allows for getting the object data
	GetObject(key string, params ...Params) (io.Reader, error)

	// GetObjectURL returns a secure url to the object
	GetObjectURL(key string, timeout time.Duration, write ...bool) (string, error)

	// PutObject set the value
	PutObject(key string, r io.Reader, params ...Params) error

	// DeleteObject deletes and object
	DeleteObject(key string, params ...Params) error

	// Name returns the object store name
	Name() string
}

type Params = sparks.Params

type Provider interface {
	// ProxyHTTP handles incoming cloud events, proxying them to the virtual http.Handler
	ProxyHTTP(http.Handler) error

	// Close is called to cleanup the provider
	Close()
}

type Queue interface {
	// Publish publishes the message body with optioanl attributes and return the id
	Publish(body []byte, attributes ...Attributes) (string, error)
}

type QueueProvider interface {
	OpenQueue(name string, params Params) (Queue, error)
}

type TokenValidationError error

type User interface {
	// Login returns the user login i.e. username
	Login() string

	// Attributes returns a map of user attributes
	Attributes() types.StringMap

	// Status returns the user status as a string
	Status() string

	// Enabled represents the user's status
	Enabled() bool

	// Groups returns a list of groups the user belongs to
	Groups() []string
}

type UserPool interface {
	// AuthenticateUser authenticates the user and returns an AuthToken
	AuthenticateUser(username, password string) (AuthToken, error)

	// AuthorizeToken takes the signed JWT string, parses and validates it returning an AuthToken
	AuthorizeToken(token string, scopes ...[]string) (AuthToken, error)

	// CreateUser creates a new user
	CreateUser(username, password string, attributes map[string]string, options ...Params) (User, error)

	// ChangeUserPassword attempts to change the users password from current to the proposed
	ChangeUserPassword(username, current, proposed string) error

	// GetUser returns a user
	GetUser(username string) (User, error)

	// UpdateUser updates a users attributes
	UpdateUser(username string, attributes types.StringMap) error

	// DeleteUser deletes a user record
	DeleteUser(username string) error

	// DisableUser disables a user account
	DisableUser(username string) error
}

type UserProvider interface {
	// OpenUserPool returns a user pool with the given name and parameters
	OpenUserPool(name string, params Params) (UserPool, error)
}