Merge pull request firebase#175 from firebase/custom-recovery

implement custom password recovery controller

Author: yramanchuk

FirebaseAuthUI/FIRAuthUI.h

@@ -25,6 +25,7 @@
 @class FIREmailEntryViewController;
 @class FIRPasswordSignInViewController;
 @class FIRPasswordSignUpViewController;
+@class FIRPasswordRecoveryViewController;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -68,25 +69,34 @@ typedef void (^FIRAuthUIResultCallback)(FIRUser *_Nullable user, NSError *_Nulla
 - (FIREmailEntryViewController *)emailEntryViewControllerForAuthUI:(FIRAuthUI *)authUI;
 
 /** @fn passwordSignInViewControllerForAuthUI:email:
- @brief Sent to the receiver to ask for an instance of @c FIRPasswordSignInViewController subclass
- to allow sign-in UI customizations.
- @param authUI The @c FIRAuthUI instance sending the message.
- @param email The email user is using for sin-in.
- @return an instance of @c FIRPasswordSignInViewController subclass.
+  @brief Sent to the receiver to ask for an instance of @c FIRPasswordSignInViewController subclass
+  to allow sign-in UI customizations.
+  @param authUI The @c FIRAuthUI instance sending the message.
+  @param email The email user is using for sin-in.
+  @return an instance of @c FIRPasswordSignInViewController subclass.
  */
 - (FIRPasswordSignInViewController *)passwordSignInViewControllerForAuthUI:(FIRAuthUI *)authUI
  email:(NSString *)email;
 
 /** @fn passwordSignInViewControllerForAuthUI:email:
- @brief Sent to the receiver to ask for an instance of @c FIRPasswordSignUpViewController subclass
- to allow sign-up UI customizations.
- @param authUI The @c FIRAuthUI instance sending the message.
- @param email The email user is using for sin-in.
- @return an instance of @c FIRPasswordSignUpViewController subclass.
+  @brief Sent to the receiver to ask for an instance of @c FIRPasswordSignUpViewController subclass
+  to allow sign-up UI customizations.
+  @param authUI The @c FIRAuthUI instance sending the message.
+  @param email The email user is using for sin-in.
+  @return an instance of @c FIRPasswordSignUpViewController subclass.
  */
 - (FIRPasswordSignUpViewController *)passwordSignUpViewControllerForAuthUI:(FIRAuthUI *)authUI
  email:(NSString *)email;
 
+/** @fn passwordRecoveryViewControllerForAuthUI:email:
+ @brief Sent to the receiver to ask for an instance of @c FIRPasswordRecoveryViewController subclass
+ to allow sign-up UI customizations.
+ @param authUI The @c FIRAuthUI instance sending the message.
+ @param email The email user is using for password recovery.
+ @return an instance of @c FIRPasswordRecoveryViewController subclass.
+ */
+- (FIRPasswordRecoveryViewController *)passwordRecoveryViewControllerForAuthUI:(FIRAuthUI *)authUI
+ email:(NSString *)email;
 @end
 
 /** @class FIRAuthUI

FirebaseAuthUI/FIRAuthUIStrings.h

@@ -45,6 +45,12 @@
  */
 + (NSString *)invalidEmailError;
 
+/** @fn invalidPasswordError
+ @brief Error message displayed when user enters an empty password.
+ @return Localized string.
+ */
++ (NSString *)invalidPasswordError;
+
 /** @fn cannotAuthenticateError
  @brief Error message displayed when the app cannot authenticate user's account.
  @return Localized string.

FirebaseAuthUI/FIRAuthUIStrings.m

@@ -24,6 +24,7 @@
 static NSString *const kSignInWithEmail = @"SignInWithEmail";
 static NSString *const kEnterYourEmail = @"EnterYourEmail";
 static NSString *const kInvalidEmailError = @"InvalidEmailError";
+static NSString *const kInvalidPasswordError = @"InvalidPasswordError";
 static NSString *const kCannotAuthenticateError = @"CannotAuthenticateError";
 static NSString *const kExistingAccountTitle = @"ExistingAccountTitle";
 static NSString *const kProviderUsedPreviouslyMessage = @"ProviderUsedPreviouslyMessage";
@@ -104,6 +105,10 @@ + (NSString *)invalidEmailError {
  return [self localizedStringForKey:kInvalidEmailError];
 }
 
++ (NSString *)invalidPasswordError {
+ return [self localizedStringForKey:kInvalidPasswordError];
+}
+
 + (NSString *)cannotAuthenticateError {
  return [self localizedStringForKey:kCannotAuthenticateError];
 }

FirebaseAuthUI/FIREmailEntryViewController.h

@@ -32,12 +32,12 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)onNext:(NSString *)emailText;
 
-/** @fn onEmailValueChanged:
+/** @fn didChangeEmail:
  @brief Should be called after any change of email value. Updates UI controls state
  (e g state of next button)
  @param emailText Email value entered by user.
  */
-- (void)onEmailValueChanged:(NSString *)emailText;
+- (void)didChangeEmail:(NSString *)emailText;
 
 @end
 

FirebaseAuthUI/FIREmailEntryViewController.m

@@ -165,10 +165,10 @@ - (void)onNext:(NSString *)emailText {
 }
 
 - (void)textFieldDidChange {
- [self onEmailValueChanged:_emailField.text];
+ [self didChangeEmail:_emailField.text];
 }
 
-- (void)onEmailValueChanged:(NSString *)emailText {
+- (void)didChangeEmail:(NSString *)emailText {
  self.navigationItem.rightBarButtonItem.enabled = (emailText.length > 0);
 }
 
@@ -199,7 +199,7 @@ - (UITableViewCell *)tableView:(UITableView *)tableView
  [cell.textField addTarget:self
  action:@selector(textFieldDidChange)
  forControlEvents:UIControlEventEditingChanged];
- [self onEmailValueChanged:_emailField.text];
+ [self didChangeEmail:_emailField.text];
  return cell;
 }
 

FirebaseAuthUI/FIRPasswordRecoveryViewController.h

@@ -25,11 +25,6 @@ NS_ASSUME_NONNULL_BEGIN
  */
 @interface FIRPasswordRecoveryViewController : FIRAuthUIBaseViewController
 
-/** @property footerTextView
- @brief The text view in the footer of the table.
- */
-@property(nonatomic, strong) IBOutlet UITextView *footerTextView;
-
 /** @fn initWithNibName:bundle:authUI:
  @brief Please use @c initWithAuthUI:email:.
  */
@@ -42,14 +37,33 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (instancetype)initWithAuthUI:(FIRAuthUI *)authUI NS_UNAVAILABLE;
 
-/** @fn initWithAuthUI:email:
+/** @fn initWithNibName:bundle:authUI:email:
  @brief Designated initializer.
+ @param nibNameOrNil The name of the nib file to associate with the view controller.
+ @param nibBundleOrNil The bundle in which to search for the nib file.
  @param authUI The @c FIRAuthUI instance that manages this view controller.
  @param email The email address of the user.
  */
-- (instancetype)initWithAuthUI:(FIRAuthUI *)authUI
- email:(NSString *_Nullable)email NS_DESIGNATED_INITIALIZER;
+- (instancetype)initWithNibName:(nullable NSString *)nibNameOrNil
+ bundle:(nullable NSBundle *)nibBundleOrNil
+ authUI:(FIRAuthUI *)authUI
+ email:(NSString *_Nullable)email NS_DESIGNATED_INITIALIZER;
+
 
+/** @fn didChangeEmail:
+ @brief Should be called after any change of email value. Updates UI controls state
+ (e g state of send button)
+ @param email The email address of the user.
+ */
+- (void)didChangeEmail:(NSString *)email;
+
+
+/** @fn recoverEmail:
+ @brief Should be called when user want to recover password for specified email.
+ Sends email recover request.
+ @param email The email address of the user.
+ */
+- (void)recoverEmail:(NSString *)email;
 @end
 
 NS_ASSUME_NONNULL_END

FirebaseAuthUI/FIRPasswordRecoveryViewController.m

@@ -33,11 +33,16 @@
 static const CGFloat kFooterTextViewHorizontalInset = 8.0f;
 
 @interface FIRPasswordRecoveryViewController () <UITableViewDataSource, UITextFieldDelegate>
+/** @property footerTextView
+ @brief The text view in the footer of the table.
+ */
+@property(nonatomic, strong) IBOutlet UITextView *footerTextView;
+
 @end
 
 @implementation FIRPasswordRecoveryViewController {
  /** @var _email
- @brief The @c The email address of the user from the previous screen.
+ @brief The @c email address of the user from the previous screen.
  */
  NSString *_email;
 
@@ -47,10 +52,12 @@ @implementation FIRPasswordRecoveryViewController {
  UITextField *_emailField;
 }
 
-- (instancetype)initWithAuthUI:(FIRAuthUI *)authUI
- email:(NSString *_Nullable)email {
- self = [super initWithNibName:NSStringFromClass([self class])
- bundle:[FIRAuthUIUtils frameworkBundle]
+- (instancetype)initWithNibName:(nullable NSString *)nibNameOrNil
+ bundle:(nullable NSBundle *)nibBundleOrNil
+ authUI:(FIRAuthUI *)authUI
+ email:(NSString *_Nullable)email {
+ self = [super initWithNibName:nibNameOrNil
+ bundle:nibBundleOrNil
  authUI:authUI];
  if (self) {
  _email = [email copy];
@@ -86,7 +93,10 @@ - (void)viewDidLayoutSubviews {
 #pragma mark - Actions
 
 - (void)send {
- NSString *email = _emailField.text;
+ [self recoverEmail:_emailField.text];
+}
+
+- (void)recoverEmail:(NSString *)email {
  if (![[self class] isValidEmail:email]) {
  [self showAlertWithMessage:[FIRAuthUIStrings invalidEmailError]];
  return;
@@ -96,36 +106,37 @@ - (void)send {
 
  [self.auth sendPasswordResetWithEmail:email
  completion:^(NSError *_Nullable error) {
- // The dispatch is a workaround for a bug in FirebaseAuth 3.0.2, which doesn't call the
- // completion block on the main queue.
- dispatch_async(dispatch_get_main_queue(), ^{
- [self decrementActivity];
-
- if (error) {
- if (error.code == FIRAuthErrorCodeUserNotFound) {
- [self showAlertWithMessage:[FIRAuthUIStrings userNotFoundError]];
- return;
- }
-
- [self.navigationController dismissViewControllerAnimated:YES completion:^{
- [self.authUI invokeResultCallbackWithUser:nil error:error];
- }];
- return;
- }
-
- NSString *message =
- [NSString stringWithFormat:[FIRAuthUIStrings passwordRecoveryEmailSentMessage], email];
- [self showAlertWithMessage:message];
- });
- }];
+  // The dispatch is a workaround for a bug in FirebaseAuth 3.0.2, which doesn't call the
+  // completion block on the main queue.
+  dispatch_async(dispatch_get_main_queue(), ^{
+  [self decrementActivity];
+
+  if (error) {
+  if (error.code == FIRAuthErrorCodeUserNotFound) {
+  [self showAlertWithMessage:[FIRAuthUIStrings userNotFoundError]];
+  return;
+  }
+
+  [self.navigationController dismissViewControllerAnimated:YES completion:^{
+  [self.authUI invokeResultCallbackWithUser:nil error:error];
+  }];
+  return;
+  }
+
+  NSString *message =
+  [NSString stringWithFormat:[FIRAuthUIStrings passwordRecoveryEmailSentMessage], email];
+  [self showAlertWithMessage:message];
+  });
+  }];
 }
 
 - (void)textFieldDidChange {
- [self updateActionButton];
+ [self didChangeEmail:_emailField.text];
 }
 
-- (void)updateActionButton {
- self.navigationItem.rightBarButtonItem.enabled = (_emailField.text.length > 0);
+- (void)didChangeEmail:(NSString *)email {
+ self.navigationItem.rightBarButtonItem.enabled = (email.length > 0);
+
 }
 
 #pragma mark - UITableViewDataSource
@@ -153,7 +164,7 @@ - (UITableViewCell *)tableView:(UITableView *)tableView
  [cell.textField addTarget:self
  action:@selector(textFieldDidChange)
  forControlEvents:UIControlEventEditingChanged];
- [self updateActionButton];
+ [self didChangeEmail:_emailField.text];
  return cell;
 }
 

FirebaseAuthUI/FIRPasswordSignInViewController.h

@@ -24,14 +24,6 @@ NS_ASSUME_NONNULL_BEGIN
  @brief The view controller that asks for user's password.
  */
 @interface FIRPasswordSignInViewController : FIRAuthUIBaseViewController
-{
- @protected
- /** @var _email
- @brief The @c email address of the user from the previous screen.
- */
- NSString *_email;
-
-}
 
 /** @fn initWithNibName:bundle:authUI:
  @brief Please use @c initWithNibName:bundle:authUI:email:.

FirebaseAuthUI/FIRPasswordSignInViewController.m

@@ -32,6 +32,11 @@ @interface FIRPasswordSignInViewController () <UITableViewDataSource, UITextFiel
 @end
 
 @implementation FIRPasswordSignInViewController {
+ /** @var _email
+ @brief The @c email address of the user from the previous screen.
+ */
+ NSString *_email;
+
  /** @var _emailField
  @brief The @c UITextField that user enters email address into.
  */
@@ -77,6 +82,10 @@ - (void)signInWithEmail:(NSString *)email andPassword:(NSString *)password {
  [self showAlertWithMessage:[FIRAuthUIStrings invalidEmailError]];
  return;
  }
+ if (password.length <= 0) {
+ [self showAlertWithMessage:[FIRAuthUIStrings invalidPasswordError]];
+ return;
+ }
 
  [self incrementActivity];
 
@@ -113,9 +122,16 @@ - (void)signIn {
 }
 
 - (void)forgotPasswordForEmail:(NSString *)email {
- UIViewController *viewController =
- [[FIRPasswordRecoveryViewController alloc] initWithAuthUI:self.authUI
- email:email];
+ UIViewController *viewController;
+ if ([self.authUI.delegate respondsToSelector:@selector(passwordRecoveryViewControllerForAuthUI:email:)]) {
+ viewController = [self.authUI.delegate passwordRecoveryViewControllerForAuthUI:self.authUI
+ email:email];
+ } else {
+ viewController = [[FIRPasswordRecoveryViewController alloc] initWithNibName:NSStringFromClass([FIRPasswordRecoveryViewController class])
+ bundle:[FIRAuthUIUtils frameworkBundle]
+ authUI:self.authUI
+ email:email];
+ }
  [self pushViewController:viewController];
 
 }

FirebaseAuthUI/FIRPasswordSignUpViewController.h

@@ -24,13 +24,6 @@ NS_ASSUME_NONNULL_BEGIN
  @brief The view controller where user signs up as a password account.
  */
 @interface FIRPasswordSignUpViewController : FIRAuthUIBaseViewController
-{
- @protected
- /** @var _email
- @brief The @c email address of the user from the previous screen.
- */
- NSString *_email;
-}
 
 /** @property footerTextView
  @brief The text view in the footer of the table.