Merge pull request #31 from drivergroup/PDSUI-2275v0.3.23

PDSUI-2275 Added delivery methods to intervention type entrypoint

5 files changed, 208 insertions, 15 deletions

diff --git a/src/main/scala/xyz/driver/pdsuidomain/entities/Intervention.scala b/src/main/scala/xyz/driver/pdsuidomain/entities/Intervention.scala
index 5dada55..d0eefa9 100644
--- a/src/main/scala/xyz/driver/pdsuidomain/entities/Intervention.scala
+++ b/src/main/scala/xyz/driver/pdsuidomain/entities/Intervention.scala
@@ -2,10 +2,174 @@ package xyz.driver.pdsuidomain.entities
 
 import xyz.driver.pdsuicommon.domain.{LongId, StringId}
 import xyz.driver.pdsuicommon.logging._
+import xyz.driver.pdsuidomain.entities.InterventionType.DeliveryMethod
+import xyz.driver.pdsuidomain.entities.InterventionType.DeliveryMethod._
 
-final case class InterventionType(id: LongId[InterventionType], name: String)
+sealed trait InterventionType {
+  val id: LongId[InterventionType]
+  val name: String
+  val deliveryMethods: Set[DeliveryMethod]
+}
 
 object InterventionType {
+
+  final case object RadiationTherapy extends InterventionType {
+    val id: LongId[InterventionType]         = LongId[InterventionType](1)
+    val name: String                         = "Radiation therapy"
+    val deliveryMethods: Set[DeliveryMethod] = commonMethods
+  }
+
+  final case object Chemotherapy extends InterventionType {
+    val id: LongId[InterventionType]         = LongId[InterventionType](2)
+    val name: String                         = "Chemotherapy"
+    val deliveryMethods: Set[DeliveryMethod] = commonMethods
+  }
+
+  final case object TargetedTherapy extends InterventionType {
+    val id: LongId[InterventionType]         = LongId[InterventionType](3)
+    val name: String                         = "Targeted therapy"
+    val deliveryMethods: Set[DeliveryMethod] = commonMethods
+  }
+
+  final case object Immunotherapy extends InterventionType {
+    val id: LongId[InterventionType]         = LongId[InterventionType](4)
+    val name: String                         = "Immunotherapy"
+    val deliveryMethods: Set[DeliveryMethod] = commonMethods
+  }
+
+  final case object Surgery extends InterventionType {
+    val id: LongId[InterventionType]         = LongId[InterventionType](5)
+    val name: String                         = "Surgery"
+    val deliveryMethods: Set[DeliveryMethod] = commonMethods
+  }
+
+  final case object HormoneTherapy extends InterventionType {
+    val id: LongId[InterventionType]         = LongId[InterventionType](6)
+    val name: String                         = "Hormone therapy"
+    val deliveryMethods: Set[DeliveryMethod] = commonMethods
+  }
+
+  final case object Other extends InterventionType {
+    val id: LongId[InterventionType]         = LongId[InterventionType](7)
+    val name: String                         = "Other"
+    val deliveryMethods: Set[DeliveryMethod] = commonMethods
+  }
+
+  final case object Radiation extends InterventionType {
+    val id: LongId[InterventionType] = LongId[InterventionType](8)
+    val name: String                 = "Radiation"
+    val deliveryMethods: Set[DeliveryMethod] = Set(
+      ExternalRadiationTherapy,
+      Brachytherapy,
+      SystemicRadiationTherapyIV,
+      SystemicRadiationTherapyOral,
+      ProtonBeamTherapy
+    )
+  }
+
+  final case object SurgeryProcedure extends InterventionType {
+    val id: LongId[InterventionType] = LongId[InterventionType](9)
+    val name: String                 = "Surgery/Procedure"
+    val deliveryMethods: Set[DeliveryMethod] = Set(
+      RadioFrequencyAblationRFA,
+      Cryoablation,
+      TherapeuticConventionalSurgery,
+      RoboticAssistedLaparoscopicSurgery
+    )
+  }
+
+  def typeFromString: PartialFunction[String, InterventionType] = {
+    case "Radiation therapy" => RadiationTherapy
+    case "Chemotherapy"      => Chemotherapy
+    case "Targeted therapy"  => TargetedTherapy
+    case "Immunotherapy"     => Immunotherapy
+    case "Surgery"           => Surgery
+    case "Hormone therapy"   => HormoneTherapy
+    case "Other"             => Other
+    case "Radiation"         => Radiation
+    case "Surgery/Procedure" => SurgeryProcedure
+  }
+
+  sealed trait DeliveryMethod
+  object DeliveryMethod {
+    case object IntravenousInfusionIV              extends DeliveryMethod
+    case object IntramuscularInjection             extends DeliveryMethod
+    case object SubcutaneousInjection              extends DeliveryMethod
+    case object IntradermalInjection               extends DeliveryMethod
+    case object SpinalInjection                    extends DeliveryMethod
+    case object Oral                               extends DeliveryMethod
+    case object Topical                            extends DeliveryMethod
+    case object TransdermalPatch                   extends DeliveryMethod
+    case object Inhalation                         extends DeliveryMethod
+    case object Rectal                             extends DeliveryMethod
+    case object ExternalRadiationTherapy           extends DeliveryMethod
+    case object Brachytherapy                      extends DeliveryMethod
+    case object SystemicRadiationTherapyIV         extends DeliveryMethod
+    case object SystemicRadiationTherapyOral       extends DeliveryMethod
+    case object ProtonBeamTherapy                  extends DeliveryMethod
+    case object RadioFrequencyAblationRFA          extends DeliveryMethod
+    case object Cryoablation                       extends DeliveryMethod
+    case object TherapeuticConventionalSurgery     extends DeliveryMethod
+    case object RoboticAssistedLaparoscopicSurgery extends DeliveryMethod
+
+    def fromString: PartialFunction[String, DeliveryMethod] = {
+      case "Intravenous Infusion (IV)"             => IntravenousInfusionIV
+      case "Intramuscular Injection"               => IntramuscularInjection
+      case "Subcutaneous Injection"                => SubcutaneousInjection
+      case "Intradermal Injection"                 => IntradermalInjection
+      case "Spinal Injection"                      => SpinalInjection
+      case "Oral"                                  => Oral
+      case "Topical"                               => Topical
+      case "Transdermal Patch"                     => TransdermalPatch
+      case "Inhalation"                            => Inhalation
+      case "Rectal"                                => Rectal
+      case "External Radiation Therapy"            => ExternalRadiationTherapy
+      case "Brachytherapy"                         => Brachytherapy
+      case "Systemic Radiation Therapy (IV)"       => SystemicRadiationTherapyIV
+      case "Systemic Radiation Therapy (Oral)"     => SystemicRadiationTherapyOral
+      case "Proton Beam Therapy"                   => ProtonBeamTherapy
+      case "Radio-Frequency Ablation (RFA)"        => RadioFrequencyAblationRFA
+      case "Cryoablation"                          => Cryoablation
+      case "Therapeutic Conventional Surgery"      => TherapeuticConventionalSurgery
+      case "Robotic Assisted Laparoscopic Surgery" => RoboticAssistedLaparoscopicSurgery
+    }
+
+    def methodToString(x: DeliveryMethod): String = x match {
+      case IntravenousInfusionIV              => "Intravenous Infusion (IV)"
+      case IntramuscularInjection             => "Intramuscular Injection"
+      case SubcutaneousInjection              => "Subcutaneous Injection"
+      case IntradermalInjection               => "Intradermal Injection"
+      case SpinalInjection                    => "Spinal Injection"
+      case Oral                               => "Oral"
+      case Topical                            => "Topical"
+      case TransdermalPatch                   => "Transdermal Patch"
+      case Inhalation                         => "Inhalation"
+      case Rectal                             => "Rectal"
+      case ExternalRadiationTherapy           => "External Radiation Therapy"
+      case Brachytherapy                      => "Brachytherapy"
+      case SystemicRadiationTherapyIV         => "Systemic Radiation Therapy (IV)"
+      case SystemicRadiationTherapyOral       => "Systemic Radiation Therapy (Oral)"
+      case ProtonBeamTherapy                  => "Proton Beam Therapy"
+      case RadioFrequencyAblationRFA          => "Radio-Frequency Ablation (RFA)"
+      case Cryoablation                       => "Cryoablation"
+      case TherapeuticConventionalSurgery     => "Therapeutic Conventional Surgery"
+      case RoboticAssistedLaparoscopicSurgery => "Robotic Assisted Laparoscopic Surgery"
+    }
+  }
+
+  val commonMethods = Set[DeliveryMethod](
+    IntravenousInfusionIV,
+    IntramuscularInjection,
+    SubcutaneousInjection,
+    IntradermalInjection,
+    SpinalInjection,
+    Oral,
+    Topical,
+    TransdermalPatch,
+    Inhalation,
+    Rectal
+  )
+
   implicit def toPhiString(x: InterventionType): PhiString = {
     import x._
     phi"InterventionType(id=$id, name=${Unsafe(name)})"
diff --git a/src/main/scala/xyz/driver/pdsuidomain/fakes/entities/trialcuration.scala b/src/main/scala/xyz/driver/pdsuidomain/fakes/entities/trialcuration.scala
index a2bdf43..fe5bf09 100644
--- a/src/main/scala/xyz/driver/pdsuidomain/fakes/entities/trialcuration.scala
+++ b/src/main/scala/xyz/driver/pdsuidomain/fakes/entities/trialcuration.scala
@@ -7,6 +7,7 @@ import xyz.driver.pdsuidomain.services.CriterionService.RichCriterion
 object trialcuration {
   import xyz.driver.core.generators
   import common._
+  import xyz.driver.pdsuidomain.entities.InterventionType._
 
   def nextTrial(): Trial = Trial(
     id = nextStringId[Trial],
@@ -130,9 +131,16 @@ object trialcuration {
     name = generators.nextString()
   )
 
-  def nextInterventionType(): InterventionType = InterventionType(
-    id = nextLongId[InterventionType],
-    name = generators.nextString()
+  def nextInterventionType(): InterventionType = generators.oneOf[InterventionType](
+    RadiationTherapy,
+    Chemotherapy,
+    TargetedTherapy,
+    Immunotherapy,
+    Surgery,
+    HormoneTherapy,
+    Other,
+    Radiation,
+    SurgeryProcedure
   )
 
 }
diff --git a/src/main/scala/xyz/driver/pdsuidomain/formats/json/intervention/ApiInterventionType.scala b/src/main/scala/xyz/driver/pdsuidomain/formats/json/intervention/ApiInterventionType.scala
index ebef225..3db8bfa 100644
--- a/src/main/scala/xyz/driver/pdsuidomain/formats/json/intervention/ApiInterventionType.scala
+++ b/src/main/scala/xyz/driver/pdsuidomain/formats/json/intervention/ApiInterventionType.scala
@@ -2,23 +2,25 @@ package xyz.driver.pdsuidomain.formats.json.intervention
 
 import play.api.libs.functional.syntax._
 import play.api.libs.json.{Format, JsPath}
-import xyz.driver.pdsuicommon.domain.LongId
 import xyz.driver.pdsuidomain.entities.InterventionType
+import xyz.driver.pdsuidomain.entities.InterventionType.DeliveryMethod
 
-final case class ApiInterventionType(id: Long, name: String) {
+final case class ApiInterventionType(id: Long, name: String, deliveryMethods: List[String]) {
 
-  def toDomain = InterventionType(id = LongId[InterventionType](id), name = name)
+  def toDomain = InterventionType.typeFromString(name)
 }
 
 object ApiInterventionType {
 
   implicit val format: Format[ApiInterventionType] = (
     (JsPath \ "id").format[Long] and
-      (JsPath \ "name").format[String]
+      (JsPath \ "name").format[String] and
+      (JsPath \ "deliveryMethods").format[List[String]]
   )(ApiInterventionType.apply, unlift(ApiInterventionType.unapply))
 
   def fromDomain(interventionType: InterventionType) = ApiInterventionType(
     id = interventionType.id.id,
-    name = interventionType.name
+    name = interventionType.name,
+    deliveryMethods = interventionType.deliveryMethods.map(DeliveryMethod.methodToString).toList
   )
 }
diff --git a/src/main/scala/xyz/driver/pdsuidomain/formats/json/sprayformats/intervention.scala b/src/main/scala/xyz/driver/pdsuidomain/formats/json/sprayformats/intervention.scala
index daa28e4..62cb9fa 100644
--- a/src/main/scala/xyz/driver/pdsuidomain/formats/json/sprayformats/intervention.scala
+++ b/src/main/scala/xyz/driver/pdsuidomain/formats/json/sprayformats/intervention.scala
@@ -2,6 +2,7 @@ package xyz.driver.pdsuidomain.formats.json.sprayformats
 
 import spray.json._
 import xyz.driver.pdsuicommon.domain.{LongId, StringId}
+import xyz.driver.pdsuidomain.entities.InterventionType.DeliveryMethod
 import xyz.driver.pdsuidomain.entities._
 
 object intervention {
@@ -119,6 +120,25 @@ object intervention {
     case _ => deserializationError(s"Expected Json Object as partial Intervention, but got $json")
   }
 
-  implicit val interventionTypeFormat: RootJsonFormat[InterventionType] = jsonFormat2(InterventionType.apply)
+  implicit val interventionTypeFormat: JsonFormat[InterventionType] = new RootJsonFormat[InterventionType] {
+    override def read(json: JsValue) = json match {
+      case JsObject(fields) =>
+        val name = fields
+          .get("name")
+          .map(_.convertTo[String])
+          .getOrElse(deserializationError(s"Intervention type json object does not contain `name` field: $json"))
+
+        InterventionType.typeFromString(name)
+
+      case _ => deserializationError(s"Expected Json Object as Intervention type, but got $json")
+    }
+
+    override def write(obj: InterventionType) =
+      JsObject(
+        "id"              -> obj.id.toJson,
+        "name"            -> obj.name.toJson,
+        "deliveryMethods" -> obj.deliveryMethods.map(DeliveryMethod.methodToString).toJson
+      )
+  }
 
 }
diff --git a/src/test/scala/xyz/driver/pdsuidomain/formats/json/sprayformats/InterventionFormatSuite.scala b/src/test/scala/xyz/driver/pdsuidomain/formats/json/sprayformats/InterventionFormatSuite.scala
index ebb5f3d..dad39c8 100644
--- a/src/test/scala/xyz/driver/pdsuidomain/formats/json/sprayformats/InterventionFormatSuite.scala
+++ b/src/test/scala/xyz/driver/pdsuidomain/formats/json/sprayformats/InterventionFormatSuite.scala
@@ -59,13 +59,12 @@ class InterventionFormatSuite extends FlatSpec with Matchers {
   }
 
   "Json format for InterventionType" should "read and write correct JSON" in {
-    val interventionType = InterventionType(
-      id = LongId(10),
-      name = "type name"
-    )
+    val interventionType = InterventionType.typeFromString("Surgery/Procedure")
     val writtenJson = interventionTypeFormat.write(interventionType)
 
-    writtenJson should be("""{"id":10,"name":"type name"}""".parseJson)
+    writtenJson should be(
+      """{"id":9,"name":"Surgery/Procedure","deliveryMethods":["Radio-Frequency Ablation (RFA)",
+        "Cryoablation","Therapeutic Conventional Surgery","Robotic Assisted Laparoscopic Surgery"]}""".parseJson)
 
     val parsedInterventionType = interventionTypeFormat.read(writtenJson)
     parsedInterventionType should be(interventionType)