Add ULI check digit API

Author: jmarin

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

@@ -0,0 +1,9 @@
+package hmda.api.model.public
+
+object ULIModel {
+
+  case class Loan(loanId: String)
+  case class ULI(loanId: String, checkDigit: Int, uli: String)
+  case class ULICheck(uli: String)
+  case class ULIValidated(isValid: Boolean)
+}

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

@@ -0,0 +1,13 @@
+package hmda.api.protocol.public
+
+import hmda.api.model.public.ULIModel.{ Loan, ULI, ULICheck, ULIValidated }
+import spray.json.DefaultJsonProtocol
+
+object ULIProtocol extends DefaultJsonProtocol {
+
+  implicit val loanFormat = jsonFormat1(Loan.apply)
+  implicit val uliFormat = jsonFormat3(ULI.apply)
+  implicit val uliCheckFormat = jsonFormat1(ULICheck.apply)
+  implicit val uliValidated = jsonFormat1(ULIValidated.apply)
+
+}

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

@@ -6,6 +6,11 @@ import akka.stream.ActorMaterializer
 import akka.util.Timeout
 import hmda.api.http.HmdaCustomDirectives
 import akka.http.scaladsl.server.Directives._
+import hmda.api.model.public.ULIModel.{ Loan, ULI, ULICheck, ULIValidated }
+import hmda.api.protocol.public.ULIProtocol._
+import hmda.validation.engine.lar.ULI._
+import akka.http.scaladsl.marshallers.sprayjson.SprayJsonSupport._
+import akka.http.scaladsl.marshalling.ToResponseMarshallable
 
 import scala.concurrent.ExecutionContext
 
@@ -22,7 +27,29 @@ trait PublicHttpApi extends PublicLarHttpApi with HmdaCustomDirectives {
       encodeResponse {
         pathPrefix("institutions" / Segment) { instId =>
           modifiedLar(instId)
-        }
+        } ~
+          pathPrefix("uli") {
+            path("check-digit") {
+              timedPost { _ =>
+                entity(as[Loan]) { loan =>
+                  val loanId = loan.loanId
+                  val check = checkDigit(loanId)
+                  val uli = ULI(loanId, check.toInt, loanId + check)
+                  complete(ToResponseMarshallable(uli))
+                }
+              }
+            } ~
+              path("validate") {
+                timedPost { _ =>
+                  entity(as[ULICheck]) { uc =>
+                    val uli = uc.uli
+                    val isValid = validateULI(uli)
+                    val validated = ULIValidated(isValid)
+                    complete(ToResponseMarshallable(validated))
+                  }
+                }
+              }
+          }
       }
     }
 }

validation/src/main/scala/hmda/validation/engine/lar/ULI.scala

@@ -58,7 +58,7 @@ object ULI {
     uli + checkDigit(uli).toString()
   }
 
-  def validate(uli: String): Boolean = {
+  def validateULI(uli: String): Boolean = {
     calculateMod(BigInt(convert(uli))) == 1
   }
 

validation/src/test/scala/hmda/validation/engine/lar/ULISpec.scala

@@ -13,8 +13,8 @@ class ULISpec extends WordSpec with MustMatchers {
       ULI.generateULI(validULI) mustBe "10Bx939c5543TqA1144M999143X38"
     }
     "Validate ULI" in {
-      ULI.validate(validULI + "38") mustBe true
-      ULI.validate(invalidULI) mustBe false
+      ULI.validateULI(validULI + "38") mustBe true
+      ULI.validateULI(invalidULI) mustBe false
     }
   }
 }