Handle missing email error (#54)

Adds appropriate error handling for missing email in the createUserWithEmail:password:completion: flow.

Also fixes a few typos.

Author: protocol86

Example/Auth/Tests/FIRAuthTests.m

@@ -1200,6 +1200,25 @@ - (void)testCreateUserEmptyPasswordFailure {
   [self waitForExpectationsWithTimeout:kExpectationTimeout handler:nil];
 }
 
+/** @fn testCreateUserEmptyEmailFailure
+    @brief Tests the flow of a failed @c createUserWithEmail:password:completion: call due to an
+        empty email adress. This error occurs on the client side, so there is no need to fake an RPC
+        response.
+ */
+- (void)testCreateUserEmptyEmailFailure {
+  [self expectGetAccountInfo];
+  XCTestExpectation *expectation = [self expectationWithDescription:@"callback"];
+  [[FIRAuth auth] signOut:NULL];
+  [[FIRAuth auth] createUserWithEmail:@""
+                             password:kPassword
+                           completion:^(FIRUser *_Nullable user, NSError *_Nullable error) {
+    XCTAssertTrue([NSThread isMainThread]);
+    XCTAssertEqual(error.code, FIRAuthErrorCodeMissingEmail);
+    [expectation fulfill];
+  }];
+  [self waitForExpectationsWithTimeout:kExpectationTimeout handler:nil];
+}
+
 /** @fn testSendPasswordResetEmailSuccess
     @brief Tests the flow of a successful @c sendPasswordResetWithEmail:completion: call.
  */

Example/Auth/Tests/FIRSignUpNewUserResponseTests.m

@@ -242,11 +242,11 @@ - (void)testSignUpNewUserPasswordLoginDisabledError {
   XCTAssertEqual(RPCError.code, FIRAuthErrorCodeOperationNotAllowed);
 }
 
-/** @fn testinvalidEmailError
+/** @fn testInvalidEmailError
     @brief This test simulates making a request containing an invalid email address and receiving @c
         FIRAuthErrorInvalidEmail error as a result.
  */
-- (void)testinvalidEmailError {
+- (void)testInvalidEmailError {
   FIRSignUpNewUserRequest *request = [[FIRSignUpNewUserRequest alloc] initWithAPIKey:kTestAPIKey];
 
   __block BOOL callbackInvoked;

Firebase/Auth/Source/FIRAuth.m

@@ -93,7 +93,7 @@
 /** @var kMissingEmailInvalidParameterExceptionReason
     @brief The key of missing email key @c invalidParameterException.
  */
-static NSString *const kEmailInvalidParameterReason = @"The email used to initiate user password "
+static NSString *const kEmailInvalidParameterReason = @"The email used to initiate password reset "
     "cannot be nil";
 
 static NSString *const kPasswordResetRequestType = @"PASSWORD_RESET";
@@ -650,6 +650,10 @@ - (void)createUserWithEmail:(NSString *)email
           weakPasswordErrorWithServerResponseReason:kMissingPasswordReason]);
       return;
     }
+    if (![request.email length]) {
+      decoratedCallback(nil, [FIRAuthErrorUtils missingEmail]);
+      return;
+    }
     [FIRAuthBackend signUpNewUser:request
                          callback:^(FIRSignUpNewUserResponse *_Nullable response,
                                      NSError *_Nullable error) {

Firebase/Auth/Source/FIRAuthErrorUtils.m

@@ -217,6 +217,11 @@
 static NSString *const kFIRAuthErrorMessageInvalidRecipientEmail = @"The action code is invalid. "
    "This can happen if the code is malformed, expired, or has already been used.";
 
+/** @var kFIRAuthErrorMessageMissingEmail
+    @brief Message for @c FIRAuthErrorCodeMissingEmail error code.
+ */
+static NSString *const kFIRAuthErrorMessageMissingEmail = @"An email address must be provided.";
+
 /** @var kFIRAuthErrorMessageMissingContinueURI
     @brief Message for @c FIRAuthErrorCodeMissingContinueURI error code.
  */
@@ -381,6 +386,8 @@
       return kFIRAuthErrorMessageInvalidMessagePayload;
     case FIRAuthErrorCodeInvalidRecipientEmail:
       return kFIRAuthErrorMessageInvalidRecipientEmail;
+    case FIRAuthErrorCodeMissingEmail:
+      return kFIRAuthErrorMessageMissingEmail;
     case FIRAuthErrorCodeMissingPhoneNumber:
       return kFIRAuthErrorMessageMissingPhoneNumber;
     case FIRAuthErrorCodeInvalidPhoneNumber:
@@ -474,6 +481,8 @@
       return @"ERROR_INVALID_SENDER";
     case FIRAuthErrorCodeInvalidRecipientEmail:
       return @"ERROR_INVALID_RECIPIENT_EMAIL";
+    case FIRAuthErrorCodeMissingEmail:
+      return @"MISSING_EMAIL";
     case FIRAuthErrorCodeMissingPhoneNumber:
       return @"ERROR_MISSING_PHONE_NUMBER";
     case FIRAuthErrorCodeInvalidPhoneNumber:
@@ -731,6 +740,10 @@ + (NSError *)invalidRecipientEmailErrorWithMessage:(nullable NSString *)message
   return [self errorWithCode:FIRAuthInternalErrorCodeInvalidRecipientEmail message:message];
 }
 
++ (NSError *)missingEmail {
+  return [self errorWithCode:FIRAuthInternalErrorCodeMissingEmail];
+}
+
 + (NSError *)missingPhoneNumberErrorWithMessage:(nullable NSString *)message {
   return [self errorWithCode:FIRAuthInternalErrorCodeMissingPhoneNumber message:message];
 }

Firebase/Auth/Source/FIRAuthErrors.h

@@ -184,7 +184,11 @@ typedef NS_ENUM(NSInteger, FIRAuthErrorCode) {
      */
     FIRAuthErrorCodeInvalidRecipientEmail = 17033,
 
-    // The enum values between 17033 and 17041 are reserved and should NOT be used for new error
+    /** Indicates that an email address was expected but one was not provided.
+     */
+    FIRAuthErrorCodeMissingEmail = 17034,
+
+    // The enum values between 17034 and 17041 are reserved and should NOT be used for new error
     // codes.
 
     /** Indicates that a phone number was not provided in a call to

Firebase/Auth/Source/Private/FIRAuthErrorUtils.h

@@ -313,6 +313,12 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (NSError *)invalidRecipientEmailErrorWithMessage:(nullable NSString *)message;
 
+/** @fn missingEmail
+    @brief Constructs an @c NSError with the @c FIRAuthErrorCodeMissingEmail code.
+    @return The NSError instance associated with the given FIRAuthError.
+ */
++ (NSError *)missingEmail;
+
 /** @fn missingPhoneNumberErrorWithMessage:
     @brief Constructs an @c NSError with the @c FIRAuthErrorCodeMissingPhoneNumber code.
     @param message Error message from the backend, if any.

Firebase/Auth/Source/Private/FIRAuthInternalErrors.h

@@ -238,6 +238,11 @@ typedef NS_ENUM(NSInteger, FIRAuthInternalErrorCode) {
   FIRAuthInternalErrorCodeInvalidRecipientEmail =
       FIRAuthPublicErrorCodeFlag | FIRAuthErrorCodeInvalidRecipientEmail,
 
+  /** Indicates that an email address was expected but one was not provided.
+   */
+  FIRAuthInternalErrorCodeMissingEmail =
+      FIRAuthPublicErrorCodeFlag | FIRAuthErrorCodeMissingEmail,
+
   /** Indicates that a phone number was not provided in a call to @c verifyPhoneNumber:completion:.
    */
   FIRAuthInternalErrorCodeMissingPhoneNumber =