util

Documentation

Index

• Constants
• Variables
• func CleanEndpoint(s string) (string, error)
• func ComputeJSONHmac(hash, data, secret string, order bool) (string, error)
• func ConvertDefaultHeaderToCustomHeader(h *http.Header) *datastore.HttpHeader
• func GenerateAPIKey() (string, string)
• func GenerateRandomString(n int) (string, error)
• func GenerateSecret() (string, error)
• func IsJSON(s string) bool
• func IsStringEmpty(s string) bool
• func JsonReMarshalString(s string) (string, error)
• func ReadJSON(r *http.Request, dst interface{}) error
• func Validate(dst interface{}) error
• type Response
  • func (res Response) Render(w http.ResponseWriter, r *http.Request) error
• type ServerResponse
  • func NewErrorResponse(msg string, statusCode int) ServerResponse
  • func NewServerResponse(msg string, object interface{}, statusCode int) ServerResponse
  • func NewServiceErrResponse(err error) ServerResponse
• type ServiceError
  • func NewServiceError(errCode int, errMsg error) *ServiceError
  • func (s *ServiceError) ErrCode() int
  • func (s *ServiceError) Error() string
• type Signature
  • func GenerateSignatureHeader(replayAttacks bool, hash string, secret string, data json.RawMessage) (*Signature, error)

Constants

const (
	Prefix    string = "CO"
	Seperator string = "."
)

Variables

var ErrEmptyBody = errors.New("body must not be empty")

Functions

func CleanEndpoint

func CleanEndpoint(s string) (string, error)

func ComputeJSONHmac

func ComputeJSONHmac(hash, data, secret string, order bool) (string, error)

func ConvertDefaultHeaderToCustomHeader

func ConvertDefaultHeaderToCustomHeader(h *http.Header) *datastore.HttpHeader

ConvertDefaultHeaderToCustomHeader converts http.Header to convoy.HttpHeader

func GenerateAPIKey

func GenerateAPIKey() (string, string)

func GenerateRandomString

func GenerateRandomString(n int) (string, error)

func GenerateSecret

func GenerateSecret() (string, error)

func IsJSON

func IsJSON(s string) bool

func IsStringEmpty

func IsStringEmpty(s string) bool

IsStringEmpty checks if the given string s is empty or not

func JsonReMarshalString

func JsonReMarshalString(s string) (string, error)

func ReadJSON

func ReadJSON(r *http.Request, dst interface{}) error

func Validate

func Validate(dst interface{}) error

Types

type Response

type Response struct {
	StatusCode int `json:"-"`
}

func (Response) Render

func (res Response) Render(w http.ResponseWriter, r *http.Request) error

type ServerResponse

type ServerResponse struct {
	Response
	Status  bool            `json:"status"`
	Message string          `json:"message"`
	Data    json.RawMessage `json:"data,omitempty"`
}

func NewErrorResponse

func NewErrorResponse(msg string, statusCode int) ServerResponse

func NewServerResponse

func NewServerResponse(msg string, object interface{}, statusCode int) ServerResponse

func NewServiceErrResponse

func NewServiceErrResponse(err error) ServerResponse

type ServiceError

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

func NewServiceError

func NewServiceError(errCode int, errMsg error) *ServiceError

func (*ServiceError) ErrCode

func (s *ServiceError) ErrCode() int

func (*ServiceError) Error

func (s *ServiceError) Error() string

type Signature

type Signature struct {
	Timestamp   string
	Hmac        string
	EncodedData []byte
}

func GenerateSignatureHeader

func GenerateSignatureHeader(replayAttacks bool, hash string, secret string, data json.RawMessage) (*Signature, error)