goat

package module

Go to main page

Versions in this module

v0

v0.2.3-alpha-5

Sep 29, 2023

v0.2.3-alpha-4

May 16, 2023

v0.2.3-alpha-3

May 16, 2023

v0.2.3-alpha-2

May 12, 2023

v0.2.3-alpha-1

May 12, 2023

v0.2.3-alpha

May 11, 2023

v0.2.2

Apr 25, 2023

v0.2.2-alpha

May 10, 2023

v0.2.1

Apr 17, 2023

Changes in this version

+ const ContentTypeForm

+ const ContentTypeJson

+ const HeaderContentType

+ func ApplyQueryToGorm(db *gorm.DB, q query.Builder, paginate bool)

+ func AssertRecordDeleted(t *testing.T, db *gorm.DB, input M, msg string)

+ func BindRequest(cx *gin.Context) (T, error)

+ func EnvDuration(key string, defaultValue time.Duration) time.Duration

+ func EnvFloat64(key string, defaultValue float64) float64

+ func EnvInt32(key string, defaultValue int32) int32

+ func EnvInt64(key string, defaultValue int64) int64

+ func EnvIntSlice(key string, defaultValue []int) []int

+ func EnvStringMap(key string, defaultValue map[string]any) map[string]any

+ func EnvStringMapString(key string, defaultValue map[string]string) map[string]string

+ func EnvStringSlice(key string, defaultValue []string) []string

+ func EnvTime(key string, defaultValue time.Time) time.Time

+ func EnvUint16(key string, defaultValue uint16) uint16

+ func EnvUint32(key string, defaultValue uint32) uint32

+ func EnvUint64(key string, defaultValue uint64) uint64

+ func ErrorBesidesRecordNotFound(err error) bool

+ func GetStrictLogger() *zap.Logger

+ func GetUrl(key ...string) *url.URL

+ func HealthHandler(path string, message ...string) (string, gin.HandlerFunc)

+ func MustInit()

+ func NewResourceLinks(key, path string) *hal.ResourceLinks

+ func NewValidationError(field, rule string) error

+ func ParseParam(cx *gin.Context, key string, parser ParamParser[T]) (T, error)

+ func RespondAccepted(cx *gin.Context, data any)

+ func RespondForbidden(cx *gin.Context, err error)

+ func RespondNoContent(cx *gin.Context)

+ func RespondNotFound(cx *gin.Context, err error)

+ func RespondOk(cx *gin.Context, data any)

+ func RespondUnauthorized(cx *gin.Context, err error)

+ func RespondUsed(cx *gin.Context, data any)

+ func SetUrl(key string, value *url.URL)

+ func ValueOrDefault(input *T, defaultValue T) T

+ func ValueToString(value any) (string, error)

+ func VersionHandler(path string, version ...string) (string, gin.HandlerFunc)

+ type ApiProblem hal.ApiProblem

+ type Collection hal.Collection[T]

+ type DatabaseConfig database.Config

type HandlerTest

+ func (h *HandlerTest) NewRequest(path string) (*Request, error)

+ func (h *HandlerTest) SetRequest(request *Request) *HandlerTest

type ID

+ func GetIDParam(cx *gin.Context) (ID, error)

+ type ParamParser func(string) (T, error)

+ type RedirectHandler func(req *http.Request, via []*http.Request) error

+ type Request struct

+ Headers map[string]string

+ Method string

+ URL string

+ func NewRequest(baseUrl string) (*Request, error)

+ func (r *Request) AddFormParam(key, value string) *Request

+ func (r *Request) AddQueryParam(key, value string) *Request

+ func (r *Request) Build() (*http.Request, error)

+ func (r *Request) GetBodyForm() (io.Reader, error)

+ func (r *Request) GetBodyJSON() (io.Reader, error)

+ func (r *Request) Send() (*http.Response, error)

+ func (r *Request) SendAndRead(output any) (*http.Response, error)

+ func (r *Request) SetBodyForm(data url.Values) *Request

+ func (r *Request) SetBodyJSON(body any) *Request

+ func (r *Request) SetContentTypeForm() *Request

+ func (r *Request) SetContentTypeJSON() *Request

+ func (r *Request) SetFormParam(key, value string) *Request

+ func (r *Request) SetHeader(key, value string) *Request

+ func (r *Request) SetMethod(method string) *Request

+ func (r *Request) SetQueryParam(key, value string) *Request

+ func (r *Request) SetRedirectHandler(handler RedirectHandler) *Request

+ type RequestData url.Values

+ func MakeRequestData() RequestData

+ func (v RequestData) Add(key, value string) RequestData

+ func (v RequestData) Del(key string) RequestData

+ func (v RequestData) Get(key string) string

+ func (v RequestData) Has(key string) bool

+ func (v RequestData) Set(key, value string) RequestData

+ func (v RequestData) Values() url.Values

+ type Resource hal.Resource

type Router

+ func InitRouter(baseUrl ...string) (Router, error)

v0.2.0-alpha.3

Dec 23, 2022

v0.2.0-alpha.2

Dec 23, 2022

v0.2.0-alpha.1

Dec 23, 2022

v0.2.0-alpha

Dec 23, 2022

v0.1.31

Dec 4, 2020

Changes in this version

type Router

+ GetEngine func() *gin.Engine

+ InitRegistry func() gin.HandlerFunc

+ SetRegistry func(d map[string]interface{})

v0.1.30

Dec 4, 2020

Changes in this version

+ func IsNotFoundError(err error) bool

v0.1.29

Dec 4, 2020

Changes in this version

+ func ApplyPaginationToQuery(q *query.Query, baseGormQuery *gorm.DB) error

+ func FilterMiddleware() gin.HandlerFunc

+ func GetFilter(c *gin.Context) *query.Query

+ func GetHandlerContext(c *gin.Context) context.Context

+ type ModelHardDelete struct

+ CreatedAt time.Time

+ ID ID

+ UpdatedAt *time.Time

+ func (m ModelHardDelete) BeforeCreate(scope *gorm.Scope) error

v0.1.28

Jun 2, 2020

v0.1.27

Jun 2, 2020

v0.1.26

May 29, 2020

Changes in this version

+ func GetCustomDB(c database.ConnectionConfig) (*gorm.DB, error)

v0.1.25

May 28, 2020

v0.1.24

Nov 15, 2019

v0.1.23

Nov 15, 2019

Changes in this version

+ func GetMigrationDB() (*gorm.DB, error)

+ func GetSchema(connection *gorm.DB) (goose.SchemaInterface, error)

v0.1.22

Nov 10, 2019

v0.1.21

Nov 10, 2019

v0.1.20

Nov 10, 2019

v0.1.19

Nov 10, 2019

v0.1.18

Nov 10, 2019

v0.1.17

Nov 10, 2019

v0.1.16

Nov 10, 2019

v0.1.15

Nov 10, 2019

v0.1.14

Nov 10, 2019

v0.1.13

Nov 10, 2019

v0.1.12

Nov 10, 2019

v0.1.11

Nov 10, 2019

v0.1.10

Nov 10, 2019

v0.1.9

Nov 10, 2019

v0.1.8

Nov 10, 2019

v0.1.7

Nov 10, 2019

Changes in this version

+ type App interface

+ GetDB func() *gorm.DB

+ GetLogger func() *logrus.Logger

+ type Initializer func() App

v0.1.6

Nov 10, 2019

v0.1.5

Nov 9, 2019

v0.1.4

Nov 9, 2019

v0.1.3

Nov 9, 2019

v0.1.2

Nov 9, 2019

v0.1.1

Nov 9, 2019

Changes in this version

+ func BindMiddleware(r interface{}) gin.HandlerFunc

+ func DebugEnabled() bool

+ func EnvInt(s string, defaultValue int) int

+ func ErrorIfProd() error

+ func ExitError(err error)

+ func ExitErrors(errs []error)

+ func GetDB(key string) (*gorm.DB, error)

+ func GetFileLogger(name string) (*logrus.Logger, error)

+ func GetLogger() *logrus.Logger

+ func GetMainDB() (*gorm.DB, error)

+ func GetRouter(setRoutes http.RouterInitializer, getApp app.Initializer) http.Router

+ type CSVCallback func(line []string, eof bool) error

v0.1.0

Oct 15, 2019

Changes in this version

+ func AssertValidID(t *testing.T, id ID)

+ func AssertValidInitialCreatedAt(t *testing.T, d time.Time)

+ func AssertValidInitialDeletedAt(t *testing.T, d *time.Time)

+ func AssertValidInitialUpdatedAt(t *testing.T, d *time.Time)

+ func AssertValidModifiedUpdatedAt(t *testing.T, d *time.Time)

+ func BindRequestMiddleware(req interface{}) gin.HandlerFunc

+ func CWD() string

+ func ConfigFileName() string

+ func ConfigFilePath() string

+ func EnvBool(s string, defaultValue bool) bool

+ func EnvString(s string, defaultValue string) string

+ func ErrorsBesidesRecordNotFound(errs []error) bool

+ func ErrorsToError(errs []error) error

+ func ErrorsToString(errs []error) string

+ func ErrorsToStrings(errs []error) []string

+ func ExeDir() string

+ func ExePath() string

+ func ExitIfProduction()

+ func ExitSuccess()

+ func ExitWithError(err error)

+ func ExitWithErrors(errs []error)

+ func GenerateToken() string

+ func GetCountArg(countArg string) (int, error)

+ func GetErrors() []error

+ func GetRequest(c *gin.Context) interface

+ func GetStructFieldValidationMeta(strct reflect.Type, e *validator.FieldError) (string, string, error)

+ func HandleCSVRows(path string, skipHeaderRow bool, breakOnEOF bool, ...) error

+ func HasErrors() bool

+ func Init() []error

+ func MustEnvInt(s string, defaultValue int) int

+ func NewCustomDB(c DBConfig) (*gorm.DB, error)

+ func NewCustomLogger(l string) *logrus.Logger

+ func NewDB() (*gorm.DB, error)

+ func NewLogger() *logrus.Logger

+ func NewSTDOutLogger() *logrus.Logger

+ func OpenCSV(path string) (reader *csv.Reader, err error)

+ func PrependErrors(errs []error, err error) []error

+ func PrintFail(s string)

+ func PrintHeading(s string)

+ func PrintIndent(s string)

+ func PrintInfo(s string)

+ func PrintSuccess(s string)

+ func PrintWarning(s string)

+ func RandomBool() bool

+ func RandomDecimal(min, max int64) decimal.Decimal

+ func RandomDecimalExp(min, max int64, exp int32) decimal.Decimal

+ func RandomIndex(length int) int

+ func RandomInt(min, max int) int

+ func RandomInt32(min, max int32) int32

+ func RandomInt64(min, max int64) int64

+ func ReadConfig(b bool)

+ func RecordNotFound(errs []error) bool

+ func RequireDecimalEqual(t *testing.T, exp, act interface{}, msgAndArgs ...interface{})

+ func RespondAuthenticationError(c *gin.Context)

+ func RespondBadRequest(c *gin.Context, data interface{})

+ func RespondBadRequestError(c *gin.Context, err error)

+ func RespondBadRequestErrors(c *gin.Context, errs []error)

+ func RespondCreated(c *gin.Context, data interface{})

+ func RespondData(c *gin.Context, data interface{})

+ func RespondInvalid(c *gin.Context)

+ func RespondMessage(c *gin.Context, m string)

+ func RespondNotFoundError(c *gin.Context, err error)

+ func RespondNotFoundErrors(c *gin.Context, errs []error)

+ func RespondRequestValidationError(c *gin.Context, err error, t reflect.Type)

+ func RespondServerError(c *gin.Context, err error)

+ func RespondServerErrors(c *gin.Context, errs []error)

+ func RespondUnauthorizedError(c *gin.Context)

+ func RespondValid(c *gin.Context)

+ func RespondValidationError(c *gin.Context, errs map[string]error)

+ func Root() string

+ func RootPath(path string) string

+ func SetConfigFile(filename string) error

+ func SetConfigFilePath(path string) error

+ func SetDBPanicMode(b bool)

+ func SetJSONTagExcludedStructs(s []string)

+ func SetRoot(p string)

+ func TimeToPrettyString(t time.Time) string

+ func TimeToYMDHISString(t time.Time) string

+ func TimeToYMDString(t time.Time) string

+ func ValidPort(port string) (valid bool, message string)

+ func YMDHISStringToTime(str string) (time.Time, error)

+ func YMDStringToTime(str string) (time.Time, error)

+ type BoolResponse struct

+ Valid bool

+ type Container struct

+ Config configInterface

+ Path pathInterface

+ Utils utilsInterface

+ type ContextResponder func(c *gin.Context)

+ type DBConfig struct

+ Database string

+ Debug bool

+ Host string

+ MultiStatements bool

+ Password string

+ Port int

+ Username string

+ func GetDefaultDBConfig() DBConfig

+ func (d *DBConfig) String() string

+ type ErrorHandler interface

+ HandleContext func(c *gin.Context, m string, responder ContextResponder)

+ HandleError func(c *gin.Context, err error, responder ErrorResponder)

+ HandleErrorM func(c *gin.Context, err error, m string, responder ErrorResponder)

+ HandleErrors func(c *gin.Context, errs []error, responder ErrorResponder)

+ HandleErrorsM func(c *gin.Context, errs []error, m string, responder ErrorResponder)

+ HandleMessage func(c *gin.Context, m string, responder ErrorResponder)

+ func NewErrorHandler(l *logrus.Logger) ErrorHandler

+ type ErrorHandlerGin struct

+ func (h ErrorHandlerGin) HandleContext(c *gin.Context, m string, responder ContextResponder)

+ func (h ErrorHandlerGin) HandleError(c *gin.Context, err error, responder ErrorResponder)

+ func (h ErrorHandlerGin) HandleErrorM(c *gin.Context, err error, m string, responder ErrorResponder)

+ func (h ErrorHandlerGin) HandleErrors(c *gin.Context, errs []error, responder ErrorResponder)

+ func (h ErrorHandlerGin) HandleErrorsM(c *gin.Context, errs []error, m string, responder ErrorResponder)

+ func (h ErrorHandlerGin) HandleMessage(c *gin.Context, m string, responder ErrorResponder)

+ type ErrorResponder func(c *gin.Context, e error)

+ type HandlerTest struct

+ func NewHandlerTest(r *Router) *HandlerTest

+ func (h *HandlerTest) Body(data *map[string]interface{}) *HandlerTest

+ func (h *HandlerTest) Delete(url string) *HandlerTest

+ func (h *HandlerTest) DeleteF(urlf string, a ...interface{}) *HandlerTest

+ func (h *HandlerTest) Get(url string) *HandlerTest

+ func (h *HandlerTest) GetF(urlf string, a ...interface{}) *HandlerTest

+ func (h *HandlerTest) Headers(headers map[string]string) *HandlerTest

+ func (h *HandlerTest) Post(url string) *HandlerTest

+ func (h *HandlerTest) PostF(urlf string, a ...interface{}) *HandlerTest

+ func (h *HandlerTest) Put(url string) *HandlerTest

+ func (h *HandlerTest) PutF(urlf string, a ...interface{}) *HandlerTest

+ func (h *HandlerTest) Request(method, url string) *HandlerTest

+ func (h *HandlerTest) RequestF(method, urlf string, a ...interface{}) *HandlerTest

+ func (h *HandlerTest) Send() *HandlerTestResponse

+ func (h *HandlerTest) SetRemoteAddr(ip string)

+ type HandlerTestResponse struct

+ BodyString string

+ func (r *HandlerTestResponse) Map(m interface{}) error

+ type ID uuid.UUID

+ func NewID() ID

+ func NilID() ID

+ func ParseAllIDs(s []string) ([]ID, error)

+ func ParseID(s string) (ID, error)

+ func (id *ID) Scan(src interface{}) error

+ func (id *ID) UnmarshalBinary(data []byte) error

+ func (id *ID) UnmarshalText(data []byte) error

+ func (id ID) MarshalBinary() ([]byte, error)

+ func (id ID) MarshalText() ([]byte, error)

+ func (id ID) String() string

+ func (id ID) Valid() bool

+ func (id ID) Value() (driver.Value, error)

+ type Model struct

+ CreatedAt time.Time

+ DeletedAt *time.Time

+ ID ID

+ UpdatedAt *time.Time

+ func (m Model) BeforeCreate(scope *gorm.Scope) error

+ type RequestValidator struct

+ func (v *RequestValidator) ValidateStruct(i interface{}) error

+ type Response struct

+ Data map[string]interface{}

+ Errors []string

+ Message string

+ type Router struct

+ DB *gorm.DB

+ Engine *gin.Engine

+ Mode string

+ RoutesFunc func(*Router)

+ func NewRouter(mode string, getRoutes func(*Router)) *Router

+ func (r *Router) Run(addr ...string) error

+ func (r *Router) SetConfig(d map[string]interface{})

+ type ValidationResponse struct

+ Errors map[string]string

+ Message string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL