bingo

README

bingo

bingo is a toolkit for building microservices . It is meant to be used along with https://goji.io

It is currently a work in progress

Documentation

Index

• func BoundParam(ctx context.Context, name string) string
• func Close(closer io.Closer, log log.Logger)
• func JSONW(w http.ResponseWriter, status int, l log.Logger, data interface{})
• func PrintBanner(a ...interface{})
• func PrintError(a ...interface{})
• func PrintName(str string)
• func ReadBody(request *http.Request, des interface{}, msg string) error
• func Run(addr string, timeout time.Duration, h http.Handler)
• type Handler
  • func Wrap(h http.Handler) *Handler
  • func (h *Handler) AddCloser(c io.Closer) *Handler
  • func (h *Handler) Close() error
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Functions

func BoundParam

func BoundParam(ctx context.Context, name string) string

BoundParam returns the bound parameter with the given name. Wraps around goji's pat.Param

func Close

func Close(closer io.Closer, log log.Logger)

Close an io.Closer object by handling it's error. Example:

h, err := app.Init(env)
defer utils.Close(h, conf.Config.Log())

func JSONW

func JSONW(w http.ResponseWriter, status int, l log.Logger, data interface{})

JSONW writes JSON response to the given writer

func PrintBanner

func PrintBanner(a ...interface{})

PrintBanner prints the banner

func PrintError

func PrintError(a ...interface{})

PrintError prints the error

func PrintName

func PrintName(str string)

PrintName prints the app name

func ReadBody

func ReadBody(request *http.Request, des interface{}, msg string) error

ReadBody decodes request.Body into the destination.

Warning: des should be a pointer

func Run

func Run(addr string, timeout time.Duration, h http.Handler)

Run gracefully starts the http server

Types

type Handler

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

Handler encapsulates the handlers

func Wrap

func Wrap(h http.Handler) *Handler

Wrap wraps http.Handler with the bingo Handler

func (*Handler) AddCloser

func (h *Handler) AddCloser(c io.Closer) *Handler

AddCloser adds a closer

func (*Handler) Close

func (h *Handler) Close() error

Close cleans up any resources

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)