hmrc · Ardesco · Jan 7, 2022 · Jan 7, 2022
diff --git a/app/Module.scala b/app/Module.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/apiplatform/DocumentationController.scala b/app/apiplatform/DocumentationController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/config/Capitalisation.scala b/app/config/Capitalisation.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/config/ConfigHelper.scala b/app/config/ConfigHelper.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/controllers/AddressController.scala b/app/controllers/AddressController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/controllers/AddressLookupIdController.scala b/app/controllers/AddressLookupIdController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/controllers/AddressSearchController.scala b/app/controllers/AddressSearchController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/controllers/PostcodesController.scala b/app/controllers/PostcodesController.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/controllers/services/AddressSearcher.scala b/app/controllers/services/AddressSearcher.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/controllers/services/AddressSearcherMetrics.scala b/app/controllers/services/AddressSearcherMetrics.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/controllers/services/ReferenceData.scala b/app/controllers/services/ReferenceData.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/controllers/services/ResponseProcessor.scala b/app/controllers/services/ResponseProcessor.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/controllers/services/package.scala b/app/controllers/services/package.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/model/AddressSearchAuditEvent.scala b/app/model/AddressSearchAuditEvent.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/model/address/Address.scala b/app/model/address/Address.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/model/address/AddressRecord.scala b/app/model/address/AddressRecord.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/model/address/AddressRecordConverter.scala b/app/model/address/AddressRecordConverter.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/model/address/Country.scala b/app/model/address/Country.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/model/address/Location.scala b/app/model/address/Location.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/model/address/Outcode.scala b/app/model/address/Outcode.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/model/address/Postcode.scala b/app/model/address/Postcode.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/model/internal.scala b/app/model/internal.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/model/request.scala b/app/model/request.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -44,7 +44,9 @@ object request {
 
     implicit val reads: Reads[LookupByPostcodeRequest] = (
         (JsPath \ "postcode").read[Postcode] and
-            (JsPath \ "filter").readNullable[String]
+            (JsPath \ "filter").readNullable[String].map(fo =>
+              fo.flatMap(f => if(f.trim.isEmpty) None else Some(f))
+            )
         ) (
       (pc, fo) => LookupByPostcodeRequest.apply(pc, fo))
 
@@ -70,7 +72,9 @@ object request {
   object LookupByPostTownRequest {
     implicit val reads: Reads[LookupByPostTownRequest] = (
         (JsPath \ "posttown").read[String].map(_.toUpperCase) and
-            (JsPath \ "filter").readNullable[String]
+            (JsPath \ "filter").readNullable[String].map(fo =>
+              fo.flatMap(f => if(f.trim.isEmpty) None else Some(f))
+            )
         ) (
       (pt, fo) => LookupByPostTownRequest.apply(pt, fo))
 

diff --git a/app/repositories/AddressLookupRepository.scala b/app/repositories/AddressLookupRepository.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/repositories/CSV.scala b/app/repositories/CSV.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/repositories/CsvLineSplitter.scala b/app/repositories/CsvLineSplitter.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/repositories/InMemoryAddressLookupRepository.scala b/app/repositories/InMemoryAddressLookupRepository.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/repositories/RdsQueryConfig.scala b/app/repositories/RdsQueryConfig.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/repositories/TransactorProvider.scala b/app/repositories/TransactorProvider.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/services/AddressLookupService.scala b/app/services/AddressLookupService.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/app/util/package.scala b/app/util/package.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/conf/application.conf b/conf/application.conf
@@ -1,4 +1,4 @@
-# Copyright 2021 HM Revenue & Customs
+# Copyright 2022 HM Revenue & Customs
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/test/unit/controllers/AddressLookupIdControllerTest.scala b/test/unit/controllers/AddressLookupIdControllerTest.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/test/unit/controllers/AddressSearchControllerTest.scala b/test/unit/controllers/AddressSearchControllerTest.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/test/unit/controllers/services/AddressSearcherMetricsTest.scala b/test/unit/controllers/services/AddressSearcherMetricsTest.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/test/unit/controllers/services/ResponseProcessorTest.scala b/test/unit/controllers/services/ResponseProcessorTest.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/test/unit/model/AddressTest.scala b/test/unit/model/AddressTest.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/test/unit/model/RequestTest.scala b/test/unit/model/RequestTest.scala
@@ -0,0 +1,85 @@
+/*
+ * Copyright 2022 HM Revenue & Customs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package model
+
+import model.address.Postcode
+import org.scalatest.matchers.should.Matchers
+import org.scalatest.wordspec.AnyWordSpec
+import play.api.libs.json._
+
+class RequestTest extends AnyWordSpec with Matchers {
+
+  import model.request.LookupByPostTownRequest
+
+  "LookupByPostTownRequest" should {
+    "de-serialise filter correctly" when {
+      "filter is specified and is non-empty" in {
+        val postTownJson = Json.parse("""{"posttown":"WINDSOR", "filter":"some-filter"}""")
+        val postTownRequest = Json.fromJson[LookupByPostTownRequest](postTownJson)
+        postTownRequest shouldBe a[JsSuccess[_]]
+        postTownRequest.get.posttown shouldBe "WINDSOR"
+        postTownRequest.get.filter shouldBe Some("some-filter")
+      }
+
+      "filter is not specified" in {
+        val postTownJson = Json.parse("""{"posttown":"WINDSOR"}""")
+        val postTownRequest = Json.fromJson[LookupByPostTownRequest](postTownJson)
+        postTownRequest shouldBe a[JsSuccess[_]]
+        postTownRequest.get.posttown shouldBe "WINDSOR"
+        postTownRequest.get.filter shouldBe None
+      }
+
+      "filter is specified but is empty" in {
+        val postTownJson = Json.parse("""{"posttown":"WINDSOR", "filter":""}""")
+        val postTownRequest = Json.fromJson[LookupByPostTownRequest](postTownJson)
+        postTownRequest shouldBe a[JsSuccess[_]]
+        postTownRequest.get.posttown shouldBe "WINDSOR"
+        postTownRequest.get.filter shouldBe None
+      }
+    }
+  }
+
+  "LookupByPostcodeRequest" should {
+    import model.request.LookupByPostcodeRequest
+
+    "de-serialise correctly" when {
+      "filter is specified and is non-empty" in {
+        val postCodeJson = Json.parse("""{"postcode":"SW6 6SA", "filter":"some-filter"}""")
+        val postCodeRequest = Json.fromJson[LookupByPostcodeRequest](postCodeJson)
+        postCodeRequest shouldBe a[JsSuccess[_]]
+        postCodeRequest.get.postcode shouldBe Postcode("SW6 6SA")
+        postCodeRequest.get.filter shouldBe Some("some-filter")
+      }
+
+      "filter is not specified" in {
+        val postCodeJson = Json.parse("""{"postcode":"SW6 6SA"}""")
+        val postCodeRequest = Json.fromJson[LookupByPostcodeRequest](postCodeJson)
+        postCodeRequest shouldBe a[JsSuccess[_]]
+        postCodeRequest.get.postcode shouldBe Postcode("SW6 6SA")
+        postCodeRequest.get.filter shouldBe None
+      }
+
+      "filter is specified but is empty" in {
+        val postCodeJson = Json.parse("""{"postcode":"SW6 6SA", "filter":""}""")
+        val postCodeRequest = Json.fromJson[LookupByPostcodeRequest](postCodeJson)
+        postCodeRequest shouldBe a[JsSuccess[_]]
+        postCodeRequest.get.postcode shouldBe Postcode("SW6 6SA")
+        postCodeRequest.get.filter shouldBe None
+      }
+    }
+  }
+}
diff --git a/test/unit/repositories/AddressLookupRepositoryTest.scala b/test/unit/repositories/AddressLookupRepositoryTest.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/test/unit/util/utils.scala b/test/unit/util/utils.scala
@@ -1,5 +1,5 @@
 /*
- * Copyright 2021 HM Revenue & Customs
+ * Copyright 2022 HM Revenue & Customs
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.