dojo

Jun 12, 2021

Changes in this version

type Router

+ func (r *Router) Host(tpl string, cb func(router *Router))

Jun 4, 2021

Changes in this version

type DefaultConfiguration

+ Redis RedisConfig

+ type RedisConfig struct

+ Database int

+ Host string

+ Password string

+ Port int

May 30, 2021

Changes in this version

+ const FlashOldKey

+ var ErrBadGateway = NewHTTPError(http.StatusBadGateway)

+ var ErrBadRequest = NewHTTPError(http.StatusBadRequest)

+ var ErrCookieNotFound = errors.New("cookie not found")

+ var ErrForbidden = NewHTTPError(http.StatusForbidden)

+ var ErrInternalServerError = NewHTTPError(http.StatusInternalServerError)

+ var ErrInvalidCertOrKeyType = errors.New("invalid cert or key type, must be string or []byte")

+ var ErrInvalidListenerNetwork = errors.New("invalid listener network")

+ var ErrInvalidRedirectCode = errors.New("invalid redirect status code")

+ var ErrMethodNotAllowed = NewHTTPError(http.StatusMethodNotAllowed)

+ var ErrNotFound = NewHTTPError(http.StatusNotFound)

+ var ErrRendererNotRegistered = errors.New("renderer not registered")

+ var ErrRequestTimeout = NewHTTPError(http.StatusRequestTimeout)

+ var ErrServiceUnavailable = NewHTTPError(http.StatusServiceUnavailable)

+ var ErrStatusRequestEntityTooLarge = NewHTTPError(http.StatusRequestEntityTooLarge)

+ var ErrTooManyRequests = NewHTTPError(http.StatusTooManyRequests)

+ var ErrUnauthorized = NewHTTPError(http.StatusUnauthorized)

+ var ErrUnsupportedMediaType = NewHTTPError(http.StatusUnsupportedMediaType)

+ var ErrValidatorNotRegistered = errors.New("validator not registered")

type AppConfig

+ Debug bool

type Context

+ Dojo func() *Dojo

+ JSON func(code int, data interface{}) error

+ NoContent func(code int) error

+ RealIP func() string

+ View func(view string, data ViewAdditionalData) error

type DefaultContext

+ func (ctx *DefaultContext) Dojo() *Dojo

+ func (ctx *DefaultContext) JSON(code int, data interface{}) error

+ func (ctx *DefaultContext) NoContent(code int) error

+ func (ctx *DefaultContext) RealIP() string

+ func (ctx *DefaultContext) View(viewName string, data ViewAdditionalData) error

+ type Dojo struct

+ Auth *Authentication

+ Configuration DefaultConfiguration

+ Debug bool

+ HTTPErrorHandler HTTPErrorHandler

+ Logger *logrus.Logger

+ MiddlewareRegistry *MiddlewareRegistry

+ Route *Router

+ SessionStore *sessions.CookieStore

+ func (dojo *Dojo) Assets() []Asset

+ func (dojo *Dojo) DefaultHTTPErrorHandler(err error, c Context)

+ func (dojo *Dojo) NewContext(rc RouteConfig, w http.ResponseWriter, r *http.Request) Context

+ func (dojo *Dojo) Serve()

+ type HTTPError struct

+ Code int

+ Internal error

+ Message interface{}

+ func NewHTTPError(code int, message ...interface{}) *HTTPError

+ func (e *HTTPError) Error() string

+ type HTTPErrorHandler func(error, Context)

+ type Map map[string]interface

type RouteConfig

+ Dojo *Dojo

type Router

+ func (r *Router) DeleteWithName(path string, name string, handler Handler, middlewares ...MiddlewareFunc)

+ func (r *Router) GetWithName(path string, name string, handler Handler, middlewares ...MiddlewareFunc)

+ func (r *Router) PatchWithName(path string, name string, handler Handler, middlewares ...MiddlewareFunc)

+ func (r *Router) PostWithName(path string, name string, handler Handler, middlewares ...MiddlewareFunc)

+ func (r *Router) PutWithName(path string, name string, handler Handler, middlewares ...MiddlewareFunc)

type Session

+ func (s *Session) Flash(key string, value interface{})

+ func (s *Session) GetFlash(key string) []interface{}

+ func (s *Session) WithOld(data map[string]interface{})

May 16, 2021

Changes in this version

type Authentication

+ func (auth *Authentication) Logout(ctx Context) error

May 16, 2021

Changes in this version

+ const HeaderAccept

+ const HeaderAcceptEncoding

+ const HeaderAccessControlAllowCredentials

+ const HeaderAccessControlAllowHeaders

+ const HeaderAccessControlAllowMethods

+ const HeaderAccessControlAllowOrigin

+ const HeaderAccessControlExposeHeaders

+ const HeaderAccessControlMaxAge

+ const HeaderAccessControlRequestHeaders

+ const HeaderAccessControlRequestMethod

+ const HeaderAllow

+ const HeaderAuthorization

+ const HeaderContentDisposition

+ const HeaderContentEncoding

+ const HeaderContentLength

+ const HeaderContentSecurityPolicy

+ const HeaderContentSecurityPolicyReportOnly

+ const HeaderContentType

+ const HeaderCookie

+ const HeaderIfModifiedSince

+ const HeaderLastModified

+ const HeaderLocation

+ const HeaderOrigin

+ const HeaderReferrerPolicy

+ const HeaderServer

+ const HeaderSetCookie

+ const HeaderStrictTransportSecurity

+ const HeaderUpgrade

+ const HeaderVary

+ const HeaderWWWAuthenticate

+ const HeaderXCSRFToken

+ const HeaderXContentTypeOptions

+ const HeaderXForwardedFor

+ const HeaderXForwardedProto

+ const HeaderXForwardedProtocol

+ const HeaderXForwardedSsl

+ const HeaderXFrameOptions

+ const HeaderXHTTPMethodOverride

+ const HeaderXRealIP

+ const HeaderXRequestID

+ const HeaderXRequestedWith

+ const HeaderXUrlScheme

+ const HeaderXXSSProtection

+ const MIMEApplicationForm

+ const MIMEApplicationJSON

+ const MIMEApplicationJSONCharsetUTF8

+ const MIMEApplicationJavaScript

+ const MIMEApplicationJavaScriptCharsetUTF8

+ const MIMEApplicationMsgpack

+ const MIMEApplicationProtobuf

+ const MIMEApplicationXML

+ const MIMEApplicationXMLCharsetUTF8

+ const MIMECloudEventJSONCharsetUTF8

+ const MIMEMultipartForm

+ const MIMEOctetStream

+ const MIMETextHTML

+ const MIMETextHTMLCharsetUTF8

+ const MIMETextPlain

+ const MIMETextPlainCharsetUTF8

+ const MIMETextXML

+ const MIMETextXMLCharsetUTF8

+ const PROPFIND

+ const REPORT

type Context

+ Set func(string, interface{})

May 16, 2021

Changes in this version

type AuthUser

+ func (u *AuthUser) IsGuest() bool

type Authenticable

+ IsGuest func() bool

+ type ViewAdditionalData map[string]interface

type ViewData

+ Assets []Asset

+ Data map[string]interface{}

+ User Authenticable

May 16, 2021

Changes in this version

type DatabaseConfig

+ SSLMode string

May 15, 2021

Changes in this version

type AuthUser

+ ID uuid.UUID

+ func (u *AuthUser) GetAuthData() interface{}

+ func (u *AuthUser) GetAuthID() uuid.UUID

+ func (u *AuthUser) GetAuthType() AuthUserType

+ type Authenticable interface

+ GetAuthData func() interface{}

+ GetAuthID func() uuid.UUID

+ GetAuthType func() AuthUserType

type Authentication

+ func (auth *Authentication) Login(ctx Context, user Authenticable) error

type Router

+ func (r Router) Redirect(ctx Context, url string)

May 13, 2021

Changes in this version

type DatabaseConfig

+ func (c DatabaseConfig) DSN() string

type DefaultConfiguration

+ func GetConfig() *DefaultConfiguration

+ type Environment string

+ const Development

+ const Production

+ const Staging

+ const Testing

type Flash

+ func (f Flash) Persist(session *Session)

May 13, 2021

Changes in this version

type Context

+ Bind func(interface{}) error

+ Cookies func() *Cookies

+ Data func() map[string]interface{}

+ Param func(string) string

+ Params func() ParamValues

+ Session func() *Session

+ type Cookies struct

+ func (c *Cookies) Delete(name string)

+ func (c *Cookies) Get(name string) (string, error)

+ func (c *Cookies) Set(name, value string, maxAge time.Duration)

+ func (c *Cookies) SetWithExpirationTime(name, value string, expires time.Time)

+ func (c *Cookies) SetWithPath(name, value, path string)

type DefaultContext

+ func (d *DefaultContext) Bind(dst interface{}) error

+ func (d *DefaultContext) Cookies() *Cookies

+ func (d *DefaultContext) Data() map[string]interface{}

+ func (d *DefaultContext) Flash() *Flash

+ func (d *DefaultContext) Param(key string) string

+ func (d *DefaultContext) Session() *Session

+ func (d *DefaultContext) Set(key string, value interface{})

+ func (d *DefaultContext) Value(key interface{}) interface{}

+ type Flash struct

+ func (f *Flash) Clear()

+ func (f Flash) Add(key, value string)

+ func (f Flash) Delete(key string)

+ func (f Flash) Set(key string, values []string)

May 13, 2021

Changes in this version

type Asset

+ Path string

May 13, 2021

Changes in this version

type Application

+ Route *Router

type Router

+ func (r *Router) Connect(path string, handler Handler)

+ func (r *Router) Delete(path string, handler Handler)

+ func (r *Router) Options(path string, handler Handler)

+ func (r *Router) Patch(path string, handler Handler)

+ func (r *Router) Post(path string, handler Handler)

+ func (r *Router) Put(path string, handler Handler)

+ func (r *Router) Trace(path string, handler Handler)

May 13, 2021

Changes in this version

+ var DefaultConfigs = &PasswordConfig

+ var ErrIncompatibleVersion = errors.New("argon2id: incompatible version of argon2")

+ var ErrInvalidHash = errors.New("argon2id: hash is not in the correct format")

type Application

+ Auth *Authentication

+ Logger *logrus.Logger

+ MiddlewareRegistry *MiddlewareRegistry

+ SessionStore *sessions.CookieStore

+ func (app Application) JSON(ctx Context, data interface{}) error

+ type AuthUser struct

+ Data interface{}

+ Type AuthUserType

+ type AuthUserType string

+ const GuestUserType

+ const UserUserType

+ type Authentication struct

+ func NewAuthentication(app *Application) *Authentication

+ func (auth *Authentication) ExchangeAuthorisationCode(ctx Context, authorisationCode string) (OAuthResult, error)

+ func (auth *Authentication) GetAuthUser(ctx Context) AuthUser

+ func (auth *Authentication) GetAuthorizationUri(ctx Context) string

+ func (auth Authentication) CompareOAuthState(ctx Context, state string) error

+ func (auth Authentication) ComparePasswordAndHash(password, hash string) (match bool, err error)

+ func (auth Authentication) GeneratePasswordHash(c *PasswordConfig, password string) (string, error)

+ type AuthenticationConfig struct

+ ClientID string

+ ClientSecret string

+ Endpoint string

+ Provider AuthenticationProvider

+ RedirectPath string

+ Scopes []string

+ Table string

+ type AuthenticationProvider string

+ const DatabaseAuthenticationProvider

+ const OAuthAuthenticationProvider

type DefaultConfiguration

+ Auth AuthenticationConfig

+ Session SessionConfig

+ type ExchangeAuthorisationCodeRequest struct

+ ClientId string

+ ClientSecret string

+ Code string

+ GrantType string

+ RedirectUri string

+ type JsonResponseBody struct

+ Data interface{}

+ type Middleware struct

+ Handler MiddlewareFunc

+ Name string

+ type MiddlewareRegistry struct

+ func NewMiddlewareRegistry() *MiddlewareRegistry

+ func (registry *MiddlewareRegistry) Register(name string, fn MiddlewareFunc)

+ func (registry *MiddlewareRegistry) RegisterStack(name string, middlewares []string)

+ type OAuthResult struct

+ AccessToken string

+ ExpiresIn int

+ RefreshToken string

+ Scope string

+ TokenType string

+ type PasswordConfig struct

+ Iterations uint32

+ KeyLength uint32

+ Memory uint32

+ Parallelism uint8

+ SaltLength uint32

type RouteConfig

+ Middlewares MiddlewareStack

+ type Router struct

+ func NewRouter(app *Application) *Router

+ func (r *Router) Get(path string, handler Handler)

+ func (r *Router) GetMux() *mux.Router

+ func (r *Router) RouteGroup(prefix string, cb func(router *Router))

+ func (r *Router) Use(name string)

+ func (r *Router) UseStack(name string)

+ type Session struct

+ Session *sessions.Session

+ func (s *Session) Clear()

+ func (s *Session) Delete(name interface{})

+ func (s *Session) Get(name interface{}) interface{}

+ func (s *Session) GetOnce(name interface{}) interface{}

+ func (s *Session) Save() error

+ func (s *Session) Set(name, value interface{})

+ type SessionConfig struct

+ Name string

+ Secret string

May 9, 2021

Changes in this version

type Application

+ func (app *Application) Assets() []Asset

+ type Asset struct

+ Extension FileExtension

+ Name string

+ type AssetsConfigs struct

+ Path string

type DefaultConfiguration

+ Assets AssetsConfigs

+ type FileExtension string

+ const Javascript

+ const Stylesheet

May 9, 2021

Changes in this version

type Application

+ Middleware *MiddlewareStack

+ func (app *Application) GET(p string, h Handler)

+ func (app *Application) Use(mw ...MiddlewareFunc)

+ func (app Application) NewContext(rc RouteConfig, w http.ResponseWriter, r *http.Request) Context

+ func (app Application) View(ctx Context, viewName string, data ViewData)

type Context

+ Request func() *http.Request

+ Response func() http.ResponseWriter

type DefaultConfiguration

+ View ViewConfig

+ type DefaultContext struct

+ func (d *DefaultContext) Params() ParamValues

+ func (d *DefaultContext) Request() *http.Request

+ func (d *DefaultContext) Response() http.ResponseWriter

+ type MiddlewareFunc func(Handler) Handler

+ type MiddlewareStack struct

+ func (ms *MiddlewareStack) Use(mw ...MiddlewareFunc)

+ type ParamValues interface

+ Get func(string) string

+ type RouteConfig struct

+ Aliases []string

+ App *Application

+ Handler Handler

+ HandlerName string

+ Method string

+ MuxRoute *mux.Route

+ Path string

+ PathName string

+ ResourceName string

+ func (r RouteConfig) ServeHTTP(res http.ResponseWriter, req *http.Request)

+ type ViewConfig struct

+ Path string

+ type ViewData map[string]interface

May 8, 2021

Changes in this version

+ func LoadConfigs(cfg *DefaultConfiguration)

+ type AppConfig struct

+ Domain string

+ Environment string

+ Name string

+ Port int

+ Version string

+ type Application struct

+ Configuration DefaultConfiguration

+ func New(conf DefaultConfiguration) *Application

+ func (app *Application) Serve()

+ type Context interface

+ type DatabaseConfig struct

+ Database string

+ Host string

+ Password string

+ Port int

+ User string

+ type DefaultConfiguration struct

+ App AppConfig

+ DB DatabaseConfig

+ type Handler func(ctx Context) error