utilities

Documentation

Index

• func CheckObjectID(hexID string) bool
• func GenerateObjectID() string
• func HandleOptionsRequest(w http.ResponseWriter, r *http.Request)
• func RespondWithError(w http.ResponseWriter, status int, error JWTError)
• func SetResponseHeaders(w http.ResponseWriter, authToken string, apiKey string) http.ResponseWriter
• type JWTError
• type JsonErr

Functions

func CheckObjectID

func CheckObjectID(hexID string) bool

CheckObjectID checks whether a hexID is null or now

func GenerateObjectID

func GenerateObjectID() string

GenerateObjectID for index keying records of data

func HandleOptionsRequest

func HandleOptionsRequest(w http.ResponseWriter, r *http.Request)

HandleOptionsRequest handles incoming OPTIONS request

func RespondWithError

func RespondWithError(w http.ResponseWriter, status int, error JWTError)

RespondWithError returns JSON Error to Requested is Auth is bad

func SetResponseHeaders

func SetResponseHeaders(w http.ResponseWriter, authToken string, apiKey string) http.ResponseWriter

SetResponseHeaders sets the response headers being sent back to the client

Types

type JWTError

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

JWTError is a struct that is used to contain a json encoded error message for any JWT related errors

type JsonErr

type JsonErr struct {
	Code int    `json:"code"`
	Text string `json:"text"`
}

JsonErr structures a standard error to return