Add string extension for decoding URLs (#89)

* Add string extension for decoding URLs

* Refactor Person controller to use decodeUrl string extension

* Rename decodeUrl to decodeUrlCharacters

* Add test to confirm returns string back when no encoded URL characters

Author: chubberlisk

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/PersonController.kt

@@ -8,15 +8,14 @@ import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RequestParam
 import org.springframework.web.bind.annotation.RestController
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.exception.EntityNotFoundException
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.decodeUrlCharacters
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.Address
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.ImageMetadata
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.Person
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.GetAddressesForPersonService
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.GetImageMetadataForPersonService
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.GetPersonService
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.GetPersonsService
-import java.net.URLDecoder
-import java.nio.charset.StandardCharsets
 
 @RestController
 @RequestMapping("/persons")
@@ -43,7 +42,7 @@ class PersonController(
 
   @GetMapping("{encodedPncId}")
   fun getPerson(@PathVariable encodedPncId: String): Map<String, Person?> {
-    val pncId = URLDecoder.decode(encodedPncId, StandardCharsets.UTF_8)
+    val pncId = encodedPncId.decodeUrlCharacters()
     val result = getPersonService.execute(pncId)
 
     if (result.isNullOrEmpty()) {
@@ -55,17 +54,17 @@ class PersonController(
 
   @GetMapping("{encodedPncId}/images")
   fun getPersonImages(@PathVariable encodedPncId: String): Map<String, List<ImageMetadata>> {
-    val pncId = URLDecoder.decode(encodedPncId, StandardCharsets.UTF_8)
+    val pncId = encodedPncId.decodeUrlCharacters()
     val images = getImageMetadataForPersonService.execute(pncId)
 
     return mapOf("images" to images)
   }
 
   @GetMapping("{encodedPncId}/addresses")
   fun getPersonAddresses(@PathVariable encodedPncId: String): Map<String, List<Address>> {
-    val pncId = URLDecoder.decode(encodedPncId, StandardCharsets.UTF_8)
-    val addresses =
-      getAddressesForPersonService.execute(pncId) ?: throw EntityNotFoundException("Could not find person with id: $pncId")
+    val pncId = encodedPncId.decodeUrlCharacters()
+    val addresses = getAddressesForPersonService.execute(pncId)
+      ?: throw EntityNotFoundException("Could not find person with id: $pncId")
 
     return mapOf("addresses" to addresses)
   }

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/extensions/StringExtension.kt

@@ -1,3 +1,8 @@
 package uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions
 
+import java.net.URLDecoder
+import java.nio.charset.StandardCharsets
+
 fun String.removeWhitespaceAndNewlines(): String = this.replace("(\"[^\"]*\")|\\s".toRegex(), "\$1")
+
+fun String.decodeUrlCharacters(): String = URLDecoder.decode(this, StandardCharsets.UTF_8)

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/extensions/StringExtensionTest.kt

@@ -23,4 +23,14 @@ class StringExtensionTest : DescribeSpec({
       """.removeWhitespaceAndNewlines().shouldBe("{\"cat\":\"meow meow\"}")
     }
   }
+
+  describe("#decodeUrlCharacters") {
+    it("decodes URL encoded string") {
+      "never%21gonna%26give%2Fyou%23up".decodeUrlCharacters().shouldBe("never!gonna&give/you#up")
+    }
+
+    it("returns same string when no URL encoded characters") {
+      "never/gonna/give/you/up".decodeUrlCharacters().shouldBe("never/gonna/give/you/up")
+    }
+  }
 },)