domain

Documentation

Index

• Constants
• Variables
• type ErrorResponse
• type Family
• type Member
• type Person
• type PersonRepository
• type PersonRequest
• type PersonUseCase
• type Relation
• type Relationship
• type RelationshipRepository
• type RelationshipUseCase

Constants

const (
	ChildrenName = "children"
	ParentName   = "parent"
)

Variables

var (
	// ErrRegistrationNotFound will throw if the searched person registration cannot be found
	ErrRegistrationNotFound = errors.New("person registration not found")
	// ErrInvalidSelfRelation will throw if the attempted relationship is with oneself.
	ErrInvalidSelfRelation = errors.New("cannot create a relationship with oneself")
	// ErrDuplicateRelation will throw if the attempted relationship already exists.
	ErrDuplicateRelation = errors.New("relationship already exists")
	// ErrRelationNotFound will throw if the searched relationship cannot be found.
	ErrRelationNotFound = errors.New("relationship not found")
	// ErrIncestuousRelation will throw if the attempted relationship is incestuous.
	ErrIncestuousRelation = errors.New("cannot create incestuous relationship")
)

var FamilyConnection = map[string]int64{
	"self":         0,
	"parent":       1,
	"children":     1,
	"sibling":      2,
	"grandparent":  2,
	"grandchild":   2,
	"aunt_uncle":   3,
	"niece_nephew": 3,
	"cousin":       4,
}

Types

type ErrorResponse

type ErrorResponse struct {
	ErrorMessage string `json:"error"`
}

type Family

type Family struct {
	ID               int64      `json:"id" xml:"id"`
	Name             string     `json:"name" xml:"name"`
	Relationship     string     `json:"relationship" xml:"relationship"`
	FamilyConnection int64      `json:"family_connection" xml:"family_connection"`
	Relationships    []Relation `json:"relationships" xml:"relationships>relation"`
}

type Member

type Member struct {
	XMLName xml.Name `json:"-" xml:"family"`
	ID      int64    `json:"id" xml:"id"`
	Name    string   `json:"name" xml:"name"`
	Members []Family `json:"members" xml:"members>member"`
}

type Person

type Person struct {
	ID        int64      `json:"id"`
	Name      string     `json:"name"`
	Email     string     `json:"email"`
	BirthDate *time.Time `json:"birth_date"`
	CreatedAt time.Time  `json:"created_at"`
}

type PersonRepository

type PersonRepository interface {
	GetByID(id int64) (Person, error)
	CreatePerson(person PersonRequest) error
	GetAllPerson() ([]Person, error)
}

type PersonRequest

type PersonRequest struct {
	Name      string `json:"name" binding:"required,min=3"`
	Email     string `json:"email" binding:"required,email"`
	BirthDate string `json:"birth_date"`
}

type PersonUseCase

type PersonUseCase interface {
	GetByID(id int64) (Person, error)
	CreatePerson(person PersonRequest) error
	GetAllPerson() ([]Person, error)
}

type Relation

type Relation struct {
	ID           int64  `json:"id" xml:"id"`
	Name         string `json:"name" xml:"name"`
	Relationship string `json:"relationship" xml:"relationship"`
}

type Relationship

type Relationship struct {
	ParentId   int64 `json:"parent"`
	ChildrenId int64 `json:"children"`
}

type RelationshipRepository

type RelationshipRepository interface {
	GetRelationshipByID(personId int64) (*Member, error)
	CreateRelationship(personId int64, relationship Relationship) error
	DeleteRelationship(personId int64) error
}

type RelationshipUseCase

type RelationshipUseCase interface {
	GetRelationshipByID(personId int64) (*Member, error)
	CreateRelationship(personId int64, person Relationship) error
	DeleteRelationship(personId int64) error
}