rest

type Client struct {
	*http.Client

	// Host is the address of the remote REST endpoint where requests should be
	// sent to.
	Host string

	// Root is a prefix that will be preprended to all path requests created by
	// this client.
	Root string

	// Header is a list of HTTP requests that will be added to every requests
	// originating from this client.
	Header http.Header

	// GzipLevel is used to compress requests to a certain level, using gzip.
	GzipLevel int

	// Limit sets a hard limit on the number of concurrent requests. If not set
	// then no limits are imposed.
	Limit uint
	// contains filtered or unexported fields
}

type CodedError struct {
	Code int
	Sub  error
}

type Error struct {
	// Type is the type of the error.
	Type ErrorType

	// Sub is the wrapped error.
	Sub error
}

type ErrorType string

type Mux struct {

	// Root is the path prefix of all the routes to be matched by this
	// mux. Must be set before calling Init and can't be changed
	// afterwards.
	Root string

	// ErrorFunc is called for all errors that passes through this mux. The
	// returned value will overwrite the current error and will be returned to
	// the client instead.. If it's return value is a rest.CodedError then the
	// status code of the error object will be used.
	ErrorFunc func(ErrorType, error) error

	DefaultHandler http.Handler
	// contains filtered or unexported fields
}

type Path []PathItem

type PathItem struct {
	Name  string
	IsArg bool
}

type Request struct {

	// REST is the client that originated the request. Can be nil.
	REST *Client

	// Client is the http.Client used to send the request. Defaults to
	// http.DefaultClient and can changed via the SetClient method.
	Client *http.Client

	// Host is the address of the remote REST endpoint where requests should be
	// sent to.
	Host string

	// Root is a prefix that will be preprended to all path requests created by
	// this client.
	Root string

	// Path is the absolute path where the Request should be routed to on the
	// remote endpoint. Can be changed via the SetPath method.
	Path string

	// Query contains the url parameters and values that will be sent with the
	// request. Paramerters can be added via the AddParam method.
	Query url.Values

	// Method is the HTTP verb used for the HTTP request.
	Method string

	// Header contains all the headers to be added to the HTTP request. Can be
	// changed via the AddHeader method.
	Header http.Header

	// GzipLevel is used to compress requests using gzip.
	GzipLevel int

	// Body is the JSON serialized body of the HTTP request. Can be set via the
	// SetBody method.
	Body []byte

	HTTP *http.Request
	// contains filtered or unexported fields
}

type Response struct {

	// Request is the request that originated the response.
	Request *Request

	// Code is the http status code returned by the endpoint.
	Code int

	// Header holds the headers of the HTTP response.
	Header http.Header

	// Body holds the raw unmarshalled body of the HTTP response. GetBody can be
	// used to unmarshal the body.
	Body []byte

	// Error is set if an error occured while sending the request.
	Error *Error

	// Latency indicates how long the request round-trip took.
	Latency time.Duration
}

type Routable interface {

	// RESTRoutes returns a list of Route that can be used for routing REST
	// requests.
	RESTRoutes() Routes
}

type Route struct {

	// Path is the templated path required by this route. See Handler for the
	// rules related to path.
	Path Path

	// Method represents the HTTP verb required by this route.
	Method string

	// Handler is a function to be invoked whenever for a given HTTP method and
	// templated path.
	//
	// The function can only return at most 2 values where one will be an error
	// object and the other will be the body of the HTTP response.
	//
	// The function needs enough arguments to accept the Path arguments and,
	// optionally, the body of the request. The path arguments will be applied
	// in the same order as the function arguments with the last function
	// argument being the body.
	//
	// If any of the previous rules are broken, Route will panic when Init is
	// called.
	Handler interface{}

	// GzipLevel is used to set the response gzip compression level.
	GzipLevel int
	// contains filtered or unexported fields
}

type Routes []*Route