Merge branch 'feature/add-public-email-to-users-api' into 'master'

Feature/add public email to users api

Closes #39346

See merge request gitlab-org/gitlab-ce!21909

7 files changed, 99 insertions, 61 deletions

diff --git a/changelogs/unreleased/feature-add-public-email-to-users-api.yml b/changelogs/unreleased/feature-add-public-email-to-users-api.yml
new file mode 100644
index 00000000000..1f5d3fb113d
--- /dev/null
+++ b/changelogs/unreleased/feature-add-public-email-to-users-api.yml
@@ -0,0 +1,5 @@
+---
+title: Adds the user's public_email attribute to the API
+merge_request: 21909
+author: Alexis Reigel
+type: added
diff --git a/doc/api/deployments.md b/doc/api/deployments.md
index fd11894ea8f..1963b0a21de 100644
--- a/doc/api/deployments.md
+++ b/doc/api/deployments.md
@@ -46,19 +46,21 @@ Example of response
       "status": "success",
       "tag": false,
       "user": {
+        "id": 1,
+        "name": "Administrator",
+        "username": "root",
+        "state": "active",
         "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
+        "web_url": "http://gitlab.dev/root",
+        "created_at": "2015-12-21T13:14:24.077Z",
         "bio": null,
-        "created_at": "2016-08-11T07:09:20.351Z",
-        "id": 1,
-        "linkedin": "",
         "location": null,
-        "name": "Administrator",
+        "public_email": "",
         "skype": "",
-        "state": "active",
+        "linkedin": "",
         "twitter": "",
-        "username": "root",
-        "web_url": "http://localhost:3000/root",
-        "website_url": ""
+        "website_url": "",
+        "organization": ""
       }
     },
     "environment": {
@@ -103,19 +105,21 @@ Example of response
       "status": "success",
       "tag": false,
       "user": {
+        "id": 1,
+        "name": "Administrator",
+        "username": "root",
+        "state": "active",
         "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
+        "web_url": "http://gitlab.dev/root",
+        "created_at": "2015-12-21T13:14:24.077Z",
         "bio": null,
-        "created_at": "2016-08-11T07:09:20.351Z",
-        "id": 1,
-        "linkedin": "",
         "location": null,
-        "name": "Administrator",
+        "public_email": "",
         "skype": "",
-        "state": "active",
+        "linkedin": "",
         "twitter": "",
-        "username": "root",
-        "web_url": "http://localhost:3000/root",
-        "website_url": ""
+        "website_url": "",
+        "organization": ""
       }
     },
     "environment": {
@@ -188,19 +192,20 @@ Example of response
     "started_at": null,
     "finished_at": "2016-08-11T11:32:35.145Z",
     "user": {
+      "id": 1,
       "name": "Administrator",
       "username": "root",
-      "id": 1,
       "state": "active",
       "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-      "web_url": "http://localhost:3000/root",
-      "created_at": "2016-08-11T07:09:20.351Z",
+      "web_url": "http://gitlab.dev/root",
+      "created_at": "2015-12-21T13:14:24.077Z",
       "bio": null,
       "location": null,
       "skype": "",
       "linkedin": "",
       "twitter": "",
-      "website_url": ""
+      "website_url": "",
+      "organization": ""
     },
     "commit": {
       "id": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
diff --git a/doc/api/jobs.md b/doc/api/jobs.md
index cf292adf150..aa290ff4cf8 100644
--- a/doc/api/jobs.md
+++ b/doc/api/jobs.md
@@ -53,18 +53,21 @@ Example of response
     "tag": false,
     "web_url": "https://example.com/foo/bar/-/jobs/6",
     "user": {
-      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-      "bio": null,
-      "created_at": "2015-12-21T13:14:24.077Z",
       "id": 1,
-      "linkedin": "",
       "name": "Administrator",
-      "skype": "",
-      "state": "active",
-      "twitter": "",
       "username": "root",
+      "state": "active",
+      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
       "web_url": "http://gitlab.dev/root",
-      "website_url": ""
+      "created_at": "2015-12-21T13:14:24.077Z",
+      "bio": null,
+      "location": null,
+      "public_email": "",
+      "skype": "",
+      "linkedin": "",
+      "twitter": "",
+      "website_url": "",
+      "organization": ""
     }
   },
   {
@@ -109,18 +112,21 @@ Example of response
     "tag": false,
     "web_url": "https://example.com/foo/bar/-/jobs/7",
     "user": {
-      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-      "bio": null,
-      "created_at": "2015-12-21T13:14:24.077Z",
       "id": 1,
-      "linkedin": "",
       "name": "Administrator",
-      "skype": "",
-      "state": "active",
-      "twitter": "",
       "username": "root",
+      "state": "active",
+      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
       "web_url": "http://gitlab.dev/root",
-      "website_url": ""
+      "created_at": "2015-12-21T13:14:24.077Z",
+      "bio": null,
+      "location": null,
+      "public_email": "",
+      "skype": "",
+      "linkedin": "",
+      "twitter": "",
+      "website_url": "",
+      "organization": ""
     }
   }
 ]
@@ -180,18 +186,21 @@ Example of response
     "tag": false,
     "web_url": "https://example.com/foo/bar/-/jobs/6",
     "user": {
-      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-      "bio": null,
-      "created_at": "2015-12-21T13:14:24.077Z",
       "id": 1,
-      "linkedin": "",
       "name": "Administrator",
-      "skype": "",
-      "state": "active",
-      "twitter": "",
       "username": "root",
+      "state": "active",
+      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
       "web_url": "http://gitlab.dev/root",
-      "website_url": ""
+      "created_at": "2015-12-21T13:14:24.077Z",
+      "bio": null,
+      "location": null,
+      "public_email": "",
+      "skype": "",
+      "linkedin": "",
+      "twitter": "",
+      "website_url": "",
+      "organization": ""
     }
   },
   {
@@ -236,18 +245,21 @@ Example of response
     "tag": false,
     "web_url": "https://example.com/foo/bar/-/jobs/7",
     "user": {
-      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-      "bio": null,
-      "created_at": "2015-12-21T13:14:24.077Z",
       "id": 1,
-      "linkedin": "",
       "name": "Administrator",
-      "skype": "",
-      "state": "active",
-      "twitter": "",
       "username": "root",
+      "state": "active",
+      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
       "web_url": "http://gitlab.dev/root",
-      "website_url": ""
+      "created_at": "2015-12-21T13:14:24.077Z",
+      "bio": null,
+      "location": null,
+      "public_email": "",
+      "skype": "",
+      "linkedin": "",
+      "twitter": "",
+      "website_url": "",
+      "organization": ""
     }
   }
 ]
@@ -305,18 +317,21 @@ Example of response
   "tag": false,
   "web_url": "https://example.com/foo/bar/-/jobs/8",
   "user": {
-    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
-    "bio": null,
-    "created_at": "2015-12-21T13:14:24.077Z",
     "id": 1,
-    "linkedin": "",
     "name": "Administrator",
-    "skype": "",
-    "state": "active",
-    "twitter": "",
     "username": "root",
+    "state": "active",
+    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
     "web_url": "http://gitlab.dev/root",
-    "website_url": ""
+    "created_at": "2015-12-21T13:14:24.077Z",
+    "bio": null,
+    "location": null,
+    "public_email": "",
+    "skype": "",
+    "linkedin": "",
+    "twitter": "",
+    "website_url": "",
+    "organization": ""
   }
 }
 ```
diff --git a/doc/api/keys.md b/doc/api/keys.md
index ddcf7830621..06b31a67d6a 100644
--- a/doc/api/keys.md
+++ b/doc/api/keys.md
@@ -27,10 +27,16 @@ Parameters:
     "web_url": "http://localhost:3000/john_smith",
     "created_at": "2015-09-03T07:24:01.670Z",
     "bio": null,
+    "location": null,
+    "public_email": "john@example.com",
     "skype": "",
     "linkedin": "",
     "twitter": "",
     "website_url": "",
+    "organization": null,
+    "last_sign_in_at": "2015-09-03T07:24:01.670Z",
+    "confirmed_at": "2015-09-03T07:24:01.670Z",
+    "last_activity_on": "2015-09-03",
     "email": "john@example.com",
     "theme_id": 2,
     "color_scheme_id": 1,
@@ -40,6 +46,8 @@ Parameters:
     "can_create_group": true,
     "can_create_project": true,
     "two_factor_enabled": false
+    "external": false,
+    "private_profile": null
   }
 }
 ```
diff --git a/doc/api/runners.md b/doc/api/runners.md
index 71ecb6606c1..0bcbd0aebf0 100644
--- a/doc/api/runners.md
+++ b/doc/api/runners.md
@@ -294,6 +294,7 @@ Example response:
             "created_at": "2017-11-16T18:38:46.000Z",
             "bio": null,
             "location": null,
+            "public_email": "",
             "skype": "",
             "linkedin": "",
             "twitter": "",
diff --git a/doc/api/users.md b/doc/api/users.md
index b0ae455a025..762ea53edee 100644
--- a/doc/api/users.md
+++ b/doc/api/users.md
@@ -199,6 +199,7 @@ Parameters:
   "created_at": "2012-05-23T08:00:58Z",
   "bio": null,
   "location": null,
+  "public_email": "john@example.com",
   "skype": "",
   "linkedin": "",
   "twitter": "",
@@ -230,6 +231,7 @@ Parameters:
   "is_admin": false,
   "bio": null,
   "location": null,
+  "public_email": "john@example.com",
   "skype": "",
   "linkedin": "",
   "twitter": "",
@@ -367,6 +369,7 @@ GET /user
   "created_at": "2012-05-23T08:00:58Z",
   "bio": null,
   "location": null,
+  "public_email": "john@example.com",
   "skype": "",
   "linkedin": "",
   "twitter": "",
@@ -415,6 +418,7 @@ GET /user
   "is_admin": false,
   "bio": null,
   "location": null,
+  "public_email": "john@example.com",
   "skype": "",
   "linkedin": "",
   "twitter": "",
diff --git a/lib/api/entities.rb b/lib/api/entities.rb
index 0fec3dc3dc4..12c4340c1ba 100644
--- a/lib/api/entities.rb
+++ b/lib/api/entities.rb
@@ -53,7 +53,7 @@ module API
 
     class User < UserBasic
       expose :created_at, if: ->(user, opts) { Ability.allowed?(opts[:current_user], :read_user_profile, user) }
-      expose :bio, :location, :skype, :linkedin, :twitter, :website_url, :organization
+      expose :bio, :location, :public_email, :skype, :linkedin, :twitter, :website_url, :organization
     end
 
     class UserActivity < Grape::Entity