Auth jazzy fixes and Swift sample updates (#19)

* Removes the '@c' that would cause Jazzy issue down the road.

Author: paulb777

AuthSamples/SwiftSample/Main.storyboard

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>application-identifier</key>
+	<string>$(AppIdentifierPrefix)$(CFBundleIdentifier)</string>
+	<key>aps-environment</key>
+	<string>development</string>
+</dict>
+</plist>

AuthSamples/SwiftSample/Sample.entitlements

@@ -19,7 +19,7 @@ import UIKit
 import FirebaseDev // FirebaseAuth
 import GoogleSignIn // GoogleSignIn
 
-final class ViewController: UIViewController {
+final class ViewController: UIViewController, UITextFieldDelegate {
   /// The profile image for the currently signed-in user.
   @IBOutlet weak var profileImage: UIImageView!
 
@@ -56,6 +56,15 @@ final class ViewController: UIViewController {
   /// The "password" text field.
   @IBOutlet weak var passwordField: UITextField!
 
+  /// The "phone" text field.
+  @IBOutlet weak var phoneField: UITextField!
+
+  /// The scroll view holding all content.
+  @IBOutlet weak var scrollView: UIScrollView!
+
+  // The active keyboard input field.
+  var activeField: UITextField?
+
   /// The currently selected action type.
   fileprivate var actionType = ActionType(rawValue: 0)! {
     didSet {
@@ -86,6 +95,67 @@ final class ViewController: UIViewController {
     }
   }
 
+  func registerForKeyboardNotifications() {
+    NotificationCenter.default.addObserver(self,
+                                           selector:
+                                           #selector(keyboardWillBeShown(notification:)),
+                                           name: NSNotification.Name.UIKeyboardWillShow,
+                                           object: nil)
+    NotificationCenter.default.addObserver(self,
+                                           selector: #selector(keyboardWillBeHidden(notification:)),
+                                           name: NSNotification.Name.UIKeyboardWillHide,
+                                           object: nil)
+  }
+
+  func deregisterFromKeyboardNotifications() {
+    NotificationCenter.default.removeObserver(self,
+                                              name: NSNotification.Name.UIKeyboardWillShow,
+                                              object: nil)
+    NotificationCenter.default.removeObserver(self,
+                                              name: NSNotification.Name.UIKeyboardWillHide,
+                                              object: nil)
+  }
+
+  func keyboardWillBeShown(notification: NSNotification) {
+    scrollView.isScrollEnabled = true
+    let info = notification.userInfo!
+    let keyboardSize = (info[UIKeyboardFrameBeginUserInfoKey] as? NSValue)?.cgRectValue.size
+    let contentInsets : UIEdgeInsets = UIEdgeInsetsMake(0.0, 0.0, keyboardSize!.height, 0.0)
+
+    scrollView.contentInset = contentInsets
+    scrollView.scrollIndicatorInsets = contentInsets
+
+    var aRect = self.view.frame
+    aRect.size.height -= keyboardSize!.height
+    if let activeField = activeField {
+      if (!aRect.contains(activeField.frame.origin)) {
+        scrollView.scrollRectToVisible(activeField.frame, animated: true)
+      }
+    }
+  }
+
+  func keyboardWillBeHidden(notification: NSNotification){
+    let info = notification.userInfo!
+    let keyboardSize = (info[UIKeyboardFrameBeginUserInfoKey] as? NSValue)?.cgRectValue.size
+    let contentInsets : UIEdgeInsets = UIEdgeInsetsMake(0.0, 0.0, -keyboardSize!.height, 0.0)
+    scrollView.contentInset = contentInsets
+    scrollView.scrollIndicatorInsets = contentInsets
+    self.view.endEditing(true)
+    scrollView.isScrollEnabled = false
+  }
+
+  func textFieldDidBeginEditing(_ textField: UITextField) {
+      activeField = textField
+  }
+
+  func textFieldDidEndEditing(_ textField: UITextField) {
+      activeField = nil
+  }
+
+  func dismissKeyboard() {
+      view.endEditing(true)
+  }
+
   /// The user's photo URL used by the last network request for its contents.
   fileprivate var lastPhotoURL: URL? = nil
 
@@ -96,6 +166,15 @@ final class ViewController: UIViewController {
                                            object: Auth.auth(), queue: nil) { notification in
       self.updateUserInfo(notification.object as? Auth)
     }
+    phoneField.delegate = self
+    registerForKeyboardNotifications()
+
+    let tap = UITapGestureRecognizer(target: self, action: #selector(dismissKeyboard))
+    scrollView.addGestureRecognizer(tap)
+  }
+
+  override func viewWillDisappear(_ animated: Bool) {
+    deregisterFromKeyboardNotifications()
   }
 
   /// Executes the action designated by the operator on the UI.
@@ -200,7 +279,34 @@ final class ViewController: UIViewController {
       GIDSignIn.sharedInstance().signIn()
     case .password:
       completion(EmailAuthProvider.credential(withEmail: emailField.text!,
-                                                         password: passwordField.text!))
+                                              password: passwordField.text!))
+    case .phone:
+      if #available(iOS 8.0, *) {
+        let phoneNumber = phoneField.text
+        PhoneAuthProvider.provider().verifyPhoneNumber(phoneNumber!) { verificationID, error in
+          guard error == nil else {
+            self.showAlert(title: "Error", message: error!.localizedDescription)
+            return
+          }
+
+          let codeAlertController =
+              UIAlertController(title: "Enter Code", message: nil, preferredStyle: .alert)
+          codeAlertController.addTextField { (textfield) in
+              textfield.placeholder = "SMS Codde"
+              textfield.keyboardType = UIKeyboardType.numberPad
+          }
+          codeAlertController.addAction(UIAlertAction(title: "OK",
+                                                      style: .default,
+                                                      handler: { (UIAlertAction) in
+            let code = codeAlertController.textFields!.first!.text!
+            let phoneCredential =
+              PhoneAuthProvider.provider().credential(withVerificationID: verificationID ?? "",
+                                                      verificationCode: code)
+            completion(phoneCredential)
+          }))
+          self.present(codeAlertController, animated: true, completion: nil)
+        }
+      }
     }
   }
 
@@ -250,6 +356,7 @@ final class ViewController: UIViewController {
         action.requiresPassword
     passwordInputLabel.alpha = isPasswordEnabled ? 1.0 : 0.6
     passwordField.isEnabled = isPasswordEnabled
+    phoneField.isEnabled = credentialType.requiresPhone
   }
 
   fileprivate func showAlert(title: String, message: String? = "") {
@@ -486,11 +593,11 @@ fileprivate enum UserAction: Int, Action {
 /// The list of all possible credential types the operator can use to sign in or link.
 fileprivate enum CredentialType: Int {
 
-  case google, password
+  case google, password, phone
 
   /// Total number of enum values.
   static var count: Int {
-    return CredentialType.password.rawValue + 1
+    return CredentialType.phone.rawValue + 1
   }
 
   /// The text description for a particular enum value.
@@ -500,6 +607,12 @@ fileprivate enum CredentialType: Int {
       return "Google"
     case .password:
       return "Password ➡️️"
+    case .phone:
+      if #available(iOS 8.0, *) {
+        return "Phone ➡️️"
+      } else {
+        return "-"
+      }
     }
   }
 
@@ -512,6 +625,11 @@ fileprivate enum CredentialType: Int {
   var requiresPassword : Bool {
     return self == .password
   }
+
+  /// Whether or not the credential requires phone.
+  var requiresPhone : Bool {
+    return self == .phone
+  }
 }
 
 fileprivate extension User {

AuthSamples/SwiftSample/ViewController.swift

@@ -16,9 +16,9 @@
 
 #import <Foundation/Foundation.h>
 
-#import "FIRAuth.h"
 #import "FIRAuthSwiftNameSupport.h"
 
+@class FIRAuth;
 @class FIRPhoneAuthCredential;
 
 NS_ASSUME_NONNULL_BEGIN
@@ -38,8 +38,8 @@ typedef void (^FIRVerificationResultCallback)(NSString *_Nullable verificationID
                                               NSError *_Nullable error)
     FIR_SWIFT_NAME(VerificationResultCallback);
 
-/** @class FIRPhoneNumberProvider
-    @brief A concrete implementation of @c FIRAuthProvider for Phone Auth Providers.
+/** @class FIRPhoneAuthProvider
+    @brief A concrete implementation of @c FIRAuthProvider for phone auth providers.
  */
 FIR_SWIFT_NAME(PhoneAuthProvider)
 @interface FIRPhoneAuthProvider : NSObject
@@ -52,7 +52,7 @@ FIR_SWIFT_NAME(PhoneAuthProvider)
 /** @fn providerWithAuth:
     @brief Returns an instance of @c FIRPhoneAuthProvider for the provided @c FIRAuth object.
 
-    @param auth The auth object to associate with the @c PhoneauthProvider instance.
+    @param auth The auth object to associate with the phone auth provider instance.
  */
 + (instancetype)providerWithAuth:(FIRAuth *)auth FIR_SWIFT_NAME(provider(auth:));
 
@@ -70,18 +70,18 @@ FIR_SWIFT_NAME(PhoneAuthProvider)
     @brief Creates an @c FIRAuthCredential for the phone number provider identified by the
         verification ID and verification code.
 
-    @param verificationID The verification ID obtained from invoking @c
+    @param verificationID The verification ID obtained from invoking
         verifyPhoneNumber:completion:
     @param verificationCode The verification code obtained from the user.
-    @return The corresponding @c FIRAuthCredential for the verification ID and verification code
+    @return The corresponding phone auth credential for the verification ID and verification code
         provided.
  */
 - (FIRPhoneAuthCredential *)credentialWithVerificationID:(NSString *)verificationID
                                         verificationCode:(NSString *)verificationCode;
 
 /** @fn init
-    @brief Please use the @c provider or @providerWithAuth: methods to obtain an instance of @c
-        FIRPhoneAuthProvider.
+    @brief Please use the @c provider or @c providerWithAuth: methods to obtain an instance of
+        @c FIRPhoneAuthProvider.
  */
 - (instancetype)init NS_UNAVAILABLE;
 

Firebase/Auth/Source/AuthProviders/Phone/FIRPhoneAuthProvider.h

@@ -62,8 +62,8 @@ typedef void(^FIRIDTokenDidChangeListenerBlock)(FIRAuth *auth, FIRUser *_Nullabl
 /** @typedef FIRAuthDataResultCallback
     @brief The type of block invoked when sign-in related events complete.
 
-    @param authResult Optionally; Result of sign-in request containing @c FIRUser and
-       @c FIRAdditionalUserInfo.
+    @param authResult Optionally; Result of sign-in request containing both the user and
+       the additional user info.
     @param error Optionally; the error which occurred - or nil if the request was successful.
  */
 typedef void (^FIRAuthDataResultCallback)(FIRAuthDataResult *_Nullable authResult,
@@ -151,8 +151,8 @@ typedef void (^FIRApplyActionCodeCallback)(NSError *_Nullable error)
     FIR_SWIFT_NAME(ApplyActionCodeCallback);
 
 /**
-    @brief Keys used to retrieve operation data from a @c FIRActionCodeInfo object by the @c
-        dataForKey method.
+    @brief Keys used to retrieve operation data from a @c FIRActionCodeInfo object by the
+        @c dataForKey method.
   */
 typedef NS_ENUM(NSInteger, FIRActionDataKey) {
   /**
@@ -598,8 +598,8 @@ FIR_SWIFT_NAME(Auth)
     @brief Whether the specific remote notification is handled by @c FIRAuth .
     @param userInfo A dictionary that contains information related to the
         notification in question.
-    @return Whether or the notification is handled. @c YES means the notification is for @c FIRAuth
-        so the caller should ignore the notification from further processing, and @c NO means the
+    @return Whether or the notification is handled. YES means the notification is for Firebase Auth
+        so the caller should ignore the notification from further processing, and NO means the
         the notification is for the app (or another libaray) so the caller should continue handling
         this notification as usual.
     @remarks If swizzling is disabled, related remote notifications must be forwarded to this method

Firebase/Auth/Source/FIRAuth.h

@@ -241,20 +241,20 @@
     @brief Message for @c FIRAuthErrorCodeMissingVerificationCode error code.
  */
 static NSString *const kFIRAuthErrorMessageMissingVerificationCode =
-    @"The Phone Auth Credential was created with an empty SMS verification Code.";
+    @"The phone auth credential was created with an empty SMS verification Code.";
 
 /** @var kFIRAuthErrorMessageInvalidVerificationCode
     @brief Message for @c FIRAuthErrorCodeInvalidVerificationCode error code.
  */
 static NSString *const kFIRAuthErrorMessageInvalidVerificationCode =
     @"The SMS verification code used to create the phone auth credential is invalid. Please resend "
-    "the verification code sms and be sure use the verification code provided by the user.";
+    "the verification code SMS and be sure to use the verification code provided by the user.";
 
 /** @var kFIRAuthErrorMessageMissingVerificationID
     @brief Message for @c FIRAuthErrorCodeInvalidVerificationID error code.
  */
 static NSString *const kFIRAuthErrorMessageMissingVerificationID =
-    @"The Phone Auth Credential was created with an empty verification ID.";
+    @"The phone auth credential was created with an empty verification ID.";
 
 /** @var kFIRAuthErrorMessageInvalidVerificationID
     @brief Message for @c FIRAuthErrorCodeInvalidVerificationID error code.
@@ -280,13 +280,14 @@
     @brief Message for @c FIRAuthErrorCodeInvalidAppCredential error code.
  */
 static NSString *const kFIRAuthErrorMessageInvalidAppCredential = @"The APNs device token provided "
-    "may be incorrect or does not match the private certificate uploaded to the Firebase Console.";
+    "is either incorrect or does not match the private certificate uploaded to the Firebase "
+    "Console.";
 
 /** @var kFIRAuthErrorMessageQuotaExceeded
     @brief Message for @c FIRAuthErrorCodeQuotaExceeded error code.
  */
-static NSString *const kFIRAuthErrorMessageQuotaExceeded = @"The SMS quota for this project has "
-    "been exceeded.";
+static NSString *const kFIRAuthErrorMessageQuotaExceeded = @"The phone verification quota for this "
+    "project has been exceeded.";
 
 /** @var kFIRAuthErrorMessageMissingAppToken
     @brief Message for @c FIRAuthErrorCodeMissingAppToken error code.

Firebase/Auth/Source/FIRAuthErrorUtils.m

@@ -128,8 +128,8 @@ typedef NS_ENUM(NSInteger, FIRAuthErrorCode) {
     FIRAuthErrorCodeInvalidUserToken = 17017,
 
     /** Indicates a network error occurred (such as a timeout, interrupted connection, or
-        unreachable host). These types of errors are often recoverable with a retry. The @c
-        NSUnderlyingError field in the @c NSError.userInfo dictionary will contain the error
+        unreachable host). These types of errors are often recoverable with a retry. The
+        @c NSUnderlyingError field in the @c NSError.userInfo dictionary will contain the error
         encountered.
      */
     FIRAuthErrorCodeNetworkError = 17020,
@@ -187,13 +187,13 @@ typedef NS_ENUM(NSInteger, FIRAuthErrorCode) {
     // The enum values between 17033 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 @c
-        verifyPhoneNumber:completion:.
+    /** Indicates that a phone number was not provided in a call to
+        @c verifyPhoneNumber:completion:.
      */
     FIRAuthErrorCodeMissingPhoneNumber = 17041,
 
-    /** Indicates that an invalid phone number was provided in a call to @c
-        verifyPhoneNumber:completion:.
+    /** Indicates that an invalid phone number was provided in a call to
+        @c verifyPhoneNumber:completion:.
      */
     FIRAuthErrorCodeInvalidPhoneNumber = 17042,