app

Documentation

Overview

Package app ties together application resources and handlers.

Index

• Variables
• func ErrInvalidRequest(err error) render.Renderer
• func ErrRender(err error) render.Renderer
• func ErrValidation(err error, valErr validation.Errors) render.Renderer
• type API
  • func NewAPI(db *pg.DB) (*API, error)
  • func (a *API) Router() *chi.Mux
• type AccountResource
  • func NewAccountResource(store AccountStore) *AccountResource
• type AccountStore
• type ErrResponse
  • func (e *ErrResponse) Render(w http.ResponseWriter, r *http.Request) error
• type ProfileResource
  • func NewProfileResource(store ProfileStore) *ProfileResource
• type ProfileStore

Variables

var (
	// ErrBadRequest returns status 400 Bad Request for malformed request body.
	ErrBadRequest = &ErrResponse{HTTPStatusCode: http.StatusBadRequest, StatusText: http.StatusText(http.StatusBadRequest)}

	// ErrUnauthorized returns 401 Unauthorized.
	ErrUnauthorized = &ErrResponse{HTTPStatusCode: http.StatusUnauthorized, StatusText: http.StatusText(http.StatusUnauthorized)}

	// ErrForbidden returns status 403 Forbidden for unauthorized request.
	ErrForbidden = &ErrResponse{HTTPStatusCode: http.StatusForbidden, StatusText: http.StatusText(http.StatusForbidden)}

	// ErrNotFound returns status 404 Not Found for invalid resource request.
	ErrNotFound = &ErrResponse{HTTPStatusCode: http.StatusNotFound, StatusText: http.StatusText(http.StatusNotFound)}

	// ErrInternalServerError returns status 500 Internal Server Error.
	ErrInternalServerError = &ErrResponse{HTTPStatusCode: http.StatusInternalServerError, StatusText: http.StatusText(http.StatusInternalServerError)}
)

var (
	ErrAccountValidation = errors.New("account validation error")
)

The list of error types returned from account resource.

var (
	ErrProfileValidation = errors.New("profile validation error")
)

The list of error types returned from account resource.

Functions

func ErrInvalidRequest

func ErrInvalidRequest(err error) render.Renderer

ErrInvalidRequest returns status 422 Unprocessable Entity including error message.

func ErrRender

func ErrRender(err error) render.Renderer

ErrRender returns status 422 Unprocessable Entity rendering response error.

func ErrValidation

func ErrValidation(err error, valErr validation.Errors) render.Renderer

ErrValidation returns status 422 Unprocessable Entity stating validation errors.

Types

type API

type API struct {
	Account *AccountResource
	Profile *ProfileResource
}

API provides application resources and handlers.

func NewAPI

func NewAPI(db *pg.DB) (*API, error)

NewAPI configures and returns application API.

func (*API) Router

func (a *API) Router() *chi.Mux

Router provides application routes.

type AccountResource

type AccountResource struct {
	Store AccountStore
}

AccountResource implements account management handler.

func NewAccountResource

func NewAccountResource(store AccountStore) *AccountResource

NewAccountResource creates and returns an account resource.

type AccountStore

type AccountStore interface {
	Get(id int) (*pwdless.Account, error)
	Update(*pwdless.Account) error
	Delete(*pwdless.Account) error
	UpdateToken(*jwt.Token) error
	DeleteToken(*jwt.Token) error
}

AccountStore defines database operations for account.

type ErrResponse

type ErrResponse struct {
	Err            error `json:"-"` // low-level runtime error
	HTTPStatusCode int   `json:"-"` // http response status code

	StatusText       string            `json:"status"`           // user-level status message
	AppCode          int64             `json:"code,omitempty"`   // application-specific error code
	ErrorText        string            `json:"error,omitempty"`  // application-level error message, for debugging
	ValidationErrors validation.Errors `json:"errors,omitempty"` // user level model validation errors
}

ErrResponse renderer type for handling all sorts of errors.

func (*ErrResponse) Render

func (e *ErrResponse) Render(w http.ResponseWriter, r *http.Request) error

Render sets the application-specific error code in AppCode.

type ProfileResource

type ProfileResource struct {
	Store ProfileStore
}

ProfileResource implements profile management handler.

func NewProfileResource

func NewProfileResource(store ProfileStore) *ProfileResource

NewProfileResource creates and returns a profile resource.

type ProfileStore

type ProfileStore interface {
	Get(accountID int) (*models.Profile, error)
	Update(p *models.Profile) error
}

ProfileStore defines database operations for a profile.