Documentation
¶
Index ¶
- Variables
- type Beverage
- type BeverageController
- func (controller *BeverageController) DeleteBeverage(ctx *gin.Context)
- func (controller *BeverageController) GetBeverage(ctx *gin.Context)
- func (controller *BeverageController) GetBeverages(ctx *gin.Context)
- func (controller *BeverageController) GivePermissionToUser(ctx *gin.Context)
- func (controller *BeverageController) NewBeverage(ctx *gin.Context)
- func (controller *BeverageController) UpdateBeverage(ctx *gin.Context)
- type BeverageRepo
- func (br *BeverageRepo) BackupTo(bkpDest string) error
- func (ar *BeverageRepo) DeleteInstance(bevID string) error
- func (ar *BeverageRepo) GetAllBeverages() ([]*Beverage, error)
- func (ar *BeverageRepo) GetInstance(bevID string) (*Beverage, error)
- func (ar *BeverageRepo) SaveInstance(bev *Beverage) error
- type BeverageService
- func (service *BeverageService) DeleteBeverage(bevID, userID string) error
- func (service *BeverageService) GetBeverage(bevID, userID string) (*Beverage, error)
- func (service *BeverageService) GetBeverages(userID string) ([]*Beverage, error)
- func (service *BeverageService) GivePermissionToUser(bevID, ownerID, newOwnerID string, perm permissions.PermissionType) error
- func (service *BeverageService) NewBeverage(userID, aName string, aValue, aAvailable int) (*Beverage, error)
- func (service *BeverageService) UpdateBeverage(bevID, userID, aName string, aValue, aAvailable int) (*Beverage, error)
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrBeverageDoesNotExist = errors.New("Beverage with this id does not exist")
View Source
var ErrInvalidAvailable = errors.New("Available needs to be a positive integers")
View Source
var ErrInvalidGroupID = errors.New("ID for beverage is not in your group")
View Source
var ErrInvalidID = errors.New("ID for beverage is invalid")
View Source
var ErrInvalidName = errors.New("Name needs to be a nonempty string")
View Source
var ErrInvalidValue = errors.New("Values needs to be a positive integers")
View Source
var ErrNoPermission = errors.New("No permission for this action")
Functions ¶
This section is empty.
Types ¶
type Beverage ¶
type Beverage struct {
ID string `json:"ID"`
Name string `json:"Name"`
Value int `json:"Value"`
Available int `json:"Available"`
}
Beverage : Model for the system
type BeverageController ¶
type BeverageController struct {
// contains filtered or unexported fields
}
BeverageController : Controller for the Beverages
func NewBeverageController ¶
func NewBeverageController(bevService *BeverageService) *BeverageController
NewBeverageController creates a new BeverageController and initializes its service
func (*BeverageController) DeleteBeverage ¶
func (controller *BeverageController) DeleteBeverage(ctx *gin.Context)
DeleteBeverage deletes the beverage identified by the ID in the query and responds with a YEP/NOPE
func (*BeverageController) GetBeverage ¶
func (controller *BeverageController) GetBeverage(ctx *gin.Context)
GetBeverage responds with the beverage identified by the ID in the query
func (*BeverageController) GetBeverages ¶
func (controller *BeverageController) GetBeverages(ctx *gin.Context)
GetBeverages responds with all existing Beverages
func (*BeverageController) GivePermissionToUser ¶
func (controller *BeverageController) GivePermissionToUser(ctx *gin.Context)
GivePermissionToUser gives the other user permission to read/alter the beverage
func (*BeverageController) NewBeverage ¶
func (controller *BeverageController) NewBeverage(ctx *gin.Context)
NewBeverage creates a new beverage with the given form-values "value", "name" and "available" and returns it
func (*BeverageController) UpdateBeverage ¶
func (controller *BeverageController) UpdateBeverage(ctx *gin.Context)
UpdateBeverage updates the beverage identified by the ID the query with the given form-values "value", "name" and "available" and returns it
type BeverageRepo ¶
func NewBeverageRepo ¶
func NewBeverageRepo(dir string) (*BeverageRepo, error)
func (*BeverageRepo) BackupTo ¶
func (br *BeverageRepo) BackupTo(bkpDest string) error
func (*BeverageRepo) DeleteInstance ¶
func (ar *BeverageRepo) DeleteInstance(bevID string) error
func (*BeverageRepo) GetAllBeverages ¶
func (ar *BeverageRepo) GetAllBeverages() ([]*Beverage, error)
func (*BeverageRepo) GetInstance ¶
func (ar *BeverageRepo) GetInstance(bevID string) (*Beverage, error)
func (*BeverageRepo) SaveInstance ¶
func (ar *BeverageRepo) SaveInstance(bev *Beverage) error
type BeverageService ¶
type BeverageService struct {
// contains filtered or unexported fields
}
BeverageService handles the persistence of beverages for us
func NewBeverageService ¶
func NewBeverageService(repo *BeverageRepo, perms *permissions.Permissions) *BeverageService
NewBeverageService creates a new Service
func (*BeverageService) DeleteBeverage ¶
func (service *BeverageService) DeleteBeverage(bevID, userID string) error
DeleteBeverage deletes the identified beverage
func (*BeverageService) GetBeverage ¶
func (service *BeverageService) GetBeverage(bevID, userID string) (*Beverage, error)
GetBeverage returns the identified beverage
func (*BeverageService) GetBeverages ¶
func (service *BeverageService) GetBeverages(userID string) ([]*Beverage, error)
GetBeverages returns all existing beverages
func (*BeverageService) GivePermissionToUser ¶
func (service *BeverageService) GivePermissionToUser(bevID, ownerID, newOwnerID string, perm permissions.PermissionType) error
GivePermissionToUser gives the newOwner the permissions
func (*BeverageService) NewBeverage ¶
func (service *BeverageService) NewBeverage(userID, aName string, aValue, aAvailable int) (*Beverage, error)
NewBeverage creates a new beverage and stores it in the database
func (*BeverageService) UpdateBeverage ¶
func (service *BeverageService) UpdateBeverage(bevID, userID, aName string, aValue, aAvailable int) (*Beverage, error)
UpdateBeverage updates the data for the identified beverage (eg name and value)
Source Files
Click to show internal directories.
Click to hide internal directories.