Fixes #564 - Support of Base64url encoding and decoding (#870)

neo4j-contrib · Aug 8, 2018 · 7070052 · 7070052
1 parent bdd9646
commit 7070052
Show file tree

Hide file tree

Showing 4 changed files with 114 additions and 1 deletion.
diff --git a/docs/overview.adoc b/docs/overview.adoc
@@ -872,6 +872,10 @@ Example: `'FRIEND|MENTORS>|<REPORTS_TO'` will match to :FRIEND relationships in
 | apoc.text.byteCount(text,[charset]) | return size of text in bytes
 | apoc.text.bytes(text,[charset]) - return bytes of the text
 | apoc.text.toCypher(value, {skipKeys,keepKeys,skipValues,keepValues,skipNull,node,relationship,start,end}) | tries it's best to convert the value to a cypher-property-string
+| apoc.text.base64Encode(text) - Encode a string with Base64
+| apoc.text.base64Decode(text) - Decode Base64 encoded string
+| apoc.text.base64UrlEncode(url) - Encode a url with Base64
+| apoc.text.base64UrlDecode(url) - Decode Base64 encoded url
 |===
 
 === Data Extraction

diff --git a/docs/text.adoc b/docs/text.adoc
@@ -132,6 +132,51 @@ RETURN apoc.text.toUpperCase("foo$$bar")        // "FOO_BAR"
 RETURN apoc.text.toUpperCase("foo 22 bar")      // "FOO_22_BAR"
 
 
+== Base64
+
+Encode or decode a string in base64 or base64Url
+
+_EncodeBase64_
+
+[source,cypher]
+RETURN apoc.text.base64Encode("neo4j") as value
+
+result:
+
+[source,text]
+bmVvNGo=
+
+
+_DecodeBase64_
+
+[source,cypher]
+RETURN apoc.text.base64Decode("bmVvNGo=") as value
+
+result:
+
+[source,text]
+neo4j
+
+
+_EncodeBase64Url_
+
+[source,cypher]
+RETURN apoc.text.base64EncodeUrl("http://neo4j.com/?test=test") as value
+
+result:
+[source,text]
+aHR0cDovL25lbzRqLmNvbS8_dGVzdD10ZXN0
+
+_DecodeBase64Url_
+
+[source,cypher]
+RETURN apoc.text.base64DecodeUrl("aHR0cDovL25lbzRqLmNvbS8_dGVzdD10ZXN0") as value
+
+result:
+
+[source,text]
+http://neo4j.com/?test=test
+
 == Random String
 
 You can generate a random string to a specified length by calling `apoc.text.random` with a length parameter and optional string of valid characters.

diff --git a/src/main/java/apoc/text/Strings.java b/src/main/java/apoc/text/Strings.java
@@ -445,6 +445,20 @@ public String base64Decode(@Name("text") String text) {
         return new String(decoded);
     }
 
+    @UserFunction
+    @Description("apoc.text.base64UrlEncode(text) YIELD value - Encode a url with Base64")
+    public String base64UrlEncode(@Name("url") String url) {
+        byte[] encoded = Base64.getUrlEncoder().encode(url.getBytes());
+        return new String(encoded);
+    }
+
+    @UserFunction
+    @Description("apoc.text.base64UrlDecode(url) YIELD value - Decode Base64 encoded url")
+    public String base64UrlDecode(@Name("url") String url) {
+        byte[] decoded = Base64.getUrlDecoder().decode(url.getBytes());
+        return new String(decoded);
+    }
+
     @UserFunction
     @Description("apoc.text.charAt(text, index) - the decimal value of the character at the given index")
     public Long charAt(@Name("text") String text, @Name("index") Long index) {

diff --git a/src/test/java/apoc/text/StringsTest.java b/src/test/java/apoc/text/StringsTest.java
@@ -528,6 +528,56 @@ public void testBase64Decode() {
         );
     }
 
+
+    @Test
+    public void testBase64EncodeWithUrl() {
+        String text = "http://neo4j.com/?test=test";
+
+        testCall(
+                db,
+                "RETURN apoc.text.base64Encode({text}) as value",
+                map("text", text),
+                row -> assertEquals("aHR0cDovL25lbzRqLmNvbS8/dGVzdD10ZXN0", row.get("value").toString())
+        );
+    }
+
+    @Test
+    public void testBase64DecodeWithUrl() {
+        String text = "aHR0cDovL25lbzRqLmNvbS8/dGVzdD10ZXN0";
+
+        testCall(
+                db,
+                "RETURN apoc.text.base64Decode({text}) as value",
+                map("text", text),
+                row -> assertEquals("http://neo4j.com/?test=test", row.get("value").toString())
+        );
+    }
+
+    @Test
+    public void testBase64EncodeUrl() {
+        String text = "http://neo4j.com/?test=test";
+
+        testCall(
+                db,
+                "RETURN apoc.text.base64UrlEncode({text}) as value",
+                map("text", text),
+                row -> assertEquals("aHR0cDovL25lbzRqLmNvbS8_dGVzdD10ZXN0", row.get("value").toString())
+        );
+    }
+
+    @Test
+    public void testBase64DecodeUrl() {
+        String text = "aHR0cDovL25lbzRqLmNvbS8_dGVzdD10ZXN0";
+
+        testCall(
+                db,
+                "RETURN apoc.text.base64UrlDecode({text}) as value",
+                map("text", text),
+                row -> assertEquals("http://neo4j.com/?test=test", row.get("value").toString())
+        );
+    }
+
+
     @Test
     public void testSorensenDiceSimilarity() {
         String text1 = "belly";
@@ -554,7 +604,7 @@ public void testSorensenDiceSimilarityWithTurkishLocale() {
 
     @Test
     public void testHexvalue() {
-        testCall(db,  "RETURN [x IN {values} | apoc.text.hexValue(x)] as value",  
+        testCall(db,  "RETURN [x IN {values} | apoc.text.hexValue(x)] as value",
                       map("values", Arrays.<Long>asList(null,0L,1L,255L,65534L,65536L,305419896L,2309737967L,4294967294L,187723572702975L)),
                       row -> assertEquals(Arrays.<String>asList(null,"0000","0001","00FF","FFFE","00010000","12345678","89ABCDEF","FFFFFFFE","0000AABBCCDDEEFF"), row.get("value")));
     }