Merge pull request cfpb#1150 from nickgrippin/email-on-sign

Email on sign

Author: schbetsy

README.md

@@ -157,6 +157,11 @@ docker-compose -f docker-dev.yml up
 
 When finished, use `docker-compose down` to gracefully stop the running containers.
 
+In order to not get Postgres connection error upon signing a submission, you may want to start up the keycloak image as well.
+```shell
+docker-compose up keycloak
+```
+Not having the keycloak image running will produce an error in the console, but will not cause the platform to crash.
 
 #### Running the API
 
@@ -214,13 +219,13 @@ The Filing API will run on `$(docker-machine ip):8080`
 The Public API will run on `$(docker-machine ip):8082`
 
 By default, the `HDMA Platform` runs with a log level of `INFO`. This can be changed by establishing a different log level in the `HMDA_LOGLEVEL` environment variable.
-For the different logging options, see the [reference.conf](https://github.com/akka/akka/blob/master/akka-actor/src/main/resources/reference.conf#L38) default configuration file for `Akka`. 
+For the different logging options, see the [reference.conf](https://github.com/akka/akka/blob/master/akka-actor/src/main/resources/reference.conf#L38) default configuration file for `Akka`.
 
 #### To run the entire platform
 
 1. Ensure you have a Docker Machine with sufficient resources, as described in the [Docker](#docker) section above.
 
-1. Clone [hmda-platform-ui](https://github.com/cfpb/hmda-platform-ui) and 
+1. Clone [hmda-platform-ui](https://github.com/cfpb/hmda-platform-ui) and
     [hmda-platform-auth](https://github.com/cfpb/hmda-platform-auth) into the same
     directory as hmda-platform.
 
@@ -270,7 +275,7 @@ For the different logging options, see the [reference.conf](https://github.com/a
         **Note:** You must register with an email address from our whitelist of email domains.
         For convenience, `bank0.com` and `bank1.com` address should be available automatically.
 
-    1. Browse to the mock email server at https://192.168.99.100:8443/mail/, and select the 
+    1. Browse to the mock email server at https://192.168.99.100:8443/mail/, and select the
         verification link in the email found there.  This should take you back to the HMDA
         filing web app, now logged in.
 
@@ -281,7 +286,7 @@ For the different logging options, see the [reference.conf](https://github.com/a
 
 ##### Updating an existing system
 
-If you've updated any of the hmda-platform services, and would like to see those 
+If you've updated any of the hmda-platform services, and would like to see those
 changes reflected in the Docker Compose setup, the simplest way to do this is to
 rebuild everything from scratch.  The following command should be executed from
 within the `hmda-platform` directory.

api/src/main/resources/application.conf

@@ -27,6 +27,14 @@ hmda {
     timeout = 10
     timeout = ${?HMDA_HTTP_TIMEOUT}
   }
+  mail {
+    host = "mail_dev"
+    host = ${?HMDA_MAIL_HOST}
+    port = "25"
+    port = ${?HMDA_MAIL_PORT}
+    senderAddress = "no-reply@cfpb.gov"
+    senderAddress = ${?HMDA_MAIL_SENDER_ADDRESS}
+  }
   isDemo = false
   isDemo = ${?HMDA_IS_DEMO}
   panel {

api/src/main/scala/hmda/api/http/institutions/submissions/SubmissionSignPaths.scala

@@ -1,5 +1,7 @@
 package hmda.api.http.institutions.submissions
 
+import java.time.{ ZoneOffset, ZonedDateTime }
+
 import akka.actor.{ ActorRef, ActorSystem }
 import akka.event.LoggingAdapter
 import akka.pattern.ask
@@ -22,6 +24,15 @@ import spray.json.{ JsBoolean, JsFalse, JsObject, JsTrue }
 
 import scala.util.{ Failure, Success }
 import scala.concurrent.{ ExecutionContext, Future }
+import javax.mail._
+import javax.mail.internet.{ InternetAddress, MimeMessage }
+
+import com.typesafe.config.ConfigFactory
+import hmda.model.institution.Institution
+import hmda.persistence.model.HmdaSupervisorActor.FindActorByName
+import hmda.query.repository.KeyCloakRepository
+import hmda.query.view.institutions.InstitutionView
+import hmda.query.view.institutions.InstitutionView.GetInstitutionById
 
 trait SubmissionSignPaths
     extends InstitutionProtocol
@@ -30,7 +41,8 @@ trait SubmissionSignPaths
     with EditResultsProtocol
     with HmdaCustomDirectives
     with RequestVerificationUtils
-    with ValidationErrorConverter {
+    with ValidationErrorConverter
+    with KeyCloakRepository {
 
   implicit val system: ActorSystem
   implicit val materializer: ActorMaterializer
@@ -44,7 +56,7 @@ trait SubmissionSignPaths
       val submissionId = SubmissionId(institutionId, period, id)
       timedGet { uri =>
         completeVerified(supervisor, querySupervisor, institutionId, period, id, uri) {
-          completeWithSubmissionReceipt(supervisor, submissionId, uri)
+          completeWithSubmissionReceipt(supervisor, submissionId, uri, signed = false)
         }
       } ~
         timedPost { uri =>
@@ -59,7 +71,7 @@ trait SubmissionSignPaths
                     s <- actor ? hmda.persistence.processing.ProcessingMessages.Signed
                   } yield s
                   onComplete(fSign) {
-                    case Success(Some(_)) => completeWithSubmissionReceipt(supervisor, submissionId, uri)
+                    case Success(Some(_)) => completeWithSubmissionReceipt(supervisor, submissionId, uri, signed = true)
                     case Success(_) =>
                       val errorResponse = ErrorResponse(400, "Illegal State: Submission must be Validated or ValidatedWithErrors to sign", uri.path)
                       complete(ToResponseMarshallable(StatusCodes.BadRequest -> errorResponse))
@@ -76,7 +88,7 @@ trait SubmissionSignPaths
         }
     }
 
-  private def completeWithSubmissionReceipt(supervisor: ActorRef, subId: SubmissionId, uri: Uri)(implicit ec: ExecutionContext) = {
+  private def completeWithSubmissionReceipt(supervisor: ActorRef, subId: SubmissionId, uri: Uri, signed: Boolean)(implicit ec: ExecutionContext) = {
     val fSubmissionsActor = (supervisor ? FindSubmissions(SubmissionPersistence.name, subId.institutionId, subId.period)).mapTo[ActorRef]
     val fSubmission = for {
       a <- fSubmissionsActor
@@ -85,8 +97,69 @@ trait SubmissionSignPaths
 
     onComplete(fSubmission) {
       case Success(sub) =>
+        if (signed) {
+          emailSignature(supervisor, sub)
+        }
         complete(ToResponseMarshallable(Receipt(sub.end, sub.receipt, sub.status)))
       case Failure(error) => completeWithInternalError(uri, error)
     }
   }
+
+  private def emailSignature(supervisor: ActorRef, submission: Submission)(implicit ec: ExecutionContext) = {
+    val emails = findEmailsById(submission.id.institutionId)
+    val querySupervisor = system.actorSelection("/user/query-supervisor/singleton")
+    val fInstitutionsActor = (querySupervisor ? FindActorByName(InstitutionView.name)).mapTo[ActorRef]
+    val fName = for {
+      a <- fInstitutionsActor
+      i <- (a ? GetInstitutionById(submission.id.institutionId)).mapTo[Institution]
+      e <- emails
+    } yield (i.respondent.name, e)
+
+    fName.onComplete({
+      case Success((instName, emailSeq)) =>
+        emailSeq.foreach(t => {
+          val username = t._1 + " " + t._2
+          sendMail(t._3, username, submission, instName)
+        })
+      case Failure(error) => log.error(error, s"An error has occured retrieving the institution name for ID ${submission.id.institutionId}")
+    })
+  }
+
+  private def sendMail(address: String, username: String, submission: Submission, instName: String) = {
+    val config = ConfigFactory.load()
+    val host = config.getString("hmda.mail.host")
+    val port = config.getString("hmda.mail.port")
+    val senderAddress = config.getString("hmda.mail.senderAddress")
+
+    val properties = System.getProperties
+    properties.put("mail.smtp.host", host)
+    properties.put("mail.smtp.port", port)
+
+    val session = Session.getDefaultInstance(properties)
+    val message = new MimeMessage(session)
+
+    val date = getFormattedDate
+
+    val text = s"$username,\n\nCongratulations, you've completed filing your HMDA data for $instName for filing period ${submission.id.period}.\n" +
+      s"We received your filing on: $date\n" +
+      s"Your receipt is: ${submission.receipt}"
+    message.setFrom(new InternetAddress(senderAddress))
+    message.setRecipients(Message.RecipientType.TO, address)
+    message.setSubject("HMDA Filing Successful")
+    message.setText(text)
+
+    log.info(s"Sending message to $address with the message \n$text")
+    Transport.send(message)
+  }
+
+  private def getFormattedDate: String = {
+    val offset = ZoneOffset.ofHours(-5)
+    val zonedTime = ZonedDateTime.now(offset)
+
+    val day = zonedTime.getDayOfMonth
+    val month = zonedTime.getMonthValue
+    val year = zonedTime.getYear
+
+    s"$month/$day/$year"
+  }
 }

build.sbt

@@ -211,7 +211,7 @@ lazy val api = (project in file("api"))
           oldStrategy(x)
       },
       parallelExecution in Test := false,
-      libraryDependencies ++= httpDeps
+      libraryDependencies ++= httpDeps ++ Seq(javaMail)
     )
   )
   .dependsOn(persistenceModel % "compile->compile;test->test")

docker-compose.yml

@@ -45,7 +45,7 @@ services:
       APP_URL: https://192.168.99.100
       HMDA_API: https://192.168.99.100:4443/hmda
       KEYCLOAK_URL: https://192.168.99.100:8443/auth/realms/hmda
-      # lb settings 
+      # lb settings
       VIRTUAL_HOST: 'http://*:80/*, https://*:443/*'
       EXCLUDE_PORTS: '443' # use lb's ssl instead of ui's nginx
       FORCE_SSL: 'true' # redirect 80 to 443
@@ -82,6 +82,8 @@ services:
 
   keycloak_db:
     image: postgres:9.6.1
+    ports:
+          - '5433:5432'
     environment:
       POSTGRES_DB: keycloak
       POSTGRES_USER: keycloak

docker-dev.yml

@@ -11,4 +11,4 @@ services:
     ports:
       - '9042:9042'
       - '7000:7000'
-      - '7199:7199'
+      - '7199:7199'

persistence-model/src/main/scala/hmda/persistence/model/HmdaPersistentActor.scala

@@ -24,8 +24,10 @@ abstract class HmdaPersistentActor extends PersistentActor with HmdaActor {
   }
 
   override def receiveCommand: Receive = {
-    case ReceiveTimeout =>
+    case ReceiveTimeout => {
+      log.info("Received Timeout, sending Shutdown message. Thread: " + Thread.currentThread().getName)
       self ! Shutdown
+    }
 
     case Shutdown =>
       context stop self

project/Dependencies.scala

@@ -40,4 +40,5 @@ object Dependencies {
   val cassandraUnit = "org.cassandraunit" % "cassandra-unit" % Version.cassandraUnit
   val alpakkaCassandra = "com.lightbend.akka" %% "akka-stream-alpakka-cassandra" % Version.alpakka
   val cassandraDriver = "com.datastax.cassandra" % "cassandra-driver-core" % Version.cassandraDriver
+  val javaMail = "javax.mail" % "mail" % Version.javaMail
 }

project/Version.scala

@@ -22,4 +22,5 @@ object Version {
   val cassandraUnit = "3.1.3.2"
   val alpakka = "0.9"
   val cassandraDriver = "3.2.0"
+  val javaMail = "1.4.7"
 }

query/src/main/resources/application.conf

@@ -36,6 +36,26 @@ hmda {
 //  }
 //}
 
+db {
+  driver = "slick.driver.PostgresDriver$"
+  db {
+    driver = org.postgresql.Driver
+    host = "192.168.99.100"
+    host = ${?KEYCLOAK_HOST}
+    port = "5433"
+    port = ${?KEYCLOAK_PORT}
+    database = "keycloak"
+    database = ${?KEYCLOAK_DATABASE}
+    url = "jdbc:postgresql://"${db.db.host}":"${db.db.port}"/"${db.db.database}
+    url = ${?KEYCLOAK_URL_OVERRIDE}
+    user = "keycloak"
+    user = ${?KEYCLOAK_USER}
+    password = "password"
+    password = ${?KEYCLOAK_PASSWORD}
+    connectionPool = disabled
+  }
+}
+
 cassandra {
   host = "192.168.99.100"
   host = ${?CASSANDRA_CLUSTER_HOSTS}