app

Documentation

Overview

Package app provides a preconfigured HTTP server.

Index

• func NewMuxRouter() *mux.Router
• type AccessTokenConverter
• type Authorizer
• type CreateMovieService
• type DeleteMovieService
• type Driver
  • func NewDriver() *Driver
  • func (d *Driver) ListenAndServe(addr string, h http.Handler) error
  • func (d *Driver) Shutdown(ctx context.Context) error
• type FindMovieService
• type LoggerService
• type PingService
• type Server
  • func NewServer(r *mux.Router, params *ServerParams) (*Server, error)
  • func (s *Server) AccessTokenHandler(h http.Handler) http.Handler
  • func (s *Server) AuthorizeUserHandler(h http.Handler) http.Handler
  • func (s *Server) ConvertAccessTokenHandler(h http.Handler) http.Handler
  • func (s *Server) CtxWithUserChain() alice.Chain
  • func (s *Server) DefaultRealmHandler(h http.Handler) http.Handler
  • func (s *Server) JSONContentTypeResponseHandler(h http.Handler) http.Handler
  • func (s *Server) ListenAndServe() error
  • func (s *Server) LoggerChain() alice.Chain
  • func (s *Server) Shutdown(ctx context.Context) error
• type ServerParams
  • func NewServerParams(lgr zerolog.Logger, d driver.Server) *ServerParams
• type UpdateMovieService

Functions

func NewMuxRouter

func NewMuxRouter() *mux.Router

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

Types

type AccessTokenConverter

type AccessTokenConverter interface {
	Convert(ctx context.Context, token auth.AccessToken) (user.User, error)
}

AccessTokenConverter interface converts an access token to a User

type Authorizer

type Authorizer interface {
	Authorize(lgr zerolog.Logger, sub user.User, obj string, act string) error
}

Authorizer interface authorizes access to a resource given a user and action

type CreateMovieService

type CreateMovieService interface {
	Create(ctx context.Context, r *service.CreateMovieRequest, u user.User) (service.MovieResponse, error)
}

CreateMovieService creates a Movie

type DeleteMovieService

type DeleteMovieService interface {
	Delete(ctx context.Context, extlID string) (service.DeleteMovieResponse, error)
}

DeleteMovieService is a service for deleting a Movie

type Driver

type Driver struct {
	Server http.Server
}

Driver implements the driver.Server interface. The zero value is a valid http.Server.

func NewDriver

func NewDriver() *Driver

NewDriver creates a Driver with an http.Server with default timeouts.

func (*Driver) ListenAndServe

func (d *Driver) ListenAndServe(addr string, h http.Handler) error

ListenAndServe sets the address and handler on Driver's http.Server, then calls ListenAndServe on it.

func (*Driver) Shutdown

func (d *Driver) Shutdown(ctx context.Context) error

Shutdown gracefully shuts down the server without interrupting any active connections, by calling Shutdown on Driver's http.Server

type FindMovieService

type FindMovieService interface {
	FindMovieByID(ctx context.Context, extlID string) (service.MovieResponse, error)
	FindAllMovies(ctx context.Context) ([]service.MovieResponse, error)
}

FindMovieService interface reads a Movie form the database

type LoggerService

type LoggerService interface {
	Read() service.LoggerResponse
	Update(r *service.LoggerRequest) (service.LoggerResponse, error)
}

LoggerService reads and updates the logger state

type PingService

type PingService interface {
	Ping(ctx context.Context, logger zerolog.Logger) service.PingResponse
}

PingService pings the database and responds whether it is up or down

type Server

type Server struct {

	// Addr optionally specifies the TCP address for the server to listen on,
	// in the form "host:port". If empty, ":http" (port 80) is used.
	// The service names are defined in RFC 6335 and assigned by IANA.
	// See net.Dial for details of the address format.
	Addr string

	// Authorization
	AccessTokenConverter AccessTokenConverter
	Authorizer           Authorizer

	// Services used by the various HTTP routes.
	PingService        PingService
	LoggerService      LoggerService
	CreateMovieService CreateMovieService
	UpdateMovieService UpdateMovieService
	DeleteMovieService DeleteMovieService
	FindMovieService   FindMovieService
	// contains filtered or unexported fields
}

Server represents an HTTP server.

func NewServer

func NewServer(r *mux.Router, params *ServerParams) (*Server, error)

NewServer initializes a new Server and registers routes to the given router

func (*Server) AccessTokenHandler

func (s *Server) 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 (*Server) AuthorizeUserHandler

func (s *Server) AuthorizeUserHandler(h http.Handler) http.Handler

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

func (*Server) ConvertAccessTokenHandler

func (s *Server) 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 (*Server) CtxWithUserChain

func (s *Server) CtxWithUserChain() alice.Chain

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

func (*Server) DefaultRealmHandler

func (s *Server) DefaultRealmHandler(h http.Handler) http.Handler

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

func (*Server) JSONContentTypeResponseHandler

func (s *Server) JSONContentTypeResponseHandler(h http.Handler) http.Handler

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

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

ListenAndServe is a wrapper to use wherever http.ListenAndServe is used.

func (*Server) LoggerChain

func (s *Server) 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.

func (*Server) Shutdown

func (s *Server) Shutdown(ctx context.Context) error

Shutdown gracefully shuts down the server without interrupting any active connections.

type ServerParams

type ServerParams struct {
	// Logger is used for app logging
	Logger zerolog.Logger

	// Driver serves HTTP requests.
	Driver driver.Server
}

ServerParams is the set of configuration parameters for a Server

func NewServerParams

func NewServerParams(lgr zerolog.Logger, d driver.Server) *ServerParams

NewServerParams is an initializer for ServerParams

type UpdateMovieService

type UpdateMovieService interface {
	Update(ctx context.Context, r *service.UpdateMovieRequest, u user.User) (service.MovieResponse, error)
}

UpdateMovieService is a service for updating a Movie