1//
2// Copyright 2018, Sander van Harmelen
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15//
16
17package gitlab
18
19import (
20 "fmt"
21 "time"
22)
23
24// GroupMilestonesService handles communication with the milestone related
25// methods of the GitLab API.
26//
27// GitLab API docs: https://docs.gitlab.com/ce/api/group_milestones.html
28type GroupMilestonesService struct {
29 client *Client
30}
31
32// GroupMilestone represents a GitLab milestone.
33//
34// GitLab API docs: https://docs.gitlab.com/ce/api/group_milestones.html
35type GroupMilestone struct {
36 ID int `json:"id"`
37 IID int `json:"iid"`
38 GroupID int `json:"group_id"`
39 Title string `json:"title"`
40 Description string `json:"description"`
41 StartDate *ISOTime `json:"start_date"`
42 DueDate *ISOTime `json:"due_date"`
43 State string `json:"state"`
44 UpdatedAt *time.Time `json:"updated_at"`
45 CreatedAt *time.Time `json:"created_at"`
46}
47
48func (m GroupMilestone) String() string {
49 return Stringify(m)
50}
51
52// ListGroupMilestonesOptions represents the available
53// ListGroupMilestones() options.
54//
55// GitLab API docs:
56// https://docs.gitlab.com/ce/api/group_milestones.html#list-group-milestones
57type ListGroupMilestonesOptions struct {
58 ListOptions
59 IIDs []int `url:"iids,omitempty" json:"iids,omitempty"`
60 State string `url:"state,omitempty" json:"state,omitempty"`
61 Search string `url:"search,omitempty" json:"search,omitempty"`
62}
63
64// ListGroupMilestones returns a list of group milestones.
65//
66// GitLab API docs:
67// https://docs.gitlab.com/ce/api/group_milestones.html#list-group-milestones
68func (s *GroupMilestonesService) ListGroupMilestones(gid interface{}, opt *ListGroupMilestonesOptions, options ...OptionFunc) ([]*GroupMilestone, *Response, error) {
69 group, err := parseID(gid)
70 if err != nil {
71 return nil, nil, err
72 }
73 u := fmt.Sprintf("groups/%s/milestones", pathEscape(group))
74
75 req, err := s.client.NewRequest("GET", u, opt, options)
76 if err != nil {
77 return nil, nil, err
78 }
79
80 var m []*GroupMilestone
81 resp, err := s.client.Do(req, &m)
82 if err != nil {
83 return nil, resp, err
84 }
85
86 return m, resp, err
87}
88
89// GetGroupMilestone gets a single group milestone.
90//
91// GitLab API docs:
92// https://docs.gitlab.com/ce/api/group_milestones.html#get-single-milestone
93func (s *GroupMilestonesService) GetGroupMilestone(gid interface{}, milestone int, options ...OptionFunc) (*GroupMilestone, *Response, error) {
94 group, err := parseID(gid)
95 if err != nil {
96 return nil, nil, err
97 }
98 u := fmt.Sprintf("groups/%s/milestones/%d", pathEscape(group), milestone)
99
100 req, err := s.client.NewRequest("GET", u, nil, options)
101 if err != nil {
102 return nil, nil, err
103 }
104
105 m := new(GroupMilestone)
106 resp, err := s.client.Do(req, m)
107 if err != nil {
108 return nil, resp, err
109 }
110
111 return m, resp, err
112}
113
114// CreateGroupMilestoneOptions represents the available CreateGroupMilestone() options.
115//
116// GitLab API docs:
117// https://docs.gitlab.com/ce/api/group_milestones.html#create-new-milestone
118type CreateGroupMilestoneOptions struct {
119 Title *string `url:"title,omitempty" json:"title,omitempty"`
120 Description *string `url:"description,omitempty" json:"description,omitempty"`
121 StartDate *ISOTime `url:"start_date,omitempty" json:"start_date,omitempty"`
122 DueDate *ISOTime `url:"due_date,omitempty" json:"due_date,omitempty"`
123}
124
125// CreateGroupMilestone creates a new group milestone.
126//
127// GitLab API docs:
128// https://docs.gitlab.com/ce/api/group_milestones.html#create-new-milestone
129func (s *GroupMilestonesService) CreateGroupMilestone(gid interface{}, opt *CreateGroupMilestoneOptions, options ...OptionFunc) (*GroupMilestone, *Response, error) {
130 group, err := parseID(gid)
131 if err != nil {
132 return nil, nil, err
133 }
134 u := fmt.Sprintf("groups/%s/milestones", pathEscape(group))
135
136 req, err := s.client.NewRequest("POST", u, opt, options)
137 if err != nil {
138 return nil, nil, err
139 }
140
141 m := new(GroupMilestone)
142 resp, err := s.client.Do(req, m)
143 if err != nil {
144 return nil, resp, err
145 }
146
147 return m, resp, err
148}
149
150// UpdateGroupMilestoneOptions represents the available UpdateGroupMilestone() options.
151//
152// GitLab API docs:
153// https://docs.gitlab.com/ce/api/group_milestones.html#edit-milestone
154type UpdateGroupMilestoneOptions struct {
155 Title *string `url:"title,omitempty" json:"title,omitempty"`
156 Description *string `url:"description,omitempty" json:"description,omitempty"`
157 StartDate *ISOTime `url:"start_date,omitempty" json:"start_date,omitempty"`
158 DueDate *ISOTime `url:"due_date,omitempty" json:"due_date,omitempty"`
159 StateEvent *string `url:"state_event,omitempty" json:"state_event,omitempty"`
160}
161
162// UpdateGroupMilestone updates an existing group milestone.
163//
164// GitLab API docs:
165// https://docs.gitlab.com/ce/api/group_milestones.html#edit-milestone
166func (s *GroupMilestonesService) UpdateGroupMilestone(gid interface{}, milestone int, opt *UpdateGroupMilestoneOptions, options ...OptionFunc) (*GroupMilestone, *Response, error) {
167 group, err := parseID(gid)
168 if err != nil {
169 return nil, nil, err
170 }
171 u := fmt.Sprintf("groups/%s/milestones/%d", pathEscape(group), milestone)
172
173 req, err := s.client.NewRequest("PUT", u, opt, options)
174 if err != nil {
175 return nil, nil, err
176 }
177
178 m := new(GroupMilestone)
179 resp, err := s.client.Do(req, m)
180 if err != nil {
181 return nil, resp, err
182 }
183
184 return m, resp, err
185}
186
187// GetGroupMilestoneIssuesOptions represents the available GetGroupMilestoneIssues() options.
188//
189// GitLab API docs:
190// https://docs.gitlab.com/ce/api/group_milestones.html#get-all-issues-assigned-to-a-single-milestone
191type GetGroupMilestoneIssuesOptions ListOptions
192
193// GetGroupMilestoneIssues gets all issues assigned to a single group milestone.
194//
195// GitLab API docs:
196// https://docs.gitlab.com/ce/api/group_milestones.html#get-all-issues-assigned-to-a-single-milestone
197func (s *GroupMilestonesService) GetGroupMilestoneIssues(gid interface{}, milestone int, opt *GetGroupMilestoneIssuesOptions, options ...OptionFunc) ([]*Issue, *Response, error) {
198 group, err := parseID(gid)
199 if err != nil {
200 return nil, nil, err
201 }
202 u := fmt.Sprintf("groups/%s/milestones/%d/issues", pathEscape(group), milestone)
203
204 req, err := s.client.NewRequest("GET", u, opt, options)
205 if err != nil {
206 return nil, nil, err
207 }
208
209 var i []*Issue
210 resp, err := s.client.Do(req, &i)
211 if err != nil {
212 return nil, resp, err
213 }
214
215 return i, resp, err
216}
217
218// GetGroupMilestoneMergeRequestsOptions represents the available
219// GetGroupMilestoneMergeRequests() options.
220//
221// GitLab API docs:
222// https://docs.gitlab.com/ce/api/group_milestones.html#get-all-merge-requests-assigned-to-a-single-milestone
223type GetGroupMilestoneMergeRequestsOptions ListOptions
224
225// GetGroupMilestoneMergeRequests gets all merge requests assigned to a
226// single group milestone.
227//
228// GitLab API docs:
229// https://docs.gitlab.com/ce/api/group_milestones.html#get-all-merge-requests-assigned-to-a-single-milestone
230func (s *GroupMilestonesService) GetGroupMilestoneMergeRequests(gid interface{}, milestone int, opt *GetGroupMilestoneMergeRequestsOptions, options ...OptionFunc) ([]*MergeRequest, *Response, error) {
231 group, err := parseID(gid)
232 if err != nil {
233 return nil, nil, err
234 }
235 u := fmt.Sprintf("groups/%s/milestones/%d/merge_requests", pathEscape(group), milestone)
236
237 req, err := s.client.NewRequest("GET", u, opt, options)
238 if err != nil {
239 return nil, nil, err
240 }
241
242 var mr []*MergeRequest
243 resp, err := s.client.Do(req, &mr)
244 if err != nil {
245 return nil, resp, err
246 }
247
248 return mr, resp, err
249}