allow to get Claim as custom class

lbalmaceda · lbalmaceda · commit 973f989541b7 · 2016-12-14T18:35:10.000-03:00
diff --git a/README.md b/README.md
@@ -286,8 +286,6 @@ JWT.require(Algorithm.HMAC256("secret"))
     .verify("my.jwt.token");
 ```
 
-> The value of the custom Claim in all the cases must be of a `Integer`, `Double`, `Date`, `String`, or `Boolean` class.
-
 
 ### Claim Class
 The Claim class is a wrapper for the Claim values. It allows you to get the Claim as different class types. The available helpers are:
@@ -299,13 +297,14 @@ The Claim class is a wrapper for the Claim values. It allows you to get the Clai
 * **asString()**: Returns the String value or null if it can't be converted.
 * **asDate()**: Returns the Date value or null if it can't be converted. This must be a NumericDate (Unix Epoch/Timestamp). Note that the [JWT Standard](https://tools.ietf.org/html/rfc7519#section-2) specified that all the *NumericDate* values must be in seconds.
 
-#### Collections
+#### Custom Class and Collections
 To obtain a Claim as a Collection you'll need to provide the **Class Type** of the contents to convert from.
 
+* **as(class)**: Returns the value parsed as **Class Type**.
 * **asArray(class)**: Returns the value parsed as an Array of elements of type **Class Type**, or null if the value isn't a JSON Array.
 * **asList(class)**: Returns the value parsed as a List of elements of type **Class Type**, or null if the value isn't a JSON Array.
 
-If the values inside the JSON Array can't be converted to the given **Class Type**, a `JWTDecodeException` will raise.
+If the values can't be converted to the given **Class Type** a `JWTDecodeException` will raise.
 
 
 
diff --git a/lib/src/main/java/com/auth0/jwt/impl/JsonNodeClaim.java b/lib/src/main/java/com/auth0/jwt/impl/JsonNodeClaim.java
@@ -89,6 +89,16 @@ public <T> List<T> asList(Class<T> tClazz) throws JWTDecodeException {
         return list;
     }
 
+    @Override
+    public <T> T as(Class<T> tClazz) throws JWTDecodeException {
+        ObjectMapper mapper = new ObjectMapper();
+        try {
+            return mapper.treeToValue(data, tClazz);
+        } catch (JsonProcessingException e) {
+            throw new JWTDecodeException("Couldn't map the Claim value to " + tClazz.getSimpleName(), e);
+        }
+    }
+
     @Override
     public boolean isNull() {
         return !(data.isArray() || data.canConvertToLong() || data.isTextual() || data.isNumber() || data.isBoolean());
diff --git a/lib/src/main/java/com/auth0/jwt/impl/NullClaim.java b/lib/src/main/java/com/auth0/jwt/impl/NullClaim.java
@@ -49,4 +49,9 @@ public <T> T[] asArray(Class<T> tClazz) throws JWTDecodeException {
     public <T> List<T> asList(Class<T> tClazz) throws JWTDecodeException {
         return null;
     }
+
+    @Override
+    public <T> T as(Class<T> tClazz) throws JWTDecodeException {
+        return null;
+    }
 }
diff --git a/lib/src/main/java/com/auth0/jwt/interfaces/Claim.java b/lib/src/main/java/com/auth0/jwt/interfaces/Claim.java
@@ -69,4 +69,12 @@ public interface Claim {
      * @throws JWTDecodeException if the values inside the List can't be converted to a class T.
      */
     <T> List<T> asList(Class<T> tClazz) throws JWTDecodeException;
+
+    /**
+     * Get this Claim as a custom type T.
+     *
+     * @return the value as instance of T.
+     * @throws JWTDecodeException if the value can't be converted to a class T.
+     */
+    <T> T as(Class<T> tClazz) throws JWTDecodeException;
 }
diff --git a/lib/src/test/java/com/auth0/jwt/impl/BasicHeaderTest.java b/lib/src/test/java/com/auth0/jwt/impl/BasicHeaderTest.java
@@ -14,7 +14,7 @@
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.*;
 
-public class HeaderImplTest {
+public class BasicHeaderTest {
 
     @Rule
     public ExpectedException exception = ExpectedException.none();
diff --git a/lib/src/test/java/com/auth0/jwt/impl/JsonNodeClaimTest.java b/lib/src/test/java/com/auth0/jwt/impl/JsonNodeClaimTest.java
@@ -7,22 +7,22 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.MissingNode;
 import com.fasterxml.jackson.databind.node.NullNode;
+import org.hamcrest.collection.IsMapContaining;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
 
-import java.util.Arrays;
-import java.util.Date;
+import java.util.*;
 
-import static com.auth0.jwt.impl.JsonNodeClaim.claimFromNode;
 import static com.auth0.jwt.impl.JWTParser.getDefaultObjectMapper;
+import static com.auth0.jwt.impl.JsonNodeClaim.claimFromNode;
 import static org.hamcrest.Matchers.*;
 import static org.hamcrest.core.IsNull.notNullValue;
 import static org.hamcrest.core.IsNull.nullValue;
 import static org.junit.Assert.assertThat;
 
-public class ClaimImplTest {
+public class JsonNodeClaimTest {
 
     private ObjectMapper mapper;
     @Rule
@@ -204,6 +204,37 @@ public void shouldThrowIfListClassMismatch() throws Exception {
         claim.asList(UserPojo.class);
     }
 
+    @Test
+    public void shouldGetCustomClassValue() throws Exception {
+        JsonNode value = mapper.valueToTree(new UserPojo("john", 123));
+        Claim claim = claimFromNode(value);
+
+        assertThat(claim, is(notNullValue()));
+        assertThat(claim.as(UserPojo.class).getName(), is("john"));
+        assertThat(claim.as(UserPojo.class).getId(), is(123));
+    }
+
+    @Test
+    public void shouldThrowIfCustomClassMismatch() throws Exception {
+        JsonNode value = mapper.valueToTree(new UserPojo("john", 123));
+        Claim claim = claimFromNode(value);
+
+        exception.expect(JWTDecodeException.class);
+        claim.as(String.class);
+    }
+
+    @SuppressWarnings("unchecked")
+    @Test
+    public void shouldGetAsMapValue() throws Exception {
+        JsonNode value = mapper.valueToTree(Collections.singletonMap("key", new UserPojo("john", 123)));
+        Claim claim = claimFromNode(value);
+
+        assertThat(claim, is(notNullValue()));
+        Map map = claim.as(Map.class);
+        assertThat(((HashMap<String, Object>) map.get("key")), IsMapContaining.hasEntry("name", "john"));
+        assertThat(((HashMap<String, Object>) map.get("key")), IsMapContaining.hasEntry("id", 123));
+    }
+
     @Test
     public void shouldReturnBaseClaimWhenParsingMissingNode() throws Exception {
         JsonNode value = MissingNode.getInstance();

Original file line number	Diff line number	Diff line change
`@@ -49,4 +49,9 @@ public <T> T[] asArray(Class<T> tClazz) throws JWTDecodeException {`
`49`	`49`	`public <T> List<T> asList(Class<T> tClazz) throws JWTDecodeException {`
`50`	`50`	`return null;`
`51`	`51`	`}`
	`52`	`+`
	`53`	`+ @Override`
	`54`	`+ public <T> T as(Class<T> tClazz) throws JWTDecodeException {`
	`55`	`+ return null;`
	`56`	`+ }`
`52`	`57`	`}`