handler

Documentation

Overview

Package handler is for all the application handlers and routing

Index

• func AccessTokenHandler(h http.Handler) http.Handler
• func AuthorizeUserHandler(authorizer auth.Authorizer) (mw func(h http.Handler) http.Handler)
• func ConvertAccessTokenHandler(converter auth.AccessTokenConverter) (mw func(h http.Handler) http.Handler)
• func DecoderErr(err error) error
• func JSONContentTypeResponseHandler(h http.Handler) http.Handler
• func NewMuxRouter(logger zerolog.Logger, mw Middleware, handlers Handlers) *mux.Router
• type AccessTokenMw
  • func NewAccessTokenMw() AccessTokenMw
• type AuthorizeUserMw
  • func NewAuthorizeUserMw(authorizer auth.Authorizer) AuthorizeUserMw
• type ConvertAccessTokenMw
  • func NewConvertAccessTokenMw(converter auth.AccessTokenConverter) ConvertAccessTokenMw
• type CreateMovieHandler
  • func NewCreateMovieHandler(h DefaultMovieHandlers) CreateMovieHandler
• type DefaultLoggerHandlers
  • func (h DefaultLoggerHandlers) ReadLogger(w http.ResponseWriter, r *http.Request)
  • func (h DefaultLoggerHandlers) UpdateLogger(w http.ResponseWriter, r *http.Request)
• 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 JSONContentTypeResponseMw
  • func NewJSONContentTypeResponseMw() JSONContentTypeResponseMw
• type Middleware
  • func (mw Middleware) AccessTokenMiddleware() alice.Constructor
  • func (mw Middleware) AuthorizeUserMiddleware() alice.Constructor
  • func (mw Middleware) ConvertAccessTokenMiddleware() alice.Constructor
  • func (mw Middleware) JSONContentTypeResponseMiddleware() alice.Constructor
• type PingHandler
  • func NewPingHandler(h DefaultPingHandler) PingHandler
• type ReadLoggerHandler
  • func NewReadLoggerHandler(h DefaultLoggerHandlers) ReadLoggerHandler
• type UpdateLoggerHandler
  • func NewUpdateLoggerHandler(h DefaultLoggerHandlers) UpdateLoggerHandler
• type UpdateMovieHandler
  • func NewUpdateMovieHandler(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 AuthorizeUserHandler

func AuthorizeUserHandler(authorizer auth.Authorizer) (mw func(h http.Handler) http.Handler)

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

func ConvertAccessTokenHandler

func ConvertAccessTokenHandler(converter auth.AccessTokenConverter) (mw func(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 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 JSONContentTypeResponseHandler

func JSONContentTypeResponseHandler(h http.Handler) http.Handler

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

func NewMuxRouter

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

NewMuxRouter initializes a gorilla/mux router and registers routes and corresponding middleware/handlers to it

Types

type AccessTokenMw

type AccessTokenMw alice.Constructor

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

func NewAccessTokenMw

func NewAccessTokenMw() AccessTokenMw

NewAccessTokenMw is an initializer for AccessTokenMw

type AuthorizeUserMw

type AuthorizeUserMw alice.Constructor

AuthorizeUserMw middleware is used to authorize a User's access to a resource at a given request path and http method

func NewAuthorizeUserMw

func NewAuthorizeUserMw(authorizer auth.Authorizer) AuthorizeUserMw

NewAuthorizeUserMw is an initializer for AuthorizeUserMw

type ConvertAccessTokenMw

type ConvertAccessTokenMw alice.Constructor

ConvertAccessTokenMw middleware is used to convert an access token to a User

func NewConvertAccessTokenMw

func NewConvertAccessTokenMw(converter auth.AccessTokenConverter) ConvertAccessTokenMw

NewConvertAccessTokenMw is an initializer for ConvertAccessTokenMw

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 DefaultLoggerHandlers

type DefaultLoggerHandlers struct {
	AccessTokenConverter auth.AccessTokenConverter
	Authorizer           auth.Authorizer
}

DefaultLoggerHandlers are the default handlers for working with the app logger. Each method on the struct is a separate handler.

func (DefaultLoggerHandlers) ReadLogger

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

ReadLogger handles GET requests for the /logger endpoint

func (DefaultLoggerHandlers) UpdateLogger

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

UpdateLogger handles PUT requests for the /logger endpoint and updates the given movie

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 JSONContentTypeResponseMw

type JSONContentTypeResponseMw alice.Constructor

JSONContentTypeResponseMw is a middleware to add a application/json Content-Type Header to responses

func NewJSONContentTypeResponseMw

func NewJSONContentTypeResponseMw() JSONContentTypeResponseMw

NewJSONContentTypeResponseMw is an initializer for JSONContentTypeResponseMw

type Middleware

type Middleware struct {
	JSONContentTypeResponseMw JSONContentTypeResponseMw
	AccessTokenMw             AccessTokenMw
	ConvertAccessTokenMw      ConvertAccessTokenMw
	AuthorizeUserMw           AuthorizeUserMw
}

Middleware are a bundled set of all the application middlewares

func (Middleware) AccessTokenMiddleware

func (mw Middleware) AccessTokenMiddleware() alice.Constructor

AccessTokenMiddleware returns the access token middleware

func (Middleware) AuthorizeUserMiddleware

func (mw Middleware) AuthorizeUserMiddleware() alice.Constructor

AuthorizeUserMiddleware returns the Authorize User middleware

func (Middleware) ConvertAccessTokenMiddleware

func (mw Middleware) ConvertAccessTokenMiddleware() alice.Constructor

ConvertAccessTokenMiddleware returns the Access Token converter middleware

func (Middleware) JSONContentTypeResponseMiddleware

func (mw Middleware) JSONContentTypeResponseMiddleware() alice.Constructor

JSONContentTypeResponseMiddleware returns the JSON Content response middleware

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(h DefaultLoggerHandlers) 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(h DefaultLoggerHandlers) 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