Add batch check digit

Author: jmarin

api-model/src/main/scala/hmda/api/model/public/ULIModel.scala

@@ -3,7 +3,10 @@ package hmda.api.model.public
 object ULIModel {
 
   case class Loan(loanId: String)
-  case class ULI(loanId: String, checkDigit: Int, uli: String)
+  case class ULI(loanId: String, checkDigit: Int, uli: String) {
+    def toCSV: String = s"$loanId,$checkDigit,$uli"
+  }
+  case class LoanCheckDigitResponse(loanIds: Seq[ULI])
   case class ULICheck(uli: String)
   case class ULIValidated(isValid: Boolean)
   case class ULIBatchValidated(uli: String, isValid: Boolean) {

api-model/src/main/scala/hmda/api/protocol/public/ULIProtocol.scala

@@ -7,6 +7,7 @@ trait ULIProtocol extends DefaultJsonProtocol {
 
   implicit val loanFormat = jsonFormat1(Loan.apply)
   implicit val uliFormat = jsonFormat3(ULI.apply)
+  implicit val loanCheckDigitResponse = jsonFormat1(LoanCheckDigitResponse.apply)
   implicit val uliCheckFormat = jsonFormat1(ULICheck.apply)
   implicit val uliValidatedFormat = jsonFormat1(ULIValidated.apply)
   implicit val uliBatchValidatedFormat = jsonFormat2(ULIBatchValidated.apply)

api/src/main/scala/hmda/api/http/public/PublicHttpApi.scala

@@ -16,6 +16,7 @@ import akka.stream.scaladsl.{ Sink, Source }
 import hmda.api.protocol.processing.ApiErrorProtocol
 import hmda.api.protocol.public.ULIProtocol
 import hmda.api.util.FlowUtils
+
 import scala.concurrent.ExecutionContext
 import scala.util.{ Failure, Success }
 
@@ -41,9 +42,39 @@ trait PublicHttpApi extends PublicLarHttpApi with HmdaCustomDirectives with ApiE
                   val check = checkDigit(loanId)
                   val uli = ULI(loanId, check.toInt, loanId + check)
                   complete(ToResponseMarshallable(uli))
-                }
+                } ~
+                  fileUpload("file") {
+                    case (_, byteSource) =>
+                      val checkDigitF = processLoanIdFile(byteSource).runWith(Sink.seq)
+                      onComplete(checkDigitF) {
+                        case Success(checkDigits) => {
+                          complete(ToResponseMarshallable(LoanCheckDigitResponse(checkDigits)))
+                        }
+                        case Failure(error) =>
+                          log.error(error.getLocalizedMessage)
+                          complete(ToResponseMarshallable(StatusCodes.InternalServerError))
+                      }
+                    case _ =>
+                      complete(ToResponseMarshallable(StatusCodes.BadRequest))
+                  }
               }
             } ~
+              path("check-digit" / "csv") {
+                timedPost { _ =>
+                  fileUpload("file") {
+                    case (_, byteSource) =>
+                      val checkDigit = processLoanIdFile(byteSource)
+                        .map(l => l.toCSV)
+                        .map(l => l + "\n")
+                        .map(s => ByteString(s))
+
+                      complete(HttpEntity.Chunked.fromData(`text/csv`.toContentType(HttpCharsets.`UTF-8`), checkDigit))
+
+                    case _ =>
+                      complete(ToResponseMarshallable(StatusCodes.BadRequest))
+                  }
+                }
+              } ~
               path("validate") {
                 timedPost { _ =>
                   entity(as[ULICheck]) { uc =>
@@ -88,6 +119,13 @@ trait PublicHttpApi extends PublicLarHttpApi with HmdaCustomDirectives with ApiE
       }
     }
 
+  private def processLoanIdFile(byteSource: Source[ByteString, Any]) = {
+    byteSource
+      .via(framing)
+      .map(_.utf8String)
+      .map(loanId => ULI(loanId, checkDigit(loanId).toInt, loanId + checkDigit(loanId)))
+  }
+
   private def processUliFile(byteSource: Source[ByteString, Any]) = {
     byteSource
       .via(framing)

api/src/test/scala/hmda/api/http/public/PublicHttpApiSpec.scala

@@ -32,6 +32,9 @@ class PublicHttpApiSpec extends WordSpec with MustMatchers with BeforeAndAfterAl
     "10Bx939c5543TqA1144M999143X38\n" +
     "10Bx939c5543TqA1144M999133X38\n"
 
+  val loanTxt = "10Bx939c5543TqA1144M999143X\n" +
+    "10Cx939c5543TqA1144M999143X"
+
   "Modified LAR Http API" must {
     "return list of modified LARs in proper format" in {
       Get("/institutions/0/filings/2017/lar") ~> publicHttpRoutes ~> check {
@@ -45,6 +48,7 @@ class PublicHttpApiSpec extends WordSpec with MustMatchers with BeforeAndAfterAl
 
   "ULI API" must {
     val uliFile = multiPartFile(uliTxt, "ulis.txt")
+    val loanFile = multiPartFile(loanTxt, "loanIds.txt")
     val loanId = "10Bx939c5543TqA1144M999143X"
     val checkDigit = 38
     val uli = "10Bx939c5543TqA1144M999143X" + checkDigit
@@ -56,6 +60,23 @@ class PublicHttpApiSpec extends WordSpec with MustMatchers with BeforeAndAfterAl
         responseAs[ULI] mustBe ULI(loanId, checkDigit, uli)
       }
     }
+    "return check digit and ULI from file of loan ids" in {
+      Post("/uli/check-digit", loanFile) ~> publicHttpRoutes ~> check {
+        status mustBe StatusCodes.OK
+        responseAs[LoanCheckDigitResponse].loanIds mustBe Seq(
+          ULI("10Bx939c5543TqA1144M999143X", 38, "10Bx939c5543TqA1144M999143X38"),
+          ULI("10Cx939c5543TqA1144M999143X", 10, "10Cx939c5543TqA1144M999143X10")
+        )
+      }
+    }
+    "return csv with check digit and ULI from file of loan ids" in {
+      Post("/uli/check-digit/csv", loanFile) ~> publicHttpRoutes ~> check {
+        status mustBe StatusCodes.OK
+        val csv = responseAs[String]
+        csv must include("10Bx939c5543TqA1144M999143X,38,10Bx939c5543TqA1144M999143X38")
+        csv must include("10Cx939c5543TqA1144M999143X,10,10Cx939c5543TqA1144M999143X10")
+      }
+    }
     "Validate ULI" in {
       Post("/uli/validate", uliCheck) ~> publicHttpRoutes ~> check {
         responseAs[ULIValidated] mustBe ULIValidated(true)