common

type AuthServerError struct {
	ErrorMessage string
	Response     *http.Response
}

type Config struct {
	objx.Map
}

type Credentials struct {
	objx.Map
}

type MissingParameterError struct {
	ParameterName string
}

type MissingProviderError struct {
	ProviderName string
}

type Provider interface {
	codecs.Facade

	// Name is the unique name for this provider.
	Name() string

	// DisplayName is a human readable name for the provider.
	DisplayName() string

	// GetBeginAuthURL gets the URL that the client must visit in order
	// to begin the authentication process.
	//
	// The state argument contains anything you wish to have sent back to your
	// callback endpoint.
	// The options argument takes any options used to configure the auth request
	// sent to the provider.
	GetBeginAuthURL(state *State, options objx.Map) (string, error)

	// CompleteAuth takes a map of arguments that are used to
	// complete the authorisation process, completes it, and returns
	// the appropriate Credentials.
	CompleteAuth(data objx.Map) (*Credentials, error)

	// GetUser uses the specified Credentials to access the users profile
	// from the remote provider, and builds the appropriate User object.
	GetUser(creds *Credentials) (User, error)

	// Get makes an authenticated request and returns the data in the
	// response as a data map.
	Get(creds *Credentials, endpoint string) (objx.Map, error)

	// GetClient gets an http.Client authenticated with the specified
	// Credentials.
	GetClient(creds *Credentials) (*http.Client, error)
}

type ProviderList interface {

	// Providers gets all registered Provider objects.
	Providers() []Provider

	// Provider gets a provider by name, or returns a MissingProviderError
	// if no provider with that name is registered.
	Provider(name string) (Provider, error)
}

type State struct {
	objx.Map
}

type Tripper interface {
	http.RoundTripper
	// Credentials gets the authentication credentials that
	// this Tripper will use.
	Credentials() *Credentials

	// Provider gets the Provider that this tripper will make
	// requests to.
	Provider() Provider
}

type TripperFactory interface {
	NewTripper(*Credentials, Provider) (Tripper, error)
}

type User interface {
	// Email gets the users email address.
	Email() string

	// Name gets the users full name.
	Name() string

	// Nickname gets the users nickname or username.
	Nickname() string

	// AvatarURL gets the URL of an image representing the user.
	AvatarURL() string

	// ProviderCredentials gets a map of Credentials (by provider name).
	ProviderCredentials() map[string]*Credentials

	// IDForProvider gets the ID value for the specified provider name for
	// this user from the ProviderCredentials data.
	IDForProvider(provider string) string

	// AuthCode gets this user's globally unique ID (generated by the host program)
	AuthCode() string

	// Data gets the underlying data that makes up this User.
	Data() objx.Map
}