common

Documentation

Index

• Constants
• func AddOneItem[T any](r *http.Request, cache *core.Cache, model *T)
• func DeleteOneItem[T any](r *http.Request, cache *core.Cache, model *T)
• func FlushUserData(users *map[string]models.User, callerID string) *map[string]models.User
• func GetAllItems[T any](r *http.Request, cache *core.Cache, model T, subsystem string)
• func GetOneItem[T any](r *http.Request, cache *core.Cache, model T, subsystem string)
• func UnmarshalRequestData[T any](r *http.Request, model *T) error
• func UpdateOneItem[T any](r *http.Request, cache *core.Cache, model *T)
• func WriteResponse(w http.ResponseWriter, resp interface{}, code int) error
• type APIResponse
• type Logger
  • func NewLogger(r *http.Request, worker string) *Logger
  • func (l *Logger) Error(err error) *Logger
  • func (l *Logger) Log() *Logger
  • func (l *Logger) Msg(msg string) *Logger
  • func (l *Logger) Payload(pl interface{}) *Logger
  • func (l *Logger) Println(msg string, code int) bool
  • func (l *Logger) Status(code int) *Logger
  • func (l *Logger) Write(w http.ResponseWriter)
• type ServiceOpts

Constants

const (
	// generic error messages
	ERR_CALLER_BLANK      = "callerID cannot be empty"
	ERR_CALLER_FAIL       = "could not get caller's name"
	ERR_CALLER_NOT_FOUND  = "caller not found in the database"
	ERR_USER_NOT_FOUND    = "user not found in the database"
	ERR_PAGENO_INCORRECT  = "pageNo has to be specified as integer/number"
	ERR_PAGE_EXPORT_NIL   = "could not get more pages, one exported map is nil!"
	ERR_INPUT_DATA_FAIL   = "could not process the input data, try again"
	ERR_API_TOKEN_BLANK   = "blank API token sent"
	ERR_API_TOKEN_INVALID = "invalid API token sent"

	// auth-related error messages
	ERR_AUTH_FAIL           = "wrong credentials entered, or such user does not exist"
	ERR_AUTH_ACC_TOKEN_FAIL = "could not generate new access token"
	ERR_AUTH_REF_TOKEN_FAIL = "could not generate new refresh token"
	ERR_TOKEN_SAVE_FAIL     = "could not save new token to database"

	// post-related error messages
	ERR_POST_BLANK          = "post has got no content"
	ERR_POSTER_INVALID      = "you can add yours posts only"
	ERR_POST_SAVE_FAIL      = "could not save the post, try again"
	ERR_POST_NOT_FOUND      = "could not find the post (may be deleted)"
	ERR_POST_SELF_RATE      = "you cannot rate your own posts"
	ERR_POST_UPDATE_FOREIGN = "you cannot update a foreigner's post"
	ERR_POST_DELETE_FOREIGN = "you cannot delete a foreigner's post"
	ERR_POST_DELETE_FAIL    = "could not delete the post, try again"
	ERR_POST_DELETE_THUMB   = "could not delete associated thumbnail"
	ERR_POST_DELETE_FULLIMG = "could not delete associated full image"

	// image-processing-related error messages
	ERR_IMG_DECODE_FAIL      = "image: could not decode to byte stream"
	ERR_IMG_ENCODE_FAIL      = "image: could not re-encode"
	ERR_IMG_ORIENTATION_FAIL = "image: could not fix the orientation"
	ERR_IMG_GIF_TO_WEBP_FAIL = "image: could not convert GIF to WebP"
	ERR_IMG_UNKNOWN_TYPE     = "image: unsupported format entered"
	ERR_IMG_SAVE_FILE_FAIL   = "image: could not save to a file"
	ERR_IMG_THUMBNAIL_FAIL   = "image: could not re-encode the thumbnail"

	// user-related error messages
	ERR_USER_DELETE_FOREIGN      = "you cannot delete a foreigner's account"
	ERR_USER_DELETE_FAIL         = "could not delete the user from user database, try again"
	ERR_SUBSCRIPTION_DELETE_FAIL = "could not delete the user from subscriptions, try again"

	// poll-related error messages
	ERR_POLL_AUTHOR_MISMATCH = "you cannot post a foreigner's poll"
	ERR_POLL_SAVE_FAIL       = "could not save the poll, try again"
	ERR_POLL_POST_FAIL       = "could not save a post about the new poll"
	ERR_POLL_NOT_FOUND       = "such poll not found in the database (may be deleted)"
	ERR_POLL_SELF_VOTE       = "you cannot vote on yours own poll"
	ERR_POLL_EXISTING_VOTE   = "you have already voted on such poll"
	ERR_POLL_DELETE_FOREIGN  = "you cannot delete a foreigner's poll"
	ERR_POLL_DELETE_FAIL     = "could not delete the poll, try again"

	// push-related error messages
	ERR_DEVICE_NOT_FOUND       = "devices not found in the database"
	ERR_SUBSCRIPTION_SAVE_FAIL = "could not save the subscription to database"
	ERR_SUBSCRIPTION_NOT_FOUND = "such subscription not found in the database"
	ERR_DEVICE_SUBSCRIBED      = "this device has been already registered"
	ERR_PUSH_SELF_NOTIF        = "will not notify oneself"
	ERR_PUSH_DISABLED_NOTIF    = "will not notify original poster"
	ERR_PUSH_UUID_BLANK        = "device's UUID cannot be sent empty"
)

Functions

func AddOneItem

func AddOneItem[T any](r *http.Request, cache *core.Cache, model *T)

func DeleteOneItem

func DeleteOneItem[T any](r *http.Request, cache *core.Cache, model *T)

func FlushUserData

func FlushUserData(users *map[string]models.User, callerID string) *map[string]models.User

func GetAllItems

func GetAllItems[T any](r *http.Request, cache *core.Cache, model T, subsystem string)

func GetOneItem

func GetOneItem[T any](r *http.Request, cache *core.Cache, model T, subsystem string)

func UnmarshalRequestData

func UnmarshalRequestData[T any](r *http.Request, model *T) error

func UpdateOneItem

func UpdateOneItem[T any](r *http.Request, cache *core.Cache, model *T)

func WriteResponse

func WriteResponse(w http.ResponseWriter, resp interface{}, code int) error

Types

type APIResponse

type APIResponse struct {
	// Common fields for all responses
	Message   string `json:"message"`
	Timestamp int64  `json:"timestamp"`

	// Data field for any payload
	Data interface{} `json:"data"`
}

new generic API response schema idea

type Logger

type Logger struct {
	// CallerID is a nickname of the user calling the API.
	CallerID string `json:"-"`

	// Code integer is a HTTP return code.
	Code int `json:"code" validation:"required"`

	// IPAddress string is basically an user's IPv4/IPv6 address (beware of proxies).
	IPAddress string `json:"-"`

	// Message string holds a custom message returned by a various HTTP handler.
	Message string `json:"message" validation:"required"`

	// Method string hold a HTTP method name.
	Method string `json:"method"`

	// Route string is the very route called by user.
	Route string `json:"route"`

	// Time property hold the actual time of the request processing.
	Time time.Time `json:"time" validation:"required"`

	// Version is the tagged version of the client's SW (compiled in).
	Version string `json:"version"`

	// WorkerName string is the name of a worker processing such request.
	WorkerName string `json:"worker_name" validation:"required"`

	Response *APIResponse `json:"-"`

	Err error `json:"-"`
}

func NewLogger

func NewLogger(r *http.Request, worker string) *Logger

func (*Logger) Error

func (l *Logger) Error(err error) *Logger

func (*Logger) Log

func (l *Logger) Log() *Logger

func (*Logger) Msg

func (l *Logger) Msg(msg string) *Logger

l.Msg("this user does not exist in the database").StatusCode(http.StatusNotFound).Log().Write(w)

func (*Logger) Payload

func (l *Logger) Payload(pl interface{}) *Logger

func (*Logger) Println

func (l *Logger) Println(msg string, code int) bool

Println formats the encoded Logger struct into an output string to stdin.

func (*Logger) Status

func (l *Logger) Status(code int) *Logger

func (*Logger) Write

func (l *Logger) Write(w http.ResponseWriter)

type ServiceOpts

type ServiceOpts struct {
	Request *http.Request

	Polls bool
	Posts bool
	Stats bool
	Users bool
}