Completed truss code gen for generating model requests and crud.

example-project/internal/project/models.go

@@ -1,43 +1,96 @@
 package project
 
 import (
+	"database/sql/driver"
 	"time"
 
-	"gopkg.in/mgo.v2/bson"
+	"github.com/lib/pq"
+	"github.com/pkg/errors"
+	"gopkg.in/go-playground/validator.v9"
 )
 
-// Project is an item we sell.
+// Project represents a workflow.
 type Project struct {
-	ID           bson.ObjectId `bson:"_id" json:"id"`                      // Unique identifier.
-	Name         string        `bson:"name" json:"name"`                   // Display name of the project.
-	Cost         int           `bson:"cost" json:"cost"`                   // Price for one item in cents.
-	Quantity     int           `bson:"quantity" json:"quantity"`           // Original number of items available.
-	DateCreated  time.Time     `bson:"date_created" json:"date_created"`   // When the project was added.
-	DateModified time.Time     `bson:"date_modified" json:"date_modified"` // When the project record was lost modified.
+	ID            string         `json:"id" validate:"required,uuid"`
+	AccountID     string         `json:"account_id" validate:"required,uuid" truss:"api-create"`
+	Name          string         `json:"name"  validate:"required"`
+	Status        ProjectStatus  `json:"status" validate:"omitempty,oneof=active disabled"`
+	CreatedAt     time.Time      `json:"created_at" truss:"api-read"`
+	UpdatedAt     time.Time      `json:"updated_at" truss:"api-read"`
+	ArchivedAt    pq.NullTime    `json:"archived_at" truss:"api-hide"`
 }
 
-// NewProject is what we require from clients when adding a Project.
-type NewProject struct {
-	Name     string `json:"name" validate:"required"`
-	Cost     int    `json:"cost" validate:"required,gte=0"`
-	Quantity int    `json:"quantity" validate:"required,gte=1"`
+// CreateProjectRequest contains information needed to create a new Project.
+type ProjectCreateRequest struct {
+	AccountID        string `json:"account_id" validate:"required,uuid"`
+	Name          string         `json:"name" validate:"required"`
+	Status        *ProjectStatus `json:"status" validate:"omitempty,oneof=active disabled"`
 }
 
-// UpdateProject defines what information may be provided to modify an
-// existing Project. All fields are optional so clients can send just the
-// fields they want changed. It uses pointer fields so we can differentiate
-// between a field that was not provided and a field that was provided as
-// explicitly blank. Normally we do not want to use pointers to basic types but
-// we make exceptions around marshalling/unmarshalling.
-type UpdateProject struct {
-	Name     *string `json:"name"`
-	Cost     *int    `json:"cost" validate:"omitempty,gte=0"`
-	Quantity *int    `json:"quantity" validate:"omitempty,gte=1"`
+// UpdateProjectRequest defines what information may be provided to modify an existing
+// Project. All fields are optional so clients can send just the fields they want
+// changed. It uses pointer fields so we can differentiate between a field that
+// was not provided and a field that was provided as explicitly blank. Normally
+// we do not want to use pointers to basic types but we make exceptions around
+// marshalling/unmarshalling.
+type ProjectUpdateRequest struct {
+	ID            string         `validate:"required,uuid"`
+	Name          *string        `json:"name" validate:"omitempty"`
+	Status        *ProjectStatus `json:"status" validate:"omitempty,oneof=active pending disabled"`
 }
 
-// Sale represents a transaction where we sold some quantity of a
-// Project.
-type Sale struct{}
+// ProjectFindRequest defines the possible options to search for projects. By default
+// archived projects will be excluded from response.
+type ProjectFindRequest struct {
+	Where            *string
+	Args             []interface{}
+	Order            []string
+	Limit            *uint
+	Offset           *uint
+	IncludedArchived bool
+}
 
-// NewSale defines what we require when creating a Sale record.
-type NewSale struct{}
+// ProjectStatus represents the status of an project.
+type ProjectStatus string
+
+// ProjectStatus values define the status field of a user project.
+const (
+	// ProjectStatus_Active defines the state when a user can access an project.
+	ProjectStatus_Active ProjectStatus = "active"
+	// ProjectStatus_Disabled defines the state when a user has been disabled from
+	// accessing an project.
+	ProjectStatus_Disabled ProjectStatus = "disabled"
+)
+
+// ProjectStatus_Values provides list of valid ProjectStatus values.
+var ProjectStatus_Values = []ProjectStatus{
+	ProjectStatus_Active,
+	ProjectStatus_Disabled,
+}
+
+// Scan supports reading the ProjectStatus value from the database.
+func (s *ProjectStatus) Scan(value interface{}) error {
+	asBytes, ok := value.([]byte)
+	if !ok {
+		return errors.New("Scan source is not []byte")
+	}
+	*s = ProjectStatus(string(asBytes))
+	return nil
+}
+
+// Value converts the ProjectStatus value to be stored in the database.
+func (s ProjectStatus) Value() (driver.Value, error) {
+	v := validator.New()
+
+	errs := v.Var(s, "required,oneof=active disabled")
+	if errs != nil {
+		return nil, errs
+	}
+
+	return string(s), nil
+}
+
+// String converts the ProjectStatus value to a string.
+func (s ProjectStatus) String() string {
+	return string(s)
+}