简化 Request 的 API 名称以及增加更详细的注释

Author: 彭博

cmd/login.go

@@ -28,10 +28,8 @@ import (
 )
 
 const (
-	// loginURL       = "/api/v2/account/login"
 	loginURI       = "/api/v2/account/login"
 	minAccountSize = 6
-	cookieFile     = ".cookie"
 )
 
 var account string
@@ -99,7 +97,7 @@ func login(account string, sha1Password string) error {
 	form := url.Values{}
 	form.Set("account", account)
 	form.Set("password", sha1Password)
-	req := request.NewPostRequest(loginURI, &form)
+	req := request.NewPost(loginURI, &form)
 	req.On2fa = get2faCode
 	_, err := req.Send()
 	if err != nil {

cmd/release.go

@@ -121,7 +121,10 @@ var releaseCmd = &cobra.Command{
 }
 
 // release 主要包含以下五个部分
-// 1. 变更记录（Changelog） 2. 版本对比（Diff） 3.发布服务列表 4.服务配置更新
+// 1. 变更记录（Changelog）
+// 2. 版本对比（Diff）
+// 3. 发布服务列表
+// 4. 服务配置更新
 func release(src string, target string) (err error) {
 	// Ref to Commit ID
 	s := src
@@ -140,17 +143,17 @@ func release(src string, target string) (err error) {
 	}
 	fmt.Printf("compare: %s(%s)...%s(%s)\n\n", s, src, t, target)
 
-	// Changlog
+	// Changelog
 	d, err := diff(s, t)
 	if err != nil {
 		return err
 	}
-	changelogs, err := changelog(d.Commits)
+	changes, err := changelog(d.Commits)
 	if err != nil {
 		return err
 	}
-	size := len(changelogs)
-	for i, c := range changelogs {
+	size := len(changes)
+	for i, c := range changes {
 		fmt.Printf("changelog %d/%d: %s #%d\n", i+1, size, c.Title, c.MergeID)
 	}
 
@@ -276,7 +279,7 @@ func commitID(ref string) (id string, err error) {
 	if ref == "" {
 		return "", fmt.Errorf("ref 不能为空")
 	}
-	req := request.NewGetRequest(fmt.Sprintf(commitDetailURI, ref))
+	req := request.NewGet(fmt.Sprintf(commitDetailURI, ref))
 	commit := model.ComplexCommit{}
 	err = req.SendAndUnmarshal(&commit)
 	if err != nil {
@@ -286,7 +289,7 @@ func commitID(ref string) (id string, err error) {
 }
 
 func diff(src string, target string) (d *model.Diff, err error) {
-	req := request.NewGetRequest(fmt.Sprintf(diffURI, src, target))
+	req := request.NewGet(fmt.Sprintf(diffURI, src, target))
 	b := model.Diff{}
 	err = req.SendAndUnmarshal(&b)
 	if err != nil {
@@ -296,7 +299,7 @@ func diff(src string, target string) (d *model.Diff, err error) {
 }
 
 func defaultBranchCommitID() (branch string, err error) {
-	req := request.NewGetRequest(defaultBranchURI)
+	req := request.NewGet(defaultBranchURI)
 	b := model.Branch{}
 	err = req.SendAndUnmarshal(&b)
 	if err != nil {
@@ -308,13 +311,4 @@ func defaultBranchCommitID() (branch string, err error) {
 
 func init() {
 	rootCmd.AddCommand(releaseCmd)
-	// Here you will define your flags and configuration settings.
-
-	// Cobra supports Persistent Flags which will work for this command
-	// and all subcommands, e.g.:
-	// releaseCmd.PersistentFlags().String("foo", "", "A help for foo")
-
-	// Cobra supports local flags which will only run when this command
-	// is called directly, e.g.:
-	// releaseCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 }

pkg/request/request.go

@@ -24,34 +24,31 @@ const (
 
 // Request 包含了 HTTP 请求需要的基本参数
 type Request struct {
-	// URL 请求地址
-	URL string
-	// POST 提交的表单数据
-	Form *url.Values
-	// 请求方法 GET/POST/DELETE 等
-	Method string
-	// On2fa 需要两步验证验证时调用
-	On2fa func() (string, error)
+	URL    string                 // URL 请求地址
+	Form   *url.Values            // POST 提交的表单数据
+	Method string                 // 请求方法 GET/POST/DELETE 等
+	On2fa  func() (string, error) // On2fa 需要两步验证验证时调用
 }
 
-// NewGetRequest 创建 GET 请求
-func NewGetRequest(url string) *Request {
+// NewGet 创建 GET 请求
+func NewGet(url string) *Request {
 	return &Request{
 		URL:    Host + url,
 		Method: http.MethodGet,
 	}
 }
 
-// NewPostRequest 创建 POST 请求
-func NewPostRequest(url string, form *url.Values) *Request {
+// NewPost 创建 POST 请求
+func NewPost(url string, form *url.Values) *Request {
 	return &Request{
 		URL:    Host + url,
 		Method: http.MethodPost,
 		Form:   form,
 	}
 }
 
-// Send 将发送请求并解析 JSON 结果
+// Send 将发送请求并解析 JSON 结果，返回结果 Result 中如果包含 Code > 0 的情况，将视作意外出错情况
+// 只有当 Result 返回 Code 为 0 时，请求才会被当做成功
 func (r *Request) Send() (*model.Result, error) {
 	u, err := url.Parse(r.URL)
 	if err != nil {
@@ -117,21 +114,21 @@ func (r *Request) Send() (*model.Result, error) {
 		if require2faCode(&result) {
 			return r.send2faCode()
 		}
-		return nil, fmt.Errorf("请求失败, %v", msgs(&result))
+		return nil, fmt.Errorf("请求失败, %v", errorMsg(&result))
 	}
 
 	return &result, nil
 }
 
-func msgs(r *model.Result) string {
+func errorMsg(r *model.Result) string {
 	msg := make([]string, 0)
 	for _, v := range r.Msg {
 		msg = append(msg, v)
 	}
 	return strings.Join(msg, ", ")
 }
 
-// SendAndUnmarshal 将发送请求并反序列化 JSON 中的 Data 结果
+// SendAndUnmarshal 将发送请求并反序列化 JSON 中的 model.Result.Data 结果
 func (r *Request) SendAndUnmarshal(v interface{}) error {
 	result, err := r.Send()
 	if err != nil {
@@ -154,7 +151,7 @@ func (r *Request) send2faCode() (*model.Result, error) {
 	}
 	form := url.Values{}
 	form.Set("code", code)
-	req := NewPostRequest("/api/check_two_factor_auth_code", &form)
+	req := NewPost("/api/check_two_factor_auth_code", &form)
 	result, err := req.Send()
 	if err != nil {
 		return nil, err