grunway

type Account struct {
	// System fields
	PKey int64 `meddler:"pkey,pk"`

	// User fields
	Name      string `meddler:"name"`
	Email     string `meddler:"email"`
	Passhash  []byte `meddler:"passhash"`
	PublicKey string `meddler:"publickey"`
	SecretKey string `meddler:"secretkey"`

	// Times
	Created   time.Time `meddler:"created,utctimez"`
	Modified  time.Time `meddler:"modified,utctimez"`
	LastLogin time.Time `meddler:"lastlogin,utctimez"`
}

type AccountStore interface {

	// Common startup, shutdown, utility methods
	Startup(attribs string) error
	Shutdown() error

	// CREATE
	// returns created account's accountid
	CreateAccount(name, email, password string) (*Account, error)

	// DELETE
	// returns true when pkey is valid account is successfully removed.  if no account with pkey, returns false
	// returns non-nil err on failure to execute
	DeleteAccount(pkey int64) (bool, error)

	// QUERY
	AllAccounts() ([]*Account, error)
	AccountWithId(pkey int64) (MaybeAccount, error)
	AccountWithEmail(q string) (MaybeAccount, error)
	AccountWithPublicKey(q string) (MaybeAccount, error)
	EmailAddressAvailable(email string) (bool, *deeperror.DeepError)

	// UPDATE
	ChangeUserEmail(pkey int64, newEmail string) error
	ChangeUserPassword(pkey int64, newPassword string) error
	UpdateUserLastLogin(pkey int64) (MaybeAccount, error)

	// AUTH
	Login(submittedEmail, submittedPassword string) (*Account, error)
}

type AuthHandler interface {
	PerformAuth(routePtr *Route, ctx *Context) (authenticationWasSucessful bool, failureToAuthErrorNum int)
	GetSecretKey(publicKey string) (secretKey string, errNum int)
}

type CommonLogger struct {
}

type Context struct {
	Req *http.Request // original http request
	End Endpoint      // parsed endpoint information

	// only populated after auth
	PublicKey string // for Auth'd requests, will be set to public key if Auth was successful, "" otherwise

	StatusCode    int // The http status code written out. Only populated after a write.
	ContentLength int // The number of bytes written out. Only populated after a write.
	// contains filtered or unexported fields
}

type CreatePerformer interface {
	CreatePayloadIsValid(ctx *Context, createRequestPayload Payload) *deeperror.DeepError
	PerformCreate(ctx *Context, createRequestPayload Payload) (responsePayload Payload, derr *deeperror.DeepError)
}

type CustomRouteResponse func(*Context)

type DeletePerformer interface {
	PerformDelete(ctx *Context) (didSucceed bool, errNo int64)
}

type DeleteValidator interface {
	DeleteRequestIsValid(ctx *Context) (isValid bool, errNo int64)
}

type Endpoint struct {
	VersionStr string
	EntityName string
	PrimaryKey int64
	Action     string
	Extras     []string
	// contains filtered or unexported fields
}

type ErrorInfo struct {
	ErrorNumber  int64  `json:"errorNumber,omitempty"`  // will be 0 on successful responses, non-zero otherwise
	ErrorMessage string `json:"errorMessage,omitempty"` // end-user appropriate error message
	DebugNumber  int64  `json:"debugNumber,omitempty"`  // optional debug code
	DebugMessage string `json:"debugMessage,omitempty"` // optional debug message
}

type MaybeAccount struct {
	// contains filtered or unexported fields
}

type MiddlewareProcessor interface {
	Process(routePtr *Route, ctx *Context) (terminateEarly bool, derr *deeperror.DeepError)
}

type Payload interface {
	PayloadType() string
}

type PayloadController interface {
}

type PayloadWrapper struct {
	Payloads PayloadsMap `json:",omitempty"` // key is type, value is list of payloads of that type

	ErrorInfo
	Alert string `json:",omitempty"` // used when the client end user needs to be alerted of something: (eg, maintenance mode, downtime, sercurity, required update, etc.)
}

type PayloadsMap map[string][]Payload

type PostProcessor interface {
	Process(ctx *Context) (terminateEarly bool, derr *deeperror.DeepError)
}

type Route struct {
	RequiresAuth  bool
	Authenticator AuthHandler

	Method         string
	Path           string
	VersionStr     string
	EntityName     string
	Action         string
	Handler        RouteHandler
	HandlerName    string // not actually used except for logging and debugging
	ControllerName string // not actually used except for logging and debugging
}

type RouteError struct {
	// contains filtered or unexported fields
}

type RouteHandler func(*Context) RouteHandlerResult

type RouteHandlerResult struct {
	// contains filtered or unexported fields
}

type Router struct {
	BasePath string

	MiddlewareProcessors []MiddlewareProcessor
	PostProcessors       []PostProcessor

	Controllers map[string]PayloadController // key is entity name
	RouteMap    map[string]*Route            // key is entity name
}

type UpdatePerformer interface {
	UpdatePayloadIsValid(ctx *Context, updateRequestPayload Payload) *deeperror.DeepError
	PerformUpdate(ctx *Context, updateRequestPayload Payload) (responsePayload Payload, derr *deeperror.DeepError)
}

type VersionUint uint16