protocol and tests, needs a fix

Author: Nick Grippin

publication/src/main/scala/hmda/publication/reports/national/NationalAggregateReports.scala

@@ -5,12 +5,13 @@ import akka.stream.ActorMaterializer
 import akka.util.Timeout
 import com.typesafe.config.ConfigFactory
 import hmda.query.repository.filing.FilingCassandraRepository
+import hmda.publication.reports.protocol.national.N52Protocol._
 
 import scala.concurrent.Future
 import scala.concurrent.duration._
 import spray.json._
 
-class NationalAggregateReports (val sys: ActorSystem, val mat: ActorMaterializer) extends FilingCassandraRepository {
+class NationalAggregateReports(val sys: ActorSystem, val mat: ActorMaterializer) extends FilingCassandraRepository {
   override implicit def system: ActorSystem = sys
   override implicit def materializer: ActorMaterializer = mat
   val config = ConfigFactory.load()

publication/src/main/scala/hmda/publication/reports/protocol/national/N52Protocol.scala

@@ -0,0 +1,47 @@
+package hmda.publication.reports.protocol.national
+
+import hmda.model.publication.reports.ReportTypeEnum._
+import hmda.model.publication.reports.{ ApplicantIncome, Disposition }
+import hmda.publication.reports.national.N52
+import hmda.publication.reports.protocol.{ ApplicantIncomeProtocol, MSAReportProtocol, ReportTypeEnumProtocol }
+import spray.json._
+
+object N52Protocol
+    extends DefaultJsonProtocol
+    with ReportTypeEnumProtocol
+    with MSAReportProtocol
+    with ApplicantIncomeProtocol {
+
+  implicit object N52Format extends RootJsonFormat[N52] {
+    override def write(obj: N52): JsValue = {
+      JsObject(
+        "table" -> JsString("5-2"),
+        "type" -> JsString(NationalAggregate.toString),
+        "desc" -> JsString(obj.description),
+        "year" -> JsNumber(obj.year),
+        "reportDate" -> JsString(obj.reportDate),
+        "applicantIncomes" -> obj.applicantIncomes.toJson,
+        "total" -> obj.total.toJson
+      )
+    }
+
+    override def read(json: JsValue): N52 = json.asJsObject.getFields(
+      "table",
+      "type",
+      "desc",
+      "year",
+      "reportDate",
+      "applicantIncomes",
+      "total"
+    ) match {
+        case Seq(table, reportType, description, year, reportDate, applicantIncomes, total) =>
+          N52(
+            year.convertTo[Int],
+            reportDate.convertTo[String],
+            applicantIncomes.convertTo[List[ApplicantIncome]],
+            total.convertTo[List[Disposition]]
+          )
+      }
+  }
+
+}

publication/src/test/scala/hmda/publication/reports/national/N52ProtocolSpec.scala

@@ -0,0 +1,30 @@
+package hmda.publication.reports.national
+
+import org.scalatest.prop.PropertyChecks
+import org.scalatest.{ MustMatchers, PropSpec }
+import spray.json._
+import NationalAggregateReportGenerators._
+import hmda.publication.reports.protocol.national.N52Protocol._
+
+class N52ProtocolSpec extends PropSpec with PropertyChecks with MustMatchers {
+
+  property("N52 Report must convert to and from JSON") {
+    forAll(n52Gen) { n52 =>
+      n52.toJson.convertTo[N52] mustBe n52
+    }
+  }
+
+  property("N52 Report must serialize to the correct JSON format") {
+    forAll(n52Gen) { n52 =>
+      n52.toJson mustBe JsObject(
+        "table" -> JsString("5-2"),
+        "type" -> JsString("National Aggregate"),
+        "desc" -> JsString("Disposition of Applications for Conventional Home-Purchase Loans, 1-to-4 Family and Manufactured Home Dwellings, by Income, Race, and Ethnicity of Applicant"),
+        "year" -> JsNumber(n52.year),
+        "reportDate" -> JsString(n52.reportDate),
+        "applicantIncomes" -> n52.applicantIncomes.toJson,
+        "total" -> n52.total.toJson
+      )
+    }
+  }
+}

publication/src/test/scala/hmda/publication/reports/national/N52Spec.scala

@@ -0,0 +1,66 @@
+package hmda.publication.reports.national
+
+import akka.NotUsed
+import akka.actor.ActorSystem
+import akka.stream.ActorMaterializer
+import akka.stream.scaladsl.Source
+import hmda.census.model.CbsaLookup
+import hmda.model.fi.lar.{ LarGenerators, LoanApplicationRegister }
+import hmda.model.publication.reports.ActionTakenTypeEnum._
+import hmda.model.publication.reports.ApplicantIncomeEnum.LessThan50PercentOfMSAMedian
+import hmda.model.publication.reports.{ EthnicityBorrowerCharacteristic, MinorityStatusBorrowerCharacteristic, RaceBorrowerCharacteristic }
+import hmda.query.model.filing.LoanApplicationRegisterQuery
+import hmda.query.repository.filing.LarConverter._
+import org.scalacheck.Gen
+import org.scalatest.{ AsyncWordSpec, BeforeAndAfterAll, MustMatchers }
+
+class N52Spec extends AsyncWordSpec with MustMatchers with LarGenerators with BeforeAndAfterAll {
+
+  implicit val system = ActorSystem()
+  implicit val ec = system.dispatcher
+  implicit val materializer = ActorMaterializer()
+
+  override def afterAll(): Unit = {
+    super.afterAll()
+    system.terminate()
+  }
+
+  val fips = CbsaLookup.values.map(_.cbsa)
+  val fipsGen = Gen.oneOf(fips)
+  def propType = Gen.oneOf(1, 2).sample.get
+
+  val lars = lar100ListGen.sample.get.map { lar: LoanApplicationRegister =>
+    val geo = lar.geography.copy(msa = fipsGen.sample.get)
+    val loan = lar.loan.copy(loanType = 1, propertyType = propType, purpose = 1)
+    lar.copy(geography = geo, loan = loan)
+  }
+
+  val source: Source[LoanApplicationRegisterQuery, NotUsed] = Source
+    .fromIterator(() => lars.toIterator)
+    .map(lar => toLoanApplicationRegisterQuery(lar))
+
+  val expectedDispositions = List(ApplicationReceived, LoansOriginated, ApprovedButNotAccepted, ApplicationsDenied, ApplicationsWithdrawn, ClosedForIncompleteness)
+
+  "Generate an National Aggregate 5-2 report" in {
+    N52.generate(source).map { result =>
+
+      result.table mustBe "5-2"
+      result.applicantIncomes.size mustBe 5
+
+      val lowestIncome = result.applicantIncomes.head
+      lowestIncome.applicantIncome mustBe LessThan50PercentOfMSAMedian
+
+      val races = lowestIncome.borrowerCharacteristics.head.asInstanceOf[RaceBorrowerCharacteristic].races
+      races.size mustBe 8
+
+      val ethnicities = lowestIncome.borrowerCharacteristics(1).asInstanceOf[EthnicityBorrowerCharacteristic].ethnicities
+      ethnicities.size mustBe 4
+
+      val minorityStatuses = lowestIncome.borrowerCharacteristics(2).asInstanceOf[MinorityStatusBorrowerCharacteristic].minoritystatus
+      minorityStatuses.size mustBe 2
+
+      races.head.dispositions.map(_.disposition) mustBe expectedDispositions
+    }
+  }
+
+}

publication/src/test/scala/hmda/publication/reports/national/NationalAggregateReportGenerators.scala

@@ -0,0 +1,18 @@
+package hmda.publication.reports.national
+
+import java.util.Calendar
+
+import hmda.publication.reports.ReportGenerators._
+import hmda.publication.reports.util.DateUtil._
+import org.scalacheck.Gen
+
+object NationalAggregateReportGenerators {
+  implicit def n52Gen: Gen[N52] = {
+    for {
+      total <- totalDispositionGen
+      year = Calendar.getInstance().get(Calendar.YEAR)
+      reportDate = formatDate(Calendar.getInstance().toInstant)
+      applicantIncomes <- Gen.listOfN(5, applicantIncomeGen)
+    } yield N52(year, reportDate, applicantIncomes, total)
+  }
+}