Support Issues.Search()

Author: Mitsuru Nakada

backlog/backlog.go

@@ -8,7 +8,10 @@ import (
 	"io/ioutil"
 	"net/http"
 	"net/url"
+	"reflect"
 	"strings"
+
+	"github.com/google/go-querystring/query"
 )
 
 // A Client manages communication with the Backlog API.
@@ -179,3 +182,26 @@ func sanitizeURL(uri *url.URL) *url.URL {
 	}
 	return uri
 }
+
+// addOptions adds the parameters in opt as URL query parameters to s. opt
+// must be a struct whose fields may contain "url" tags.
+// https://github.com/google/go-github/blob/99760a16213d6fdde13f4e477438f876b6c9c6eb/github/github.go#L212-L232
+func addOptions(s string, opt interface{}) (string, error) {
+	v := reflect.ValueOf(opt)
+	if v.Kind() == reflect.Ptr && v.IsNil() {
+		return s, nil
+	}
+
+	u, err := url.Parse(s)
+	if err != nil {
+		return s, err
+	}
+
+	qs, err := query.Values(opt)
+	if err != nil {
+		return s, err
+	}
+
+	u.RawQuery = qs.Encode()
+	return u.String(), nil
+}

backlog/issues.go

@@ -59,6 +59,27 @@ type IssueRequest struct {
 	DueDate       *string
 }
 
+// IssueSearchRequest represents a request to create/edit an issue.
+// https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-issue-list/
+type IssueSearchRequest struct {
+	IDs            []int   `url:"id[],omitempty"`             // 課題のID
+	ProjectIDs     []int   `url:"projectId[],omitempty"`      // プロジェクトのID
+	StatusIDs      []int   `url:"statusId[],omitempty"`       // 状態のID
+	PriorityIDs    []int   `url:"priorityId[],omitempty"`     // 優先度のID
+	CategoryIDs    []int   `url:"categoryId[],omitempty"`     // カテゴリーのID
+	IssueTypeIDs   []int   `url:"issueTypeId[],omitempty"`    // 種別のID
+	AssigneeIDs    []int   `url:"assigneeId[],omitempty"`     // 担当者のID
+	ParentIssueIDs []int   `url:"parentIssueId[],omitempty"`  // 親課題のID
+	StartDateSince *string `url:"startDateSince[],omitempty"` // 開始日 (yyyy-MM-dd)
+	DueDateSince   *string `url:"dueDateSince,omitempty"`     // 期限日 (yyyy-MM-dd)
+	ParentChild    *int    `url:"parentChild,omitempty"`      // 親子課題の条件
+	Sort           *string `url:"sort,omitempty"`             // 課題一覧のソートに使用する属性名
+	Order          *string `url:"order,omitempty"`            // `asc` または `desc` 指定が無い場合は `desc`
+	Keyword        *string `url:"keyword,omitempty"`          // 検索キーワード
+	Count          *int    `url:"count,omitempty"`            // 取得上限 (1-100) 指定が無い場合は 20
+	offset         *int    `url:"offset,omitempty"`
+}
+
 // Get an issue.
 func (s *IssuesService) Get(issueKey string) (*Issue, *Response, error) {
 	u := "issues/" + issueKey
@@ -124,6 +145,22 @@ func (s *IssuesService) Delete(issueKey string) (*Response, error) {
 	return resp, nil
 }
 
+// Search issues.
+func (s *IssuesService) Search(request IssueSearchRequest) ([]*Issue, *Response, error) {
+	u, _ := addOptions("issues", request)
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	issues := []*Issue{}
+	resp, err := s.client.Do(req, &issues)
+	if err != nil {
+		return nil, resp, err
+	}
+	return issues, resp, nil
+}
+
 func (r IssueRequest) makeValues() url.Values {
 	v := url.Values{}
 	if r.ProjectID != nil {

examples/search.go

@@ -0,0 +1,48 @@
+package main
+
+import (
+	"flag"
+	"fmt"
+	"os"
+
+	pointers "github.com/f2prateek/go-pointers"
+	"github.com/mnkd/go-backlog/backlog"
+)
+
+func main() {
+	var space string
+	flag.StringVar(&space, "s", "", "Backlog space (e.g. abc-inc)")
+	flag.Parse()
+
+	if len(space) == 0 {
+		fmt.Fprintf(os.Stderr, "Usage:\n\tgo run simple.go -s space_name -k issue_key\n")
+		os.Exit(1)
+	}
+
+	apiKey := os.Getenv("BACKLOG_API_KEY")
+	if len(apiKey) == 0 {
+		fmt.Fprintf(os.Stderr, "simple.go needs \"BACKLOG_API_KEY\" environment variable.\n")
+		os.Exit(1)
+	}
+
+	client := backlog.NewClient(nil, space, apiKey)
+
+	request := backlog.IssueSearchRequest{
+		StatusIDs:   []int{2},
+		ParentChild: pointers.Int(4),
+		Sort:        pointers.String("created"),
+		Order:       pointers.String("asc"),
+		Count:       pointers.Int(10),
+	}
+
+	issues, _, err := client.Issues.Search(request)
+	if err != nil {
+		fmt.Printf("Error: %v\n", err)
+		os.Exit(1)
+	}
+
+	fmt.Printf("Results: %d\n", len(issues))
+	for _, issue := range issues {
+		fmt.Printf("%v: %v (%v)\n", issue.IssueKey, issue.Summary, issue.CreatedUser.Name)
+	}
+}