Expose name property in IDToken (#761)

Author: mokagio

CHANGELOG.md

@@ -38,7 +38,7 @@ _None._
 
 ### New Features
 
-_None._
+- Google's `IDToken` now exposes the user's full name via `name`. [#761]
 
 ### Bug Fixes
 

Demo/AuthenticatorDemo/ViewController+WordPressAuthenticator.swift

@@ -92,7 +92,7 @@ extension ViewController {
 
                 presentAlert(
                     title: "🎉",
-                    message: "Successfully authenticated with Google.\n\nEmail in received token: \(token.email)",
+                    message: "Successfully authenticated with Google.\n\nEmail in received token: \(token.email)\n\nName: \(token.name)",
                     onDismiss: {}
                 )
             } catch let error as OAuthError {

WordPressAuthenticator/GoogleSignIn/IDToken.swift

@@ -2,15 +2,22 @@
 public struct IDToken {
 
     public let token: JSONWebToken
+    public let name: String
     public let email: String
 
     // TODO: Validate token! – https://developers.google.com/identity/openid-connect/openid-connect#validatinganidtoken
     init?(jwt: JSONWebToken) {
+        // Name and email might not be part of the JWT Google sent us if the scope used for the
+        // request didn't include them
         guard let email = jwt.payload["email"] as? String else {
             return nil
         }
+        guard let name = jwt.payload["name"] as? String else {
+            return nil
+        }
 
         self.token = jwt
+        self.name = name
         self.email = email
     }
 }

WordPressAuthenticatorTests/GoogleSignIn/IDTokenTests.swift

@@ -3,14 +3,23 @@ import XCTest
 
 class IDTokenTests: XCTestCase {
 
-    func testInitWithJWTWithoutEmail() throws {
+    func testInitWithJWTWithoutNameNorEmailFails() throws {
         XCTAssertNil(IDToken(jwt: try XCTUnwrap(JSONWebToken(encodedString: JSONWebToken.validJWTString))))
     }
 
-    func testInitWithJWTWithEmail() throws {
-        let jwt = try XCTUnwrap(JSONWebToken(encodedString: JSONWebToken.validJWTStringWithEmail))
+    func testInitWithJWTWithoutEmailFails() throws {
+        XCTAssertNil(IDToken(jwt: try XCTUnwrap(JSONWebToken(encodedString: JSONWebToken.validJWTStringWithNameOnly))))
+    }
+
+    func testInitWithJWTWithoutNameFails() throws {
+        XCTAssertNil(IDToken(jwt: try XCTUnwrap(JSONWebToken(encodedString: JSONWebToken.validJWTStringWithEmailOnly))))
+    }
+
+    func testInitWithJWTWithNameAndEmailSucceeds() throws {
+        let jwt = try XCTUnwrap(JSONWebToken(encodedString: JSONWebToken.validJWTStringWithNameAndEmail))
         let token = try XCTUnwrap(IDToken(jwt: jwt))
 
+        XCTAssertEqual(token.name, JSONWebToken.nameFromValidJWTStringWithEmail)
         XCTAssertEqual(token.email, JSONWebToken.emailFromValidJWTStringWithEmail)
     }
 

WordPressAuthenticatorTests/GoogleSignIn/JSONWebToken+Fixtures.swift

@@ -24,9 +24,35 @@ extension JSONWebToken {
     //   "key": "value",
     //   "email": "[email protected]"
     // }
-    private(set) static var validJWTStringWithEmail = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ2YWx1ZSIsImVtYWlsIjoidGVzdEBlbWFpbC5jb20ifQ.b-2oTvjpc_qHM5dU6akk_ESe3eWUZwL21pvTsCmW2gE"
+    private(set) static var validJWTStringWithEmailOnly = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ2YWx1ZSIsImVtYWlsIjoidGVzdEBlbWFpbC5jb20ifQ.b-2oTvjpc_qHM5dU6akk_ESe3eWUZwL21pvTsCmW2gE"
 
-    // For convenience, this exposes the email value used in validJWTStringWithEmail.
+    // Created with https://jwt.io/ with input:
+    //
+    // header: {
+    //   "alg": "HS256",
+    //   "typ": "JWT"
+    // }
+    // payload: {
+    //   "name": "John Doe",
+    //   "key": "value"
+    // }
+    private(set) static var validJWTStringWithNameOnly = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiSm9obiBEb2UiLCJrZXkiOiJ2YWx1ZSJ9.P7Se5_EMlFBg5q8PV4C2IQ1YojTTSgitCBX7FgmXZzs"
+
+    // Created with https://jwt.io/ with input:
+    //
+    // header: {
+    //   "alg": "HS256",
+    //   "typ": "JWT"
+    // }
+    // payload: {
+    //   "name": "John Doe",
+    //   "key": "value",
+    //   "email": "[email protected]"
+    // }
+    private(set) static var validJWTStringWithNameAndEmail = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiSm9obiBEb2UiLCJrZXkiOiJ2YWx1ZSIsImVtYWlsIjoidGVzdEBlbWFpbC5jb20ifQ.-xzg0r5mMnSZ8hE3hk7S93iCZHhOez1QFYdheSmDlx4"
+
+    // For convenience, this exposes the email and name value used in the fixtures.
     // This allows us to use raw strings in tests, rather than having to implement encoding the JWT from an arbitrary string.
     private(set) static var emailFromValidJWTStringWithEmail = "[email protected]"
+    private(set) static var nameFromValidJWTStringWithEmail = "John Doe"
 }

WordPressAuthenticatorTests/GoogleSignIn/NewGoogleAuthenticatorTests.swift

@@ -86,7 +86,7 @@ class NewGoogleAuthenticatorTests: XCTestCase {
             clientId: fakeClientId,
             scheme: "scheme",
             audience: "audience",
-            oautTokenGetter: GoogleOAuthTokenGettingStub(response: .fixture(rawIDToken: JSONWebToken.validJWTStringWithEmail))
+            oautTokenGetter: GoogleOAuthTokenGettingStub(response: .fixture(rawIDToken: JSONWebToken.validJWTStringWithNameAndEmail))
         )
         let url = URL(string: "https://test.com?code=a_code")!