handler

Documentation

Overview

Package handler is for all the application handlers and routing

Index

• func AccessTokenHandler(h http.Handler) http.Handler
• func DecoderErr(err error) error
• func JSONContentTypeHandler(h http.Handler) http.Handler
• func LoggerHandlerChain(logger zerolog.Logger, c alice.Chain) alice.Chain
• func NewMuxRouter(logger zerolog.Logger, handlers Handlers) *mux.Router
• type CreateMovieHandler
  • func ProvideCreateMovieHandler(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 ProvideDeleteMovieHandler(h DefaultMovieHandlers) DeleteMovieHandler
• type FindAllMoviesHandler
  • func ProvideFindAllMoviesHandler(h DefaultMovieHandlers) FindAllMoviesHandler
• type FindMovieByIDHandler
  • func ProvideFindMovieByIDHandler(h DefaultMovieHandlers) FindMovieByIDHandler
• type Handlers
• type PingHandler
  • func ProvidePingHandler(h DefaultPingHandler) PingHandler
• type StandardResponse
  • func NewStandardResponse(r *http.Request, d interface{}) (*StandardResponse, error)
• type UpdateMovieHandler
  • func ProvideUpdateMovieHandler(h DefaultMovieHandlers) UpdateMovieHandler

Functions

func AccessTokenHandler

func 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 DecoderErr

func DecoderErr(err error) error

DecoderErr handles an error returned by json.NewDecoder(r.Body).Decode(&data) this function will determine the appropriate error response

func JSONContentTypeHandler

func JSONContentTypeHandler(h http.Handler) http.Handler

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

func LoggerHandlerChain

func LoggerHandlerChain(logger zerolog.Logger, c alice.Chain) alice.Chain

LoggerHandlerChain returns a handler chain (via alice.Chain) initialized with all the standard 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.

func NewMuxRouter

func NewMuxRouter(logger zerolog.Logger, handlers Handlers) *mux.Router

NewMuxRouter sets up the mux.Router and registers routes to URL paths using the available handlers

Types

type CreateMovieHandler

type CreateMovieHandler http.Handler

CreateMovieHandler is a Handler creates a Movie

func ProvideCreateMovieHandler

func ProvideCreateMovieHandler(h DefaultMovieHandlers) CreateMovieHandler

ProvideCreateMovieHandler is a provider for the CreateMovieHandler for wire

type DefaultMovieHandlers

type DefaultMovieHandlers struct {
	AccessTokenConverter auth.AccessTokenConverter
	Authorizer           auth.Authorizer
	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 ProvideDeleteMovieHandler

func ProvideDeleteMovieHandler(h DefaultMovieHandlers) DeleteMovieHandler

ProvideDeleteMovieHandler is a provider for the DeleteMovieHandler for wire

type FindAllMoviesHandler

type FindAllMoviesHandler http.Handler

FindAllMoviesHandler is a Handler that returns the entire set of Movies

func ProvideFindAllMoviesHandler

func ProvideFindAllMoviesHandler(h DefaultMovieHandlers) FindAllMoviesHandler

ProvideFindAllMoviesHandler is a provider for the FindAllMoviesHandler for wire

type FindMovieByIDHandler

type FindMovieByIDHandler http.Handler

FindMovieByIDHandler is a Handler finds a Movie by ID

func ProvideFindMovieByIDHandler

func ProvideFindMovieByIDHandler(h DefaultMovieHandlers) FindMovieByIDHandler

ProvideFindMovieByIDHandler is a provider for the FindMovieByIDHandler for wire

type Handlers

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

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

type PingHandler

type PingHandler http.Handler

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

func ProvidePingHandler

func ProvidePingHandler(h DefaultPingHandler) PingHandler

ProvidePingHandler is a provider for the PingHandler for wire

type StandardResponse

type StandardResponse struct {
	Path      string      `json:"path,omitempty"`
	RequestID string      `json:"request_id,omitempty"`
	Data      interface{} `json:"data"`
}

StandardResponse is meant to be included in all non-error response bodies and includes "standard" response fields

func NewStandardResponse

func NewStandardResponse(r *http.Request, d interface{}) (*StandardResponse, error)

NewStandardResponse is an initializer for the StandardResponse struct

type UpdateMovieHandler

type UpdateMovieHandler http.Handler

UpdateMovieHandler is a Handler that updates a Movie

func ProvideUpdateMovieHandler

func ProvideUpdateMovieHandler(h DefaultMovieHandlers) UpdateMovieHandler

ProvideUpdateMovieHandler is a provider for the UpdateMovieHandler for wire