model

Documentation

Index

• Variables
• func Generate() string
• func IsDefinitionError(err error) bool
• func NewDBErr(err error) error
• type DBErr
  • func (e DBErr) Error() string
• type ID
  • func NewID(value string) (ID, error)
• type IPermissions
• type Key
  • func NewKey(key string) (Key, error)
• type ModelError
  • func (e ModelError) Error() string
• type Name
  • func NewName(name string) (Name, error)
• type Node
  • func NewNode() *Node
  • func (n *Node) Add(method, path string, permissions ...string)
  • func (n *Node) Get(method, path string) []string
  • func (n *Node) Has(method, path string) bool
• type Organization
  • func NewOrganization(id, name, description string, users ...User) (*Organization, error)
  • func (o *Organization) GetDescription() string
  • func (m *Organization) GetID() *string
  • func (m *Organization) GetName() *string
  • func (o *Organization) GetUsers() Users
  • func (o *Organization) IsContainsUsers(userKey Key) (*User, bool)
• type OrganizationUserRole
  • func NewOrganizationUserRole(organization Organization, userKey, roleId string) (*OrganizationUserRole, error)
  • func (m *OrganizationUserRole) GetOrganization() Organization
  • func (m *OrganizationUserRole) GetRoleId() string
  • func (m *OrganizationUserRole) GetUserKey() string
• type OrganizationUserRoles
  • func (arr OrganizationUserRoles) Copy() OrganizationUserRoles
• type Organizations
  • func (arr Organizations) Copy() Organizations
• type Permission
  • func NewPermission(id, name, description string) (*Permission, error)
  • func (p *Permission) GetDescription() string
  • func (m *Permission) GetID() *string
  • func (m *Permission) GetName() *string
• type Permissions
  • func (arr Permissions) Copy() Permissions
• type Resource
  • func NewResource(method, uri string, permissions ...string) *Resource
  • func NewResourceByMethod(method string, uri, permissions []string) *Resource
  • func (r *Resource) Check(method, uri string, user *User) bool
• type ResourceCheck
  • func NewResourceCheck(result bool, message string) *ResourceCheck
  • func (r *ResourceCheck) GetMsg() string
  • func (r *ResourceCheck) IsOk() bool
• type Role
  • func NewRole(id, name, description string, permissions Permissions, ...) (*Role, error)
  • func (r *Role) AddPermission(permissions ...Permission)
  • func (r *Role) GetDescription() string
  • func (m *Role) GetID() *string
  • func (m *Role) GetName() *string
  • func (r *Role) GetOrganizationUserRoles() OrganizationUserRoles
  • func (r *Role) GetPermissions() Permissions
• type Roles
  • func (arr Roles) Copy() Roles
• type String
• type User
  • func NewUser(key string, roles Roles, permissions Permissions) (*User, error)
  • func (u *User) AddRole(roles ...Role)
  • func (u *User) GetKey() string
  • func (u *User) GetPermission() []Permission
  • func (u *User) GetRole() []Role
  • func (u *User) IsContainsPermission(id ID) bool
  • func (u *User) IsContainsPermissionByName(name Name) bool
• type Users
  • func (arr Users) Copy() Users

Variables

var (
	// ErrRequired `Required field of empty`
	ErrRequired = status.Error(http.StatusBadRequest, "Required field of empty")
	// ErrNoData `No data found`
	ErrNoData = status.Error(http.StatusNotFound, "No data found")
	// ErrAlreadyExists `Already exists`
	ErrAlreadyExists = status.Error(http.StatusConflict, "Already exists")
)

Functions

func Generate

func Generate() string

func IsDefinitionError

func IsDefinitionError(err error) bool

func NewDBErr

func NewDBErr(err error) error

Types

type DBErr

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

func (DBErr) Error

func (e DBErr) Error() string

type ID

type ID interface {
	String
}

func NewID

func NewID(value string) (ID, error)

type IPermissions

type IPermissions func() []string

type Key

type Key interface {
	String
}

func NewKey

func NewKey(key string) (Key, error)

type ModelError

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

func (ModelError) Error

func (e ModelError) Error() string

type Name

type Name interface {
	String
}

func NewName

func NewName(name string) (Name, error)

type Node

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

func NewNode

func NewNode() *Node

func (*Node) Add

func (n *Node) Add(method, path string, permissions ...string)

func (*Node) Get

func (n *Node) Get(method, path string) []string

func (*Node) Has

func (n *Node) Has(method, path string) bool

type Organization

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

func NewOrganization

func NewOrganization(id, name, description string, users ...User) (*Organization, error)

func (*Organization) GetDescription

func (o *Organization) GetDescription() string

func (*Organization) GetID

func (m *Organization) GetID() *string

func (*Organization) GetName

func (m *Organization) GetName() *string

func (*Organization) GetUsers

func (o *Organization) GetUsers() Users

func (*Organization) IsContainsUsers

func (o *Organization) IsContainsUsers(userKey Key) (*User, bool)

type OrganizationUserRole

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

func NewOrganizationUserRole

func NewOrganizationUserRole(organization Organization, userKey, roleId string) (*OrganizationUserRole, error)

func (*OrganizationUserRole) GetOrganization

func (m *OrganizationUserRole) GetOrganization() Organization

func (*OrganizationUserRole) GetRoleId

func (m *OrganizationUserRole) GetRoleId() string

func (*OrganizationUserRole) GetUserKey

func (m *OrganizationUserRole) GetUserKey() string

type OrganizationUserRoles

type OrganizationUserRoles []OrganizationUserRole

func (OrganizationUserRoles) Copy

func (arr OrganizationUserRoles) Copy() OrganizationUserRoles

type Organizations

type Organizations []Organization

func (Organizations) Copy

func (arr Organizations) Copy() Organizations

type Permission

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

func NewPermission

func NewPermission(id, name, description string) (*Permission, error)

func (*Permission) GetDescription

func (p *Permission) GetDescription() string

func (*Permission) GetID

func (m *Permission) GetID() *string

func (*Permission) GetName

func (m *Permission) GetName() *string

type Permissions

type Permissions []Permission

func (Permissions) Copy

func (arr Permissions) Copy() Permissions

type Resource

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

func NewResource

func NewResource(method, uri string, permissions ...string) *Resource

func NewResourceByMethod

func NewResourceByMethod(method string, uri, permissions []string) *Resource

func (*Resource) Check

func (r *Resource) Check(method, uri string, user *User) bool

type ResourceCheck

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

func NewResourceCheck

func NewResourceCheck(result bool, message string) *ResourceCheck

func (*ResourceCheck) GetMsg

func (r *ResourceCheck) GetMsg() string

func (*ResourceCheck) IsOk

func (r *ResourceCheck) IsOk() bool

type Role

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

func NewRole

func NewRole(id, name, description string, permissions Permissions, organizationUserRoles ...OrganizationUserRole) (*Role, error)

func (*Role) AddPermission

func (r *Role) AddPermission(permissions ...Permission)

AddPermission is only the permission that exists in the database

func (*Role) GetDescription

func (r *Role) GetDescription() string

func (*Role) GetID

func (m *Role) GetID() *string

func (*Role) GetName

func (m *Role) GetName() *string

func (*Role) GetOrganizationUserRoles

func (r *Role) GetOrganizationUserRoles() OrganizationUserRoles

func (*Role) GetPermissions

func (r *Role) GetPermissions() Permissions

type Roles

type Roles []Role

func (Roles) Copy

func (arr Roles) Copy() Roles

type String

type String interface {
	Err() error
	Value() *string
	// contains filtered or unexported methods
}

type User

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

func NewUser

func NewUser(key string, roles Roles, permissions Permissions) (*User, error)

func (*User) AddRole

func (u *User) AddRole(roles ...Role)

func (*User) GetKey

func (u *User) GetKey() string

func (*User) GetPermission

func (u *User) GetPermission() []Permission

func (*User) GetRole

func (u *User) GetRole() []Role

func (*User) IsContainsPermission

func (u *User) IsContainsPermission(id ID) bool

func (*User) IsContainsPermissionByName

func (u *User) IsContainsPermissionByName(name Name) bool

type Users

type Users []User

func (Users) Copy

func (arr Users) Copy() Users