web

Documentation

Index

• Constants
• func NewLogger() *log.Logger
• type Context
  • func (ctx *Context) ActiveTransaction() *dbx.Trx
  • func (ctx *Context) AddAuthCookie(user *models.User) (string, error)
  • func (ctx *Context) AddCookie(name, value string, expires time.Time)
  • func (ctx *Context) AddRenderVar(name string, value interface{})
  • func (ctx *Context) AuthEndpoint() string
  • func (ctx *Context) BadRequest(dict Map) error
  • func (ctx *Context) BaseURL() string
  • func (ctx *Context) BindTo(i actions.Actionable) *validate.Result
  • func (ctx *Context) Failure(err error) error
  • func (ctx *Context) HandleValidation(result *validate.Result) error
  • func (ctx *Context) IsAjax() bool
  • func (ctx *Context) IsAuthenticated() bool
  • func (ctx *Context) NotFound() error
  • func (ctx *Context) Ok(data interface{}) error
  • func (ctx *Context) Page(dict Map) error
  • func (ctx *Context) ParamAsInt(name string) (int, error)
  • func (ctx *Context) RemoveCookie(name string)
  • func (ctx *Context) RenderVars() Map
  • func (ctx *Context) Services() *app.Services
  • func (ctx *Context) SetActiveTransaction(trx *dbx.Trx)
  • func (ctx *Context) SetParams(dict Map)
  • func (ctx *Context) SetServices(services *app.Services)
  • func (ctx *Context) SetTenant(tenant *models.Tenant)
  • func (ctx *Context) SetUser(user *models.User)
  • func (ctx *Context) Tenant() *models.Tenant
  • func (ctx *Context) TenantBaseURL(tenant *models.Tenant) string
  • func (ctx *Context) Unauthorized() error
  • func (ctx *Context) User() *models.User
• type Engine
  • func New(settings *models.AppSettings) *Engine
  • func (e *Engine) Group(preffix string) *Group
  • func (e *Engine) HandleError(err error, ctx Context)
  • func (e *Engine) NewContext(req *http.Request, w http.ResponseWriter) Context
  • func (e *Engine) Start(address string)
  • func (e *Engine) Use(middleware MiddlewareFunc)
• type Group
  • func (g *Group) Get(path string, handler HandlerFunc)
  • func (g *Group) Group(preffix string) *Group
  • func (g *Group) Post(path string, handler HandlerFunc)
  • func (g *Group) Static(prefix, root string)
  • func (g *Group) Use(middleware MiddlewareFunc)
• type HTMLRenderer
  • func NewHTMLRenderer(settings *models.AppSettings, logger echo.Logger) *HTMLRenderer
  • func (r *HTMLRenderer) Render(w io.Writer, name string, data interface{}, c echo.Context) error
• type HandlerFunc
• type Map
• type MiddlewareFunc

Constants

const CookieAuthName = "auth"

CookieAuthName is the name of the authentication cookie

Functions

func NewLogger

func NewLogger() *log.Logger

NewLogger creates a new logger

Types

type Context

type Context struct {
	echo.Context
}

Context wraps echo.context to provide userful information

func (*Context) ActiveTransaction

func (ctx *Context) ActiveTransaction() *dbx.Trx

ActiveTransaction returns current active Database transaction

func (*Context) AddAuthCookie

func (ctx *Context) AddAuthCookie(user *models.User) (string, error)

AddAuthCookie generates and adds a cookie

func (*Context) AddCookie

func (ctx *Context) AddCookie(name, value string, expires time.Time)

AddCookie adds a cookie

func (*Context) AddRenderVar

func (ctx *Context) AddRenderVar(name string, value interface{})

AddRenderVar register given key/value to RenderVar map

func (*Context) AuthEndpoint

func (ctx *Context) AuthEndpoint() string

AuthEndpoint auth endpoint

func (*Context) BadRequest

func (ctx *Context) BadRequest(dict Map) error

BadRequest returns 400 BadRequest with JSON result

func (*Context) BaseURL

func (ctx *Context) BaseURL() string

BaseURL returns base URL as string

func (*Context) BindTo

func (ctx *Context) BindTo(i actions.Actionable) *validate.Result

BindTo context values into given model

func (*Context) Failure

func (ctx *Context) Failure(err error) error

Failure returns a 500 page

func (*Context) HandleValidation

func (ctx *Context) HandleValidation(result *validate.Result) error

HandleValidation handles given validation result property to return 400 or 500

func (*Context) IsAjax

func (ctx *Context) IsAjax() bool

IsAjax returns true if request is AJAX

func (*Context) IsAuthenticated

func (ctx *Context) IsAuthenticated() bool

IsAuthenticated returns true if user is authenticated

func (*Context) NotFound

func (ctx *Context) NotFound() error

NotFound returns a 404 page

func (*Context) Ok

func (ctx *Context) Ok(data interface{}) error

Ok returns 200 OK with JSON result

func (*Context) Page

func (ctx *Context) Page(dict Map) error

Page returns a page with given variables

func (*Context) ParamAsInt

func (ctx *Context) ParamAsInt(name string) (int, error)

ParamAsInt returns parameter as int

func (*Context) RemoveCookie

func (ctx *Context) RemoveCookie(name string)

RemoveCookie removes a cookie

func (*Context) RenderVars

func (ctx *Context) RenderVars() Map

RenderVars returns all registered RenderVar

func (*Context) Services

func (ctx *Context) Services() *app.Services

Services returns current app.Services from context

func (*Context) SetActiveTransaction

func (ctx *Context) SetActiveTransaction(trx *dbx.Trx)

SetActiveTransaction adds transaction to context

func (*Context) SetParams

func (ctx *Context) SetParams(dict Map)

SetParams sets path parameter names and values.

func (*Context) SetServices

func (ctx *Context) SetServices(services *app.Services)

SetServices update current context with app.Services

func (*Context) SetTenant

func (ctx *Context) SetTenant(tenant *models.Tenant)

SetTenant update HTTP context with current tenant

func (*Context) SetUser

func (ctx *Context) SetUser(user *models.User)

SetUser update HTTP context with current user

func (*Context) Tenant

func (ctx *Context) Tenant() *models.Tenant

Tenant returns current tenant

func (*Context) TenantBaseURL

func (ctx *Context) TenantBaseURL(tenant *models.Tenant) string

TenantBaseURL returns base URL for a given tenant

func (*Context) Unauthorized

func (ctx *Context) Unauthorized() error

Unauthorized returns a 401 response

func (*Context) User

func (ctx *Context) User() *models.User

User returns authenticated user

type Engine

type Engine struct {
	Logger *log.Logger
	// contains filtered or unexported fields
}

Engine is our web engine wrapper

func New

func New(settings *models.AppSettings) *Engine

New creates a new Engine

func (*Engine) Group

func (e *Engine) Group(preffix string) *Group

Group creates a new router group with prefix

func (*Engine) HandleError

func (e *Engine) HandleError(err error, ctx Context)

HandleError redirect error to router

func (*Engine) NewContext

func (e *Engine) NewContext(req *http.Request, w http.ResponseWriter) Context

NewContext creates and return a new context

func (*Engine) Start

func (e *Engine) Start(address string)

Start an HTTP server.

func (*Engine) Use

func (e *Engine) Use(middleware MiddlewareFunc)

Use middleware on root router

type Group

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

Group is our router group wrapper

func (*Group) Get

func (g *Group) Get(path string, handler HandlerFunc)

Get handles HTTP GET requests

func (*Group) Group

func (g *Group) Group(preffix string) *Group

Group creates asub-group with prefix

func (*Group) Post

func (g *Group) Post(path string, handler HandlerFunc)

Post handles HTTP POST requests

func (*Group) Static

func (g *Group) Static(prefix, root string)

Static return files from given folder

func (*Group) Use

func (g *Group) Use(middleware MiddlewareFunc)

Use add middleware to sub-routes within the Group

type HTMLRenderer

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

HTMLRenderer renderer

func NewHTMLRenderer

func NewHTMLRenderer(settings *models.AppSettings, logger echo.Logger) *HTMLRenderer

NewHTMLRenderer creates a new HTMLRenderer

func (*HTMLRenderer) Render

func (r *HTMLRenderer) Render(w io.Writer, name string, data interface{}, c echo.Context) error

Render a template based on parameters

type HandlerFunc

type HandlerFunc func(Context) error

HandlerFunc represents an HTTP handler

type Map

type Map map[string]interface{}

Map defines a generic map of type `map[string]interface{}`.

type MiddlewareFunc

type MiddlewareFunc func(HandlerFunc) HandlerFunc

MiddlewareFunc represents an HTTP middleware