Issue 827 getEmailVerified now reads 'email_verified' field

https://codereview.appspot.com/13431043/

Author: peleyal

findbugs-exclude.xml

@@ -2,6 +2,7 @@
 
 <FindBugsFilter>
   <!-- http://findbugs.sourceforge.net/bugDescriptions.html -->
+  <!-- http://findbugs.sourceforge.net/manual/filter.html -->
   <LastVersion value="-1" relOp="NEQ"/>
   <!-- The following have not yet been investigated -->
 
@@ -60,4 +61,8 @@
     <Bug pattern="BETA_METHOD_USAGE"/>
     <Class name="com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow$Builder"/>
   </And>
+  <And>
+    <Bug pattern="NP_BOOLEAN_RETURN_NULL"/>
+    <!-- Method with Boolean return type returns explicit null -->
+  </And>
 </FindBugsFilter>

google-api-client/src/main/java/com/google/api/client/googleapis/auth/oauth2/GoogleIdToken.java

@@ -98,9 +98,14 @@ public static class Payload extends IdToken.Payload {
     @Key("email")
     private String email;
 
-    /** {@code true} if the email is verified. */
-    @Key("verified_email")
-    private boolean emailVerified;
+    /**
+     * {@code true} if the email is verified.
+     * TODO(mwan): change the type of the field to Boolean and the handling in
+     * {@link #getEmailVerified()} accordingly after Google OpenID Connect endpoint fixes the
+     * type of the field in ID Token.
+     */
+    @Key("email_verified")
+    private Object emailVerified;
 
     public Payload() {
     }
@@ -198,9 +203,23 @@ public Payload setEmail(String email) {
      * </p>
      *
      * @since 1.10
+     *
+     * <p>
+     * Upgrade warning: in prior version 1.16 this method accessed {@code "verified_email"}
+     * and returns a boolean, but starting with verison 1.17, it now accesses
+     * {@code "email_verified"} and returns a Boolean. Previously, if this value was not
+     * specified, this method would return {@code false}, but now it returns {@code null}.
+     * </p>
      */
-    public boolean getEmailVerified() {
-      return emailVerified;
+    public Boolean getEmailVerified() {
+      if (emailVerified == null) {
+        return null;
+      }
+      if (emailVerified instanceof Boolean) {
+        return (Boolean) emailVerified;
+      }
+
+      return Boolean.valueOf((String) emailVerified);
     }
 
     /**
@@ -211,8 +230,14 @@ public boolean getEmailVerified() {
      * </p>
      *
      * @since 1.10
+     *
+     * <p>
+     * Upgrade warning: in prior version 1.16 this method accessed {@code "verified_email"} and
+     * required a boolean parameter, but starting with verison 1.17, it now accesses
+     * {@code "email_verified"} and requires a Boolean parameter.
+     * </p>
      */
-    public Payload setEmailVerified(boolean emailVerified) {
+    public Payload setEmailVerified(Boolean emailVerified) {
       this.emailVerified = emailVerified;
       return this;
     }

google-api-client/src/test/java/com/google/api/client/googleapis/auth/oauth2/GoogleIdTokenTest.java

@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2013 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+package com.google.api.client.googleapis.auth.oauth2;
+
+import com.google.api.client.googleapis.auth.oauth2.GoogleIdToken.Payload;
+
+import junit.framework.TestCase;
+
+/** Tests for {@link GoogleIdToken}.*/
+
+public class GoogleIdTokenTest extends TestCase {
+  private static final String USER_ID = "1234567890";
+  private static final String ANOTHER_USER_ID = "2345678901";
+  private static final String CLIENT_ID = "myClientId";
+  private static final String ANOTHER_CLIENT_ID = "anotherClientId";
+  private static final String EMAIL_VERIFIED_KEY = "email_verified";
+
+  private static Payload newPayload(String userId, String clientId) {
+    Payload payload = new Payload();
+    payload.setIssuer("accounts.google.com");
+    payload.setAudience(clientId);
+    payload.setAuthorizedParty(clientId);
+    payload.setSubject(userId);
+    payload.setExpirationTimeSeconds(100L);
+    payload.setIssuedAtTimeSeconds(0L);
+    return payload;
+  }
+
+  public void testDeprecatedMethods() {
+    Payload payload = newPayload(USER_ID, CLIENT_ID);
+    assertEquals(USER_ID, payload.getUserId());
+    assertEquals(CLIENT_ID, payload.getIssuee());
+
+    payload.setUserId(ANOTHER_USER_ID);
+    payload.setIssuee(ANOTHER_CLIENT_ID);
+    assertEquals(ANOTHER_USER_ID, payload.getUserId());
+    assertEquals(ANOTHER_CLIENT_ID, payload.getIssuee());
+    assertEquals(ANOTHER_USER_ID, payload.getSubject());
+    assertEquals(ANOTHER_CLIENT_ID, payload.getAuthorizedParty());
+  }
+
+  public void testEmailVerified() {
+    Payload payload = newPayload(USER_ID, CLIENT_ID);
+    assertNull(payload.getEmailVerified());
+
+    payload.setEmailVerified(true);
+    assertTrue(payload.getEmailVerified());
+
+    payload.setEmailVerified(false);
+    assertFalse(payload.getEmailVerified());
+
+    payload.setEmailVerified(null);
+    assertNull(payload.getEmailVerified());
+
+    payload.set(EMAIL_VERIFIED_KEY, "true");
+    assertTrue(payload.getEmailVerified());
+
+    payload.set(EMAIL_VERIFIED_KEY, true);
+    assertTrue(payload.getEmailVerified());
+
+    payload.set(EMAIL_VERIFIED_KEY, "false");
+    assertFalse(payload.getEmailVerified());
+
+    payload.set(EMAIL_VERIFIED_KEY, false);
+    assertFalse(payload.getEmailVerified());
+
+    payload.set(EMAIL_VERIFIED_KEY, "RandomString");
+    assertFalse(payload.getEmailVerified());
+
+    payload.set(EMAIL_VERIFIED_KEY, "");
+    assertFalse(payload.getEmailVerified());
+
+    payload.set(EMAIL_VERIFIED_KEY, null);
+    assertNull(payload.getEmailVerified());
+
+    // Wrong type.
+    payload.set(EMAIL_VERIFIED_KEY, new Integer(5));
+    try {
+      payload.getEmailVerified();
+      fail();
+    } catch (ClassCastException e) {
+      // Expected.
+    }
+  }
+}