Merge branch 'release/1.4.0'

Author: KensoDev

README.md

@@ -112,6 +112,12 @@ If you have any issues, please open one here on Github or hit me up on twitter [
 
 ## CHANGELOG
 
+
+## 1.4.0
+
+* Added the pivotal tracker client. Thanks to [@stephensxu](http://github.com/stephensxu).
+  In order to create the client and connect to pivotal tracker, you run `gong login pivotal`
+
 ### 1.3.4
 
 * Added the `create` command. Opens up the browser on the create ticket URL for

client.go

@@ -30,7 +30,7 @@ func Create(client Client) (string, error) {
 func PrepareCommitMessage(client Client, branchName, commitMessage string) string {
 	return client.PrepareCommitMessage(branchName, commitMessage)
 }
-
+	
 // Comment : Comment on an issue
 func Comment(client Client, branchName, comment string) error {
 	return client.Comment(branchName, comment)
@@ -52,9 +52,13 @@ func NewClient(clientName string) (Client, error) {
 		return NewJiraClient(), nil
 	}
 
+	if clientName == "pivotal" {
+		return NewPivotalClient(), nil
+	}
+
 	return nil, fmt.Errorf("Could not find client: %v", clientName)
 }
-
+	
 // NewAuthenticatedClient : Return a new client authenticated
 func NewAuthenticatedClient() (Client, error) {
 	fields, err := Load()

cmd/gong/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.3.4
+current_version = 1.4.0
 commit = False
 tag = False
 

cmd/gong/main.go

@@ -6,21 +6,21 @@ import (
 	"os"
 	"os/exec"
 
+	"github.com/KensoDev/gong"
 	"github.com/fatih/color"
-	"github.com/kensodev/gong"
 	"github.com/urfave/cli"
 )
 
 func main() {
 	app := cli.NewApp()
-	app.Version = "1.3.4"
+	app.Version = "1.4.0"
 
 	var branchType string
 
 	app.Commands = []cli.Command{
 		{
 			Name:  "login",
-			Usage: "Login to your Jira Instance",
+			Usage: "Login to your project managment tool instance",
 			Action: func(c *cli.Context) error {
 				clientName := c.Args()[0]
 				client, err := gong.NewClient(clientName)
@@ -68,7 +68,6 @@ func main() {
 				}
 
 				branchName, err := gong.Start(client, branchType, issueId)
-
 				if err != nil {
 					color.Red("Problem with starting the issue")
 				}

pivotal.go

@@ -0,0 +1,189 @@
+package gong
+
+import (
+	"fmt"
+	"gopkg.in/salsita/go-pivotaltracker.v1/v5/pivotal"
+	"strconv"
+	"regexp"
+)
+
+// PivotalClient : Struct implementing the generic Client interface
+type PivotalClient struct {
+	client *pivotal.Client
+	config map[string]string
+}
+
+// NewPivotalClient : Returns a pointer to PivotalClient
+func NewPivotalClient() *PivotalClient {
+	return &PivotalClient{}
+}
+
+func (p *PivotalClient) Create() (string, error) {
+	fields, err := Load()
+	
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	projectId := fields["projectId"]
+
+	domain := "https://www.pivotaltracker.com/n/projects"
+	url := fmt.Sprintf("%s/%s", domain, projectId)
+
+	if err != nil {
+		return "", err
+	}
+
+	return url, nil
+}
+
+// GetName : Return the string name of the struct eg: pivotal
+func (p *PivotalClient) GetName() string {
+	return "pivotal"
+}
+
+// Browse : Browse to the URL of the issue related to the branch name
+func (p *PivotalClient) Browse(branchName string) (string, error) {
+	issueID := GetPivotalIssueID(branchName)
+	domain := "https://www.pivotaltracker.com/story/show"
+	url := fmt.Sprintf("%s/%s", domain, issueID)
+	return url, nil
+}
+
+func GetPivotalIssueID(branchName string) string {
+	re := regexp.MustCompile(`([\d]+)`)
+	matches := re.FindAllString(branchName, -1)
+
+	if len(matches) == 0 {
+		return ""
+	}
+
+	return matches[0]
+}
+
+// Start : Start an issue
+func (p *PivotalClient) Start(issueType string, issueID string) (string, error) {
+	projectIdInt, issueIdInt, err := p.GetProjectIdAndIssueId(issueID)
+
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	request := &pivotal.StoryRequest{}
+	request.State = "started"
+
+	_, _, err = p.client.Stories.Update(projectIdInt, issueIdInt, request)
+
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	branchName, err := p.GetBranchName(issueType, issueID)
+
+	if err != nil {
+		return "", err
+	}
+
+	fmt.Println("branch name:", branchName)
+	return branchName, nil
+}
+
+func (p *PivotalClient) Comment(branchName, comment string) error {
+	fmt.Println(branchName)
+	issueID := GetPivotalIssueID(branchName)
+	fmt.Println(issueID)
+
+	projectIdInt, issueIdInt, err := p.GetProjectIdAndIssueId(issueID)
+
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	commentObject := &pivotal.Comment{}
+	commentObject.Text = comment
+
+	_, _, err = p.client.Stories.AddComment(projectIdInt, issueIdInt, commentObject)
+
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	fmt.Println("added comment", comment)
+	return nil
+}
+
+func (p *PivotalClient) PrepareCommitMessage(branchName, commitMessage string) string {
+	issueID := GetPivotalIssueID(branchName)
+	url, err := p.Browse(branchName)
+
+	if err != nil {
+		return commitMessage
+	}
+
+	patchedCommitMessage := fmt.Sprintf(`[%s](%s)`, issueID, url)
+
+	return patchedCommitMessage
+}
+
+func (p *PivotalClient) GetBranchName(issueType string, issueID string) (string, error) {
+	projectIdInt, issueIdInt, _ := p.GetProjectIdAndIssueId(issueID)
+
+	story, _, err := p.client.Stories.Get(projectIdInt, issueIdInt)
+
+	if err != nil {
+		fmt.Println(err)
+	}
+
+	issueTitleSlug := SlugifyTitle(story.Name)
+
+	return fmt.Sprintf("%s/%s-%s", issueType, issueID, issueTitleSlug), nil
+}
+
+func (p *PivotalClient) GetProjectIdAndIssueId(issueID string) (int, int, error) {
+	fields, err := Load()
+	if err != nil {
+		return 0, 0, err
+	}
+
+	projectIdInt, err := strconv.Atoi(fields["projectId"])
+	if err != nil {
+		return 0, 0, err
+	}
+
+	fmt.Println("projectIdInt", projectIdInt)
+
+	issueIdInt, err := strconv.Atoi(issueID)
+	if err != nil {
+		return 0, 0, err
+	}
+
+	fmt.Println("issueIdInt", issueIdInt)
+	return projectIdInt, issueIdInt, nil
+}
+
+// FormatField : Returns a formatted field based on internal rules
+func (p *PivotalClient) FormatField(fieldName string, value string) string {
+	return value
+}
+
+// Authenticate : Authenticates using the fields passed in
+func (p *PivotalClient) Authenticate(fields map[string]string) bool {
+	pivotalClient := pivotal.NewClient(fields["apiToken"])
+	_, _, err := pivotalClient.Me.Get()
+
+	if err != nil {
+		return false
+	}
+
+	p.client = pivotalClient
+	p.config = fields
+
+	return true
+}
+
+func (p *PivotalClient) GetAuthFields() map[string]bool {
+	return map[string]bool{
+		"projectId": false,
+		"apiToken":  true,
+	}
+}

pivotal_test.go

@@ -0,0 +1,41 @@
+package gong
+
+import (
+	. "gopkg.in/check.v1"
+	"testing"
+)
+
+func TestPivotalClient(t *testing.T) { TestingT(t) }
+
+type PivotalClientSuit struct{}
+
+var _ = Suite(&PivotalClientSuit{})
+
+func (p *PivotalClientSuit) TestBrowseWithCorrectBranchName(c * C) {
+	pivotalClient := &PivotalClient{}
+
+	url, err := pivotalClient.Browse("feature/124352-test-only")
+	c.Assert(err, Equals, nil)
+	c.Assert(url, Equals, "https://www.pivotaltracker.com/story/show/124352")
+}
+
+func (p *PivotalClientSuit) TestBrowseWithIncorrectBranchName(c * C) {
+	pivotalClient := &PivotalClient{}
+
+	url, err := pivotalClient.Browse("feature/test-only")
+	c.Assert(err, Equals, nil)
+	c.Assert(url, Equals, "https://www.pivotaltracker.com/story/show/")
+}
+
+func (p *PivotalClientSuit) TestGetPivotalIssueIDWithCorrectBranchName(c * C) {
+	branchName := "feature/1234-test-only"
+	issueId := GetPivotalIssueID(branchName)
+	c.Assert(issueId, Equals, "1234")
+}
+
+
+func (p *PivotalClientSuit) TestGetPivotalIssueIDWithInCorrectBranchName(c * C) {
+	branchName := "feature/test-only"
+	issueId := GetPivotalIssueID(branchName)
+	c.Assert(issueId, Equals, "")
+}