model

package

v0.0.0-...-ad0da93 Latest Latest Go to latest Published: Jun 27, 2018 License: MIT Imports: 4 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/artistomin/gorsk

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrGeneric = errors.New("generic error")

ErrGeneric is used for testing purposes and for errors handled later in the callstack

Functions ¶

This section is empty.

Types ¶

type AccessRole ¶

type AccessRole int8

AccessRole represents access role type

const (
	// SuperAdminRole has all permissions
	SuperAdminRole AccessRole = iota + 1

	// AdminRole has admin specific permissions
	AdminRole

	// CompanyAdminRole can edit company specific things
	CompanyAdminRole

	// LocationAdminRole can edit location specific things
	LocationAdminRole

	// UserRole is a standard user
	UserRole
)

type AccountDB ¶

type AccountDB interface {
	Create(User) (*User, error)
	ChangePassword(*User) error
}

AccountDB represents account related database interface (repository)

type AuthService ¶

type AuthService interface {
	User(echo.Context) *AuthUser
}

AuthService represents authentication service interface

type AuthToken ¶

type AuthToken struct {
	Token        string `json:"token"`
	Expires      string `json:"expires"`
	RefreshToken string `json:"refresh_token"`
}

AuthToken holds authentication token details with refresh token

type AuthUser ¶

type AuthUser struct {
	ID         int
	CompanyID  int
	LocationID int
	Username   string
	Email      string
	Role       AccessRole
}

AuthUser represents data stored in JWT token for user

type Base ¶

type Base struct {
	ID        int        `json:"id"`
	CreatedAt time.Time  `json:"created_at"`
	UpdatedAt time.Time  `json:"updated_at"`
	DeletedAt *time.Time `json:"deleted_at,omitempty"`
}

Base contains common fields for all tables

func (*Base) BeforeInsert ¶

func (b *Base) BeforeInsert(_ orm.DB) error

BeforeInsert hooks into insert operations, setting createdAt and updatedAt to current time

func (*Base) BeforeUpdate ¶

func (b *Base) BeforeUpdate(_ orm.DB) error

BeforeUpdate hooks into update operations, setting updatedAt to current time

func (*Base) Delete ¶

func (b *Base) Delete()

Delete sets deleted_at time to current_time

type Company ¶

type Company struct {
	Base
	Name      string     `json:"name"`
	Active    bool       `json:"active"`
	Locations []Location `json:"locations,omitempty"`
	Owner     User       `json:"owner"`
}

Company represents company model

type ListQuery ¶

type ListQuery struct {
	Query string
	ID    int
}

ListQuery holds company/location data used for list db queries

type Location ¶

type Location struct {
	Base
	Name    string `json:"name"`
	Active  bool   `json:"active"`
	Address string `json:"address"`

	CompanyID int `json:"company_id"`
}

Location represents company location model

type Pagination struct {
	Limit  int
	Offset int
}

Pagination holds paginations data

type RBACService ¶

type RBACService interface {
	EnforceRole(echo.Context, AccessRole) error
	EnforceUser(echo.Context, int) error
	EnforceCompany(echo.Context, int) error
	EnforceLocation(echo.Context, int) error
	AccountCreate(echo.Context, int, int, int) error
	IsLowerRole(echo.Context, AccessRole) error
}

RBACService represents role-based access control service interface

type RefreshToken ¶

type RefreshToken struct {
	Token   string `json:"token"`
	Expires string `json:"expires"`
}

RefreshToken holds authentication token details

type Role ¶

type Role struct {
	ID          int        `json:"id"`
	AccessLevel AccessRole `json:"access_level"`
	Name        string     `json:"name"`
}

Role model

type User ¶

type User struct {
	Base
	FirstName string     `json:"first_name"`
	LastName  string     `json:"last_name"`
	Username  string     `json:"username"`
	Password  string     `json:"-"`
	Email     string     `json:"email"`
	Mobile    string     `json:"mobile,omitempty"`
	Phone     string     `json:"phone,omitempty"`
	Address   string     `json:"address,omitempty"`
	LastLogin *time.Time `json:"last_login,omitempty"`
	Active    bool       `json:"active"`
	Token     string     `json:"-"`

	Role *Role `json:"role,omitempty"`

	RoleID     int `json:"-"`
	CompanyID  int `json:"company_id"`
	LocationID int `json:"location_id"`
}

User represents user domain model

func (*User) UpdateLastLogin ¶

func (u *User) UpdateLastLogin()

UpdateLastLogin updates last login field

type UserDB ¶

type UserDB interface {
	View(int) (*User, error)
	FindByUsername(string) (*User, error)
	FindByToken(string) (*User, error)
	List(*ListQuery, *Pagination) ([]User, error)
	Delete(*User) error
	Update(*User) (*User, error)
}

UserDB represents user database interface (repository)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
account
auth
mock
mockdb
platform
postgres
query
structs
rbac
user Package user contains user application services	Package user contains user application services

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