FilesExpand file tree

 master

/

pulls_comments.go

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

157 lines (133 loc) · 5.23 KB

 master

/

pulls_comments.go

Copy path

Top

File metadata and controls

• Code
• Blame

157 lines (133 loc) · 5.23 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

// Copyright 2013 The go-github AUTHORS. All rights reserved.

//

// Use of this source code is governed by a BSD-style

// license that can be found in the LICENSE file.

package github

import (

"context"

"fmt"

"time"

)

// PullRequestComment represents a comment left on a pull request.

type PullRequestComment struct {

ID *int `json:"id,omitempty"`

InReplyTo *int `json:"in_reply_to,omitempty"`

Body *string `json:"body,omitempty"`

Path *string `json:"path,omitempty"`

DiffHunk *string `json:"diff_hunk,omitempty"`

Position *int `json:"position,omitempty"`

OriginalPosition *int `json:"original_position,omitempty"`

CommitID *string `json:"commit_id,omitempty"`

OriginalCommitID *string `json:"original_commit_id,omitempty"`

User *User `json:"user,omitempty"`

Reactions *Reactions `json:"reactions,omitempty"`

CreatedAt *time.Time `json:"created_at,omitempty"`

UpdatedAt *time.Time `json:"updated_at,omitempty"`

URL *string `json:"url,omitempty"`

HTMLURL *string `json:"html_url,omitempty"`

PullRequestURL *string `json:"pull_request_url,omitempty"`

}

func (p PullRequestComment) String() string {

return Stringify(p)

}

// PullRequestListCommentsOptions specifies the optional parameters to the

// PullRequestsService.ListComments method.

type PullRequestListCommentsOptions struct {

// Sort specifies how to sort comments. Possible values are: created, updated.

Sort string `url:"sort,omitempty"`

// Direction in which to sort comments. Possible values are: asc, desc.

Direction string `url:"direction,omitempty"`

// Since filters comments by time.

Since time.Time `url:"since,omitempty"`

ListOptions

}

// ListComments lists all comments on the specified pull request. Specifying a

// pull request number of 0 will return all comments on all pull requests for

// the repository.

//

// GitHub API docs: https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request

func (s *PullRequestsService) ListComments(ctx context.Context, owner string, repo string, number int, opt *PullRequestListCommentsOptions) ([]*PullRequestComment, *Response, error) {

var u string

if number == 0 {

u = fmt.Sprintf("repos/%v/%v/pulls/comments", owner, repo)

} else {

u = fmt.Sprintf("repos/%v/%v/pulls/%d/comments", owner, repo, number)

}

u, err := addOptions(u, opt)

if err != nil {

return nil, nil, err

}

req, err := s.client.NewRequest("GET", u, nil)

if err != nil {

return nil, nil, err

}

// TODO: remove custom Accept header when this API fully launches.

req.Header.Set("Accept", mediaTypeReactionsPreview)

var comments []*PullRequestComment

resp, err := s.client.Do(ctx, req, &comments)

if err != nil {

return nil, resp, err

}

return comments, resp, nil

}

// GetComment fetches the specified pull request comment.

//

// GitHub API docs: https://developer.github.com/v3/pulls/comments/#get-a-single-comment

func (s *PullRequestsService) GetComment(ctx context.Context, owner string, repo string, number int) (*PullRequestComment, *Response, error) {

u := fmt.Sprintf("repos/%v/%v/pulls/comments/%d", owner, repo, number)

req, err := s.client.NewRequest("GET", u, nil)

if err != nil {

return nil, nil, err

}

// TODO: remove custom Accept header when this API fully launches.

req.Header.Set("Accept", mediaTypeReactionsPreview)

comment := new(PullRequestComment)

resp, err := s.client.Do(ctx, req, comment)

if err != nil {

return nil, resp, err

}

return comment, resp, nil

}

// CreateComment creates a new comment on the specified pull request.

//

// GitHub API docs: https://developer.github.com/v3/pulls/comments/#create-a-comment

func (s *PullRequestsService) CreateComment(ctx context.Context, owner string, repo string, number int, comment *PullRequestComment) (*PullRequestComment, *Response, error) {

u := fmt.Sprintf("repos/%v/%v/pulls/%d/comments", owner, repo, number)

req, err := s.client.NewRequest("POST", u, comment)

if err != nil {

return nil, nil, err

}

c := new(PullRequestComment)

resp, err := s.client.Do(ctx, req, c)

if err != nil {

return nil, resp, err

}

return c, resp, nil

}

// EditComment updates a pull request comment.

//

// GitHub API docs: https://developer.github.com/v3/pulls/comments/#edit-a-comment

func (s *PullRequestsService) EditComment(ctx context.Context, owner string, repo string, number int, comment *PullRequestComment) (*PullRequestComment, *Response, error) {

u := fmt.Sprintf("repos/%v/%v/pulls/comments/%d", owner, repo, number)

req, err := s.client.NewRequest("PATCH", u, comment)

if err != nil {

return nil, nil, err

}

c := new(PullRequestComment)

resp, err := s.client.Do(ctx, req, c)

if err != nil {

return nil, resp, err

}

return c, resp, nil

}

// DeleteComment deletes a pull request comment.

//

// GitHub API docs: https://developer.github.com/v3/pulls/comments/#delete-a-comment

func (s *PullRequestsService) DeleteComment(ctx context.Context, owner string, repo string, number int) (*Response, error) {

u := fmt.Sprintf("repos/%v/%v/pulls/comments/%d", owner, repo, number)

req, err := s.client.NewRequest("DELETE", u, nil)

if err != nil {

return nil, err

}

return s.client.Do(ctx, req, nil)

}