Added GetUser method to FirebaseAuth that can be used to retrieve a UserRecord object for the specified user ID.

renatoc8 · renatoc8 · commit 6579e7e3aa1a · 2019-05-01T12:57:05.000-07:00
diff --git a/FirebaseAdmin/FirebaseAdmin.Tests/Auth/FirebaseUserManagerTest.cs b/FirebaseAdmin/FirebaseAdmin.Tests/Auth/FirebaseUserManagerTest.cs
@@ -32,7 +32,8 @@ public class FirebaseUserManagerTest
         [Fact]
         public void InvalidUidForUserRecord()
         {
-            Assert.Throws<ArgumentException>(() => new UserRecord(null));
+            Assert.Throws<ArgumentException>(() => new UserRecord((string)null));
+            Assert.Throws<ArgumentException>(() => new UserRecord((Internal.GetAccountInfoResponse.User)null));
             Assert.Throws<ArgumentException>(() => new UserRecord(string.Empty));
             Assert.Throws<ArgumentException>(() => new UserRecord(new string('a', 129)));
         }
@@ -76,8 +77,16 @@ public async Task GetUserById()
         {
             var handler = new MockMessageHandler()
             {
-                Response = new UserRecord("user1"),
+                Response = new Internal.GetAccountInfoResponse()
+                {
+                    Kind = "identitytoolkit#GetAccountInfoResponse",
+                    Users = new List<Internal.GetAccountInfoResponse.User>()
+                    {
+                        new Internal.GetAccountInfoResponse.User() { UserID = "user1" },
+                    },
+                },
             };
+
             var factory = new MockHttpClientFactory(handler);
             var userManager = new FirebaseUserManager(
                 new FirebaseUserManagerArgs
diff --git a/FirebaseAdmin/FirebaseAdmin/Auth/FirebaseAuth.cs b/FirebaseAdmin/FirebaseAdmin/Auth/FirebaseAuth.cs
@@ -263,6 +263,20 @@ public async Task<FirebaseToken> VerifyIdTokenAsync(
                 .ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// Gets a <see cref="UserRecord"/> object containig information about the user who's
+        /// user ID was specified in <paramref name="uid"/>.
+        /// </summary>
+        /// <param name="uid">The user ID for the user who's data is to be retrieved..</param>
+        /// <returns>A task that completes with a <see cref="UserRecord"/> representing
+        /// a user with the specified user ID.</returns>
+        /// <exception cref="ArgumentException">If user ID argument is null or empty.</exception>
+        /// <exception cref="FirebaseException">If a user cannot be found with the specified user ID.</exception>
+        public async Task<UserRecord> GetUser(string uid)
+        {
+            return await this.userManager.Value.GetUserById(uid);
+        }
+
         /// <summary>
         /// Sets the specified custom claims on an existing user account. A null claims value
         /// removes any claims currently set on the user account. The claims must serialize into
diff --git a/FirebaseAdmin/FirebaseAdmin/Auth/FirebaseUserManager.cs b/FirebaseAdmin/FirebaseAdmin/Auth/FirebaseUserManager.cs
@@ -81,14 +81,15 @@ public async Task<UserRecord> GetUserById(
             {
                 { "localId", uid },
             };
-            var response = await this.PostAndDeserializeAsync<JObject>(
+
+            var response = await this.PostAndDeserializeAsync<Internal.GetAccountInfoResponse>(
                 getUserPath, payload, cancellationToken).ConfigureAwait(false);
-            if (response == null || uid != (string)response["localId"])
+            if (response == null || response.Users == null || response.Users.Count == 0)
             {
                 throw new FirebaseException($"Failed to get user: {uid}");
             }
 
-            return new UserRecord((string)response["localId"]);
+            return new UserRecord(response.Users[0]);
         }
 
         /// <summary>
diff --git a/FirebaseAdmin/FirebaseAdmin/Auth/Internal/GetAccountInfoResponse.cs b/FirebaseAdmin/FirebaseAdmin/Auth/Internal/GetAccountInfoResponse.cs
@@ -0,0 +1,145 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+using Newtonsoft.Json;
+
+namespace FirebaseAdmin.Auth.Internal
+{
+    /// <summary>
+    /// JSON data binding for GetAccountInfoResponse messages sent by Google identity toolkit service.
+    /// </summary>
+    public sealed class GetAccountInfoResponse
+    {
+        /// <summary>
+        /// Gets or sets a string representing what kind of account is represented by this object.
+        /// </summary>
+        [JsonProperty(PropertyName = "kind")]
+        public string Kind { get; set; }
+
+        /// <summary>
+        /// Gets or sets a list of provider users linked to this account.
+        /// </summary>
+        [JsonProperty(PropertyName = "users")]
+        public List<User> Users { get; set; }
+
+        /// <summary>
+        /// JSON data binding for user records.
+        /// </summary>
+        public sealed class User
+        {
+            /// <summary>
+            /// Gets or sets the user's ID.
+            /// </summary>
+            [JsonProperty(PropertyName = "localId")]
+            public string UserID { get; set; }
+
+            /// <summary>
+            /// Gets or sets the user's email address.
+            /// </summary>
+            [JsonProperty(PropertyName = "email")]
+            public string Email { get; set; }
+
+            /// <summary>
+            /// Gets or sets the user's phone number.
+            /// </summary>
+            [JsonProperty(PropertyName = "phoneNumber")]
+            public string PhoneNumber { get; set; }
+
+            /// <summary>
+            /// Gets or sets a value indicating whether the user's email address is verified or not.
+            /// </summary>
+            [JsonProperty(PropertyName = "emailVerified")]
+            public bool EmailVerified { get; set; }
+
+            /// <summary>
+            /// Gets or sets the user's display name.
+            /// </summary>
+            [JsonProperty(PropertyName = "displayName")]
+            public string DisplayName { get; set; }
+
+            /// <summary>
+            /// Gets or sets the URL for the user's photo.
+            /// </summary>
+            [JsonProperty(PropertyName = "photoUrl")]
+            public string PhotoUrl { get; set; }
+
+            /// <summary>
+            /// Gets or sets a value indicating whether the user is disabled or not.
+            /// </summary>
+            [JsonProperty(PropertyName = "disabled")]
+            public bool Disabled { get; set; }
+
+            /// <summary>
+            /// Gets or sets a list of provider-specified data for this user.
+            /// </summary>
+            [JsonProperty(PropertyName = "providerUserInfo")]
+            public List<Provider> Providers { get; set; }
+
+            /// <summary>
+            /// Gets or sets the timestamp representing the time that the user account was created.
+            /// </summary>
+            [JsonProperty(PropertyName = "createdAt")]
+            public long CreatedAt { get; set; }
+
+            /// <summary>
+            /// Gets or sets the timestamp representing the last time that the user has logged in.
+            /// </summary>
+            [JsonProperty(PropertyName = "lastLoginAt")]
+            public long LastLoginAt { get; set; }
+
+            /// <summary>
+            /// Gets or sets the timestamp representing the time that the user account was first valid.
+            /// </summary>
+            [JsonProperty(PropertyName = "validSince")]
+            public long ValidSince { get; set; }
+
+            /// <summary>
+            /// Gets or sets the user's custom claims.
+            /// </summary>
+            [JsonProperty(PropertyName = "customAttributes")]
+            public string CustomClaims { get; set; }
+        }
+
+        /// <summary>
+        /// JSON data binding for provider data.
+        /// </summary>
+        public sealed class Provider
+        {
+            /// <summary>
+            /// Gets or sets the user's ID.
+            /// </summary>
+            [JsonProperty(PropertyName = "uid")]
+            public string UserID { get; set; }
+
+            /// <summary>
+            /// Gets or sets the user's display name.
+            /// </summary>
+            [JsonProperty(PropertyName = "displayName")]
+            public string DisplayName { get; set; }
+
+            /// <summary>
+            /// Gets or sets the user's email address.
+            /// </summary>
+            [JsonProperty(PropertyName = "email")]
+            public string Email { get; set; }
+
+            /// <summary>
+            /// Gets or sets the user's phone number.
+            /// </summary>
+            [JsonProperty(PropertyName = "phoneNumber")]
+            public string PhoneNumber { get; set; }
+
+            /// <summary>
+            /// Gets or sets the URL for the user's photo.
+            /// </summary>
+            [JsonProperty(PropertyName = "photoUrl")]
+            public string PhotoUrl { get; set; }
+
+            /// <summary>
+            /// Gets or sets the provider's ID.
+            /// </summary>
+            [JsonProperty(PropertyName = "providerId")]
+            public string ProviderID { get; set; }
+        }
+    }
+}
diff --git a/FirebaseAdmin/FirebaseAdmin/Auth/ProviderUserInfo.cs b/FirebaseAdmin/FirebaseAdmin/Auth/ProviderUserInfo.cs
@@ -0,0 +1,64 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace FirebaseAdmin.Auth
+{
+    /// <summary>
+    /// Contains metadata regarding how a user is known by a particular identity provider (IdP).
+    /// Instances of this class are immutable and thread safe.
+    /// </summary>
+    public sealed class ProviderUserInfo
+    {
+        private string uid;
+        private string displayName;
+        private string email;
+        private string phoneNumber;
+        private string photoUrl;
+        private string providerId;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ProviderUserInfo"/> class with data provided by an authentication provider.
+        /// </summary>
+        /// <param name="provider">The deserialized JSON user data from the provider.</param>
+        public ProviderUserInfo(Internal.GetAccountInfoResponse.Provider provider)
+        {
+            this.uid = provider.UserID;
+            this.displayName = provider.DisplayName;
+            this.email = provider.Email;
+            this.phoneNumber = provider.PhoneNumber;
+            this.photoUrl = provider.PhotoUrl;
+            this.providerId = provider.ProviderID;
+        }
+
+        /// <summary>
+        /// Gets the user's ID.
+        /// </summary>
+        public string UserID { get => this.uid; }
+
+        /// <summary>
+        /// Gets the user's display name.
+        /// </summary>
+        public string DisplayName { get => this.displayName; }
+
+        /// <summary>
+        /// Gets the user's email address.
+        /// </summary>
+        public string Email { get => this.email; }
+
+        /// <summary>
+        /// Gets the user's phone number.
+        /// </summary>
+        public string PhoneNumber { get => this.phoneNumber; }
+
+        /// <summary>
+        /// Gets the URL for the user's photo/avatar.
+        /// </summary>
+        public string PhotoUrl { get => this.photoUrl; }
+
+        /// <summary>
+        /// Gets the user's ID specified by the provider.
+        /// </summary>
+        public string ProviderId { get => this.providerId; }
+    }
+}
diff --git a/FirebaseAdmin/FirebaseAdmin/Auth/UserMetadata.cs b/FirebaseAdmin/FirebaseAdmin/Auth/UserMetadata.cs
@@ -0,0 +1,36 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+using Newtonsoft.Json;
+
+namespace FirebaseAdmin.Auth
+{
+    /// <summary>
+    /// Contains additional metadata associated with a user account.
+    /// </summary>
+    public sealed class UserMetadata
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="UserMetadata"/> class with the specified creation and last sign-in timestamps.
+        /// </summary>
+        /// <param name="creationTimestamp">A timestamp representing the date and time that the user account was created.</param>
+        /// <param name="lastSignInTimestamp">A timestamp representing the date and time that the user account was last signed-on to.</param>
+        public UserMetadata(long creationTimestamp, long lastSignInTimestamp)
+        {
+            this.CreationTimestamp = creationTimestamp;
+            this.LastSignInTimestamp = lastSignInTimestamp;
+        }
+
+        /// <summary>
+        /// Gets or sets a timestamp representing the date and time that the account was created.
+        /// </summary>
+        [JsonProperty("creationTimestamp")]
+        public long CreationTimestamp { get; set; }
+
+        /// <summary>
+        /// Gets or sets a timestamp representing the last time that the user has logged in.
+        /// </summary>
+        [JsonProperty("lastSignInTimestamp")]
+        public long LastSignInTimestamp { get; set; }
+    }
+}
diff --git a/FirebaseAdmin/FirebaseAdmin/Auth/UserRecord.cs b/FirebaseAdmin/FirebaseAdmin/Auth/UserRecord.cs

Original file line number	Diff line number	Diff line change
`@@ -81,14 +81,15 @@ public async Task<UserRecord> GetUserById(`
`81`	`81`	`{`
`82`	`82`	`{ "localId", uid },`
`83`	`83`	`};`
`84`		`- var response = await this.PostAndDeserializeAsync<JObject>(`
	`84`	`+`
	`85`	`+ var response = await this.PostAndDeserializeAsync<Internal.GetAccountInfoResponse>(`
`85`	`86`	`getUserPath, payload, cancellationToken).ConfigureAwait(false);`
`86`		`- if (response == null \|\| uid != (string)response["localId"])`
	`87`	`+ if (response == null \|\| response.Users == null \|\| response.Users.Count == 0)`
`87`	`88`	`{`
`88`	`89`	`throw new FirebaseException($"Failed to get user: {uid}");`
`89`	`90`	`}`
`90`	`91`
`91`		`- return new UserRecord((string)response["localId"]);`
	`92`	`+ return new UserRecord(response.Users[0]);`
`92`	`93`	`}`
`93`	`94`
`94`	`95`	`/// <summary>`