Add CSV header

Author: jmarin

Documents/public-api.md

@@ -152,6 +152,7 @@ Example file contents:
 Example response in `CSV` format:
 
 ```csv
+loanId,checkDigit,uli
 10Bx939c5543TqA1144M999143X,38,10Bx939c5543TqA1144M999143X38
 10Cx939c5543TqA1144M999143X,10,10Cx939c5543TqA1144M999143X10
 ```
@@ -224,6 +225,7 @@ Example file contents:
 Example response in `CSV` format:
 
 ```csv
+uli,isValid
 10Cx939c5543TqA1144M999143X10,true
 10Bx939c5543TqA1144M999143X38,true
 10Bx939c5543TqA1144M999133X38,false

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

@@ -63,12 +63,14 @@ trait PublicHttpApi extends PublicLarHttpApi with HmdaCustomDirectives with ApiE
                 timedPost { _ =>
                   fileUpload("file") {
                     case (_, byteSource) =>
+                      val headerSource = Source.fromIterator(() => List("loanId,checkDigit,uli\n").toIterator)
                       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))
+                      val csv = headerSource.map(s => ByteString(s)).concat(checkDigit)
+                      complete(HttpEntity.Chunked.fromData(`text/csv`.toContentType(HttpCharsets.`UTF-8`), csv))
 
                     case _ =>
                       complete(ToResponseMarshallable(StatusCodes.BadRequest))
@@ -103,12 +105,14 @@ trait PublicHttpApi extends PublicLarHttpApi with HmdaCustomDirectives with ApiE
                 timedPost { _ =>
                   fileUpload("file") {
                     case (_, byteSource) =>
+                      val headerSource = Source.fromIterator(() => List("uli,isValid\n").toIterator)
                       val validated = processUliFile(byteSource)
                         .map(u => u.toCSV)
                         .map(l => l + "\n")
                         .map(s => ByteString(s))
 
-                      complete(HttpEntity.Chunked.fromData(`text/csv`.toContentType(HttpCharsets.`UTF-8`), validated))
+                      val csv = headerSource.map(s => ByteString(s)).concat(validated)
+                      complete(HttpEntity.Chunked.fromData(`text/csv`.toContentType(HttpCharsets.`UTF-8`), csv))
 
                     case _ =>
                       complete(ToResponseMarshallable(StatusCodes.BadRequest))

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

@@ -73,6 +73,7 @@ class PublicHttpApiSpec extends WordSpec with MustMatchers with BeforeAndAfterAl
       Post("/uli/checkDigit/csv", loanFile) ~> publicHttpRoutes ~> check {
         status mustBe StatusCodes.OK
         val csv = responseAs[String]
+        csv must include("loanId,checkDigit,uli")
         csv must include("10Bx939c5543TqA1144M999143X,38,10Bx939c5543TqA1144M999143X38")
         csv must include("10Cx939c5543TqA1144M999143X,10,10Cx939c5543TqA1144M999143X10")
       }
@@ -86,6 +87,7 @@ class PublicHttpApiSpec extends WordSpec with MustMatchers with BeforeAndAfterAl
       Post("/uli/validate/csv", uliFile) ~> publicHttpRoutes ~> check {
         status mustBe StatusCodes.OK
         val csv = responseAs[String]
+        csv must include("uli,isValid")
         csv must include("10Cx939c5543TqA1144M999143X10,true")
         csv must include("10Bx939c5543TqA1144M999143X38,true")
         csv must include("10Bx939c5543TqA1144M999133X38,false")