utils

package

v0.0.0-...-5f6e6a3 Latest Latest Go to latest Published: Sep 4, 2021 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/loupzeur/go-crud-api

Links

Open Source Insights

Documentation ¶

Index ¶

func DefaultFindFromRequest(r *http.Request, db *gorm.DB, data interface{}) error
func DefaultQueryAll(r *http.Request, q *gorm.DB) *gorm.DB
func GetSha(b []byte) string
func Has(b, flag RightBits) bool
func HasRights(r *http.Request, rights RightBits, ...) bool
func HasRightsRequest(r *http.Request, rights RightBits) bool
func Message(status bool, message string) map[string]interface{}
func ReadFloatURL(r *http.Request, param string) (float64, error)
func ReadInt(r *http.Request, param string, v int64) (int64, error)
func ReadIntURL(r *http.Request, param string) (int, error)
func ReadJSON(r *http.Request, v interface{}) error
func ReadURL(r *http.Request, param string) string
func Respond(w http.ResponseWriter, data map[string]interface{})
func RespondCode(w http.ResponseWriter, data map[string]interface{}, statusCode int)
type JSON
- func (j JSON) Equals(j1 JSON) bool
- func (j JSON) IsNull() bool
- func (j JSON) MarshalJSON() ([]byte, error)
- func (j *JSON) New(value interface{}) error
- func (j *JSON) Scan(value interface{}) error
- func (j JSON) To(ret interface{}) error
- func (j JSON) ToInterface() map[string]interface{}
- func (j *JSON) UnmarshalJSON(data []byte) error
- func (j JSON) Value() (driver.Value, error)
type RightBits
- func Clear(b, flag RightBits) RightBits
- func Set(b, flag RightBits) RightBits
- func Toggle(b, flag RightBits) RightBits
- func (b RightBits) Clear(flag RightBits) RightBits
- func (b RightBits) Has(flag RightBits) bool
- func (b RightBits) Set(flag RightBits) RightBits
- func (b RightBits) Toggle(flag RightBits) RightBits
type Route
type Routes
- func (r Routes) Append(routes []Route) Routes
- func (r Routes) Get(name string) Route
type Token
- func GetAuthenticatedToken(r *http.Request) (Token, bool)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DefaultFindFromRequest ¶

func DefaultFindFromRequest(r *http.Request, db *gorm.DB, data interface{}) error

func DefaultQueryAll ¶

func DefaultQueryAll(r *http.Request, q *gorm.DB) *gorm.DB

func GetSha ¶

func GetSha(b []byte) string

GetSha return a string of SHA from bytes

func Has ¶

func Has(b, flag RightBits) bool

Has a Right

func HasRights ¶

func HasRights(r *http.Request, rights RightBits, f func(r *http.Request, rights RightBits) bool) bool

HasRights check for correct role

func HasRightsRequest ¶

func HasRightsRequest(r *http.Request, rights RightBits) bool

HasRightsRequest check for correct role

func Message ¶

func Message(status bool, message string) map[string]interface{}

Message to give a status and reason about errors or if data cannot be retrieved

func ReadFloatURL ¶

func ReadFloatURL(r *http.Request, param string) (float64, error)

ReadIntURL read an URL parameter

func ReadInt ¶

func ReadInt(r *http.Request, param string, v int64) (int64, error)

ReadInt return an int or a default value

func ReadIntURL ¶

func ReadIntURL(r *http.Request, param string) (int, error)

ReadIntURL read an URL parameter

func ReadJSON ¶

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

ReadJSON read a json or return a response

func ReadURL ¶

func ReadURL(r *http.Request, param string) string

ReadURL read an URL parameter

func Respond ¶

func Respond(w http.ResponseWriter, data map[string]interface{})

Respond Create a JSON response with headers

func RespondCode ¶

func RespondCode(w http.ResponseWriter, data map[string]interface{}, statusCode int)

RespondCode Create a JSON response with headers

Types ¶

type JSON ¶

type JSON []byte

JSON return a json type

func (JSON) Equals ¶

func (j JSON) Equals(j1 JSON) bool

Equals ...

func (JSON) IsNull ¶

func (j JSON) IsNull() bool

IsNull ...

func (JSON) MarshalJSON ¶

func (j JSON) MarshalJSON() ([]byte, error)

MarshalJSON return byte

func (*JSON) New ¶

func (j *JSON) New(value interface{}) error

New to create from scratch bject

func (*JSON) Scan ¶

func (j *JSON) Scan(value interface{}) error

Scan to scan from sql value

func (JSON) To ¶

func (j JSON) To(ret interface{}) error

To return JSON to type must be transfered via pointer &val

func (JSON) ToInterface ¶

func (j JSON) ToInterface() map[string]interface{}

ToInterface to return an string interface

func (*JSON) UnmarshalJSON ¶

func (j *JSON) UnmarshalJSON(data []byte) error

UnmarshalJSON return JSON

func (JSON) Value ¶

func (j JSON) Value() (driver.Value, error)

Value to return the current value in string

type RightBits ¶

type RightBits uint32

RightBits set a right

const (
	NoRight RightBits = 0
)

func Clear ¶

func Clear(b, flag RightBits) RightBits

Clear a right

func Set ¶

func Set(b, flag RightBits) RightBits

Set a right

func Toggle ¶

func Toggle(b, flag RightBits) RightBits

Toggle a Right

func (RightBits) Clear ¶

func (b RightBits) Clear(flag RightBits) RightBits

Clear a right

func (RightBits) Has ¶

func (b RightBits) Has(flag RightBits) bool

Has a right

func (RightBits) Set ¶

func (b RightBits) Set(flag RightBits) RightBits

Set a right

func (RightBits) Toggle ¶

func (b RightBits) Toggle(flag RightBits) RightBits

Toggle a right

type Route ¶

type Route struct {
	Name          string           `json:"name"`
	Method        string           `json:"method"`
	Pattern       string           `json:"pattern"`
	HandlerFunc   http.HandlerFunc `json:"-"`
	Authorization uint32           `json:"auth"`
}

Route define a route with url and rights required to access it

type Routes ¶

type Routes []Route

Routes an array of route

func (Routes) Append ¶

func (r Routes) Append(routes []Route) Routes

Append Add routes to Routes

func (Routes) Get ¶

func (r Routes) Get(name string) Route

Get Return route by name

type Token ¶

type Token struct {
	UserId     uint
	UserRights RightBits
	jwt.StandardClaims
}

Token JWT claims struct

func GetAuthenticatedToken ¶

func GetAuthenticatedToken(r *http.Request) (Token, bool)

GetAuthenticatedToken return the Authentication token if exists in context

Source Files ¶

View all Source files

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