vmod

Documentation

Index

• type AccessRole
  • func AccessAdmin() *AccessRole
  • func AccessEmployee() *AccessRole
  • func AccessMember() *AccessRole
• type Content
• type Count
• type DeletedResponse
  • func NewDeletedResponse(id string) *DeletedResponse
• type File
• type IDParam
• type ModelID
  • func NewModelID(mID string, mType string) *ModelID
• type Modified
  • func NewModified() Modified
  • func (i *Modified) Update()
• type Money
• type Position
• type Role
  • func RoleAdmin(userID string) *Role
  • func RoleEmployee(userID string) *Role
  • func RoleMember(userID string) *Role
• type RoleList
  • func (i *RoleList) Append(role *Role)
  • func (i *RoleList) Cookie() (r *RoleListCookie)
  • func (i *RoleList) In(role string) bool
• type RoleListCookie
  • func (i *RoleListCookie) CheckRoot(role *Role) bool
  • func (i *RoleListCookie) Validate(roles string) bool
• type User
  • func (i *User) CheckUpdate(lastUpdate string) bool
  • func (i *User) Load(user interface{}) (err error)
• type WebappAccess

Types

type AccessRole

type AccessRole struct {
	Name string   `json:"name" bson:"name"`
	Root []string `json:"root" bson:"root"`
}

func AccessAdmin

func AccessAdmin() *AccessRole

AccessAdmin represents the access to a webapp with admin role.

func AccessEmployee

func AccessEmployee() *AccessRole

AccessEmployee represents the access to a webapp with employee role.

func AccessMember

func AccessMember() *AccessRole

AccessMember represents the access to a webapp with member role.

type Content

type Content struct {
	Fields map[string]interface{} `json:"content" bson:"content"`
}

type Count

type Count struct {
	Total int32 `json:"total" bson:"total"`
}

Count is used for counting results in db aggregations

type DeletedResponse

type DeletedResponse struct {
	ID string `json:"id"`
}

DeletedResponse used for handling response in deleted case.

func NewDeletedResponse

func NewDeletedResponse(id string) *DeletedResponse

NewDeletedResponse creates a new DeletedResponse type.

type File

type File struct {
	File   multipart.File
	Header *multipart.FileHeader
}

type IDParam

type IDParam struct {
	ID string `param:"id" validate:"uuid"`
}

IDParam data struct for handling '/:id'. ID needs to be a uuid.

type ModelID

type ModelID struct {
	MID  string `json:"id" bson:"id"`
	Type string `json:"type" bson:"type"`
}

func NewModelID

func NewModelID(mID string, mType string) *ModelID

type Modified

type Modified struct {
	Updated int64 `json:"updated" bson:"updated"`
	Created int64 `json:"created" bson:"created"`
}

Modified contains update and create time for an model.

func NewModified

func NewModified() Modified

NewModified initial Modified model.

func (*Modified) Update

func (i *Modified) Update()

Update updates the Updated key to the current time.

type Money

type Money struct {
	Amount   int64  `bson:"amount" json:"amount"`
	Currency string `bson:"currency" json:"currency" validate:"required"`
}

Money represent the simple Money object. The Amount is a cent representation.

type Position

type Position struct {
	Lat float64 `json:"lat" bson:"lat"`
	Lng float64 `json:"lng" bson:"lng"`
}

Position represents the lat and lng coordinates for latitude and longitude.

type Role

type Role struct {
	ID     string `json:"id" bson:"_id"`
	Name   string `json:"name" bson:"name"`
	Root   string `json:"root" bson:"root"`
	UserID string `json:"user_id" bson:"user_id"`
}

Role represents an struct for handling access roles.

func RoleAdmin

func RoleAdmin(userID string) *Role

RoleAdmin represents the admin role.

func RoleEmployee

func RoleEmployee(userID string) *Role

RoleEmployee represents the employee role.

func RoleMember

func RoleMember(userID string) *Role

RoleMember represents the member role.

type RoleList

type RoleList []Role

RoleList represents an slice of Role

func (*RoleList) Append

func (i *RoleList) Append(role *Role)

Append append a Role role to a RoleList i. If i contains the role, nothing happend.

func (*RoleList) Cookie

func (i *RoleList) Cookie() (r *RoleListCookie)

Cookie return an slice of strings they contains all role names.

func (*RoleList) In

func (i *RoleList) In(role string) bool

In check if a the RoleList contains an role.

type RoleListCookie

type RoleListCookie []string

RoleListCookie used for the access_token.

func (*RoleListCookie) CheckRoot

func (i *RoleListCookie) CheckRoot(role *Role) bool

CheckRoot check if the RoleListCookie object contains an role in the Root param. So you can check if an user is allow to give an other user an role.

func (*RoleListCookie) Validate

func (i *RoleListCookie) Validate(roles string) bool

Validate check if an RoleListCookie contains an role in the roles string. We seperate the role by ;.

Example:

"admin;employee"

type User

type User struct {
	ID            string   `json:"id,omitempty" bson:"_id"`
	Email         string   `json:"email" bson:"email"`
	FirstName     string   `bson:"first_name" json:"first_name"`
	LastName      string   `bson:"last_name" json:"last_name"`
	FullName      string   `bson:"full_name" json:"full_name"`
	RealName      string   `bson:"real_name" json:"real_name"`
	DisplayName   string   `bson:"display_name" json:"display_name"`
	Roles         RoleList `json:"system_roles" bson:"system_roles"`
	Country       string   `bson:"country" json:"country"`
	PrivacyPolicy bool     `bson:"privacy_policy" json:"privacy_policy"`
	Confirmd      bool     `bson:"confirmed" json:"confirmed"`
	LastUpdate    string   `bson:"last_update" json:"last_update"`
}

User represents the user default user information they are shared with all viva con agua services.

func (*User) CheckUpdate

func (i *User) CheckUpdate(lastUpdate string) bool

CheckUpdate checks if the lastUpdate time string is older as the users LastUpdate param. If the function return true, the user needs to be updated in this service.

func (*User) Load

func (i *User) Load(user interface{}) (err error)

Load loads an interface in an vcago.User model

type WebappAccess

type WebappAccess struct {
	Name  string       `json:"name" validate:"required"`
	Roles []AccessRole `json:"roles" validate:"required"`
}