Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove returned *http.Response from tag-related methods #360

Merged
merged 1 commit into from
Nov 6, 2021
Merged

Remove returned *http.Response from tag-related methods #360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions tag.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,12 @@ func (c *Client) ListTagsPaginated(ctx context.Context, o ListTagOptions) ([]*Ta
// CreateTag creates a new tag.
//
// Deprecated: Use CreateTagWithContext instead.
func (c *Client) CreateTag(t *Tag) (*Tag, *http.Response, error) {
func (c *Client) CreateTag(t *Tag) (*Tag, error) {
return c.CreateTagWithContext(context.Background(), t)
}

// CreateTagWithContext creates a new tag.
func (c *Client) CreateTagWithContext(ctx context.Context, t *Tag) (*Tag, *http.Response, error) {
func (c *Client) CreateTagWithContext(ctx context.Context, t *Tag) (*Tag, error) {
d := map[string]*Tag{
"tag": t,
}
Expand All @@ -115,31 +115,31 @@ func (c *Client) DeleteTagWithContext(ctx context.Context, id string) error {
// GetTag gets details about an existing tag.
//
// Deprecated: Use GetTagWithContext instead.
func (c *Client) GetTag(id string) (*Tag, *http.Response, error) {
func (c *Client) GetTag(id string) (*Tag, error) {
return c.GetTagWithContext(context.Background(), id)
}

// GetTagWithContext gets details about an existing tag.
func (c *Client) GetTagWithContext(ctx context.Context, id string) (*Tag, *http.Response, error) {
func (c *Client) GetTagWithContext(ctx context.Context, id string) (*Tag, error) {
resp, err := c.get(ctx, "/tags/"+id)
return getTagFromResponse(c, resp, err)
}

// AssignTags adds and removes tag assignments with entities.
//
// Deprecated: Use AssignTagsWithContext instead.
func (c *Client) AssignTags(e, eid string, a *TagAssignments) (*http.Response, error) {
func (c *Client) AssignTags(e, eid string, a *TagAssignments) error {
return c.AssignTagsWithContext(context.Background(), e, eid, a)
}

// AssignTagsWithContext adds and removes tag assignments with entities.
func (c *Client) AssignTagsWithContext(ctx context.Context, e, eid string, a *TagAssignments) (*http.Response, error) {
resp, err := c.post(ctx, "/"+e+"/"+eid+"/change_tags", a, nil)
func (c *Client) AssignTagsWithContext(ctx context.Context, e, eid string, a *TagAssignments) error {
_, err := c.post(ctx, "/"+e+"/"+eid+"/change_tags", a, nil)
if err != nil {
return nil, err
return err
}

return resp, nil
return nil
}

// GetUsersByTag gets related user references based on the Tag. This method
Expand Down Expand Up @@ -308,24 +308,24 @@ func (c *Client) GetTagsForEntityPaginated(ctx context.Context, entityType, enti
return getTagList(ctx, c, entityType, entityID, o)
}

func getTagFromResponse(c *Client, resp *http.Response, err error) (*Tag, *http.Response, error) {
func getTagFromResponse(c *Client, resp *http.Response, err error) (*Tag, error) {
if err != nil {
return nil, nil, err
return nil, err
}

var target map[string]Tag
if dErr := c.decodeJSON(resp, &target); dErr != nil {
return nil, nil, fmt.Errorf("Could not decode JSON response: %v", dErr)
return nil, fmt.Errorf("Could not decode JSON response: %v", dErr)
}

const rootNode = "tag"

t, nodeOK := target[rootNode]
if !nodeOK {
return nil, nil, fmt.Errorf("JSON response does not have %s field", rootNode)
return nil, fmt.Errorf("JSON response does not have %s field", rootNode)
}

return &t, resp, nil
return &t, nil
}

// getTagList is a utility function that processes all pages of a ListTagResponse
Expand Down
8 changes: 4 additions & 4 deletions tag_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ func TestTag_Create(t *testing.T) {
input := &Tag{
Label: "foo",
}
res, _, err := client.CreateTag(input)
res, err := client.CreateTag(input)

want := &Tag{
APIObject: APIObject{
Expand Down Expand Up @@ -98,7 +98,7 @@ func TestTag_Get(t *testing.T) {

client := defaultTestClient(server.URL, "foo")
id := "1"
res, _, err := client.GetTag(id)
res, err := client.GetTag(id)

want := &Tag{
APIObject: APIObject{
Expand Down Expand Up @@ -136,7 +136,7 @@ func TestTag_AssignAdd(t *testing.T) {
},
}
// this endpoint only returns an "ok" in the body. no point in testing for it.
_, err := client.AssignTags("teams", "1", ta)
err := client.AssignTags("teams", "1", ta)
if err != nil {
t.Fatal(err)
}
Expand All @@ -161,7 +161,7 @@ func TestTag_AssignRemove(t *testing.T) {
},
}
// this endpoint only returns an "ok" in the body. no point in testing for it.
_, err := client.AssignTags("teams", "1", ta)
err := client.AssignTags("teams", "1", ta)
if err != nil {
t.Fatal(err)
}
Expand Down