store

Documentation

Index

• Variables
• func Connect(address, database string) error
• func GetUserByID(id string) (m.User, error)
• func SetupDB(bootstrap, testData bool)
• type AssignmentStore
  • func NewAssignmentStore() AssignmentStore
  • func (a *AssignmentStore) BeforeSave(v *m.Assignment) error
  • func (a AssignmentStore) Store(v *m.Assignment) (string, error)
• type AssignmentTypeStore
  • func NewAssignmentTypeStore() AssignmentTypeStore
• type DefaultStore
  • func NewDefaultStore(tableName string) DefaultStore
  • func (d DefaultStore) Delete(id string) error
  • func (d *DefaultStore) Filter(data interface{}, filter interface{}) error
  • func (d DefaultStore) FindAll(data interface{}) error
  • func (d DefaultStore) FindByID(data m.Model, id string) error
  • func (d *DefaultStore) Store(v m.Model) (string, error)
  • func (d *DefaultStore) Update(v m.Model, id string) error
• type EnrollmentStore
  • func NewEnrollmentStore() EnrollmentStore
  • func (pr EnrollmentStore) Filter(enrollments *[]m.EnrollmentAPIRes, filter interface{}) error
• type SessionStore
  • func NewSessionStore() SessionStore
• type Storer
• type UserStore
  • func NewUserStore() UserStore
  • func (us *UserStore) FindByEmail(email string) (m.User, error)
  • func (us *UserStore) Store(u *m.User) error

Variables

var (

	// DB Global DB object
	DB rh.DB

	// Classes     ClassStore
	Enrollments EnrollmentStore

	Classes          = DB.NewCollection("classes")
	Terms            = DB.NewCollection("terms")
	EnrollmentH      = DB.NewCollection("enrollments")
	People           = DB.NewCollection("people")
	UserH            = DB.NewCollection("users")
	AssignmentH      = DB.NewCollection("assignments")
	AssignmentGrades = DB.NewCollection("grades")

	Assignments     AssignmentStore
	AssignmentTypes AssignmentTypeStore

	Sessions SessionStore
	Users    UserStore

	// Errors
	ErrNotFound   = errors.New("record not found")
	ErrValidation = errors.New("validation error")
)

var (
	//ErrUserOrPasswdIncorrect err for password incorrect
	ErrUserOrPasswdIncorrect = errors.New("Email or password incorrect.")

	//ErrUserAlreadyExists err for duplicate user
	ErrUserAlreadyExists = errors.New("User with email already exists.")
	//ErrUserForPersonExists err for duplicate person
	ErrUserForPersonExists = errors.New("User for person already exists.")

	//ErrUserPasswordRequired err for trying to save without a password.
	// TODO: Remove this after refactoring.
	ErrUserPasswordRequired = errors.New("Password is required")
)

Functions

func Connect

func Connect(address, database string) error

Connect establishes connection with rethinkDB

func GetUserByID

func GetUserByID(id string) (m.User, error)

GetUserByID get a user by a ID.

func SetupDB

func SetupDB(bootstrap, testData bool)

SetupDB will be used to bootstrap the DB

Types

type AssignmentStore

type AssignmentStore struct {
	DefaultStore
}

func NewAssignmentStore

func NewAssignmentStore() AssignmentStore

func (*AssignmentStore) BeforeSave

func (a *AssignmentStore) BeforeSave(v *m.Assignment) error

BeforeSave ...

func (AssignmentStore) Store

func (a AssignmentStore) Store(v *m.Assignment) (string, error)

type AssignmentTypeStore

type AssignmentTypeStore struct {
	DefaultStore
}

func NewAssignmentTypeStore

func NewAssignmentTypeStore() AssignmentTypeStore

type DefaultStore

type DefaultStore struct {
	TableName string
}

DefaultStore ...

func NewDefaultStore

func NewDefaultStore(tableName string) DefaultStore

NewDefaultStore ...

func (DefaultStore) Delete

func (d DefaultStore) Delete(id string) error

Delete ...

func (*DefaultStore) Filter

func (d *DefaultStore) Filter(data interface{}, filter interface{}) error

func (DefaultStore) FindAll

func (d DefaultStore) FindAll(data interface{}) error

FindAll ...

func (DefaultStore) FindByID

func (d DefaultStore) FindByID(data m.Model, id string) error

FindByID ...

func (*DefaultStore) Store

func (d *DefaultStore) Store(v m.Model) (string, error)

Store ...

func (*DefaultStore) Update

func (d *DefaultStore) Update(v m.Model, id string) error

Update ...

type EnrollmentStore

type EnrollmentStore struct {
	DefaultStore
}

func NewEnrollmentStore

func NewEnrollmentStore() EnrollmentStore

func (EnrollmentStore) Filter

func (pr EnrollmentStore) Filter(enrollments *[]m.EnrollmentAPIRes, filter interface{}) error

type SessionStore

type SessionStore struct {
	DefaultStore
}

func NewSessionStore

func NewSessionStore() SessionStore

type Storer

type Storer interface {
	Store(m.Model) (string, error)
	Update(m.Model, string) error
	FindAll(interface{}) error
	FindByID(m.Model, string) error
}

Storer interface

type UserStore

type UserStore struct {
	DefaultStore
}

UserStore used to interact with db users

func NewUserStore

func NewUserStore() UserStore

NewUserStore returns a UserStore.

func (*UserStore) FindByEmail

func (us *UserStore) FindByEmail(email string) (m.User, error)

FindByEmail finds a single user that matches an email.

func (*UserStore) Store

func (us *UserStore) Store(u *m.User) error

Store saves a user into the db