refactor: add api v1 package

api/v1/common.go

@@ -0,0 +1,21 @@
+package v1
+
+// RowStatus is the status for a row.
+type RowStatus string
+
+const (
+	// Normal is the status for a normal row.
+	Normal RowStatus = "NORMAL"
+	// Archived is the status for an archived row.
+	Archived RowStatus = "ARCHIVED"
+)
+
+func (e RowStatus) String() string {
+	switch e {
+	case Normal:
+		return "NORMAL"
+	case Archived:
+		return "ARCHIVED"
+	}
+	return ""
+}

api/v1/user.go

@@ -0,0 +1,106 @@
+package v1
+
+import (
+	"fmt"
+
+	"github.com/boojack/shortify/common"
+	"github.com/labstack/echo/v4"
+)
+
+// Role is the type of a role.
+type Role string
+
+const (
+	// RoleAdmin is the ADMIN role.
+	RoleAdmin Role = "ADMIN"
+	// RoleUser is the USER role.
+	RoleUser Role = "USER"
+)
+
+func (e Role) String() string {
+	switch e {
+	case RoleAdmin:
+		return "ADMIN"
+	case RoleUser:
+		return "USER"
+	}
+	return "USER"
+}
+
+type User struct {
+	ID int `json:"id"`
+
+	// Standard fields
+	CreatedTs int64     `json:"createdTs"`
+	UpdatedTs int64     `json:"updatedTs"`
+	RowStatus RowStatus `json:"rowStatus"`
+
+	// Domain specific fields
+	Email           string         `json:"email"`
+	DisplayName     string         `json:"displayName"`
+	PasswordHash    string         `json:"-"`
+	OpenID          string         `json:"openId"`
+	Role            Role           `json:"role"`
+	UserSettingList []*UserSetting `json:"userSettingList"`
+}
+
+type UserCreate struct {
+	Email        string `json:"email"`
+	DisplayName  string `json:"displayName"`
+	Password     string `json:"password"`
+	PasswordHash string `json:"-"`
+	OpenID       string `json:"-"`
+	Role         Role   `json:"-"`
+}
+
+func (create UserCreate) Validate() error {
+	if len(create.Email) < 3 {
+		return fmt.Errorf("email is too short, minimum length is 6")
+	}
+	if !common.ValidateEmail(create.Email) {
+		return fmt.Errorf("invalid email format")
+	}
+	if len(create.Password) < 3 {
+		return fmt.Errorf("password is too short, minimum length is 6")
+	}
+
+	return nil
+}
+
+type UserPatch struct {
+	ID int
+
+	// Standard fields
+	RowStatus *RowStatus `json:"rowStatus"`
+
+	// Domain specific fields
+	Email        *string `json:"email"`
+	DisplayName  *string `json:"displayName"`
+	Password     *string `json:"password"`
+	ResetOpenID  *bool   `json:"resetOpenId"`
+	PasswordHash *string `json:"-"`
+	OpenID       *string `json:"-"`
+}
+
+type UserFind struct {
+	ID *int `json:"id"`
+
+	// Standard fields
+	RowStatus *RowStatus `json:"rowStatus"`
+
+	// Domain specific fields
+	Email       *string `json:"email"`
+	DisplayName *string `json:"displayName"`
+	OpenID      *string `json:"openId"`
+	Role        *Role   `json:"-"`
+}
+
+type UserDelete struct {
+	ID int
+}
+
+func (*APIV1Service) RegisterUserRoutes(g *echo.Group) {
+	g.GET("/user", func(c echo.Context) error {
+		return c.String(200, "GET /user")
+	})
+}

api/v1/user_setting.go

@@ -0,0 +1,69 @@
+package v1
+
+import (
+	"encoding/json"
+	"fmt"
+)
+
+type UserSettingKey string
+
+const (
+	// UserSettingLocaleKey is the key type for user locale.
+	UserSettingLocaleKey UserSettingKey = "locale"
+)
+
+// String returns the string format of UserSettingKey type.
+func (key UserSettingKey) String() string {
+	if key == UserSettingLocaleKey {
+		return "locale"
+	}
+	return ""
+}
+
+var (
+	UserSettingLocaleValue = []string{"en", "zh"}
+)
+
+type UserSetting struct {
+	UserID int
+	Key    UserSettingKey `json:"key"`
+	// Value is a JSON string with basic value
+	Value string `json:"value"`
+}
+
+type UserSettingUpsert struct {
+	UserID int
+	Key    UserSettingKey `json:"key"`
+	Value  string         `json:"value"`
+}
+
+func (upsert UserSettingUpsert) Validate() error {
+	if upsert.Key == UserSettingLocaleKey {
+		localeValue := "en"
+		err := json.Unmarshal([]byte(upsert.Value), &localeValue)
+		if err != nil {
+			return fmt.Errorf("failed to unmarshal user setting locale value")
+		}
+
+		invalid := true
+		for _, value := range UserSettingLocaleValue {
+			if localeValue == value {
+				invalid = false
+				break
+			}
+		}
+		if invalid {
+			return fmt.Errorf("invalid user setting locale value")
+		}
+	} else {
+		return fmt.Errorf("invalid user setting key")
+	}
+
+	return nil
+}
+
+type UserSettingFind struct {
+	UserID int
+
+	Key *UserSettingKey `json:"key"`
+}

api/v1/v1.go

@@ -0,0 +1,23 @@
+package v1
+
+import (
+	"github.com/boojack/shortify/server/profile"
+	"github.com/boojack/shortify/store"
+	"github.com/labstack/echo/v4"
+)
+
+type APIV1Service struct {
+	Profile *profile.Profile
+	Store   *store.Store
+}
+
+func NewAPIV1Service(profile *profile.Profile, store *store.Store) *APIV1Service {
+	return &APIV1Service{
+		Profile: profile,
+		Store:   store,
+	}
+}
+
+func (s *APIV1Service) Start(apiV1Group *echo.Group) {
+	s.RegisterUserRoutes(apiV1Group)
+}