utils

Documentation

Index

• Constants
• Variables
• func DeriveCountryFromTel(number string) string
• func Indent(s string, prefix string) string
• func IsNil(v interface{}) bool
• func IsPossibleLocationPath(str string) bool
• func JSONDecodeGeneric(data []byte) (interface{}, error)
• func JSONMarshal(v interface{}) ([]byte, error)
• func JSONMarshalPretty(v interface{}) ([]byte, error)
• func MaxInt(x, y int) int
• func MinInt(x, y int) int
• func PrefixOverlap(s1, s2 string) int
• func ReadTypeFromJSON(data []byte) (string, error)
• func Snakify(text string) string
• func StringSliceContains(slice []string, str string, caseSensitive bool) bool
• func StringSlices(s string, indices []int) []string
• func TokenizeString(str string) []string
• func TokenizeStringByChars(str string, chars string) []string
• func UnmarshalAndValidate(data []byte, obj interface{}) error
• func UnmarshalAndValidateWithLimit(reader io.ReadCloser, s interface{}, limit int64) error
• func UnmarshalArray(data json.RawMessage) ([]json.RawMessage, error)
• func Validate(obj interface{}) error
• type Attachment
  • func (a Attachment) ContentType() string
  • func (a Attachment) ToParts() (string, string)
  • func (a Attachment) URL() string
• type HTTPClient
  • func NewHTTPClient(defaultUserAgent string) *HTTPClient
  • func (c *HTTPClient) Do(request *http.Request) (*http.Response, error)
  • func (c *HTTPClient) DoWithDump(request *http.Request) (*http.Response, string, error)
  • func (c *HTTPClient) MockWithDump(request *http.Request, mockStatus int, mockResponse string) (*http.Response, string, error)
• type Location
  • func NewLocation(level LocationLevel, name string) *Location
  • func (l *Location) Aliases() []string
  • func (l *Location) Children() []*Location
  • func (l *Location) Level() LocationLevel
  • func (l *Location) Name() string
  • func (l *Location) Parent() *Location
  • func (l *Location) Path() LocationPath
  • func (l *Location) String() string
• type LocationHierarchy
  • func NewLocationHierarchy(root *Location, numLevels int) *LocationHierarchy
  • func ReadLocationHierarchy(data json.RawMessage) (*LocationHierarchy, error)
  • func (h *LocationHierarchy) FindByName(name string, level LocationLevel, parent *Location) []*Location
  • func (h *LocationHierarchy) FindByPath(path LocationPath) *Location
  • func (h *LocationHierarchy) Root() *Location
  • func (h *LocationHierarchy) UnmarshalJSON(data []byte) error
• type LocationLevel
• type LocationPath
  • func NewLocationPath(parts ...string) LocationPath
  • func (p LocationPath) Name() string
  • func (p LocationPath) Normalize() LocationPath
• type Typed
• type TypedEnvelope
• type ValidationErrors
  • func (e ValidationErrors) Error() string

Constants

const (
	LocationPathSeparator = ">"
)

Variables

var Validator = validator.New()

Validator is our system validator, it can be shared across threads

Functions

func DeriveCountryFromTel

func DeriveCountryFromTel(number string) string

DeriveCountryFromTel attempts to derive a country code (e.g. RW) from a phone number

func Indent

func Indent(s string, prefix string) string

Indent indents each non-empty line in the given string

func IsNil

func IsNil(v interface{}) bool

IsNil returns whether the given object is nil or an interface to a nil

func IsPossibleLocationPath

func IsPossibleLocationPath(str string) bool

IsPossibleLocationPath returns whether the given string could be a location path

func JSONDecodeGeneric

func JSONDecodeGeneric(data []byte) (interface{}, error)

JSONDecodeGeneric decodes the given JSON as a generic map or slice

func JSONMarshal

func JSONMarshal(v interface{}) ([]byte, error)

JSONMarshal marshals the given object to JSON

func JSONMarshalPretty

func JSONMarshalPretty(v interface{}) ([]byte, error)

JSONMarshalPretty marshals the given object to pretty JSON

func MaxInt

func MaxInt(x, y int) int

MaxInt returns the maximum of two integers

func MinInt

func MinInt(x, y int) int

MinInt returns the minimum of two integers

func PrefixOverlap

func PrefixOverlap(s1, s2 string) int

PrefixOverlap returns the number of prefix characters which s1 and s2 have in common

func ReadTypeFromJSON

func ReadTypeFromJSON(data []byte) (string, error)

ReadTypeFromJSON reads a field called `type` from the given JSON

func Snakify

func Snakify(text string) string

Snakify turns the passed in string into a context reference. We replace all whitespace characters with _ and replace any duplicate underscores

func StringSliceContains

func StringSliceContains(slice []string, str string, caseSensitive bool) bool

StringSliceContains determines whether the given slice of strings contains the given string

func StringSlices

func StringSlices(s string, indices []int) []string

StringSlices returns the slices of s defined by pairs of indexes in indices

func TokenizeString

func TokenizeString(str string) []string

TokenizeString returns the words in the passed in string, split by non word characters including emojis

func TokenizeStringByChars

func TokenizeStringByChars(str string, chars string) []string

TokenizeStringByChars returns the words in the passed in string, split by the chars in the given string

func UnmarshalAndValidate

func UnmarshalAndValidate(data []byte, obj interface{}) error

UnmarshalAndValidate is a convenience function to unmarshal an object and validate it

func UnmarshalAndValidateWithLimit

func UnmarshalAndValidateWithLimit(reader io.ReadCloser, s interface{}, limit int64) error

UnmarshalAndValidateWithLimit unmarsmals a struct with a limit on how many bytes can be read from the given reader

func UnmarshalArray

func UnmarshalArray(data json.RawMessage) ([]json.RawMessage, error)

UnmarshalArray unmarshals an array of objects from the given JSON

func Validate

func Validate(obj interface{}) error

Validate will run validation on the given object and return a set of field specific errors in the format: field <fieldname> <tag specific message>

For example: "field 'flows' is required"

Types

type Attachment

type Attachment string

Attachment is a media attachment on a message in the format <content-type>:<url>. Content type may be a full media type or may omit the subtype when it is unknown.

Examples:

• image/jpeg:http://s3.amazon.com/bucket/test.jpg
• image:http://s3.amazon.com/bucket/test.jpg

func (Attachment) ContentType

func (a Attachment) ContentType() string

ContentType returns the MIME type of this attachment

func (Attachment) ToParts

func (a Attachment) ToParts() (string, string)

ToParts splits an attachment string into content-type and URL

func (Attachment) URL

func (a Attachment) URL() string

URL returns the full URL of this attachment

type HTTPClient

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

HTTPClient is a client for HTTP requests

func NewHTTPClient

func NewHTTPClient(defaultUserAgent string) *HTTPClient

NewHTTPClient creates a new HTTP client with our default options

func (*HTTPClient) Do

func (c *HTTPClient) Do(request *http.Request) (*http.Response, error)

Do does the given HTTP request

func (*HTTPClient) DoWithDump

func (c *HTTPClient) DoWithDump(request *http.Request) (*http.Response, string, error)

DoWithDump does the given HTTP request and returns a dump of the entire request

func (*HTTPClient) MockWithDump

func (c *HTTPClient) MockWithDump(request *http.Request, mockStatus int, mockResponse string) (*http.Response, string, error)

MockWithDump mocks the given HTTP request and returns a dump of the entire request

type Location

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

Location represents a single Location

func NewLocation

func NewLocation(level LocationLevel, name string) *Location

NewLocation creates a new location object

func (*Location) Aliases

func (l *Location) Aliases() []string

Aliases gets the aliases of this location

func (*Location) Children

func (l *Location) Children() []*Location

Children gets the children of this location

func (*Location) Level

func (l *Location) Level() LocationLevel

Level gets the level of this location

func (*Location) Name

func (l *Location) Name() string

Name gets the name of this location

func (*Location) Parent

func (l *Location) Parent() *Location

Parent gets the parent of this location

func (*Location) Path

func (l *Location) Path() LocationPath

Path gets the full path of this location

func (*Location) String

func (l *Location) String() string

type LocationHierarchy

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

LocationHierarchy is a hierarical tree of locations

func NewLocationHierarchy

func NewLocationHierarchy(root *Location, numLevels int) *LocationHierarchy

NewLocationHierarchy cretes a new location hierarchy

func ReadLocationHierarchy

func ReadLocationHierarchy(data json.RawMessage) (*LocationHierarchy, error)

ReadLocationHierarchy reads a location hierarchy from the given JSON

func (*LocationHierarchy) FindByName

func (h *LocationHierarchy) FindByName(name string, level LocationLevel, parent *Location) []*Location

FindByName looks for all locations in the hierarchy with the given level and name or alias

func (*LocationHierarchy) FindByPath

func (h *LocationHierarchy) FindByPath(path LocationPath) *Location

FindByPath looks for a location in the hierarchy with the given path

func (*LocationHierarchy) Root

func (h *LocationHierarchy) Root() *Location

Root gets the root location of this hierarchy (typically a country)

func (*LocationHierarchy) UnmarshalJSON

func (h *LocationHierarchy) UnmarshalJSON(data []byte) error

type LocationLevel

type LocationLevel int

LocationLevel is a numeric level, e.g. 0 = country, 1 = state

type LocationPath

type LocationPath string

LocationPath is a location described by a path Country > State ...

func NewLocationPath

func NewLocationPath(parts ...string) LocationPath

func (LocationPath) Name

func (p LocationPath) Name() string

Name returns the name of the location referenced

func (LocationPath) Normalize

func (p LocationPath) Normalize() LocationPath

Normalize normalizes this location path

type Typed

type Typed interface {
	Type() string
}

Typed is an interface of objects that are marshalled as typed envelopes

type TypedEnvelope

type TypedEnvelope struct {
	Type string `json:"type" validate:"required"`
}

TypedEnvelope can be mixed into envelopes that have a type field

type ValidationErrors

type ValidationErrors []error

ValidationErrors combines multiple validation errors as a single error

func (ValidationErrors) Error

func (e ValidationErrors) Error() string

Error returns a string representation of these validation errors