#34 Implement getting claim by its name

IlyaLisov · Apr 11, 2024 · d281336 · d281336
1 parent 49cb91b
commit d281336
Show file tree

Hide file tree

Showing 5 changed files with 145 additions and 0 deletions.
diff --git a/src/main/java/io/github/ilyalisov/jwt/service/PersistentTokenServiceImpl.java b/src/main/java/io/github/ilyalisov/jwt/service/PersistentTokenServiceImpl.java
@@ -171,6 +171,20 @@ public Map<String, Object> claims(
         return new HashMap<>(claims.getPayload());
     }
 
+    @Override
+    public Object claim(
+            final String token,
+            final String key
+    ) {
+        Jws<Claims> claims = Jwts
+                .parser()
+                .verifyWith(this.key)
+                .build()
+                .parseSignedClaims(token);
+        return claims.getPayload()
+                .get(key);
+    }
+
     @Override
     public boolean invalidate(
             final String token

diff --git a/src/main/java/io/github/ilyalisov/jwt/service/TokenService.java b/src/main/java/io/github/ilyalisov/jwt/service/TokenService.java
@@ -87,4 +87,16 @@ Map<String, Object> claims(
             String token
     );
 
+    /**
+     * Returns claim of JWT token by its key.
+     *
+     * @param token JWT token
+     * @param key   key of claim
+     * @return value of claim or null if there is no value
+     */
+    Object claim(
+            String token,
+            String key
+    );
+
 }
diff --git a/src/main/java/io/github/ilyalisov/jwt/service/TokenServiceImpl.java b/src/main/java/io/github/ilyalisov/jwt/service/TokenServiceImpl.java
@@ -138,4 +138,18 @@ public Map<String, Object> claims(
         return new HashMap<>(claims.getPayload());
     }
 
+    @Override
+    public Object claim(
+            final String token,
+            final String key
+    ) {
+        Jws<Claims> claims = Jwts
+                .parser()
+                .verifyWith(this.key)
+                .build()
+                .parseSignedClaims(token);
+        return claims.getPayload()
+                .get(key);
+    }
+
 }
diff --git a/src/test/java/io/github/ilyalisov/jwt/service/PersistentTokenServiceImplTests.java b/src/test/java/io/github/ilyalisov/jwt/service/PersistentTokenServiceImplTests.java
@@ -14,6 +14,7 @@
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 class PersistentTokenServiceImplTests {
@@ -202,6 +203,58 @@ void shouldReturnCorrectClaims() {
         assertEquals(123, claims.get("key2"));
     }
 
+
+    @Test
+    void shouldReturnCorrectClaimValue() {
+        String subject = "testSubject";
+        String type = "any";
+        Duration duration = Duration.ofMinutes(30);
+        Map<String, Object> customClaims = new HashMap<>();
+        customClaims.put("key1", "value1");
+        customClaims.put("key2", 123);
+
+        TokenParameters params = TokenParameters.builder(
+                        subject,
+                        type,
+                        duration
+                )
+                .claims(customClaims)
+                .build();
+
+        String token = tokenService.create(params);
+        Object claim = tokenService.claim(
+                token,
+                "key1"
+        );
+        assertNotNull(claim);
+        assertEquals("value1", claim);
+    }
+
+    @Test
+    void shouldReturnNull() {
+        String subject = "testSubject";
+        String type = "any";
+        Duration duration = Duration.ofMinutes(30);
+        Map<String, Object> customClaims = new HashMap<>();
+        customClaims.put("key1", "value1");
+        customClaims.put("key2", 123);
+
+        TokenParameters params = TokenParameters.builder(
+                        subject,
+                        type,
+                        duration
+                )
+                .claims(customClaims)
+                .build();
+
+        String token = tokenService.create(params);
+        Object claim = tokenService.claim(
+                token,
+                "notExistingKey"
+        );
+        assertNull(claim);
+    }
+
     @Test
     void shouldInvalidateByToken() {
         String subject = "testSubject";

diff --git a/src/test/java/io/github/ilyalisov/jwt/service/TokenServiceImplTests.java b/src/test/java/io/github/ilyalisov/jwt/service/TokenServiceImplTests.java
@@ -11,6 +11,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 class TokenServiceImplTests {
@@ -176,4 +177,55 @@ void shouldReturnCorrectClaims() {
         assertEquals(123, claims.get("key2"));
     }
 
+    @Test
+    void shouldReturnCorrectClaimValue() {
+        String subject = "testSubject";
+        String type = "any";
+        Duration duration = Duration.ofMinutes(30);
+        Map<String, Object> customClaims = new HashMap<>();
+        customClaims.put("key1", "value1");
+        customClaims.put("key2", 123);
+
+        TokenParameters params = TokenParameters.builder(
+                        subject,
+                        type,
+                        duration
+                )
+                .claims(customClaims)
+                .build();
+
+        String token = tokenService.create(params);
+        Object claim = tokenService.claim(
+                token,
+                "key1"
+        );
+        assertNotNull(claim);
+        assertEquals("value1", claim);
+    }
+
+    @Test
+    void shouldReturnNull() {
+        String subject = "testSubject";
+        String type = "any";
+        Duration duration = Duration.ofMinutes(30);
+        Map<String, Object> customClaims = new HashMap<>();
+        customClaims.put("key1", "value1");
+        customClaims.put("key2", 123);
+
+        TokenParameters params = TokenParameters.builder(
+                        subject,
+                        type,
+                        duration
+                )
+                .claims(customClaims)
+                .build();
+
+        String token = tokenService.create(params);
+        Object claim = tokenService.claim(
+                token,
+                "notExistingKey"
+        );
+        assertNull(claim);
+    }
+
 }