snap

README

snap

Typical layout for snap servers

    web/
        templates/
        static/
              app/
                 js/...
              skin1/...
              skin2/...
              favicon.ico              

Example:

package main

import (
	"git.thirdmartini.com/pub/snap"
	"git.thirdmartini.com/pub/snap/auth"
)

func handler(c *snap.Context) {
	c.Reply("snap/example/simple 1.0")
}

func handlerAuthenticated(c *snap.Context) {
	c.Reply("snap/example/simple 1.0 (authenticated)")
}

func mustRunServer(auth auth.Authenticator) {
	s := snap.New("localhost:9000", "web", auth)
	s.SetDebug(true)
	s.SetTemplatePath("web/templates")
	s.WithStaticFiles("/static", "web/static" )
	s.WithTheme("skin1")
	
	s.HandleFunc("/", handler)
	s.HandleFuncAuthenticated("/auth", "", handlerAuthenticated)

	s.Serve()
}

func main() {
	auth := auth.NewAuth("basic")
	auth.AddUser("admin", "admin", "password")
	mustRunServer(auth)
}	

Documentation

Index

• func Redirect(to string) func(c *Context)
• func Walk(fs http.FileSystem, base string, ...) error
• type Context
  • func (c *Context) Error(code int, msg string)
  • func (c *Context) ErrorObject(code int, obj interface{})
  • func (c *Context) FormValue(k string) string
  • func (c *Context) FormValueAsSlice(k string, delim string) []string
  • func (c *Context) FormValueUint64(k string) uint64
  • func (c *Context) GetObject(obj interface{}) error
  • func (c *Context) GetRequest() *http.Request
  • func (c *Context) GetUser() string
  • func (c *Context) GetVar(k string) (string, bool)
  • func (c *Context) GetVarAsSlice(k string, delim string, def []string) []string
  • func (c *Context) GetVarDefault(k string, def string) string
  • func (c *Context) ParseForm() error
  • func (c *Context) QueryHas(key string) bool
  • func (c *Context) QueryValue(key string) string
  • func (c *Context) QueryValueWithDefault(key string, def string) string
  • func (c *Context) Redirect(url string)
  • func (c *Context) Render(tmpl string, content interface{})
  • func (c *Context) RenderEx(tmpl string, content interface{})
  • func (c *Context) RenderWithMeta(tmpl string, meta map[string]string, content interface{})
  • func (c *Context) Reply(msg string)
  • func (c *Context) ReplyObject(obj interface{})
  • func (c *Context) ReplyWithHeaders(msg string, kv map[string]string)
  • func (c *Context) Writer() http.ResponseWriter
• type RouteBuilder
  • func NewRouteBuilder() *RouteBuilder
  • func (r *RouteBuilder) BuildRoute(s *Server) http.HandlerFunc
  • func (r *RouteBuilder) WithAuth(auth auth.Authenticator) *RouteBuilder
  • func (r *RouteBuilder) WithContent(contentHandler func(c *Context)) *RouteBuilder
  • func (r *RouteBuilder) WithLoginHandler(loginHandler func(c *Context) bool) *RouteBuilder
• type Server
  • func New(address string, path string, auth auth.Authenticator) *Server
  • func (s *Server) AddRoute(path string, r *RouteBuilder) *mux.Route
  • func (s *Server) Dump()
  • func (s *Server) EnableStatus(path string)
  • func (s *Server) EnableTestMode(enable bool) *Server
  • func (s *Server) HandleFunc(path string, f func(c *Context)) *mux.Route
  • func (s *Server) HandleFuncAuthenticated(path, redirect string, f func(c *Context)) *mux.Route
  • func (s *Server) HandleFuncAuthenticatedWithLogin(path string, loginHandler func(c *Context) bool, ...) *mux.Route
  • func (s *Server) HandleFuncCustomAuth(auth auth.Authenticator, path, redirect string, f func(c *Context)) *mux.Route
  • func (s *Server) LoadTemplatesFS(fs http.FileSystem, base string) (*template.Template, error)
  • func (s *Server) Router() *mux.Router
  • func (s *Server) Serve() error
  • func (s *Server) ServeTLS(keyPath string, certPath string) error
  • func (s *Server) ServeTLSRedirect(address string) error
  • func (s *Server) SetDebug(enable bool)
  • func (s *Server) SetTemplatePath(tmplPath string)
  • func (s *Server) SetTheme(themePath string)
  • func (s *Server) WithAuth(auth auth.Authenticator) *Server
  • func (s *Server) WithDebug(debugURL string) *Server
  • func (s *Server) WithHealthCheck(version, date string, status func() (bool, string))
  • func (s *Server) WithMetadata(meta map[string]string) *Server
  • func (s *Server) WithRootFileSystem(fs http.FileSystem) *Server
  • func (s *Server) WithStaticFiles(prefix string) *Server
  • func (s *Server) WithTemplateFuncs(funcs template.FuncMap) *Server
  • func (s *Server) WithTheme(themeURL string) *Server
• type SnapBaseContent
• type SnapContent

Functions

func Redirect

func Redirect(to string) func(c *Context)

func Walk

func Walk(fs http.FileSystem, base string, walkFunc func(path string, info os.FileInfo, err error) error) error

Types

type Context

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

func (*Context) Error

func (c *Context) Error(code int, msg string)

func (*Context) ErrorObject

func (c *Context) ErrorObject(code int, obj interface{})

func (*Context) FormValue

func (c *Context) FormValue(k string) string

func (*Context) FormValueAsSlice

func (c *Context) FormValueAsSlice(k string, delim string) []string

func (*Context) FormValueUint64

func (c *Context) FormValueUint64(k string) uint64

func (*Context) GetObject

func (c *Context) GetObject(obj interface{}) error

func (*Context) GetRequest

func (c *Context) GetRequest() *http.Request

func (*Context) GetUser

func (c *Context) GetUser() string

func (*Context) GetVar

func (c *Context) GetVar(k string) (string, bool)

func (*Context) GetVarAsSlice

func (c *Context) GetVarAsSlice(k string, delim string, def []string) []string

func (*Context) GetVarDefault

func (c *Context) GetVarDefault(k string, def string) string

func (*Context) ParseForm

func (c *Context) ParseForm() error

func (*Context) QueryHas

func (c *Context) QueryHas(key string) bool

func (*Context) QueryValue

func (c *Context) QueryValue(key string) string

func (*Context) QueryValueWithDefault

func (c *Context) QueryValueWithDefault(key string, def string) string

func (*Context) Redirect

func (c *Context) Redirect(url string)

func (*Context) Render

func (c *Context) Render(tmpl string, content interface{})

func (*Context) RenderEx

func (c *Context) RenderEx(tmpl string, content interface{})

func (*Context) RenderWithMeta

func (c *Context) RenderWithMeta(tmpl string, meta map[string]string, content interface{})

func (*Context) Reply

func (c *Context) Reply(msg string)

func (*Context) ReplyObject

func (c *Context) ReplyObject(obj interface{})

func (*Context) ReplyWithHeaders

func (c *Context) ReplyWithHeaders(msg string, kv map[string]string)

func (*Context) Writer

func (c *Context) Writer() http.ResponseWriter

type RouteBuilder

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

func NewRouteBuilder

func NewRouteBuilder() *RouteBuilder

func (*RouteBuilder) BuildRoute

func (r *RouteBuilder) BuildRoute(s *Server) http.HandlerFunc

func (*RouteBuilder) WithAuth

func (r *RouteBuilder) WithAuth(auth auth.Authenticator) *RouteBuilder

func (*RouteBuilder) WithContent

func (r *RouteBuilder) WithContent(contentHandler func(c *Context)) *RouteBuilder

func (*RouteBuilder) WithLoginHandler

func (r *RouteBuilder) WithLoginHandler(loginHandler func(c *Context) bool) *RouteBuilder

type Server

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

func New

func New(address string, path string, auth auth.Authenticator) *Server

func (*Server) AddRoute

func (s *Server) AddRoute(path string, r *RouteBuilder) *mux.Route

func (*Server) Dump

func (s *Server) Dump()

func (*Server) EnableStatus

func (s *Server) EnableStatus(path string)

func (*Server) EnableTestMode

func (s *Server) EnableTestMode(enable bool) *Server

func (*Server) HandleFunc

func (s *Server) HandleFunc(path string, f func(c *Context)) *mux.Route

func (*Server) HandleFuncAuthenticated

func (s *Server) HandleFuncAuthenticated(path, redirect string, f func(c *Context)) *mux.Route

func (*Server) HandleFuncAuthenticatedWithLogin

func (s *Server) HandleFuncAuthenticatedWithLogin(path string, loginHandler func(c *Context) bool, contentHandler func(c *Context)) *mux.Route

func (*Server) HandleFuncCustomAuth

func (s *Server) HandleFuncCustomAuth(auth auth.Authenticator, path, redirect string, f func(c *Context)) *mux.Route

func (*Server) LoadTemplatesFS

func (s *Server) LoadTemplatesFS(fs http.FileSystem, base string) (*template.Template, error)

func (*Server) Router

func (s *Server) Router() *mux.Router

func (*Server) Serve

func (s *Server) Serve() error

Serve serve content forever

func (*Server) ServeTLS

func (s *Server) ServeTLS(keyPath string, certPath string) error

func (*Server) ServeTLSRedirect

func (s *Server) ServeTLSRedirect(address string) error

func (*Server) SetDebug

func (s *Server) SetDebug(enable bool)

func (*Server) SetTemplatePath

func (s *Server) SetTemplatePath(tmplPath string)

func (*Server) SetTheme

func (s *Server) SetTheme(themePath string)

func (*Server) WithAuth

func (s *Server) WithAuth(auth auth.Authenticator) *Server

func (*Server) WithDebug

func (s *Server) WithDebug(debugURL string) *Server

func (*Server) WithHealthCheck

func (s *Server) WithHealthCheck(version, date string, status func() (bool, string))

func (*Server) WithMetadata

func (s *Server) WithMetadata(meta map[string]string) *Server

func (*Server) WithRootFileSystem

func (s *Server) WithRootFileSystem(fs http.FileSystem) *Server

func (*Server) WithStaticFiles

func (s *Server) WithStaticFiles(prefix string) *Server

func (*Server) WithTemplateFuncs

func (s *Server) WithTemplateFuncs(funcs template.FuncMap) *Server

func (*Server) WithTheme

func (s *Server) WithTheme(themeURL string) *Server

type SnapBaseContent

type SnapBaseContent struct {
	Theme   string
	Content interface{}
}

type SnapContent

type SnapContent struct {
	User           string
	UserProperties map[string]string
	Theme          string
	Meta           map[string]string
	Content        interface{}
}