utils

README

go-utils

Golang Utils

Documentation

Index

• Constants
• func BasicAuthCheck(r *http.Request) error
• func NewError(errStr string) error
• func ReadRequestBody(r *http.Request, out interface{}) error
• func WriteErrorResp(w http.ResponseWriter, r *http.Request, statusCode int, err error)
• func WriteHTTPResp(w http.ResponseWriter, r *http.Request, responseCode int, response interface{})
• func WriteInfoResp(w http.ResponseWriter, r *http.Request, statusCode int, response string)
• func WriteWarnResp(w http.ResponseWriter, r *http.Request, statusCode int, response string)
• type ErrResponse
• type Error
  • func (e Error) NewError() error
• type Logger
  • func (l Logger) EnableDebug() bool
  • func (l Logger) Error()
  • func (l Logger) Info()
  • func (l Logger) Warn()
• type Response
• type StringSlice
  • func (s StringSlice) EntryExists(entry string) bool

Constants

const (
	SuccessStatusCode             = 200
	CreatedStatusCode             = 201
	FoundStatusCode               = 302
	BadRequestStatusCode          = 400
	UnauthorizedStatusCode        = 401
	NotFoundStatusCode            = 404
	MethodNotAllowedStatusCode    = 405
	InternalServerErrorStatusCode = 500

	SuccessStatus             = "200 OK"
	CreatedStatus             = "201 Created"
	FoundStatus               = "302 Found"
	BadReqStatus              = "400 Bad Request"
	UnauthorizedStatus        = "401 Unauthorized"
	NotFoundStatus            = "404 Not Found"
	MethodNotAllowed          = "405 Method Not Allowed"
	InternalServerErrorStatus = "500 Internal Server Error"

	JsonMarshalErrorStr   = "JSON Marshal Error"
	JsonUnmarshalErrorStr = "JSON Unmarshal Error"
	ApiAuthErrorStr       = "401 unauthorized. Please pass username and password to the API"
)

Functions

func BasicAuthCheck

func BasicAuthCheck(r *http.Request) error

BasicAuthCheck check if basic authentication credentials are provided while making a http request The method return an error if something goes wrong

func NewError

func NewError(errStr string) error

NewError creates and returns a new error and returns it

func ReadRequestBody

func ReadRequestBody(r *http.Request, out interface{}) error

ReadRequestBody reads request body in json format, unmarshal's the json writes the data into the address

func WriteErrorResp

func WriteErrorResp(w http.ResponseWriter, r *http.Request, statusCode int, err error)

WriteErrResp writes an http error response and logs the outcome

func WriteHTTPResp

func WriteHTTPResp(w http.ResponseWriter, r *http.Request, responseCode int, response interface{})

WriteHTTPResp writes an http response

func WriteInfoResp

func WriteInfoResp(w http.ResponseWriter, r *http.Request, statusCode int, response string)

WriteInfoResp writes an http info response and logs the outcome

func WriteWarnResp

func WriteWarnResp(w http.ResponseWriter, r *http.Request, statusCode int, response string)

WriteWarnResp writes an http warn response and logs the outcome

Types

type ErrResponse

type ErrResponse struct {
	Error string `json:"error"`
}

ErrResponse represents an error response

type Error

type Error struct {
	ErrStr string
	ErrMsg string
}

Error represents the error format

func (Error) NewError

func (e Error) NewError() error

NewError formats and returns a error

type Logger

type Logger struct {
	Request *http.Request
	Message interface{}
}

Logger represents the output log message

func (Logger) EnableDebug

func (l Logger) EnableDebug() bool

EnableDebug checks if the DEBUG_LOGS env variable is set to true

func (Logger) Error

func (l Logger) Error()

Error writes error logs

func (Logger) Info

func (l Logger) Info()

Info writes information logs

func (Logger) Warn

func (l Logger) Warn()

Warn writes warning logs

type Response

type Response struct {
	Message string `json:"message"`
}

Response represents a http response message

type StringSlice

type StringSlice []string

func (StringSlice) EntryExists

func (s StringSlice) EntryExists(entry string) bool

EntryExists checks if a string exists in a slice of string