Skip to content

Commit

Permalink
Merge pull request #1 from rujic/feature/add-list-users-with-email-fi…
Browse files Browse the repository at this point in the history 
…lter

Add V2 List Users API
  • Loading branch information
@kevals-splunk
kevals-splunk authored Feb 5, 2021
2 parents c572d5c + 532c29d commit 2724b9b
Show file tree
Hide file tree
Showing 2 changed files with 171 additions and 10 deletions.
50 changes: 44 additions & 6 deletions victorops/user.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package victorops
import (
"bytes"
"encoding/json"
"fmt"
"net/url"
)

Expand All @@ -24,6 +25,16 @@ type UserList struct {
Users [][]User `json:"users"`
}

// UserListV2 is a list of Users for Version 2
type UserListV2 struct {
Users []User `json:"users"`
}

const (
userV1Endpoint = "v1/user"
userV2Endpoint = "v2/user"
)

func parseUserResponse(response string) (*User, error) {
// Parse the response and return the user object
var user User
Expand All @@ -43,7 +54,7 @@ func (c Client) CreateUser(user *User) (*User, *RequestDetails, error) {
}

// Make the request
details, err := c.makePublicAPICall("POST", "v1/user", bytes.NewBuffer(jsonUser), nil)
details, err := c.makePublicAPICall("POST", userV1Endpoint, bytes.NewBuffer(jsonUser), nil)
if err != nil {
return nil, details, err
}
Expand All @@ -59,7 +70,7 @@ func (c Client) CreateUser(user *User) (*User, *RequestDetails, error) {
// GetUser returns a specific user within this victorops organization
func (c Client) GetUser(username string) (*User, *RequestDetails, error) {
// Make the request
details, err := c.makePublicAPICall("GET", "v1/user/"+url.QueryEscape(username), bytes.NewBufferString("{}"), nil)
details, err := c.makePublicAPICall("GET", userV1Endpoint+"/"+url.QueryEscape(username), bytes.NewBufferString("{}"), nil)

// Check for errors
if err != nil {
Expand All @@ -77,7 +88,7 @@ func (c Client) GetUser(username string) (*User, *RequestDetails, error) {
// DeleteUser deletes a user from the victorops org
func (c Client) DeleteUser(username string, replacementUser string) (*RequestDetails, error) {
// Make the request
details, err := c.makePublicAPICall("DELETE", "v1/user/"+url.QueryEscape(username), bytes.NewBufferString("{\"replacement\": \""+replacementUser+"\"}"), nil)
details, err := c.makePublicAPICall("DELETE", userV1Endpoint+"/"+url.QueryEscape(username), bytes.NewBufferString("{\"replacement\": \""+replacementUser+"\"}"), nil)

// Check for errors
if err != nil {
Expand All @@ -90,7 +101,7 @@ func (c Client) DeleteUser(username string, replacementUser string) (*RequestDet
// GetAllUsers returns a list of all of the users in the victorops org
func (c Client) GetAllUsers() (*UserList, *RequestDetails, error) {
// Make the request
details, err := c.makePublicAPICall("GET", "v1/user", bytes.NewBufferString("{}"), nil)
details, err := c.makePublicAPICall("GET", userV1Endpoint, bytes.NewBufferString("{}"), nil)
if err != nil {
return nil, details, err
}
Expand All @@ -104,6 +115,33 @@ func (c Client) GetAllUsers() (*UserList, *RequestDetails, error) {
return &userList, details, nil
}

// GetAllUserV2 returns a list of all of the users in the victorops org
func (c Client) GetAllUserV2() (*UserListV2, *RequestDetails, error) {
return c.getAllUsersV2(userV2Endpoint)
}

// GetUserByEmail returns a list of all of the user(s) in the victorops org that matches the given email
func (c Client) GetUserByEmail(email string) (*UserListV2, *RequestDetails, error) {
endpoint := fmt.Sprintf("%s?email=%s", userV2Endpoint, email)
return c.getAllUsersV2(endpoint)
}

func (c Client) getAllUsersV2(endpoint string) (*UserListV2, *RequestDetails, error) {
// Make the request
details, err := c.makePublicAPICall("GET", endpoint, bytes.NewBufferString("{}"), nil)
if err != nil {
return nil, details, err
}

var userList UserListV2
err = json.Unmarshal([]byte(details.ResponseBody), &userList)
if err != nil {
return nil, details, err
}

return &userList, details, nil
}

// UpdateUser updates a victorops user
func (c Client) UpdateUser(user *User) (*User, *RequestDetails, error) {
jsonUser, err := json.Marshal(user)
Expand All @@ -112,7 +150,7 @@ func (c Client) UpdateUser(user *User) (*User, *RequestDetails, error) {
}

// Make the request
details, err := c.makePublicAPICall("PUT", "v1/user/"+url.QueryEscape(user.Username), bytes.NewBuffer(jsonUser), nil)
details, err := c.makePublicAPICall("PUT", userV1Endpoint+"/"+url.QueryEscape(user.Username), bytes.NewBuffer(jsonUser), nil)
if err != nil {
return nil, nil, err
}
Expand All @@ -133,7 +171,7 @@ type emailsResponse struct {
// TODO: Utilize the contact method methods for this
func (c Client) GetUserDefaultEmailContactID(username string) (float64, *RequestDetails, error) {
// Make the request
requestDetails, err := c.makePublicAPICall("GET", "v1/user/"+url.QueryEscape(username)+"/contact-methods/emails", bytes.NewBufferString("{}"), nil)
requestDetails, err := c.makePublicAPICall("GET", userV1Endpoint+"/"+url.QueryEscape(username)+"/contact-methods/emails", bytes.NewBufferString("{}"), nil)
if err != nil {
return 0, requestDetails, err
}
Expand Down
131 changes: 127 additions & 4 deletions victorops/user_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,6 @@ func TestCreateUser(t *testing.T) {
t.Fatal(err)
}

// Note, the response here doesn't reflect some of the values we would really expect
// this is because they are not part of the response from the API and in parsing the JSON
// if a value is missing golang will use the "empty value".
// The actual Use
want := &User{
FirstName: "test",
LastName: "user",
Expand Down Expand Up @@ -129,3 +125,130 @@ func TestCreateUserInvalidResponse(t *testing.T) {
t.Errorf("expected CreateUser to error out on an invalid response from the server")
}
}

func TestGetAllUsersV2(t *testing.T) {
setup()
defer teardown()

testMux.HandleFunc("/api-public/v2/user", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "GET")
w.Write([]byte(`{
"users": [
{
"firstName": "test",
"lastName": "user",
"displayName": "test user",
"username": "go_testuser",
"email": "[email protected]",
"createdAt": "2018-06-16T01:19:39Z",
"passwordLastUpdated": "2018-07-16T22:48:01Z",
"verified": true,
"_selfUrl": "/api-public/v1/user/go_testuser"
}
]
}`))
})

resp, _, err := testClient.GetAllUserV2()
if err != nil {
t.Fatal(err)
}
user := User{
FirstName: "test",
LastName: "user",
Username: "go_testuser",
Email: "[email protected]",
CreatedAt: "2018-06-16T01:19:39Z",
PasswordLastUpdated: "2018-07-16T22:48:01Z",
Verified: true,
}

expected := &UserListV2{
Users: []User{user},
}

if !reflect.DeepEqual(resp, expected) {
t.Errorf("returned \n\n%#v want \n\n%#v", resp, expected)
}
}

func TestGetAllUsersV2WrongFormat(t *testing.T) {
setup()
defer teardown()

testMux.HandleFunc("/api-public/v2/user", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "GET")
w.Write([]byte(`{
"users": [
[
{
"firstName": "test",
"lastName": "user",
"displayName": "test user",
"username": "go_testuser",
"email": "[email protected]",
"createdAt": "2018-06-16T01:19:39Z",
"passwordLastUpdated": "2018-07-16T22:48:01Z",
"verified": true,
"_selfUrl": "/api-public/v2/user/go_testuser"
}
]
]
}`))
})

resp, _, err := testClient.GetAllUserV2()
if err == nil {
t.Fatal(err)
}
if resp != nil {
t.Fatal(err)
}
}

func TestGetUsersByEmailV2(t *testing.T) {
setup()
defer teardown()

testEmail := "[email protected]"
testMux.HandleFunc("/api-public/v2/user", func(w http.ResponseWriter, r *http.Request) {
testMethod(t, r, "GET")
w.Write([]byte(`{
"users": [
{
"firstName": "test",
"lastName": "user",
"displayName": "test user",
"username": "go_testuser",
"email": "[email protected]",
"createdAt": "2018-06-16T01:19:39Z",
"passwordLastUpdated": "2018-07-16T22:48:01Z",
"verified": true,
"_selfUrl": "/api-public/v2/user/go_testuser"
}
]
}`))
})

resp, _, err := testClient.GetUserByEmail(testEmail)
if err != nil {
t.Fatal(err)
}
user := User{
FirstName: "test",
LastName: "user",
Username: "go_testuser",
Email: testEmail,
CreatedAt: "2018-06-16T01:19:39Z",
PasswordLastUpdated: "2018-07-16T22:48:01Z",
Verified: true,
}

expected := &UserListV2{
Users: []User{user},
}

if !reflect.DeepEqual(resp, expected) {
t.Errorf("returned \n\n%#v want \n\n%#v", resp, expected)
}
}

0 comments on commit 2724b9b

Please sign in to comment.