handler

Documentation

Overview

Package handler is for all the application handlers and routing

Index

• func DecoderErr(err error) error
• func NewMuxRouterWithSubroutes() *mux.Router
• func ReadLogger(w http.ResponseWriter, r *http.Request)
• func Routes(rtr *mux.Router, mw Middleware, handlers Handlers)
• func UpdateLogger(w http.ResponseWriter, r *http.Request)
• type CreateMovieHandler
  • func NewCreateMovieHandler(h DefaultMovieHandlers) CreateMovieHandler
• type DefaultMovieHandlers
  • func (h DefaultMovieHandlers) CreateMovie(w http.ResponseWriter, r *http.Request)
  • func (h DefaultMovieHandlers) DeleteMovie(w http.ResponseWriter, r *http.Request)
  • func (h DefaultMovieHandlers) FindAllMovies(w http.ResponseWriter, r *http.Request)
  • func (h DefaultMovieHandlers) FindByID(w http.ResponseWriter, r *http.Request)
  • func (h DefaultMovieHandlers) UpdateMovie(w http.ResponseWriter, r *http.Request)
• type DefaultPingHandler
  • func (h DefaultPingHandler) Ping(w http.ResponseWriter, r *http.Request)
• type DeleteMovieHandler
  • func NewDeleteMovieHandler(h DefaultMovieHandlers) DeleteMovieHandler
• type FindAllMoviesHandler
  • func NewFindAllMoviesHandler(h DefaultMovieHandlers) FindAllMoviesHandler
• type FindMovieByIDHandler
  • func NewFindMovieByIDHandler(h DefaultMovieHandlers) FindMovieByIDHandler
• type Handlers
• type Middleware
  • func (mw Middleware) AccessTokenHandler(h http.Handler) http.Handler
  • func (mw Middleware) AuthorizeUserHandler(h http.Handler) http.Handler
  • func (mw Middleware) ConvertAccessTokenHandler(h http.Handler) http.Handler
  • func (mw Middleware) CtxWithUserChain() alice.Chain
  • func (mw Middleware) DefaultRealmHandler(h http.Handler) http.Handler
  • func (mw Middleware) JSONContentTypeResponseHandler(h http.Handler) http.Handler
  • func (mw Middleware) LoggerChain() alice.Chain
• type PingHandler
  • func NewPingHandler(h DefaultPingHandler) PingHandler
• type ReadLoggerHandler
  • func NewReadLoggerHandler() ReadLoggerHandler
• type UpdateLoggerHandler
  • func NewUpdateLoggerHandler() UpdateLoggerHandler
• type UpdateMovieHandler
  • func NewUpdateMovieHandler(h DefaultMovieHandlers) UpdateMovieHandler

Functions

func DecoderErr

func DecoderErr(err error) error

DecoderErr is a convenience function to handle errors returned by json.NewDecoder(r.Body).Decode(&data) and return the appropriate error response

func NewMuxRouterWithSubroutes

func NewMuxRouterWithSubroutes() *mux.Router

NewMuxRouterWithSubroutes initializes a gorilla/mux router and adds the /api subroute to it

func ReadLogger

func ReadLogger(w http.ResponseWriter, r *http.Request)

ReadLogger handles GET requests for the /logger endpoint

func Routes

func Routes(rtr *mux.Router, mw Middleware, handlers Handlers)

Routes registers routes corresponding middleware/handlers to the given gorilla/mux router

func UpdateLogger

func UpdateLogger(w http.ResponseWriter, r *http.Request)

UpdateLogger handles PUT requests for the /logger endpoint and updates the logger globals

Types

type CreateMovieHandler

type CreateMovieHandler http.Handler

CreateMovieHandler is a Handler that creates a Movie

func NewCreateMovieHandler

func NewCreateMovieHandler(h DefaultMovieHandlers) CreateMovieHandler

NewCreateMovieHandler is a provider for CreateMovieHandler

type DefaultMovieHandlers

type DefaultMovieHandlers struct {
	RandomStringGenerator random.StringGenerator
	Transactor            moviestore.Transactor
	Selector              moviestore.Selector
}

DefaultMovieHandlers are the default handlers for CRUD operations for a Movie. Each method on the struct is a separate handler.

func (DefaultMovieHandlers) CreateMovie

func (h DefaultMovieHandlers) CreateMovie(w http.ResponseWriter, r *http.Request)

CreateMovie is a HandlerFunc used to create a Movie

func (DefaultMovieHandlers) DeleteMovie

func (h DefaultMovieHandlers) DeleteMovie(w http.ResponseWriter, r *http.Request)

DeleteMovie handles DELETE requests for the /movies/{id} endpoint and updates the given movie

func (DefaultMovieHandlers) FindAllMovies

func (h DefaultMovieHandlers) FindAllMovies(w http.ResponseWriter, r *http.Request)

FindAllMovies handles GET requests for the /movies endpoint and finds all movies

func (DefaultMovieHandlers) FindByID

func (h DefaultMovieHandlers) FindByID(w http.ResponseWriter, r *http.Request)

FindByID handles GET requests for the /movies/{id} endpoint and finds a movie by it's ID

func (DefaultMovieHandlers) UpdateMovie

func (h DefaultMovieHandlers) UpdateMovie(w http.ResponseWriter, r *http.Request)

UpdateMovie handles PUT requests for the /movies/{id} endpoint and updates the given movie

type DefaultPingHandler

type DefaultPingHandler struct {
	Pinger pingstore.Pinger
}

DefaultPingHandler is a handler to allow for general health checks

func (DefaultPingHandler) Ping

func (h DefaultPingHandler) Ping(w http.ResponseWriter, r *http.Request)

Ping handles GET requests for the /ping endpoint

type DeleteMovieHandler

type DeleteMovieHandler http.Handler

DeleteMovieHandler is a Handler that deletes a Movie

func NewDeleteMovieHandler

func NewDeleteMovieHandler(h DefaultMovieHandlers) DeleteMovieHandler

NewDeleteMovieHandler is a provider for DeleteMovieHandler

type FindAllMoviesHandler

type FindAllMoviesHandler http.Handler

FindAllMoviesHandler is a Handler that returns the entire set of Movies

func NewFindAllMoviesHandler

func NewFindAllMoviesHandler(h DefaultMovieHandlers) FindAllMoviesHandler

NewFindAllMoviesHandler is a provider for FindAllMoviesHandler

type FindMovieByIDHandler

type FindMovieByIDHandler http.Handler

FindMovieByIDHandler is a Handler finds a Movie by ID

func NewFindMovieByIDHandler

func NewFindMovieByIDHandler(h DefaultMovieHandlers) FindMovieByIDHandler

NewFindMovieByIDHandler is a provider for the FindMovieByIDHandler for wire

type Handlers

type Handlers struct {
	PingHandler          PingHandler
	ReadLoggerHandler    ReadLoggerHandler
	UpdateLoggerHandler  UpdateLoggerHandler
	CreateMovieHandler   CreateMovieHandler
	FindMovieByIDHandler FindMovieByIDHandler
	FindAllMoviesHandler FindAllMoviesHandler
	UpdateMovieHandler   UpdateMovieHandler
	DeleteMovieHandler   DeleteMovieHandler
}

Handlers is a bundled set of all the application's HTTP handlers

type Middleware

type Middleware struct {
	Logger               zerolog.Logger
	AccessTokenConverter auth.AccessTokenConverter
	Authorizer           auth.Authorizer
}

Middleware are the collection of app middleware handlers

func (Middleware) AccessTokenHandler

func (mw Middleware) AccessTokenHandler(h http.Handler) http.Handler

AccessTokenHandler middleware is used to pull the Bearer token from the Authorization header and set it to the request context as an auth.AccessToken

func (Middleware) AuthorizeUserHandler

func (mw Middleware) AuthorizeUserHandler(h http.Handler) http.Handler

AuthorizeUserHandler middleware is used authorize a User for a request path and http method

func (Middleware) ConvertAccessTokenHandler

func (mw Middleware) ConvertAccessTokenHandler(h http.Handler) http.Handler

ConvertAccessTokenHandler middleware is used to convert an AccessToken to a User and store the User to the request context

func (Middleware) CtxWithUserChain

func (mw Middleware) CtxWithUserChain() alice.Chain

CtxWithUserChain chains handlers together to set the Realm, Access Token and User to the Context

func (Middleware) DefaultRealmHandler

func (mw Middleware) DefaultRealmHandler(h http.Handler) http.Handler

DefaultRealmHandler middleware is used to set a default Realm to the request context

func (Middleware) JSONContentTypeResponseHandler

func (mw Middleware) JSONContentTypeResponseHandler(h http.Handler) http.Handler

JSONContentTypeResponseHandler middleware is used to add the application/json Content-Type Header for responses

func (Middleware) LoggerChain

func (mw Middleware) LoggerChain() alice.Chain

LoggerChain returns a middleware chain (via alice.Chain) initialized with all the standard middleware handlers for logging. The logger will be added to the request context for subsequent use with pre-populated fields, including the request method, url, status, size, duration, remote IP, user agent, referer. A unique Request ID is also added to the logger, context and response headers.

type PingHandler

type PingHandler http.Handler

PingHandler is a Handler that gives app status, such as db ping, etc.

func NewPingHandler

func NewPingHandler(h DefaultPingHandler) PingHandler

NewPingHandler is a provider for PingHandler

type ReadLoggerHandler

type ReadLoggerHandler http.Handler

ReadLoggerHandler is a Handler that reads the current state of the app logger

func NewReadLoggerHandler

func NewReadLoggerHandler() ReadLoggerHandler

NewReadLoggerHandler is a provider for ReadLoggerHandler

type UpdateLoggerHandler

type UpdateLoggerHandler http.Handler

UpdateLoggerHandler is a Handler that reads the current state of the app logger

func NewUpdateLoggerHandler

func NewUpdateLoggerHandler() UpdateLoggerHandler

NewUpdateLoggerHandler is a provider for UpdateLoggerHandler

type UpdateMovieHandler

type UpdateMovieHandler http.Handler

UpdateMovieHandler is a Handler that updates a Movie

func NewUpdateMovieHandler

func NewUpdateMovieHandler(h DefaultMovieHandlers) UpdateMovieHandler

NewUpdateMovieHandler is a provider for UpdateMovieHandler