diff options
author | Ruzette Tanyag <ruzette@users.noreply.github.com> | 2017-02-07 11:54:07 -0500 |
---|---|---|
committer | Christopher Speller <crspeller@gmail.com> | 2017-02-07 11:54:07 -0500 |
commit | d91fea65188a51dd41976cad47f9c8ebacd75a04 (patch) | |
tree | 792f8563d04957c1ddf56a731821051c8466eba7 /api4 | |
parent | 5cc30fa06149e1291deed6f53de53ecf25600d2c (diff) | |
download | chat-d91fea65188a51dd41976cad47f9c8ebacd75a04.tar.gz chat-d91fea65188a51dd41976cad47f9c8ebacd75a04.tar.bz2 chat-d91fea65188a51dd41976cad47f9c8ebacd75a04.zip |
Implement GET `/users/email/{email}` endpoint for APIv4 (#5309)
* added get user by email endpoint for APIv4
* added get user by email endpoint unit test and driver
* removed the appended return of user ids on logout
* Added RequireEmail to validate user email. Also updated the get user by email endpoint and unit test
Diffstat (limited to 'api4')
-rw-r--r-- | api4/context.go | 13 | ||||
-rw-r--r-- | api4/params.go | 5 | ||||
-rw-r--r-- | api4/user.go | 34 | ||||
-rw-r--r-- | api4/user_test.go | 65 |
4 files changed, 114 insertions, 3 deletions
diff --git a/api4/context.go b/api4/context.go index 1a3011795..7ad6f30b4 100644 --- a/api4/context.go +++ b/api4/context.go @@ -358,3 +358,16 @@ func (c *Context) RequireChannelId() *Context { } return c } + +func (c *Context) RequireEmail() *Context { + if c.Err != nil { + return c + } + + pos := strings.Index(c.Params.Email, "@") + if pos < 0 { + c.SetInvalidUrlParam("email") + } + + return c +} diff --git a/api4/params.go b/api4/params.go index 1c0c153ea..a043919fa 100644 --- a/api4/params.go +++ b/api4/params.go @@ -25,6 +25,7 @@ type ApiParams struct { CommandId string HookId string EmojiId string + Email string Page int PerPage int } @@ -66,6 +67,10 @@ func ApiParamsFromRequest(r *http.Request) *ApiParams { params.EmojiId = val } + if val, ok := props["email"]; ok { + params.Email = val + } + if val, err := strconv.Atoi(r.URL.Query().Get("page")); err != nil { params.Page = PAGE_DEFAULT } else { diff --git a/api4/user.go b/api4/user.go index 14067bdf5..cf9bb4ead 100644 --- a/api4/user.go +++ b/api4/user.go @@ -27,6 +27,8 @@ func InitUser() { BaseRoutes.Users.Handle("/login", ApiHandler(login)).Methods("POST") BaseRoutes.Users.Handle("/logout", ApiHandler(logout)).Methods("POST") + BaseRoutes.UserByEmail.Handle("", ApiSessionRequired(getUserByEmail)).Methods("GET") + } func createUser(c *Context, w http.ResponseWriter, r *http.Request) { @@ -88,6 +90,34 @@ func getUser(c *Context, w http.ResponseWriter, r *http.Request) { } } +func getUserByEmail(c *Context, w http.ResponseWriter, r *http.Request) { + c.RequireEmail() + if c.Err != nil { + return + } + + // No permission check required + + var user *model.User + var err *model.AppError + + if user, err = app.GetUserByEmail(c.Params.Email); err != nil { + c.Err = err + return + } + + etag := user.Etag(utils.Cfg.PrivacySettings.ShowFullName, utils.Cfg.PrivacySettings.ShowEmailAddress) + + if HandleEtag(etag, "Get User", w, r) { + return + } else { + app.SanitizeProfile(user, c.IsSystemAdmin()) + w.Header().Set(model.HEADER_ETAG_SERVER, etag) + w.Write([]byte(user.ToJson())) + return + } +} + func getUsers(c *Context, w http.ResponseWriter, r *http.Request) { inTeamId := r.URL.Query().Get("in_team") inChannelId := r.URL.Query().Get("in_channel") @@ -292,9 +322,7 @@ func logout(c *Context, w http.ResponseWriter, r *http.Request) { data["user_id"] = c.Session.UserId Logout(c, w, r) - if c.Err == nil { - w.Write([]byte(model.MapToJson(data))) - } + } func Logout(c *Context, w http.ResponseWriter, r *http.Request) { diff --git a/api4/user_test.go b/api4/user_test.go index 40f6b4117..dc8a82310 100644 --- a/api4/user_test.go +++ b/api4/user_test.go @@ -131,6 +131,71 @@ func TestGetUser(t *testing.T) { } } +func TestGetUserByEmail(t *testing.T) { + th := Setup().InitBasic().InitSystemAdmin() + defer TearDown() + Client := th.Client + + user := th.CreateUser() + + ruser, resp := Client.GetUserByEmail(user.Email, "") + CheckNoError(t, resp) + CheckUserSanitization(t, ruser) + + if ruser.Email != user.Email { + t.Fatal("emails did not match") + } + + ruser, resp = Client.GetUserByEmail(user.Email, resp.Etag) + CheckEtag(t, ruser, resp) + + + _, resp = Client.GetUserByEmail(GenerateTestUsername(), "") + CheckBadRequestStatus(t, resp) + + _, resp = Client.GetUserByEmail(GenerateTestEmail(), "") + CheckNotFoundStatus(t, resp) + + // Check against privacy config settings + emailPrivacy := utils.Cfg.PrivacySettings.ShowEmailAddress + namePrivacy := utils.Cfg.PrivacySettings.ShowFullName + defer func() { + utils.Cfg.PrivacySettings.ShowEmailAddress = emailPrivacy + utils.Cfg.PrivacySettings.ShowFullName = namePrivacy + }() + utils.Cfg.PrivacySettings.ShowEmailAddress = false + utils.Cfg.PrivacySettings.ShowFullName = false + + ruser, resp = Client.GetUserByEmail(user.Email, "") + CheckNoError(t, resp) + + if ruser.Email != "" { + t.Fatal("email should be blank") + } + if ruser.FirstName != "" { + t.Fatal("first name should be blank") + } + if ruser.LastName != "" { + t.Fatal("last name should be blank") + } + + Client.Logout() + _, resp = Client.GetUserByEmail(user.Email, "") + CheckUnauthorizedStatus(t, resp) + + // System admins should ignore privacy settings + ruser, resp = th.SystemAdminClient.GetUserByEmail(user.Email, resp.Etag) + if ruser.Email == "" { + t.Fatal("email should not be blank") + } + if ruser.FirstName == "" { + t.Fatal("first name should not be blank") + } + if ruser.LastName == "" { + t.Fatal("last name should not be blank") + } +} + func TestGetUsersByIds(t *testing.T) { th := Setup().InitBasic() Client := th.Client |