Merge pull request #28 from auth0/bugfix-json-mappings

Fix JSON mappings and auth result objects

Author: hzalaz

auth0/build.gradle

@@ -9,9 +9,7 @@ dependencies {
     compile "com.google.code.gson:gson:2.6.2"
 
     testCompile 'junit:junit:4.12'
-    testCompile 'org.hamcrest:hamcrest-integration:1.3'
-    testCompile 'org.hamcrest:hamcrest-core:1.3'
-    testCompile 'org.hamcrest:hamcrest-library:1.3'
+    testCompile 'org.hamcrest:java-hamcrest:2.0.0.0'
     testCompile 'org.mockito:mockito-core:1.10.19'
     testCompile 'com.squareup.okhttp:mockwebserver:2.5.0'
     testCompile 'com.jayway.awaitility:awaitility:1.6.4'

auth0/src/main/java/com/auth0/authentication/AuthenticationAPIClient.java

@@ -28,15 +28,13 @@
 import com.auth0.authentication.result.Credentials;
 import com.auth0.authentication.result.DatabaseUser;
 import com.auth0.authentication.result.Delegation;
-import com.auth0.authentication.result.JsonRequiredTypeAdapterFactory;
 import com.auth0.authentication.result.UserProfile;
 import com.auth0.request.AuthenticationRequest;
 import com.auth0.request.ParameterizableRequest;
 import com.auth0.request.Request;
 import com.auth0.request.internal.RequestFactory;
 import com.auth0.util.Telemetry;
 import com.google.gson.Gson;
-import com.google.gson.GsonBuilder;
 import com.squareup.okhttp.HttpUrl;
 import com.squareup.okhttp.OkHttpClient;
 
@@ -90,7 +88,7 @@ public class AuthenticationAPIClient {
      * @param auth0 account information
      */
     public AuthenticationAPIClient(Auth0 auth0) {
-        this(auth0, new OkHttpClient(), buildGson());
+        this(auth0, new OkHttpClient(), GsonProvider.buildGson());
     }
 
     private AuthenticationAPIClient(Auth0 auth0, OkHttpClient client, Gson gson) {
@@ -117,6 +115,7 @@ public String getBaseURL() {
      *
      * @param userAgent value to send in every request to Auth0
      */
+    @SuppressWarnings("unused")
     public void setUserAgent(String userAgent) {
         factory.setUserAgent(userAgent);
     }
@@ -126,6 +125,7 @@ public void setUserAgent(String userAgent) {
      *
      * @param defaultDatabaseConnection name to use on every login with DB connection
      */
+    @SuppressWarnings("unused")
     public void setDefaultDatabaseConnection(String defaultDatabaseConnection) {
         this.defaultDatabaseConnection = defaultDatabaseConnection;
     }
@@ -149,6 +149,7 @@ public void setDefaultDatabaseConnection(String defaultDatabaseConnection) {
      * @param password        of the user
      * @return a request to configure and start that will yield {@link Credentials}
      */
+    @SuppressWarnings("WeakerAccess")
     public AuthenticationRequest login(String usernameOrEmail, String password) {
         Map<String, Object> requestParameters = ParameterBuilder.newAuthenticationBuilder()
                 .set(USERNAME_KEY, usernameOrEmail)
@@ -177,6 +178,7 @@ public AuthenticationRequest login(String usernameOrEmail, String password) {
      * @param connection that will be used to authenticate the user, e.g. 'facebook'
      * @return a request to configure and start that will yield {@link Credentials}
      */
+    @SuppressWarnings("WeakerAccess")
     public AuthenticationRequest loginWithOAuthAccessToken(String token, String connection) {
         HttpUrl url = HttpUrl.parse(auth0.getDomainUrl()).newBuilder()
                 .addPathSegment(OAUTH_PATH)
@@ -211,6 +213,7 @@ public AuthenticationRequest loginWithOAuthAccessToken(String token, String conn
      * @param verificationCode sent by Auth0 via SMS
      * @return a request to configure and start that will yield {@link Credentials}
      */
+    @SuppressWarnings("WeakerAccess")
     public AuthenticationRequest loginWithPhoneNumber(String phoneNumber, String verificationCode) {
         Map<String, Object> parameters = ParameterBuilder.newAuthenticationBuilder()
                 .set(USERNAME_KEY, phoneNumber)
@@ -240,6 +243,7 @@ public AuthenticationRequest loginWithPhoneNumber(String phoneNumber, String ver
      * @param verificationCode sent by Auth0 via Email
      * @return a request to configure and start that will yield {@link Credentials}
      */
+    @SuppressWarnings("WeakerAccess")
     public AuthenticationRequest loginWithEmail(String email, String verificationCode) {
         Map<String, Object> parameters = ParameterBuilder.newAuthenticationBuilder()
                 .set(USERNAME_KEY, email)
@@ -268,6 +272,7 @@ public AuthenticationRequest loginWithEmail(String email, String verificationCod
      * @param idToken used to fetch it's information
      * @return a request to start
      */
+    @SuppressWarnings("WeakerAccess")
     public Request<UserProfile> tokenInfo(String idToken) {
         return profileRequest()
                 .addParameter(ParameterBuilder.ID_TOKEN_KEY, idToken);
@@ -293,6 +298,7 @@ public Request<UserProfile> tokenInfo(String idToken) {
      * @param username of the user and must be non null
      * @return a request to start
      */
+    @SuppressWarnings("WeakerAccess")
     public DatabaseConnectionRequest<DatabaseUser> createUser(String email, String password, String username) {
         HttpUrl url = HttpUrl.parse(auth0.getDomainUrl()).newBuilder()
                 .addPathSegment(DB_CONNECTIONS_PATH)
@@ -330,6 +336,7 @@ public DatabaseConnectionRequest<DatabaseUser> createUser(String email, String p
      * @param password of the user and must be non null
      * @return a request to start
      */
+    @SuppressWarnings("WeakerAccess")
     public DatabaseConnectionRequest<DatabaseUser> createUser(String email, String password) {
         return createUser(email, password, null);
     }
@@ -355,6 +362,7 @@ public DatabaseConnectionRequest<DatabaseUser> createUser(String email, String p
      * @param username of the user and must be non null
      * @return a request to configure and start that will yield {@link Credentials}
      */
+    @SuppressWarnings("WeakerAccess")
     public SignUpRequest signUp(String email, String password, String username) {
         final DatabaseConnectionRequest<DatabaseUser> createUserRequest = createUser(email, password, username);
         final AuthenticationRequest authenticationRequest = login(email, password);
@@ -381,6 +389,7 @@ public SignUpRequest signUp(String email, String password, String username) {
      * @param password of the user and must be non null
      * @return a request to configure and start that will yield {@link Credentials}
      */
+    @SuppressWarnings("WeakerAccess")
     public SignUpRequest signUp(String email, String password) {
         DatabaseConnectionRequest<DatabaseUser> createUserRequest = createUser(email, password);
         final AuthenticationRequest authenticationRequest = login(email, password);
@@ -404,6 +413,7 @@ public SignUpRequest signUp(String email, String password) {
      * @param email of the user that changes the password. It's also where the email will be sent with the link to perform the change password.
      * @return a request to configure and start
      */
+    @SuppressWarnings("WeakerAccess")
     public DatabaseConnectionRequest<Void> requestChangePassword(String email) {
         HttpUrl url = HttpUrl.parse(auth0.getDomainUrl()).newBuilder()
                 .addPathSegment(DB_CONNECTIONS_PATH)
@@ -437,6 +447,7 @@ public DatabaseConnectionRequest<Void> requestChangePassword(String email) {
      * @param idToken issued by Auth0 for the user. The token must not be expired.
      * @return a request to configure and start
      */
+    @SuppressWarnings("WeakerAccess")
     public DelegationRequest<Delegation> delegationWithIdToken(String idToken) {
         ParameterizableRequest<Delegation> request = delegation(Delegation.class)
                 .addParameter(ParameterBuilder.ID_TOKEN_KEY, idToken);
@@ -463,6 +474,7 @@ public DelegationRequest<Delegation> delegationWithIdToken(String idToken) {
      * @param refreshToken issued by Auth0 for the user when using the 'offline_access' scope when logging in.
      * @return a request to configure and start
      */
+    @SuppressWarnings("WeakerAccess")
     public DelegationRequest<Delegation> delegationWithRefreshToken(String refreshToken) {
         ParameterizableRequest<Delegation> request = delegation(Delegation.class)
                 .addParameter(ParameterBuilder.REFRESH_TOKEN_KEY, refreshToken);
@@ -489,6 +501,7 @@ public DelegationRequest<Delegation> delegationWithRefreshToken(String refreshTo
      * @param apiType the delegation 'api_type' parameter
      * @return a request to configure and start
      */
+    @SuppressWarnings("WeakerAccess")
     public DelegationRequest<Map<String, Object>> delegationWithIdToken(String idToken, String apiType) {
         ParameterizableRequest<Map<String, Object>> request = delegation()
                 .addParameter(ParameterBuilder.ID_TOKEN_KEY, idToken);
@@ -515,6 +528,7 @@ public DelegationRequest<Map<String, Object>> delegationWithIdToken(String idTok
      * @param accessToken of the main identity obtained after login
      * @return a request to start
      */
+    @SuppressWarnings("WeakerAccess")
     public Request<Void> unlink(String userId, String accessToken) {
         HttpUrl url = HttpUrl.parse(auth0.getDomainUrl()).newBuilder()
                 .addPathSegment(UNLINK_PATH)
@@ -548,6 +562,7 @@ public Request<Void> unlink(String userId, String accessToken) {
      * @param passwordlessType indicate whether the email should contain a code, link or magic link (android & iOS)
      * @return a request to configure and start
      */
+    @SuppressWarnings("WeakerAccess")
     public ParameterizableRequest<Void> passwordlessWithEmail(String email, PasswordlessType passwordlessType) {
         final Map<String, Object> parameters = ParameterBuilder.newBuilder()
                 .set(EMAIL_KEY, email)
@@ -577,6 +592,7 @@ public ParameterizableRequest<Void> passwordlessWithEmail(String email, Password
      * @param passwordlessType indicate whether the SMS should contain a code, link or magic link (android & iOS)
      * @return a request to configure and start
      */
+    @SuppressWarnings("WeakerAccess")
     public ParameterizableRequest<Void> passwordlessWithSMS(String phoneNumber, PasswordlessType passwordlessType) {
         final Map<String, Object> parameters = ParameterBuilder.newBuilder()
                 .set(PHONE_NUMBER_KEY, phoneNumber)
@@ -605,6 +621,7 @@ public ParameterizableRequest<Void> passwordlessWithSMS(String phoneNumber, Pass
      *
      * @return a request to configure and start
      */
+    @SuppressWarnings("WeakerAccess")
     public ParameterizableRequest<Map<String, Object>> delegation() {
         HttpUrl url = HttpUrl.parse(auth0.getDomainUrl()).newBuilder()
                 .addPathSegment(DELEGATION_PATH)
@@ -618,7 +635,7 @@ public ParameterizableRequest<Map<String, Object>> delegation() {
                 .addParameters(parameters);
     }
 
-    protected <T> ParameterizableRequest<T> delegation(Class<T> clazz) {
+    private <T> ParameterizableRequest<T> delegation(Class<T> clazz) {
         HttpUrl url = HttpUrl.parse(auth0.getDomainUrl()).newBuilder()
                 .addPathSegment(DELEGATION_PATH)
                 .build();
@@ -637,6 +654,7 @@ protected <T> ParameterizableRequest<T> delegation(Class<T> clazz) {
      *
      * @return a request to configure and start
      */
+    @SuppressWarnings("WeakerAccess")
     public ParameterizableRequest<Void> passwordless() {
         HttpUrl url = HttpUrl.parse(auth0.getDomainUrl()).newBuilder()
                 .addPathSegment(PASSWORDLESS_PATH)
@@ -710,10 +728,4 @@ public AuthenticationRequest token(String authorizationCode, String codeVerifier
         return factory.authenticationPOST(url, client, gson)
                 .addAuthenticationParameters(parameters);
     }
-
-    static Gson buildGson() {
-        return new GsonBuilder()
-                .registerTypeAdapterFactory(new JsonRequiredTypeAdapterFactory())
-                .create();
-    }
 }

auth0/src/main/java/com/auth0/authentication/GsonProvider.java

@@ -0,0 +1,17 @@
+package com.auth0.authentication;
+
+import com.auth0.util.JsonRequiredTypeAdapterFactory;
+import com.auth0.authentication.result.UserProfile;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+
+abstract class GsonProvider {
+
+    static Gson buildGson() {
+        return new GsonBuilder()
+                .registerTypeAdapterFactory(new JsonRequiredTypeAdapterFactory())
+                .registerTypeAdapter(UserProfile.class, new UserProfileDeserializer())
+                .setDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")
+                .create();
+    }
+}

auth0/src/main/java/com/auth0/authentication/UserProfileDeserializer.java

@@ -0,0 +1,50 @@
+package com.auth0.authentication;
+
+import com.auth0.authentication.result.UserIdentity;
+import com.auth0.authentication.result.UserProfile;
+import com.google.gson.*;
+import com.google.gson.reflect.TypeToken;
+import com.sun.org.apache.xpath.internal.operations.Bool;
+
+import java.lang.reflect.Type;
+import java.util.Date;
+import java.util.List;
+import java.util.Map;
+
+class UserProfileDeserializer implements JsonDeserializer<UserProfile> {
+    @Override
+    public UserProfile deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
+        if (!json.isJsonObject() || json.isJsonNull()) {
+            throw new JsonParseException("user profile json is not a valid json object");
+        }
+
+        JsonObject object = json.getAsJsonObject();
+        final String id = requiredValue("user_id", String.class, object, context);
+        final String name = requiredValue("name", String.class, object, context);
+        final String nickname = requiredValue("nickname", String.class, object, context);
+        final String picture = requiredValue("picture", String.class, object, context);
+
+        final String email = context.deserialize(object.remove("email"), String.class);
+        final String givenName = context.deserialize(object.remove("given_name"), String.class);
+        final String familyName = context.deserialize(object.remove("family_name"), String.class);
+        final Boolean emailVerified = object.has("email_verified") ? context.<Boolean>deserialize(object.remove("email_verified"), Boolean.class) : false;
+        final Date createdAt = context.deserialize(object.remove("created_at"), Date.class);
+
+        final Type identitiesType = new TypeToken<List<UserIdentity>>(){}.getType();
+        final List<UserIdentity> identities = context.deserialize(object.remove("identities"), identitiesType);
+
+        final Type metadataType = new TypeToken<Map<String, Object>>() {}.getType();
+        Map<String, Object> userMetadata = context.deserialize(object.remove("user_metadata"), metadataType);
+        Map<String, Object> appMetadata = context.deserialize(object.remove("app_metadata"), metadataType);
+        Map<String, Object> extraInfo = context.deserialize(object, metadataType);
+        return new UserProfile(id, name, nickname, picture, email, emailVerified, familyName, createdAt, identities, extraInfo, userMetadata, appMetadata, givenName);
+    }
+
+    private <T> T requiredValue(String name, Type type, JsonObject object, JsonDeserializationContext context) throws JsonParseException {
+        T value = context.deserialize(object.remove(name), type);
+        if (value == null) {
+            throw new JsonParseException(String.format("Missing required attribute %s", name));
+        }
+        return value;
+    }
+}

auth0/src/main/java/com/auth0/authentication/result/Credentials.java

@@ -25,6 +25,7 @@
 package com.auth0.authentication.result;
 
 
+import com.auth0.util.JsonRequired;
 import com.google.gson.annotations.SerializedName;
 
 /**
@@ -37,25 +38,20 @@
  */
 public class Credentials {
 
-    @SerializedName("id_token")
     @JsonRequired
-    protected String idToken;
     @SerializedName("access_token")
-    protected String accessToken;
+    private String accessToken;
+
+    @JsonRequired
     @SerializedName("token_type")
-    protected String type;
-    @SerializedName("refresh_token")
-    protected String refreshToken;
+    private String type;
 
-    protected Credentials(Credentials credentials) {
-        idToken = credentials.idToken;
-        accessToken = credentials.accessToken;
-        type = credentials.type;
-        refreshToken = credentials.refreshToken;
-    }
+    @SerializedName("id_token")
+    private String idToken;
 
-    protected Credentials() {
-    }
+
+    @SerializedName("refresh_token")
+    private String refreshToken;
 
     public Credentials(String idToken, String accessToken, String type, String refreshToken) {
         this.idToken = idToken;

auth0/src/main/java/com/auth0/authentication/result/DatabaseUser.java

@@ -24,6 +24,7 @@
 
 package com.auth0.authentication.result;
 
+import com.auth0.util.JsonRequired;
 import com.google.gson.annotations.SerializedName;
 
 /**