Merge pull request #63 from firebase/hkj-get-user

Implemented GetUserByEmail() and GetUserByPhoneNumber()

Author: hiranya911

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Unreleased
 
--
+- [added] Implemented the `GetUserByEmailAsync()` and `GetUserByPhoneNumberAsync()`
+  APIs in the `FirebaseAuth` class.
 
 # v1.5.0
 

FirebaseAdmin/FirebaseAdmin.Snippets/FirebaseAuthSnippets.cs

@@ -67,6 +67,24 @@ internal static async Task GetUserAsync(string uid)
             // [END get_user_by_id]
         }
 
+        internal static async Task GetUserByEmailAsync(string email)
+        {
+            // [START get_user_by_email]
+            UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByEmailAsync(email);
+            // See the UserRecord reference doc for the contents of userRecord.
+            Console.WriteLine("Successfully fetched user data: {0}", userRecord.Uid);
+            // [END get_user_by_email]
+        }
+
+        internal static async Task GetUserByPhoneNumberAsync(string phoneNumber)
+        {
+            // [START get_user_by_phone]
+            UserRecord userRecord = await FirebaseAuth.DefaultInstance.GetUserByPhoneNumberAsync(phoneNumber);
+            // See the UserRecord reference doc for the contents of userRecord.
+            Console.WriteLine("Successfully fetched user data: {0}", userRecord.Uid);
+            // [END get_user_by_phone]
+        }
+
         internal static async Task DeleteUserAsync(string uid)
         {
             // [START delete_user]

FirebaseAdmin/FirebaseAdmin.Tests/Auth/FirebaseUserManagerTest.cs

@@ -45,7 +45,7 @@ public async Task GetUserById()
             };
             var userManager = this.CreateFirebaseUserManager(handler);
 
-            var userRecord = await userManager.GetUserById("user1");
+            var userRecord = await userManager.GetUserByIdAsync("user1");
 
             Assert.Equal("user1", userRecord.Uid);
             Assert.Null(userRecord.DisplayName);
@@ -60,6 +60,9 @@ public async Task GetUserById()
             Assert.Empty(userRecord.ProviderData);
             Assert.Null(userRecord.UserMetaData.CreationTimestamp);
             Assert.Null(userRecord.UserMetaData.LastSignInTimestamp);
+
+            var request = NewtonsoftJsonSerializer.Instance.Deserialize<Dictionary<string, object>>(handler.Request);
+            Assert.Equal(new JArray("user1"), request["localId"]);
         }
 
         [Fact]
@@ -99,7 +102,7 @@ public async Task GetUserByIdWithProperties()
             };
             var userManager = this.CreateFirebaseUserManager(handler);
 
-            var userRecord = await userManager.GetUserById("user1");
+            var userRecord = await userManager.GetUserByIdAsync("user1");
 
             Assert.Equal("user1", userRecord.Uid);
             Assert.Equal("Test User", userRecord.DisplayName);
@@ -150,8 +153,145 @@ public async Task GetUserByIdUserNotFound()
             };
             var userManager = this.CreateFirebaseUserManager(handler);
 
-            await Assert.ThrowsAsync<FirebaseException>(
-                async () => await userManager.GetUserById("user1"));
+            var exception = await Assert.ThrowsAsync<FirebaseException>(
+                async () => await userManager.GetUserByIdAsync("user1"));
+            Assert.Equal("Failed to get user with uid: user1", exception.Message);
+        }
+
+        [Fact]
+        public async Task GetUserByIdNull()
+        {
+            var userManager = this.CreateFirebaseUserManager(new MockMessageHandler());
+            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByIdAsync(null));
+        }
+
+        [Fact]
+        public async Task GetUserByIdEmpty()
+        {
+            var userManager = this.CreateFirebaseUserManager(new MockMessageHandler());
+            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByIdAsync(string.Empty));
+        }
+
+        [Fact]
+        public async Task GetUserByEmail()
+        {
+            var handler = new MockMessageHandler()
+            {
+                Response = @"{""users"": [
+                    {
+                        ""localId"": ""user1""
+                    }
+                ]}",
+            };
+            var userManager = this.CreateFirebaseUserManager(handler);
+
+            var userRecord = await userManager.GetUserByEmailAsync("[email protected]");
+
+            Assert.Equal("user1", userRecord.Uid);
+            Assert.Null(userRecord.DisplayName);
+            Assert.Null(userRecord.Email);
+            Assert.Null(userRecord.PhoneNumber);
+            Assert.Null(userRecord.PhotoUrl);
+            Assert.Equal("firebase", userRecord.ProviderId);
+            Assert.False(userRecord.Disabled);
+            Assert.False(userRecord.EmailVerified);
+            Assert.Equal(UserRecord.UnixEpoch, userRecord.TokensValidAfterTimestamp);
+            Assert.Empty(userRecord.CustomClaims);
+            Assert.Empty(userRecord.ProviderData);
+            Assert.Null(userRecord.UserMetaData.CreationTimestamp);
+            Assert.Null(userRecord.UserMetaData.LastSignInTimestamp);
+
+            var request = NewtonsoftJsonSerializer.Instance.Deserialize<Dictionary<string, object>>(handler.Request);
+            Assert.Equal(new JArray("[email protected]"), request["email"]);
+        }
+
+        [Fact]
+        public async Task GetUserByEmailUserNotFound()
+        {
+            var handler = new MockMessageHandler()
+            {
+                Response = @"{""users"": []}",
+            };
+            var userManager = this.CreateFirebaseUserManager(handler);
+
+            var exception = await Assert.ThrowsAsync<FirebaseException>(
+                async () => await userManager.GetUserByEmailAsync("[email protected]"));
+            Assert.Equal("Failed to get user with email: [email protected]", exception.Message);
+        }
+
+        [Fact]
+        public async Task GetUserByEmailNull()
+        {
+            var userManager = this.CreateFirebaseUserManager(new MockMessageHandler());
+            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByEmailAsync(null));
+        }
+
+        [Fact]
+        public async Task GetUserByEmailEmpty()
+        {
+            var userManager = this.CreateFirebaseUserManager(new MockMessageHandler());
+            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByEmailAsync(string.Empty));
+        }
+
+        [Fact]
+        public async Task GetUserByPhoneNumber()
+        {
+            var handler = new MockMessageHandler()
+            {
+                Response = @"{""users"": [
+                    {
+                        ""localId"": ""user1""
+                    }
+                ]}",
+            };
+            var userManager = this.CreateFirebaseUserManager(handler);
+
+            var userRecord = await userManager.GetUserByPhoneNumberAsync("+1234567890");
+
+            Assert.Equal("user1", userRecord.Uid);
+            Assert.Null(userRecord.DisplayName);
+            Assert.Null(userRecord.Email);
+            Assert.Null(userRecord.PhoneNumber);
+            Assert.Null(userRecord.PhotoUrl);
+            Assert.Equal("firebase", userRecord.ProviderId);
+            Assert.False(userRecord.Disabled);
+            Assert.False(userRecord.EmailVerified);
+            Assert.Equal(UserRecord.UnixEpoch, userRecord.TokensValidAfterTimestamp);
+            Assert.Empty(userRecord.CustomClaims);
+            Assert.Empty(userRecord.ProviderData);
+            Assert.Null(userRecord.UserMetaData.CreationTimestamp);
+            Assert.Null(userRecord.UserMetaData.LastSignInTimestamp);
+
+            var request = NewtonsoftJsonSerializer.Instance.Deserialize<Dictionary<string, object>>(handler.Request);
+            Assert.Equal(new JArray("+1234567890"), request["phoneNumber"]);
+        }
+
+        [Fact]
+        public async Task GetUserByPhoneNumberUserNotFound()
+        {
+            var handler = new MockMessageHandler()
+            {
+                Response = @"{""users"": []}",
+            };
+            var userManager = this.CreateFirebaseUserManager(handler);
+
+            var exception = await Assert.ThrowsAsync<FirebaseException>(
+                async () => await userManager.GetUserByPhoneNumberAsync("+1234567890"));
+            Assert.Equal("Failed to get user with phone number: +1234567890", exception.Message);
+        }
+
+        [Fact]
+        public async Task GetUserByPhoneNumberNull()
+        {
+            var userManager = this.CreateFirebaseUserManager(new MockMessageHandler());
+            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByPhoneNumberAsync(null));
+        }
+
+        [Fact]
+        public async Task GetUserByPhoneNumberEmpty()
+        {
+            var userManager = this.CreateFirebaseUserManager(new MockMessageHandler());
+            await Assert.ThrowsAsync<ArgumentException>(() => userManager.GetUserByPhoneNumberAsync(string.Empty));
         }
 
         [Fact]

FirebaseAdmin/FirebaseAdmin/Auth/FirebaseAuth.cs

@@ -293,7 +293,73 @@ public async Task<UserRecord> GetUserAsync(
         {
             var userManager = this.IfNotDeleted(() => this.userManager.Value);
 
-            return await userManager.GetUserById(uid, cancellationToken);
+            return await userManager.GetUserByIdAsync(uid, cancellationToken);
+        }
+
+        /// <summary>
+        /// Gets a <see cref="UserRecord"/> object containing information about the user identified by
+        /// <paramref name="email"/>.
+        /// </summary>
+        /// <param name="email">The email of 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 email.</returns>
+        /// <exception cref="ArgumentException">If the email argument is null or empty.</exception>
+        /// <exception cref="FirebaseException">If a user cannot be found with the specified email.</exception>
+        public async Task<UserRecord> GetUserByEmailAsync(string email)
+        {
+            return await this.GetUserByEmailAsync(email, default(CancellationToken));
+        }
+
+        /// <summary>
+        /// Gets a <see cref="UserRecord"/> object containing information about the user identified by
+        /// <paramref name="email"/>.
+        /// </summary>
+        /// <param name="email">The email of the user who's data is to be retrieved.</param>
+        /// <param name="cancellationToken">A cancellation token to monitor the asynchronous
+        /// operation.</param>
+        /// <returns>A task that completes with a <see cref="UserRecord"/> representing
+        /// a user with the specified email.</returns>
+        /// <exception cref="ArgumentException">If the email argument is null or empty.</exception>
+        /// <exception cref="FirebaseException">If a user cannot be found with the specified email.</exception>
+        public async Task<UserRecord> GetUserByEmailAsync(
+            string email, CancellationToken cancellationToken)
+        {
+            var userManager = this.IfNotDeleted(() => this.userManager.Value);
+
+            return await userManager.GetUserByEmailAsync(email, cancellationToken);
+        }
+
+        /// <summary>
+        /// Gets a <see cref="UserRecord"/> object containing information about the user identified by
+        /// <paramref name="phoneNumber"/>.
+        /// </summary>
+        /// <param name="phoneNumber">The phone number of 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 phone number.</returns>
+        /// <exception cref="ArgumentException">If the phone number argument is null or empty.</exception>
+        /// <exception cref="FirebaseException">If a user cannot be found with the specified phone number.</exception>
+        public async Task<UserRecord> GetUserByPhoneNumberAsync(string phoneNumber)
+        {
+            return await this.GetUserByPhoneNumberAsync(phoneNumber, default(CancellationToken));
+        }
+
+        /// <summary>
+        /// Gets a <see cref="UserRecord"/> object containing information about the user identified by
+        /// <paramref name="phoneNumber"/>.
+        /// </summary>
+        /// <param name="phoneNumber">The phone number of the user who's data is to be retrieved.</param>
+        /// <param name="cancellationToken">A cancellation token to monitor the asynchronous
+        /// operation.</param>
+        /// <returns>A task that completes with a <see cref="UserRecord"/> representing
+        /// a user with the specified phone number.</returns>
+        /// <exception cref="ArgumentException">If the phone number argument is null or empty.</exception>
+        /// <exception cref="FirebaseException">If a user cannot be found with the specified phone number.</exception>
+        public async Task<UserRecord> GetUserByPhoneNumberAsync(
+            string phoneNumber, CancellationToken cancellationToken)
+        {
+            var userManager = this.IfNotDeleted(() => this.userManager.Value);
+
+            return await userManager.GetUserByPhoneNumberAsync(phoneNumber, cancellationToken);
         }
 
         /// <summary>