common

type Context interface {
	// Bind is a helper function which binds the request body to a provided value to be parsed as JSON
	Bind(value interface{}) (err error)
	// Param will return the associated parameter value with the provided key
	Param(key string) (value string)
	// AddHook will append a new hook to the Context
	AddHook(hook Hook)

	// Get will retrieve a value for a provided key from the Context's internal storage
	Get(key string) (value string)
	// Put will set a value for a provided key into the Context's internal storage
	Put(key, value string)

	// WriteString will write as a string value
	WriteString(status int, contentType, str string)
	// WriteBytes will write as a byteslice value
	WriteBytes(status int, contentType string, str []byte)
	// WriteReader will write as a reader value
	WriteReader(status int, contentType string, r io.Reader)
	// WriteJSON will write as JSON
	WriteJSON(status int, value interface{})
	// WriteNoContent will write a no content response
	WriteNoContent()
	// Redirect will redirect the client
	Redirect(status int, destination string)

	// Request will return the underlying http.Request
	Request() (req *http.Request)
	// Writer will return the underlying response writer.
	Writer() (writer http.ResponseWriter)
}

type Group interface {
	GET(route string, hs ...Handler)
	POST(route string, hs ...Handler)
	PUT(route string, hs ...Handler)
	DELETE(route string, hs ...Handler)
	OPTIONS(route string, hs ...Handler)

	Group(route string, hs ...Handler) Group
	Handle(method, route string, hs ...Handler)
}

type Handler func(ctx Context)

type Hook func(statusCode int, ctx Context)

type Plugins interface {
	Backend(key string, val interface{}) error
}

type Response struct {
	StatusCode  int
	ContentType string
	Value       interface{}

	// Optional fields used by a minority of responses
	Adopted  bool
	Callback string
}