688ee1978e
All checks were successful
continuous-integration/drone/push Build is passing
Add Docs on how to deal with this breaking change doResponse should return responce in all cases, to prosses things manualy if wanted helper func return http response Co-authored-by: 6543 <6543@obermui.de> Reviewed-on: #416 Reviewed-by: Andrew Thornton <art27@cantab.net> Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
137 lines
4.5 KiB
Go
137 lines
4.5 KiB
Go
// Copyright 2016 The Gogs Authors. All rights reserved.
|
|
// Use of this source code is governed by a MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package gitea
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/url"
|
|
"time"
|
|
)
|
|
|
|
// Comment represents a comment on a commit or issue
|
|
type Comment struct {
|
|
ID int64 `json:"id"`
|
|
HTMLURL string `json:"html_url"`
|
|
PRURL string `json:"pull_request_url"`
|
|
IssueURL string `json:"issue_url"`
|
|
Poster *User `json:"user"`
|
|
OriginalAuthor string `json:"original_author"`
|
|
OriginalAuthorID int64 `json:"original_author_id"`
|
|
Body string `json:"body"`
|
|
Created time.Time `json:"created_at"`
|
|
Updated time.Time `json:"updated_at"`
|
|
}
|
|
|
|
// ListIssueCommentOptions list comment options
|
|
type ListIssueCommentOptions struct {
|
|
ListOptions
|
|
Since time.Time
|
|
Before time.Time
|
|
}
|
|
|
|
// QueryEncode turns options into querystring argument
|
|
func (opt *ListIssueCommentOptions) QueryEncode() string {
|
|
query := opt.getURLQuery()
|
|
if !opt.Since.IsZero() {
|
|
query.Add("since", opt.Since.Format(time.RFC3339))
|
|
}
|
|
if !opt.Before.IsZero() {
|
|
query.Add("before", opt.Before.Format(time.RFC3339))
|
|
}
|
|
return query.Encode()
|
|
}
|
|
|
|
// ListIssueComments list comments on an issue.
|
|
func (c *Client) ListIssueComments(owner, repo string, index int64, opt ListIssueCommentOptions) ([]*Comment, *Response, error) {
|
|
opt.setDefaults()
|
|
link, _ := url.Parse(fmt.Sprintf("/repos/%s/%s/issues/%d/comments", owner, repo, index))
|
|
link.RawQuery = opt.QueryEncode()
|
|
comments := make([]*Comment, 0, opt.PageSize)
|
|
resp, err := c.getParsedResponse("GET", link.String(), nil, nil, &comments)
|
|
return comments, resp, err
|
|
}
|
|
|
|
// ListRepoIssueComments list comments for a given repo.
|
|
func (c *Client) ListRepoIssueComments(owner, repo string, opt ListIssueCommentOptions) ([]*Comment, *Response, error) {
|
|
opt.setDefaults()
|
|
link, _ := url.Parse(fmt.Sprintf("/repos/%s/%s/issues/comments", owner, repo))
|
|
link.RawQuery = opt.QueryEncode()
|
|
comments := make([]*Comment, 0, opt.PageSize)
|
|
resp, err := c.getParsedResponse("GET", link.String(), nil, nil, &comments)
|
|
return comments, resp, err
|
|
}
|
|
|
|
// GetIssueComment get a comment for a given repo by id.
|
|
func (c *Client) GetIssueComment(owner, repo string, id int64) (*Comment, *Response, error) {
|
|
comment := new(Comment)
|
|
if err := c.CheckServerVersionConstraint(">=1.12.0"); err != nil {
|
|
return comment, nil, err
|
|
}
|
|
resp, err := c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/issues/comments/%d", owner, repo, id), nil, nil, &comment)
|
|
return comment, resp, err
|
|
}
|
|
|
|
// CreateIssueCommentOption options for creating a comment on an issue
|
|
type CreateIssueCommentOption struct {
|
|
Body string `json:"body"`
|
|
}
|
|
|
|
// Validate the CreateIssueCommentOption struct
|
|
func (opt CreateIssueCommentOption) Validate() error {
|
|
if len(opt.Body) == 0 {
|
|
return fmt.Errorf("body is empty")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// CreateIssueComment create comment on an issue.
|
|
func (c *Client) CreateIssueComment(owner, repo string, index int64, opt CreateIssueCommentOption) (*Comment, *Response, error) {
|
|
if err := opt.Validate(); err != nil {
|
|
return nil, nil, err
|
|
}
|
|
body, err := json.Marshal(&opt)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
comment := new(Comment)
|
|
resp, err := c.getParsedResponse("POST", fmt.Sprintf("/repos/%s/%s/issues/%d/comments", owner, repo, index), jsonHeader, bytes.NewReader(body), comment)
|
|
return comment, resp, err
|
|
}
|
|
|
|
// EditIssueCommentOption options for editing a comment
|
|
type EditIssueCommentOption struct {
|
|
Body string `json:"body"`
|
|
}
|
|
|
|
// Validate the EditIssueCommentOption struct
|
|
func (opt EditIssueCommentOption) Validate() error {
|
|
if len(opt.Body) == 0 {
|
|
return fmt.Errorf("body is empty")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// EditIssueComment edits an issue comment.
|
|
func (c *Client) EditIssueComment(owner, repo string, commentID int64, opt EditIssueCommentOption) (*Comment, *Response, error) {
|
|
if err := opt.Validate(); err != nil {
|
|
return nil, nil, err
|
|
}
|
|
body, err := json.Marshal(&opt)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
comment := new(Comment)
|
|
resp, err := c.getParsedResponse("PATCH", fmt.Sprintf("/repos/%s/%s/issues/comments/%d", owner, repo, commentID), jsonHeader, bytes.NewReader(body), comment)
|
|
return comment, resp, err
|
|
}
|
|
|
|
// DeleteIssueComment deletes an issue comment.
|
|
func (c *Client) DeleteIssueComment(owner, repo string, commentID int64) (*Response, error) {
|
|
_, resp, err := c.getResponse("DELETE", fmt.Sprintf("/repos/%s/%s/issues/comments/%d", owner, repo, commentID), nil, nil)
|
|
return resp, err
|
|
}
|