service

Documentation

Index

• Constants
• func AddDateHeader(response rest.ResponseWriter)
• func CopyRequestTrace(sourceRequest *rest.Request, destinationRequest *http.Request) error
• func GetRequestAuthDetails(req *rest.Request) request.Details
• func GetRequestLogger(req *rest.Request) log.Logger
• func GetRequestTraceRequest(req *rest.Request) string
• func GetRequestTraceSession(req *rest.Request) string
• func QuoteIfString(interfaceValue interface{}) interface{}
• func SetRequestAuthDetails(req *rest.Request, details request.Details)
• func SetRequestErrors(req *rest.Request, errs []*Error)
• func SetRequestLogger(req *rest.Request, logger log.Logger)
• func SetRequestTraceRequest(req *rest.Request, traceRequest string)
• func SetRequestTraceSession(req *rest.Request, traceSession string)
• type API
• type Context
• type Error
  • func ErrorInternalServerFailure() *Error
  • func ErrorJSONMalformed() *Error
  • func ErrorTypeNotArray(value interface{}) *Error
  • func ErrorTypeNotBoolean(value interface{}) *Error
  • func ErrorTypeNotFloat(value interface{}) *Error
  • func ErrorTypeNotInteger(value interface{}) *Error
  • func ErrorTypeNotObject(value interface{}) *Error
  • func ErrorTypeNotString(value interface{}) *Error
  • func ErrorTypeNotTime(value interface{}) *Error
  • func ErrorUnauthenticated() *Error
  • func ErrorUnauthorized() *Error
  • func ErrorValueNotExists() *Error
  • func ErrorValueNotGreaterThanOrEqualTo(value interface{}, limit interface{}) *Error
  • func ErrorValueNotInRange(value interface{}, lowerLimit interface{}, upperLimit interface{}) *Error
  • func ErrorValueStringNotOneOf(value string, allowedValues []string) *Error
  • func ErrorValueTimeNotParsable(value string, layout string) *Error
  • func GetRequestErrors(req *rest.Request) []*Error
  • func (e *Error) WithMeta(meta interface{}) *Error
  • func (e *Error) WithSourceParameter(parameter string) *Error
  • func (e *Error) WithSourcePointer(pointer string) *Error
• type Meta
• type Router
• type Service
• type Source
• type Trace

Constants

const (
	HTTPHeaderTraceRequest = "X-Tidepool-Trace-Request"
	HTTPHeaderTraceSession = "X-Tidepool-Trace-Session"
)

Functions

func AddDateHeader

func AddDateHeader(response rest.ResponseWriter)

func CopyRequestTrace

func CopyRequestTrace(sourceRequest *rest.Request, destinationRequest *http.Request) error

func GetRequestAuthDetails

func GetRequestAuthDetails(req *rest.Request) request.Details

func GetRequestLogger

func GetRequestLogger(req *rest.Request) log.Logger

func GetRequestTraceRequest

func GetRequestTraceRequest(req *rest.Request) string

func GetRequestTraceSession

func GetRequestTraceSession(req *rest.Request) string

func QuoteIfString

func QuoteIfString(interfaceValue interface{}) interface{}

func SetRequestAuthDetails

func SetRequestAuthDetails(req *rest.Request, details request.Details)

func SetRequestErrors

func SetRequestErrors(req *rest.Request, errs []*Error)

func SetRequestLogger

func SetRequestLogger(req *rest.Request, logger log.Logger)

func SetRequestTraceRequest

func SetRequestTraceRequest(req *rest.Request, traceRequest string)

func SetRequestTraceSession

func SetRequestTraceSession(req *rest.Request, traceSession string)

Types

type API

type API interface {
	InitializeMiddleware() error
	InitializeRouters(routers ...Router) error

	Status() *rest.Status

	Handler() http.Handler
}

type Context

type Context interface {
	Response() rest.ResponseWriter
	Request() *rest.Request

	RespondWithError(err *Error)
	RespondWithInternalServerFailure(message string, failure ...interface{})
	RespondWithStatusAndErrors(statusCode int, errors []*Error)
	RespondWithStatusAndData(statusCode int, data interface{})
}

type Error

type Error struct {
	Code   string      `json:"code,omitempty"`
	Title  string      `json:"title,omitempty"`
	Detail string      `json:"detail,omitempty"`
	Status int         `json:"status,string,omitempty"`
	Source *Source     `json:"source,omitempty"`
	Meta   interface{} `json:"meta,omitempty"`
}

func ErrorInternalServerFailure

func ErrorInternalServerFailure() *Error

func ErrorJSONMalformed

func ErrorJSONMalformed() *Error

func ErrorTypeNotArray

func ErrorTypeNotArray(value interface{}) *Error

func ErrorTypeNotBoolean

func ErrorTypeNotBoolean(value interface{}) *Error

func ErrorTypeNotFloat

func ErrorTypeNotFloat(value interface{}) *Error

func ErrorTypeNotInteger

func ErrorTypeNotInteger(value interface{}) *Error

func ErrorTypeNotObject

func ErrorTypeNotObject(value interface{}) *Error

func ErrorTypeNotString

func ErrorTypeNotString(value interface{}) *Error

func ErrorTypeNotTime

func ErrorTypeNotTime(value interface{}) *Error

func ErrorUnauthenticated

func ErrorUnauthenticated() *Error

func ErrorUnauthorized

func ErrorUnauthorized() *Error

func ErrorValueNotExists

func ErrorValueNotExists() *Error

func ErrorValueNotGreaterThanOrEqualTo

func ErrorValueNotGreaterThanOrEqualTo(value interface{}, limit interface{}) *Error

func ErrorValueNotInRange

func ErrorValueNotInRange(value interface{}, lowerLimit interface{}, upperLimit interface{}) *Error

func ErrorValueStringNotOneOf

func ErrorValueStringNotOneOf(value string, allowedValues []string) *Error

func ErrorValueTimeNotParsable

func ErrorValueTimeNotParsable(value string, layout string) *Error

func GetRequestErrors

func GetRequestErrors(req *rest.Request) []*Error

func (*Error) WithMeta

func (e *Error) WithMeta(meta interface{}) *Error

func (*Error) WithSourceParameter

func (e *Error) WithSourceParameter(parameter string) *Error

func (*Error) WithSourcePointer

func (e *Error) WithSourcePointer(pointer string) *Error

type Meta

type Meta struct {
	Trace *Trace `json:"trace,omitempty"`
}

type Router

type Router interface {
	Routes() []*rest.Route
}

type Service

type Service interface {
	VersionReporter() version.Reporter
	ConfigReporter() config.Reporter
	Logger() log.Logger

	Secret() string
	AuthClient() auth.Client
}

type Source

type Source struct {
	Parameter string `json:"parameter,omitempty"`
	Pointer   string `json:"pointer,omitempty"`
}

type Trace

type Trace struct {
	Request string `json:"request,omitempty"`
	Session string `json:"session,omitempty"`
}