Use querystring package to build urls & rename resource urls to path

Makefile

@@ -5,9 +5,11 @@ GO_IMAGE        = golang:1.10.3
 MODD_VERSION    = 0.5
 GO_PKG_SRC_PATH = "github.com/plouc/go-gitlab-client"
 
-SHA1 = $(shell git rev-parse HEAD)
 OS   = $(shell uname)
 
+GIT_SHA  = $(shell git rev-parse HEAD)
+GIT_REF ?= $(shell git symbolic-ref -q --short HEAD)
+
 #=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 #
 #  HELP

gitlab/badges.go

@@ -2,12 +2,11 @@ package gitlab
 
 import (
 	"encoding/json"
-	"strconv"
 )
 
 const (
-	projectBadgesUrl = "/projects/:id/badges"
-	projectBadgeUrl  = "/projects/:id/badges/:badge_id"
+	ProjectBadgesApiPath = "/projects/:id/badges"
+	ProjectBadgeApiPath  = "/projects/:id/badges/:badge_id"
 )
 
 type Badge struct {
@@ -20,20 +19,7 @@ type Badge struct {
 }
 
 func (g *Gitlab) ProjectBadges(projectId string, o *PaginationOptions) ([]*Badge, *ResponseMeta, error) {
-	u := g.ResourceUrl(projectBadgesUrl, map[string]string{":id": projectId})
-
-	if o != nil {
-		q := u.Query()
-
-		if o.Page != 1 {
-			q.Set("page", strconv.Itoa(o.Page))
-		}
-		if o.PerPage != 0 {
-			q.Set("per_page", strconv.Itoa(o.PerPage))
-		}
-
-		u.RawQuery = q.Encode()
-	}
+	u := g.ResourceUrlQ(ProjectBadgesApiPath, map[string]string{":id": projectId}, o)
 
 	var badges []*Badge
 
@@ -46,7 +32,7 @@ func (g *Gitlab) ProjectBadges(projectId string, o *PaginationOptions) ([]*Badge
 }
 
 func (g *Gitlab) ProjectBadge(projectId, badgeId string) (*Badge, *ResponseMeta, error) {
-	u := g.ResourceUrl(projectBadgeUrl, map[string]string{
+	u := g.ResourceUrl(ProjectBadgeApiPath, map[string]string{
 		":id":       projectId,
 		":badge_id": badgeId,
 	})
@@ -62,7 +48,7 @@ func (g *Gitlab) ProjectBadge(projectId, badgeId string) (*Badge, *ResponseMeta,
 }
 
 func (g *Gitlab) AddProjectBadge(projectId string, badge *Badge) (*Badge, *ResponseMeta, error) {
-	u := g.ResourceUrl(projectBadgesUrl, map[string]string{":id": projectId})
+	u := g.ResourceUrl(ProjectBadgesApiPath, map[string]string{":id": projectId})
 
 	badgeJson, err := json.Marshal(badge)
 	if err != nil {
@@ -79,7 +65,7 @@ func (g *Gitlab) AddProjectBadge(projectId string, badge *Badge) (*Badge, *Respo
 }
 
 func (g *Gitlab) RemoveProjectBadge(projectId, badgeId string) (*ResponseMeta, error) {
-	u := g.ResourceUrl(projectBadgeUrl, map[string]string{
+	u := g.ResourceUrl(ProjectBadgeApiPath, map[string]string{
 		":id":       projectId,
 		":badge_id": badgeId,
 	})

gitlab/branches.go

@@ -2,13 +2,12 @@ package gitlab
 
 import (
 	"encoding/json"
-	"strconv"
 )
 
 const (
-	projectBranchesUrl       = "/projects/:id/repository/branches"         // List repository branches.
-	projectBranchUrl         = "/projects/:id/repository/branches/:branch" // Get a specific branch of a project.
-	projectMergedBranchesUrl = "/projects/:id/repository/merged_branches"
+	ProjectBranchesApiPath       = "/projects/:id/repository/branches"
+	ProjectBranchApiPath         = "/projects/:id/repository/branches/:branch"
+	ProjectMergedBranchesApiPath = "/projects/:id/repository/merged_branches"
 )
 
 type BranchCommit struct {
@@ -32,27 +31,14 @@ type Branch struct {
 
 type BranchesOptions struct {
 	PaginationOptions
-	Search string // Return list of branches matching the search criteria
+	SortOptions
+
+	// Return list of branches matching the search criteria
+	Search string `url:"search,omitempty"`
 }
 
 func (g *Gitlab) ProjectBranches(projectId string, o *BranchesOptions) ([]*Branch, *ResponseMeta, error) {
-	u := g.ResourceUrl(projectBranchesUrl, map[string]string{":id": projectId})
-
-	if o != nil {
-		q := u.Query()
-
-		if o.Page != 1 {
-			q.Set("page", strconv.Itoa(o.Page))
-		}
-		if o.PerPage != 0 {
-			q.Set("per_page", strconv.Itoa(o.PerPage))
-		}
-		if o.Search != "" {
-			q.Set("search", o.Search)
-		}
-
-		u.RawQuery = q.Encode()
-	}
+	u := g.ResourceUrlQ(ProjectBranchesApiPath, map[string]string{":id": projectId}, o)
 
 	var branches []*Branch
 
@@ -65,7 +51,7 @@ func (g *Gitlab) ProjectBranches(projectId string, o *BranchesOptions) ([]*Branc
 }
 
 func (g *Gitlab) ProjectBranch(projectId, branchName string) (*Branch, *ResponseMeta, error) {
-	u := g.ResourceUrl(projectBranchUrl, map[string]string{
+	u := g.ResourceUrl(ProjectBranchApiPath, map[string]string{
 		":id":     projectId,
 		":branch": branchName,
 	})
@@ -81,7 +67,8 @@ func (g *Gitlab) ProjectBranch(projectId, branchName string) (*Branch, *Response
 }
 
 func (g *Gitlab) AddProjectBranch(projectId string, branchName, ref string) (*Branch, *ResponseMeta, error) {
-	u := g.ResourceUrl(projectBranchesUrl, map[string]string{":id": projectId})
+	u := g.ResourceUrl(ProjectBranchesApiPath, map[string]string{":id": projectId})
+
 	q := u.Query()
 	q.Set("branch", branchName)
 	q.Set("ref", ref)
@@ -97,7 +84,7 @@ func (g *Gitlab) AddProjectBranch(projectId string, branchName, ref string) (*Br
 }
 
 func (g *Gitlab) RemoveProjectBranch(projectId, branchName string) (*ResponseMeta, error) {
-	u := g.ResourceUrl(projectBranchUrl, map[string]string{
+	u := g.ResourceUrl(ProjectBranchApiPath, map[string]string{
 		":id":     projectId,
 		":branch": branchName,
 	})
@@ -109,7 +96,7 @@ func (g *Gitlab) RemoveProjectBranch(projectId, branchName string) (*ResponseMet
 }
 
 func (g *Gitlab) RemoveProjectMergedBranches(projectId string) (string, *ResponseMeta, error) {
-	u := g.ResourceUrl(projectMergedBranchesUrl, map[string]string{":id": projectId})
+	u := g.ResourceUrl(ProjectMergedBranchesApiPath, map[string]string{":id": projectId})
 
 	var responseWithMessage *ResponseWithMessage
 	contents, meta, err := g.buildAndExecRequest("DELETE", u.String(), nil)

gitlab/builds.go

@@ -6,8 +6,8 @@ import (
 )
 
 const (
-	projectCommitBuildsUrl   = "/projects/:id/repository/commits/:sha/builds"
-	projectBuildArtifactsUrl = "/projects/:id/builds/:build_id/artifacts"
+	ProjectCommitBuildsApiPath   = "/projects/:id/repository/commits/:sha/builds"
+	ProjectBuildArtifactsApiPath = "/projects/:id/builds/:build_id/artifacts"
 )
 
 type ArtifactsFile struct {
@@ -34,7 +34,7 @@ type Build struct {
 }
 
 func (g *Gitlab) ProjectCommitBuilds(id, sha1 string) ([]*Build, *ResponseMeta, error) {
-	u := g.ResourceUrl(projectCommitBuildsUrl, map[string]string{
+	u := g.ResourceUrl(ProjectCommitBuildsApiPath, map[string]string{
 		":id":  id,
 		":sha": sha1,
 	})
@@ -52,7 +52,7 @@ func (g *Gitlab) ProjectCommitBuilds(id, sha1 string) ([]*Build, *ResponseMeta,
 }
 
 func (g *Gitlab) ProjectBuildArtifacts(id, buildId string) (io.ReadCloser, error) {
-	u := g.ResourceUrl(projectBuildArtifactsUrl, map[string]string{
+	u := g.ResourceUrl(ProjectBuildArtifactsApiPath, map[string]string{
 		":id":       id,
 		":build_id": buildId,
 	})

gitlab/commits.go

@@ -6,7 +6,7 @@ import (
 )
 
 const (
-	projectCommitStatusesUrl = "/projects/:id/repository/commits/:sha/statuses"
+	ProjectCommitStatusesApiPath = "/projects/:id/repository/commits/:sha/statuses"
 )
 
 type CommitStatus struct {
@@ -25,7 +25,7 @@ type CommitStatus struct {
 }
 
 func (g *Gitlab) ProjectCommitStatuses(id, sha1 string) ([]*CommitStatus, *ResponseMeta, error) {
-	u := g.ResourceUrl(projectCommitStatusesUrl, map[string]string{
+	u := g.ResourceUrl(ProjectCommitStatusesApiPath, map[string]string{
 		":id":  id,
 		":sha": sha1,
 	})

gitlab/deploy_keys.go

@@ -6,8 +6,8 @@ import (
 )
 
 const (
-	projectDeployKeysUrl = "/projects/:id/keys"
-	projectDeployKeyUrl  = "/projects/:id/keys/:key_id"
+	ProjectDeployKeysApiPath = "/projects/:id/keys"
+	ProjectDeployKeyApiPath  = "/projects/:id/keys/:key_id"
 )
 
 /*
@@ -21,7 +21,7 @@ Parameters:
 
 */
 func (g *Gitlab) ProjectDeployKeys(id string) ([]*PublicKey, *ResponseMeta, error) {
-	u := g.ResourceUrl(projectDeployKeysUrl, map[string]string{":id": id})
+	u := g.ResourceUrl(ProjectDeployKeysApiPath, map[string]string{":id": id})
 
 	var deployKeys []*PublicKey
 
@@ -45,7 +45,7 @@ Parameters:
 
 */
 func (g *Gitlab) ProjectDeployKey(id, keyId string) (*PublicKey, *ResponseMeta, error) {
-	u := g.ResourceUrl(projectDeployKeyUrl, map[string]string{
+	u := g.ResourceUrl(ProjectDeployKeyApiPath, map[string]string{
 		":id":     id,
 		":key_id": keyId,
 	})
@@ -73,7 +73,7 @@ Parameters:
 
 */
 func (g *Gitlab) AddProjectDeployKey(id, title, key string) (*ResponseMeta, error) {
-	u := g.ResourceUrl(projectDeployKeysUrl, map[string]string{":id": id})
+	u := g.ResourceUrl(ProjectDeployKeysApiPath, map[string]string{":id": id})
 
 	var err error
 
@@ -100,7 +100,7 @@ Parameters:
 
 */
 func (g *Gitlab) RemoveProjectDeployKey(id, keyId string) (*ResponseMeta, error) {
-	u := g.ResourceUrl(projectDeployKeyUrl, map[string]string{
+	u := g.ResourceUrl(ProjectDeployKeyApiPath, map[string]string{
 		":id":     id,
 		":key_id": keyId,
 	})

gitlab/events.go

@@ -35,8 +35,7 @@ type FeedCommit struct {
 }
 
 func (g *Gitlab) Activity() (ActivityFeed, error) {
-	url := g.BaseUrl + dashboardFeedPath + "?private_token=" + g.Token
-	fmt.Println(url)
+	url := g.BaseUrl + DashboardFeedPath + "?private_token=" + g.Token
 
 	contents, _, err := g.buildAndExecRequest("GET", url, nil)
 	if err != nil {

gitlab/gitlab.go

@@ -11,10 +11,12 @@ import (
 	"net/url"
 	"strconv"
 	"strings"
+
+	"github.com/google/go-querystring/query"
 )
 
 const (
-	dashboardFeedPath = "/dashboard.atom"
+	DashboardFeedPath = "/dashboard.atom"
 )
 
 type Gitlab struct {
@@ -26,8 +28,8 @@ type Gitlab struct {
 }
 
 type PaginationOptions struct {
-	Page    int
-	PerPage int
+	Page    int `url:"page,omitempty"`
+	PerPage int `url:"per_page,omitempty"`
 }
 
 type SortDirection string
@@ -37,6 +39,11 @@ const (
 	SortDirectionDesc SortDirection = "desc"
 )
 
+type SortOptions struct {
+	OrderBy string        `url:"order_by,omitempty"`
+	Sort    SortDirection `url:"sort,omitempty"`
+}
+
 type ResponseWithMessage struct {
 	Message string `json:"message"`
 }
@@ -64,6 +71,7 @@ var (
 		`If set to true, gitlab client will skip certificate checking for https, possibly exposing your system to MITM attack.`)
 )
 
+// NewGitlab generates a new gitlab service
 func NewGitlab(baseUrl, apiPath, token string) *Gitlab {
 	config := &tls.Config{InsecureSkipVerify: *skipCertVerify}
 	tr := &http.Transport{
@@ -80,16 +88,38 @@ func NewGitlab(baseUrl, apiPath, token string) *Gitlab {
 	}
 }
 
-func (g *Gitlab) ResourceUrl(p string, params map[string]string) *url.URL {
+// ResourceUrl builds an url for given resource path.
+//
+// It replaces path placeholders with values from `params`:
+//
+//   /whatever/:id => /whatever/1
+//
+func (g *Gitlab) ResourceUrl(path string, params map[string]string) *url.URL {
 	if params != nil {
 		for key, val := range params {
-			p = strings.Replace(p, key, val, -1)
+			path = strings.Replace(path, key, val, -1)
 		}
 	}
 
-	u, err := url.Parse(g.BaseUrl + g.ApiPath + p)
+	u, err := url.Parse(g.BaseUrl + g.ApiPath + path)
 	if err != nil {
-		panic("Error while building gitlab url")
+		panic("Error while building gitlab url, unable to parse generated url")
+	}
+
+	return u
+}
+
+// ResourceUrlQ generates an url and appends a query string to it if available
+func (g *Gitlab) ResourceUrlQ(path string, params map[string]string, qs interface{}) *url.URL {
+	u := g.ResourceUrl(path, params)
+
+	if qs != nil {
+		v, err := query.Values(qs)
+		if err != nil {
+			panic("Error while building gitlab url, unable to set query string")
+		}
+
+		u.RawQuery = v.Encode()
 	}
 
 	return u

gitlab/gitlab_test.go

@@ -10,12 +10,12 @@ func TestResourceUrl(t *testing.T) {
 
 	assert.Equal(
 		t,
-		gitlab.ResourceUrl(projectsUrl, nil).String(),
+		gitlab.ResourceUrl(ProjectsApiPath, nil).String(),
 		"http://base_url/api_path/projects",
 	)
 	assert.Equal(
 		t,
-		gitlab.ResourceUrl(projectUrl, map[string]string{":id": "123"}).String(),
+		gitlab.ResourceUrl(ProjectApiPath, map[string]string{":id": "123"}).String(),
 		"http://base_url/api_path/projects/123",
 	)
 }