model

Documentation

Index

• Constants
• type Comment
• type Group
• type Post
• type Presence
• type Role
• type Task
• type User

Constants

const ApiPrefix = "/api/"

const (
	// CommentCollection holds the name of the comment collection.
	CommentCollection = "comments"
)

const FbKeyEmail = "email"

const FbKeyEmailVerified = "email_verified"

const FbKeyUserID = "user_id"

const KeyAuth = "authorization"

const KeyCategory = "category"

const KeyCategoryID = "categoryId"

const KeyClaims = "claims"

const KeyComment = "comment"

Comments

const KeyDataDb = "dataDb"

const KeyEditedUser = "user"

const KeyEditedUserRoles = "editedUserRoles"

const KeyEmail = "email"

const KeyEmailVerified = "emailVerified"

const KeyMgoID = "id"

const KeyParentID = "parentId"

const KeyPath = "path"

const KeyPost = "post"

Posts

const KeyPresence = "presence"

User Meta

const KeyTags = "tags"

const KeyTask = "task"

Tasks

const KeyUser = "user"

Users

const KeyUserDb = "userDb"

various const KeyDb = "db"

const KeyUserDisplayName = "userDisplayName"

const KeyUserID = "userId"

const KeyUserRecord = "userRecord"

const KeyUserRoles = "userRoles"

const PolicyCanEdit = "CAN_EDIT"

const PolicyCanManage = "CAN_MANAGE"

const PolicyCanRead = "CAN_READ"

Known Policies

const (
	// PostCollection holds the name of the post collection
	PostCollection = "posts"
)

const (
	PresenceCollection = "presence"
)

const RoleAdmin = "ADMIN"

Known Roles

const RoleAnonymous = "ANONYMOUS"

const RoleEditor = "EDITOR"

const RoleGuest = "GUEST"

const RoleModerator = "MODERATOR"

const RoleRegistered = "REGISTERED"

const RoleUserAdmin = "USER_ADMIN"

const RoleVolunteer = "VOLUNTEER"

const StoreTypeGorm = "gorm"

const StoreTypeMgo = "mongodb"

Store types

const (
	TaskCollection = "tasks"
)

Types

type Comment

type Comment struct {
	ID       bson.ObjectId `json:"id,omitempty"  bson:"id,omitempty"`
	Date     int64         `json:"date,omitempty"`
	ParentID string        `json:"parentId" binding:"required" bson:"parentId"`
	AuthorID string        `json:"authorId" bson:"authorId"`
	Author   string        `json:"author" bson:"author"`
	Body     string        `json:"body" bson:"body"`

	CreatedOn int64  `json:"createdOn,omitempty" bson:"createdOn"`
	UpdatedOn int64  `json:"updatedOn,omitempty" bson:"updatedOn"`
	UpdatedBy string `json:"updatedBy" bson:"updatedBy"`
}

Comment model.

type Group

type Group struct {
	ID    string `json:"id"`
	Label string `json:"label"`
	Type  string `json:"type"`
}

Group might be a user or a role

type Post

type Post struct {
	ID       bson.ObjectId `json:"id,omitempty"  bson:"id,omitempty"`
	Date     int64         `json:"date,omitempty" bson:"date"`
	Path     string        `json:"path" binding:"required" bson:"path"`
	Title    string        `json:"title" binding:"required" bson:"title"`
	AuthorID string        `json:"authorId" bson:"authorId"`
	Author   string        `json:"author" bson:"author"`
	Tags     string        `json:"tags" bson:"tags"`
	Desc     string        `json:"desc" bson:"desc"`
	Hero     string        `json:"hero" binding:"required" bson:"hero"`
	Thumb    string        `json:"thumb" binding:"required" bson:"thumb"`
	Body     string        `json:"body" bson:"body"`
	Audience string        `json:"audience" bson:"audience"`
	Weight   int           `json:"weight,omitempty" bson:"weight"`

	CreatedOn int64  `json:"createdOn,omitempty" bson:"createdOn"`
	UpdatedOn int64  `json:"updatedOn,omitempty" bson:"updatedOn"`
	UpdatedBy string `json:"updatedBy" bson:"updatedBy"`

	// Convenience fields to communicate with the front end. Not persisted.
	CommentCount int `json:"commentCount" bson:"-"`
}

Post model

type Presence

type Presence struct {
	ID        bson.ObjectId `json:"id,omitempty"  bson:"id,omitempty"`
	UserID    string        `json:"userId" binding:"required" bson:"userId"`
	IsComing  bool          `json:"isComing" bson:"isComing"`
	Transport string        `json:"transport" bson:"transport"`
	AdultNb   int8          `json:"adultNb" bson:"adultNb"`
	ChildNb   int8          `json:"childNb" bson:"childNb"`
	D1        bool          `json:"d1" bson:"d1"`
	D2        bool          `json:"d2" bson:"d2"`
	D3        bool          `json:"d3" bson:"d3"`
	D4        bool          `json:"d4" bson:"d4"`
	D5        bool          `json:"d5" bson:"d5"`
	D6        bool          `json:"d6" bson:"d6"`
	D7        bool          `json:"d7" bson:"d7"`
	D8        bool          `json:"d8" bson:"d8"`
	Comments  string        `json:"comments" bson:"comments"`

	UpdatedOn int64  `json:"updatedOn,omitempty" bson:"updatedOn"`
	UpdatedBy string `json:"updatedBy" bson:"updatedBy"`
}

Presence model.

type Role

type Role struct {
	RoleID string `gorm:"primary_key" json:"roleId"`
	Label  string `gorm:"" json:"label"`
}

Role is used to manage permissions

type Task

type Task struct {
	ID         bson.ObjectId `json:"id,omitempty"  bson:"id,omitempty"`
	Flags      int           `json:"flags"  bson:"flags"`
	CategoryId string        `json:"categoryId"  bson:"categoryId"`
	ManagerID  string        `json:"managerId" bson:"managerId"`
	Manager    string        `json:"manager" bson:"manager"`
	Desc       string        `json:"desc" bson:"desc"`

	CreationDate int64  `json:"creationDate" bson:"creationDate"`
	CloseDate    int64  `json:"closeDate" bson:"closeDate"`
	CancelDate   int64  `json:"cancelDate" bson:"cancelDate"`
	DueDate      int64  `json:"dueDate" bson:"dueDate"`
	UpdateDate   int64  `json:"updatedOn,omitempty" bson:"updatedOn"`
	UpdateBy     string `json:"updatedBy" bson:"updatedBy"`
}

Task model.

type User

type User struct {
	gorm.Model
	UserID  string `gorm:"not null" json:"userId"`
	Name    string `gorm:"" json:"name"`
	Email   string `gorm:"not null" json:"email"`
	Address string `gorm:"" json:"address"`
	Roles   []Role `gorm:"many2many:user_roles" json:"roles"`

	// Ease front end and JSON communication, not persisted
	UserRoles []string               `gorm:"-" json:"userRoles"`
	Meta      map[string]interface{} `gorm:"-" json:"meta"`
}

User represents a user in both gorm and json worlds