sms

type Agency interface {

	// Send 发送短信
	// 无论是否发送成功，SMSResult都有值，成功是error是nil，否则有值
	Send(number, content string) (*Result, error)
}

type AliyunSender struct {
	// contains filtered or unexported fields
}

type Code struct {
	// contains filtered or unexported fields
}

type ErrReproduceRemain int64

type FetchScene func(sceneID string) (*Scene, error)

type FnSkip func(sceneID string, number string, code string) bool

type GenCode func(codeLen int) string

type GenCodeReplaceble interface {
	SetGenCode(genCode GenCode)
}

type RawResult map[string]string

type Result struct {
	Raw RawResult
}

type Scene struct {
	// 验证码内容模板
	Templdate string
	// 有效期 秒数
	ValidDuration int64
	// 可重发的间隔 秒数
	ReproduceInterval int64
	// 验证码位数
	CodeLen int
}

type SceneModel struct {
	// 场景ID
	SceneID string `gorm:"type:varchar(30);primay_key"`
	// 模板 格式：您好，您的验证码是{{code}} 当前预设的变量只有code
	Template string `gorm:"type:varchar(100);not null"`
	// �有效时长，单位秒
	ValidDuration int64 `gorm:"not null"`
	// 可重发的时间间隔，单位秒
	ReproduceInterval int64 `gorm:"not null"`
	// 验证码的位数
	CodeLen   int `gorm:"not null"`
	CreatedAt time.Time
	UpdatedAt time.Time
	DeletedAt *time.Time `sql:"index"`
}

type SendQueue struct {
	ID        uint       `gorm:"primaryKey" json:"id" field:"id"`
	CreatedAt time.Time  `json:"createdAt" field:"created_at"`
	UpdatedAt time.Time  `json:"updatedAt" field:"updated_at"`
	DeletedAt *time.Time `sql:"index" json:"deletedAt" field:"deleted_at"`
	Number    string     `gorm:"type:varchar(20)" json:"number" field:"number"`
	Content   string     `gorm:"type:varchar(255)" json:"content" field:"content"`
	// 发送状态 0:待发送 1:发送成功 2:发送失败
	Status byte `json:"status" field:"status"`
}

type Sender func(number, content string) (RawResult, error)

type Skippable interface {
	SetFnSkip(fnSkip FnSkip)
}

type Storage interface {
	// 获取 bool表示是否取到
	Get(key string) (*Code, bool)
	// 保存
	Set(key string, code *Code) error
	// 删除
	Delete(key string)
}

type Validator interface {

	// 生成验证码
	// sceneID 代表一个场景
	Produce(sceneID string, number string) (*Code, error)

	// 校验验证码
	// 成功校验后验证码即失效
	Validate(sceneID string, number string, code string) error
}