Merge pull request #22 from hmrc/PE-3061

PE-3061: Add ISO 3166 Alpha-2-code country code to the address
hmrc · Jul 6, 2017 · 4bd5389 · 4bd5389
2 parents 56f0d6d + 3af0de5
commit 4bd5389
Show file tree

Hide file tree

Showing 14 changed files with 328 additions and 300 deletions.
diff --git a/app/uk/gov/hmrc/openidconnect/userinfo/data/UserInfoGenerator.scala b/app/uk/gov/hmrc/openidconnect/userinfo/data/UserInfoGenerator.scala
@@ -29,7 +29,7 @@ trait UserInfoGenerator {
     """221B Baker Street
       |London
       |NW1 9NT
-      |Great Britain""".stripMargin, Some("NW1 9NT"), Some("Great Britain")))
+      |Great Britain""".stripMargin, Some("NW1 9NT"), Some("Great Britain"), Some("GB")))
   val enrolments = Seq(Enrolment("IR-SA", List(EnrolmentIdentifier("UTR", "174371121"))))
   val government_gateway: GovernmentGatewayDetails = GovernmentGatewayDetails(Some("32131"),Some(Token("ggToken")),Some("User"),Some("affinityGroup"))
 

diff --git a/app/uk/gov/hmrc/openidconnect/userinfo/domain/UserInfo.scala b/app/uk/gov/hmrc/openidconnect/userinfo/domain/UserInfo.scala
@@ -20,7 +20,8 @@ import org.joda.time.LocalDate
 
 case class Address(formatted: String,
                    postal_code: Option[String],
-                   country: Option[String])
+                   country: Option[String],
+                   code: Option[String])
 
 case class UserInfo(given_name: Option[String],
                     family_name: Option[String],
@@ -55,3 +56,6 @@ case class DesAddress(line1: Option[String],
                       line4: Option[String],
                       postcode: Option[String],
                       countryCode: Option[Int])
+
+case class Country(shortName: Option[String],
+                   alphaTwoCode: Option[String])
diff --git a/app/uk/gov/hmrc/openidconnect/userinfo/domain/package.scala b/app/uk/gov/hmrc/openidconnect/userinfo/domain/package.scala
@@ -27,6 +27,13 @@ package object domain {
 
   implicit val desAddress = Json.format[DesAddress]
 
+  implicit val country: Reads[Country] = (
+    (__ \ "short_name").readNullable[String] and
+    (__ \ "alpha_two_code").readNullable[String]
+  )(Country.apply _)
+
+  implicit val countriesMap = Reads.mapReads[Country]
+
   implicit val desUserInfo : Reads[DesUserInfo] = (
   (JsPath \ "names" \ "1").read[DesUserName] and
   (JsPath \ "dateOfBirth").readNullable[LocalDate] and

diff --git a/app/uk/gov/hmrc/openidconnect/userinfo/services/CountryService.scala b/app/uk/gov/hmrc/openidconnect/userinfo/services/CountryService.scala
@@ -16,23 +16,25 @@
 
 package uk.gov.hmrc.openidconnect.userinfo.services
 
+import play.api.libs.json.Json
+import uk.gov.hmrc.openidconnect.userinfo.domain.Country
+
 import scala.io.Source
 
 trait CountryService {
 
-  val countries: Map[String, String]
+  val countries: Map[String, Country]
 
-  def getCountry(countryCode: Int): Option[String] = countries.get(countryCode.toString)
+  def getCountry(countryCode: Int): Option[Country] = countries.get(countryCode.toString)
 }
 
 object CountryService extends CountryService {
-  override val countries = loadCountriesFromFile("/resources/country.properties")
+  override val countries = loadCountriesFromFile("/resources/country.json")
 
   private def loadCountriesFromFile(file: String) = {
     val is = getClass.getResourceAsStream(file)
     try {
-      val lines = Source.fromInputStream(is).getLines().toSeq
-      lines.map(_.split("=")).map(t => (t(0), t(1))).toMap
+      Json.parse(Source.fromInputStream(is).mkString).as[Map[String, Country]]
     } finally is.close()
   }
 }
diff --git a/app/uk/gov/hmrc/openidconnect/userinfo/services/UserInfoTransformer.scala b/app/uk/gov/hmrc/openidconnect/userinfo/services/UserInfoTransformer.scala
@@ -17,7 +17,7 @@
 package uk.gov.hmrc.openidconnect.userinfo.services
 
 import org.joda.time.LocalDate
-import uk.gov.hmrc.openidconnect.userinfo.domain.{Address, Authority, DesAddress, DesUserInfo, Enrolment, GovernmentGatewayDetails, UserDetails, UserInfo}
+import uk.gov.hmrc.openidconnect.userinfo.domain.{Address, Authority, Country, DesAddress, DesUserInfo, Enrolment, GovernmentGatewayDetails, UserDetails, UserInfo}
 import uk.gov.hmrc.play.http.Token
 
 trait UserInfoTransformer {
@@ -30,7 +30,9 @@ trait UserInfoTransformer {
 
     def address = if (scopes.contains("address")) {
       val country = desUserInfo flatMap (u => u.address.countryCode flatMap countryService.getCountry)
-      desUserInfo map (u => Address(formattedAddress(u.address, country), u.address.postcode, country))
+      val countryName = country flatMap {c => c.shortName}
+      val countryCode = country flatMap {c => c.alphaTwoCode}
+      desUserInfo map (u => Address(formattedAddress(u.address, country), u.address.postcode, countryName, countryCode))
     } else None
 
     val identifier = if (scopes.contains("openid:gov-uk-identifiers")) authority flatMap  {a => a.nino map {n => n}} else None
@@ -54,8 +56,10 @@ trait UserInfoTransformer {
       ggInfo)
   }
 
-  private def formattedAddress(desAddress: DesAddress, country: Option[String]) = {
-    Seq(desAddress.line1, desAddress.line2, desAddress.line3, desAddress.line4, desAddress.postcode, country).flatten.mkString("\n")
+  private def formattedAddress(desAddress: DesAddress, country: Option[Country]) = {
+    val countryName = country flatMap {c => c.shortName}
+    val countryCode = country flatMap {c => c.alphaTwoCode}
+    Seq(desAddress.line1, desAddress.line2, desAddress.line3, desAddress.line4, desAddress.postcode, countryName, countryCode).flatten.mkString("\n")
   }
 
   private def formatGGInfo(authority: Option[Authority], userDetails: Option[UserDetails], token: Option[Token]): Option[GovernmentGatewayDetails] = {