265 lines
8.4 KiB
Go
265 lines
8.4 KiB
Go
//
|
|
// Copyright 2015, Sander van Harmelen
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
package gitlab
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/url"
|
|
"strings"
|
|
"time"
|
|
)
|
|
|
|
// IssuesService handles communication with the issue related methods
|
|
// of the GitLab API.
|
|
//
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/issues.html
|
|
type IssuesService struct {
|
|
client *Client
|
|
}
|
|
|
|
// Issue represents a GitLab issue.
|
|
//
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/issues.html
|
|
type Issue struct {
|
|
ID int `json:"id"`
|
|
IID int `json:"iid"`
|
|
ProjectID int `json:"project_id"`
|
|
Title string `json:"title"`
|
|
Description string `json:"description"`
|
|
Labels []string `json:"labels"`
|
|
Milestone *Milestone `json:"milestone"`
|
|
Assignee struct {
|
|
ID int `json:"id"`
|
|
Username string `json:"username"`
|
|
Email string `json:"email"`
|
|
Name string `json:"name"`
|
|
State string `json:"state"`
|
|
CreatedAt *time.Time `json:"created_at"`
|
|
} `json:"assignee"`
|
|
Author struct {
|
|
ID int `json:"id"`
|
|
Username string `json:"username"`
|
|
Email string `json:"email"`
|
|
Name string `json:"name"`
|
|
State string `json:"state"`
|
|
CreatedAt *time.Time `json:"created_at"`
|
|
} `json:"author"`
|
|
State string `json:"state"`
|
|
UpdatedAt *time.Time `json:"updated_at"`
|
|
CreatedAt *time.Time `json:"created_at"`
|
|
Subscribed bool `json:"subscribed"`
|
|
UserNotesCount int `json:"user_notes_count"`
|
|
Confidential bool `json:"confidential"`
|
|
DueDate string `json:"due_date"`
|
|
WebURL string `json:"web_url"`
|
|
}
|
|
|
|
func (i Issue) String() string {
|
|
return Stringify(i)
|
|
}
|
|
|
|
// Labels is a custom type with specific marshaling characteristics.
|
|
type Labels []string
|
|
|
|
// MarshalJSON implements the json.Marshaler interface.
|
|
func (l *Labels) MarshalJSON() ([]byte, error) {
|
|
return json.Marshal(strings.Join(*l, ","))
|
|
}
|
|
|
|
// ListIssuesOptions represents the available ListIssues() options.
|
|
//
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/issues.html#list-issues
|
|
type ListIssuesOptions struct {
|
|
ListOptions
|
|
State *string `url:"state,omitempty" json:"state,omitempty"`
|
|
Labels Labels `url:"labels,comma,omitempty" json:"labels,omitempty"`
|
|
OrderBy *string `url:"order_by,omitempty" json:"order_by,omitempty"`
|
|
Sort *string `url:"sort,omitempty" json:"sort,omitempty"`
|
|
}
|
|
|
|
// ListIssues gets all issues created by authenticated user. This function
|
|
// takes pagination parameters page and per_page to restrict the list of issues.
|
|
//
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/issues.html#list-issues
|
|
func (s *IssuesService) ListIssues(opt *ListIssuesOptions, options ...OptionFunc) ([]*Issue, *Response, error) {
|
|
req, err := s.client.NewRequest("GET", "issues", opt, options)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
var i []*Issue
|
|
resp, err := s.client.Do(req, &i)
|
|
if err != nil {
|
|
return nil, resp, err
|
|
}
|
|
|
|
return i, resp, err
|
|
}
|
|
|
|
// ListProjectIssuesOptions represents the available ListProjectIssues() options.
|
|
//
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/issues.html#list-issues
|
|
type ListProjectIssuesOptions struct {
|
|
ListOptions
|
|
IID *int `url:"iid,omitempty" json:"iid,omitempty"`
|
|
State *string `url:"state,omitempty" json:"state,omitempty"`
|
|
Labels Labels `url:"labels,comma,omitempty" json:"labels,omitempty"`
|
|
Milestone *string `url:"milestone,omitempty" json:"milestone,omitempty"`
|
|
OrderBy *string `url:"order_by,omitempty" json:"order_by,omitempty"`
|
|
Sort *string `url:"sort,omitempty" json:"sort,omitempty"`
|
|
}
|
|
|
|
// ListProjectIssues gets a list of project issues. This function accepts
|
|
// pagination parameters page and per_page to return the list of project issues.
|
|
//
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/issues.html#list-project-issues
|
|
func (s *IssuesService) ListProjectIssues(pid interface{}, opt *ListProjectIssuesOptions, options ...OptionFunc) ([]*Issue, *Response, error) {
|
|
project, err := parseID(pid)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
u := fmt.Sprintf("projects/%s/issues", url.QueryEscape(project))
|
|
|
|
req, err := s.client.NewRequest("GET", u, opt, options)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
var i []*Issue
|
|
resp, err := s.client.Do(req, &i)
|
|
if err != nil {
|
|
return nil, resp, err
|
|
}
|
|
|
|
return i, resp, err
|
|
}
|
|
|
|
// GetIssue gets a single project issue.
|
|
//
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/issues.html#single-issues
|
|
func (s *IssuesService) GetIssue(pid interface{}, issue int, options ...OptionFunc) (*Issue, *Response, error) {
|
|
project, err := parseID(pid)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
u := fmt.Sprintf("projects/%s/issues/%d", url.QueryEscape(project), issue)
|
|
|
|
req, err := s.client.NewRequest("GET", u, nil, options)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
i := new(Issue)
|
|
resp, err := s.client.Do(req, i)
|
|
if err != nil {
|
|
return nil, resp, err
|
|
}
|
|
|
|
return i, resp, err
|
|
}
|
|
|
|
// CreateIssueOptions represents the available CreateIssue() options.
|
|
//
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/issues.html#new-issues
|
|
type CreateIssueOptions struct {
|
|
Title *string `url:"title,omitempty" json:"title,omitempty"`
|
|
Description *string `url:"description,omitempty" json:"description,omitempty"`
|
|
AssigneeID *int `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
|
|
MilestoneID *int `url:"milestone_id,omitempty" json:"milestone_id,omitempty"`
|
|
Labels Labels `url:"labels,comma,omitempty" json:"labels,omitempty"`
|
|
}
|
|
|
|
// CreateIssue creates a new project issue.
|
|
//
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/issues.html#new-issues
|
|
func (s *IssuesService) CreateIssue(pid interface{}, opt *CreateIssueOptions, options ...OptionFunc) (*Issue, *Response, error) {
|
|
project, err := parseID(pid)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
u := fmt.Sprintf("projects/%s/issues", url.QueryEscape(project))
|
|
|
|
req, err := s.client.NewRequest("POST", u, opt, options)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
i := new(Issue)
|
|
resp, err := s.client.Do(req, i)
|
|
if err != nil {
|
|
return nil, resp, err
|
|
}
|
|
|
|
return i, resp, err
|
|
}
|
|
|
|
// UpdateIssueOptions represents the available UpdateIssue() options.
|
|
//
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/issues.html#edit-issues
|
|
type UpdateIssueOptions struct {
|
|
Title *string `url:"title,omitempty" json:"title,omitempty"`
|
|
Description *string `url:"description,omitempty" json:"description,omitempty"`
|
|
AssigneeID *int `url:"assignee_id,omitempty" json:"assignee_id,omitempty"`
|
|
MilestoneID *int `url:"milestone_id,omitempty" json:"milestone_id,omitempty"`
|
|
Labels Labels `url:"labels,comma,omitempty" json:"labels,omitempty"`
|
|
StateEvent *string `url:"state_event,omitempty" json:"state_event,omitempty"`
|
|
}
|
|
|
|
// UpdateIssue updates an existing project issue. This function is also used
|
|
// to mark an issue as closed.
|
|
//
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/issues.html#edit-issues
|
|
func (s *IssuesService) UpdateIssue(pid interface{}, issue int, opt *UpdateIssueOptions, options ...OptionFunc) (*Issue, *Response, error) {
|
|
project, err := parseID(pid)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
u := fmt.Sprintf("projects/%s/issues/%d", url.QueryEscape(project), issue)
|
|
|
|
req, err := s.client.NewRequest("PUT", u, opt, options)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
i := new(Issue)
|
|
resp, err := s.client.Do(req, i)
|
|
if err != nil {
|
|
return nil, resp, err
|
|
}
|
|
|
|
return i, resp, err
|
|
}
|
|
|
|
// DeleteIssue deletes a single project issue.
|
|
//
|
|
// GitLab API docs: https://docs.gitlab.com/ce/api/issues.html#delete-an-issue
|
|
func (s *IssuesService) DeleteIssue(pid interface{}, issue int, options ...OptionFunc) (*Response, error) {
|
|
project, err := parseID(pid)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
u := fmt.Sprintf("projects/%s/issues/%d", url.QueryEscape(project), issue)
|
|
|
|
req, err := s.client.NewRequest("DELETE", u, nil, options)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return s.client.Do(req, nil)
|
|
}
|