api

Documentation

Index

• func AdminAuth(c *fiber.Ctx) error
• func CreateTokenFromUser(user *types.User) string
• func ErrorHandler(c *fiber.Ctx, err error) error
• func JWTAuthentication(userStore db.UserStore) fiber.Handler
• type AuthHandler
  • func NewAuthHandler(userStore db.UserStore) *AuthHandler
  • func (h *AuthHandler) HandleAuthenticate(c *fiber.Ctx) error
• type AuthParams
• type AuthResponse
• type BookRoomParams
  • func (p *BookRoomParams) Validate() error
• type BookingHandler
  • func NewBookingHandler(store *db.Store) *BookingHandler
  • func (h *BookingHandler) HandleCancelBooking(c *fiber.Ctx) error
  • func (h *BookingHandler) HandleGetBooking(c *fiber.Ctx) error
  • func (h *BookingHandler) HandleGetBookings(c *fiber.Ctx) error
• type Error
  • func ErrBadRequest() Error
  • func ErrInvalidID() Error
  • func ErrResourceNotFound(res string) Error
  • func ErrUnauthorized() Error
  • func NewError(code int, err string) Error
  • func (e Error) Error() string
• type HotelHandler
  • func NewHotelHandler(store *db.Store) *HotelHandler
  • func (h *HotelHandler) HandleGetHotel(c *fiber.Ctx) error
  • func (h *HotelHandler) HandleGetHotels(c *fiber.Ctx) error
  • func (h *HotelHandler) HandleGetRooms(c *fiber.Ctx) error
• type HotelQueryParams
• type ResourceResponse
• type RoomHandler
  • func NewRoomHandler(store *db.Store) *RoomHandler
  • func (h *RoomHandler) HandleBookRoom(c *fiber.Ctx) error
  • func (h *RoomHandler) HandleGetRooms(c *fiber.Ctx) error
• type UserHandler
  • func NewUserHandler(userStore db.UserStore) *UserHandler
  • func (h *UserHandler) HandleDeleteUser(c *fiber.Ctx) error
  • func (h *UserHandler) HandleGetUser(c *fiber.Ctx) error
  • func (h *UserHandler) HandleGetUsers(c *fiber.Ctx) error
  • func (h *UserHandler) HandlePostUser(c *fiber.Ctx) error
  • func (h *UserHandler) HandlePutUser(c *fiber.Ctx) error

Functions

func AdminAuth

func AdminAuth(c *fiber.Ctx) error

func CreateTokenFromUser

func CreateTokenFromUser(user *types.User) string

func ErrorHandler

func ErrorHandler(c *fiber.Ctx, err error) error

func JWTAuthentication

func JWTAuthentication(userStore db.UserStore) fiber.Handler

Types

type AuthHandler

type AuthHandler struct {
	// contains filtered or unexported fields
}

func NewAuthHandler

func NewAuthHandler(userStore db.UserStore) *AuthHandler

func (*AuthHandler) HandleAuthenticate

func (h *AuthHandler) HandleAuthenticate(c *fiber.Ctx) error

A handler should only do: 1. Parse (serialize) the incoming request (JSON, XML, etc.) 2. Do some data fetching (if needed), from a database or an external API 3. Call some buisess logic (e.g. validation, transformation) 4. Return a response (JSON, XML, etc.) back to the client

type AuthParams

type AuthParams struct {
	Email    string `json:"email"`
	Password string `json:"password"`
}

type AuthResponse

type AuthResponse struct {
	User  *types.User `json:"user"`
	Token string      `json:"token"`
}

type BookRoomParams

type BookRoomParams struct {
	FromDate   time.Time `json:"fromDate"`
	TillDate   time.Time `json:"tillDate"`
	NumPersons int       `json:"numPersons"`
}

func (*BookRoomParams) Validate

func (p *BookRoomParams) Validate() error

type BookingHandler

type BookingHandler struct {
	// contains filtered or unexported fields
}

func NewBookingHandler

func NewBookingHandler(store *db.Store) *BookingHandler

func (*BookingHandler) HandleCancelBooking

func (h *BookingHandler) HandleCancelBooking(c *fiber.Ctx) error

func (*BookingHandler) HandleGetBooking

func (h *BookingHandler) HandleGetBooking(c *fiber.Ctx) error

func (*BookingHandler) HandleGetBookings

func (h *BookingHandler) HandleGetBookings(c *fiber.Ctx) error

type Error

type Error struct {
	Code int    `json:"code"`
	Err  string `json:"error"`
}

func ErrBadRequest

func ErrBadRequest() Error

func ErrInvalidID

func ErrInvalidID() Error

func ErrResourceNotFound

func ErrResourceNotFound(res string) Error

func ErrUnauthorized

func ErrUnauthorized() Error

func NewError

func NewError(code int, err string) Error

func (Error) Error

func (e Error) Error() string

Error, (struct above), implements the error interface

type HotelHandler

type HotelHandler struct {
	// contains filtered or unexported fields
}

func NewHotelHandler

func NewHotelHandler(store *db.Store) *HotelHandler

func (*HotelHandler) HandleGetHotel

func (h *HotelHandler) HandleGetHotel(c *fiber.Ctx) error

func (*HotelHandler) HandleGetHotels

func (h *HotelHandler) HandleGetHotels(c *fiber.Ctx) error

func (*HotelHandler) HandleGetRooms

func (h *HotelHandler) HandleGetRooms(c *fiber.Ctx) error

type HotelQueryParams

type HotelQueryParams struct {
	db.Pagination
	Rating int
}

type ResourceResponse

type ResourceResponse struct {
	Results int `json:"results"`
	Data    any `json:"data"`
	Page    int `json:"page"`
}

type RoomHandler

type RoomHandler struct {
	// contains filtered or unexported fields
}

func NewRoomHandler

func NewRoomHandler(store *db.Store) *RoomHandler

func (*RoomHandler) HandleBookRoom

func (h *RoomHandler) HandleBookRoom(c *fiber.Ctx) error

func (*RoomHandler) HandleGetRooms

func (h *RoomHandler) HandleGetRooms(c *fiber.Ctx) error

type UserHandler

type UserHandler struct {
	// contains filtered or unexported fields
}

func NewUserHandler

func NewUserHandler(userStore db.UserStore) *UserHandler

constructor; a factory function

func (*UserHandler) HandleDeleteUser

func (h *UserHandler) HandleDeleteUser(c *fiber.Ctx) error

func (*UserHandler) HandleGetUser

func (h *UserHandler) HandleGetUser(c *fiber.Ctx) error

func (*UserHandler) HandleGetUsers

func (h *UserHandler) HandleGetUsers(c *fiber.Ctx) error

func (*UserHandler) HandlePostUser

func (h *UserHandler) HandlePostUser(c *fiber.Ctx) error

func (*UserHandler) HandlePutUser

func (h *UserHandler) HandlePutUser(c *fiber.Ctx) error