[JB][OPS-13147] add alcohol duty origins (#24)

Author: barnesjake

app/uk/gov/hmrc/cardpaymentfrontend/controllers/CheckYourAnswersController.scala

@@ -16,13 +16,13 @@
 
 package uk.gov.hmrc.cardpaymentfrontend.controllers
 
-import payapi.corcommon.model.Origin
 import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
 import uk.gov.hmrc.cardpaymentfrontend.actions.{Actions, JourneyRequest}
 import uk.gov.hmrc.cardpaymentfrontend.models.CheckYourAnswersRow
 import uk.gov.hmrc.cardpaymentfrontend.models.CheckYourAnswersRow.summarise
+import uk.gov.hmrc.cardpaymentfrontend.models.extendedorigins.ExtendedOrigin
+import uk.gov.hmrc.cardpaymentfrontend.models.extendedorigins.ExtendedOrigin.OriginExtended
 import uk.gov.hmrc.cardpaymentfrontend.requests.RequestSupport
-import uk.gov.hmrc.cardpaymentfrontend.utils.OriginExtraInfo
 import uk.gov.hmrc.cardpaymentfrontend.views.html.CheckYourAnswersPage
 import uk.gov.hmrc.govukfrontend.views.Aliases.SummaryList
 import uk.gov.hmrc.govukfrontend.views.viewmodels.summarylist.SummaryListRow
@@ -34,23 +34,29 @@ import javax.inject.{Inject, Singleton}
 class CheckYourAnswersController @Inject() (
     actions:              Actions,
     mcc:                  MessagesControllerComponents,
-    originExtraInfo:      OriginExtraInfo,
     checkYourAnswersPage: CheckYourAnswersPage,
     requestSupport:       RequestSupport
 ) extends FrontendController(mcc) {
   import requestSupport._
 
   def renderPage: Action[AnyContent] = actions.journeyAction { implicit journeyRequest: JourneyRequest[AnyContent] =>
-    val origin: Origin = journeyRequest.journey.origin
-    val liftedOrigin = originExtraInfo.lift(origin)
+    val extendedOrigin: ExtendedOrigin = journeyRequest.journey.origin.lift
 
-    val paymentDate: Option[CheckYourAnswersRow] = liftedOrigin.checkYourAnswersPaymentDateRow(journeyRequest)
-    val referenceRow: Option[CheckYourAnswersRow] = liftedOrigin.checkYourAnswersReferenceRow(journeyRequest)
-    val amountRow: Option[CheckYourAnswersRow] = liftedOrigin.checkYourAnswersAmountSummaryRow(journeyRequest)
-    val maybeEmailRow: Option[CheckYourAnswersRow] = liftedOrigin.checkYourAnswersEmailAddressRow(journeyRequest)
-    val cardBillingAddressRow: Option[CheckYourAnswersRow] = liftedOrigin.checkYourAnswersCardBillingAddressRow(journeyRequest)
+    val paymentDate: Option[CheckYourAnswersRow] = extendedOrigin.checkYourAnswersPaymentDateRow(journeyRequest)
+    val referenceRow: Option[CheckYourAnswersRow] = extendedOrigin.checkYourAnswersReferenceRow(journeyRequest)
+    val additionalReferenceRow: Option[CheckYourAnswersRow] = extendedOrigin.checkYourAnswersAdditionalReferenceRow(journeyRequest)
+    val amountRow: Option[CheckYourAnswersRow] = extendedOrigin.checkYourAnswersAmountSummaryRow(journeyRequest)
+    val maybeEmailRow: Option[CheckYourAnswersRow] = extendedOrigin.checkYourAnswersEmailAddressRow(journeyRequest)
+    val cardBillingAddressRow: Option[CheckYourAnswersRow] = extendedOrigin.checkYourAnswersCardBillingAddressRow(journeyRequest)
 
-    val summaryListRows: Seq[SummaryListRow] = Seq(paymentDate, referenceRow, amountRow, maybeEmailRow, cardBillingAddressRow).flatten.map(summarise)
+    val summaryListRows: Seq[SummaryListRow] = Seq(
+      paymentDate,
+      referenceRow,
+      additionalReferenceRow,
+      amountRow,
+      maybeEmailRow,
+      cardBillingAddressRow
+    ).flatten.map(summarise)
 
     Ok(checkYourAnswersPage(SummaryList(summaryListRows)))
   }

app/uk/gov/hmrc/cardpaymentfrontend/controllers/FeesController.scala

@@ -16,128 +16,30 @@
 
 package uk.gov.hmrc.cardpaymentfrontend.controllers
 
-import payapi.corcommon.model.{Origin, Origins}
+import payapi.corcommon.model.Origin
 import play.api.mvc.{Action, AnyContent, Call, MessagesControllerComponents}
 import uk.gov.hmrc.cardpaymentfrontend.actions.{Actions, JourneyRequest}
 import uk.gov.hmrc.cardpaymentfrontend.config.AppConfig
-import uk.gov.hmrc.cardpaymentfrontend.models.Link
+import uk.gov.hmrc.cardpaymentfrontend.models.extendedorigins.ExtendedOrigin.OriginExtended
+import uk.gov.hmrc.cardpaymentfrontend.models.{Link, PaymentMethod}
 import uk.gov.hmrc.cardpaymentfrontend.requests.RequestSupport
-import uk.gov.hmrc.cardpaymentfrontend.utils.{OriginExtraInfo, PaymentMethod, PaymentMethods}
 import uk.gov.hmrc.cardpaymentfrontend.views.html.FeesPage
 import uk.gov.hmrc.play.bootstrap.frontend.controller.FrontendController
 
 import javax.inject.{Inject, Singleton}
 
 @Singleton
 class FeesController @Inject() (
-    actions:         Actions,
-    appConfig:       AppConfig,
-    feesPage:        FeesPage,
-    mcc:             MessagesControllerComponents,
-    originExtraInfo: OriginExtraInfo,
-    requestSupport:  RequestSupport
+    actions:        Actions,
+    appConfig:      AppConfig,
+    feesPage:       FeesPage,
+    mcc:            MessagesControllerComponents,
+    requestSupport: RequestSupport
 ) extends FrontendController(mcc) {
 
-  private[controllers] def twoDirectDebitsPrimaryLink(origin: Origin): Option[Link] = {
-    origin match {
-      case Origins.BtaEpayeBill => Some(Link(
-        href       = Call("GET", "http://SomeDDUrl"),
-        linkId     = "direct-debit-link-both-primary",
-        messageKey = "card-fees.para2.direct-debit"
-      ))
-      case Origins.PfMgd => Some(Link(
-        href       = Call("GET", "http://SomeDDUrl"),
-        linkId     = "direct-debit-link-both-primary",
-        messageKey = "card-fees.para2.direct-debit"
-      ))
-      case _ => None
-    }
-  }
-
-  private[controllers] def twoDirectDebitsSecondaryLink(origin: Origin): Option[Link] = {
-    origin match {
-      case Origins.BtaEpayeBill => Some(Link(
-        href       = Call("GET", "http://SomeDDUrl"),
-        linkId     = "direct-debit-link-both-secondary",
-        messageKey = "card-fees.para2.direct-debit"
-      ))
-      case Origins.PfMgd => Some(Link(
-        href       = Call("GET", "http://SomeDDUrl"),
-        linkId     = "direct-debit-link-both-secondary",
-        messageKey = "card-fees.para2.direct-debit"
-      ))
-      case _ => None
-    }
-  }
-  private[controllers] def altPaymentLinks(origin: Origin): Seq[Link] = {
-    val bacsLink = Seq(
-      Link(
-        href       = Call("GET", "http://SomeURL"),
-        linkId     = "bank-account-link-primary",
-        messageKey = "card-fees.para2.bank-account"
-      )
-    )
-
-    val openBankingLink = if (originExtraInfo.openBankingAllowed(origin)) {
-      Seq(Link(
-        href       = Call("GET", "http://SomeURLOpenBankingUrl"),
-        linkId     = "open-banking-link",
-        messageKey = "card-fees.para2.open-banking"
-      ))
-    } else Seq.empty[Link]
-
-    val oneKindOfDDCondition: Boolean =
-      (originExtraInfo.variableDirectDebitAllowed(origin) && !originExtraInfo.oneOffDirectDebitAllowed(origin)) ||
-        (!originExtraInfo.variableDirectDebitAllowed(origin) && originExtraInfo.oneOffDirectDebitAllowed(origin))
-
-    val oneKindOfDDlink = if (oneKindOfDDCondition) {
-      Seq(Link(
-        href       = Call("GET", "http://SomeDDUrl"),
-        linkId     = "direct-debit-link",
-        messageKey = "card-fees.para2.direct-debit"
-      ))
-    } else Seq.empty[Link]
-
-    val twoKindsOfDDPrimary = twoDirectDebitsPrimaryLink(origin) match {
-      case Some(link) => Seq(link)
-      case None       => Seq.empty[Link]
-    }
-
-    val twoKindsOfDDSecondary = twoDirectDebitsSecondaryLink(origin) match {
-      case Some(link) => Seq(link)
-      case None       => Seq.empty[Link]
-    }
-
-    bacsLink ++ openBankingLink ++ oneKindOfDDlink ++ twoKindsOfDDSecondary ++ twoKindsOfDDPrimary
-  }
-
-  //Note that when the Origin system is available this will be replaced with something more sensible
-  def renderPage(origin: Origin): Action[AnyContent] = Action { implicit request =>
-    val altPayments = altPaymentLinks(origin)
-    if (altPayments.isEmpty) Redirect("http://nextpage.html")
-    else Ok(feesPage(altPayments))
-  }
-
-  def renderPage0(): Action[AnyContent] = renderPage(Origins.AppSimpleAssessment)
-
-  //Show open banking link
-  def renderPage1(): Action[AnyContent] = renderPage(Origins.PfChildBenefitRepayments)
-
-  //Show Variable Direct Debit link
-  def renderPage2(): Action[AnyContent] = renderPage(Origins.PfSdil)
-
-  //Show one off direct debit link
-  def renderPage3(): Action[AnyContent] = renderPage(Origins.PfTpes)
-
-  //Two kinds of DD with a primary link
-  def renderPage4(): Action[AnyContent] = renderPage(Origins.BtaEpayeBill)
-
-  // Two kinds of DD with secondary link
-  def renderPage5(): Action[AnyContent] = renderPage(Origins.PfMgd)
-
   import requestSupport._
 
-  def renderPageNew(): Action[AnyContent] = actions.journeyAction { implicit journeyRequest: JourneyRequest[AnyContent] =>
+  def renderPage: Action[AnyContent] = actions.journeyAction { implicit journeyRequest: JourneyRequest[AnyContent] =>
     val altPayments = linksAvailableOnFeesPage(journeyRequest.journey.origin)
     if (altPayments.isEmpty) Redirect("http://nextpage.html")
     else Ok(feesPage(altPayments))
@@ -150,12 +52,11 @@ class FeesController @Inject() (
   private[controllers] def paymentMethodToBeShown(paymentMethod: PaymentMethod, paymentMethods: Set[PaymentMethod]): Boolean = paymentMethods.contains(paymentMethod)
 
   private[controllers] def linksAvailableOnFeesPage(origin: Origin): Seq[Link] = {
-
-    val extendedOrigin = originExtraInfo.lift(origin)
+    val extendedOrigin = origin.lift
     val paymentMethodsToShow: Set[PaymentMethod] = extendedOrigin.cardFeesPagePaymentMethods
-    val showOpenBankingLink: Boolean = paymentMethodToBeShown(PaymentMethods.OpenBanking, paymentMethodsToShow)
-    val showBankTransferLink: Boolean = paymentMethodToBeShown(PaymentMethods.Bacs, paymentMethodsToShow)
-    val showOneOffDirectDebitLink: Boolean = paymentMethodToBeShown(PaymentMethods.OneOffDirectDebit, paymentMethodsToShow)
+    val showOpenBankingLink: Boolean = paymentMethodToBeShown(PaymentMethod.OpenBanking, paymentMethodsToShow)
+    val showBankTransferLink: Boolean = paymentMethodToBeShown(PaymentMethod.Bacs, paymentMethodsToShow)
+    val showOneOffDirectDebitLink: Boolean = paymentMethodToBeShown(PaymentMethod.OneOffDirectDebit, paymentMethodsToShow)
 
     val maybeOpenBankingLink = if (showOpenBankingLink) {
       Seq(Link(

app/uk/gov/hmrc/cardpaymentfrontend/controllers/OpenBankingController.scala

@@ -21,9 +21,9 @@ import play.api.mvc.Results.Redirect
 import play.api.mvc.{Action, AnyContent}
 import uk.gov.hmrc.cardpaymentfrontend.actions.{Actions, JourneyRequest}
 import uk.gov.hmrc.cardpaymentfrontend.connectors.OpenBankingConnector
+import uk.gov.hmrc.cardpaymentfrontend.models.extendedorigins.ExtendedOrigin.OriginExtended
 import uk.gov.hmrc.cardpaymentfrontend.models.openbanking.CreateSessionDataRequest
 import uk.gov.hmrc.cardpaymentfrontend.requests.RequestSupport
-import uk.gov.hmrc.cardpaymentfrontend.utils.OriginExtraInfo
 
 import javax.inject.{Inject, Singleton}
 import scala.concurrent.ExecutionContext
@@ -32,20 +32,21 @@ import scala.concurrent.ExecutionContext
 class OpenBankingController @Inject() (
     actions:              Actions,
     openBankingConnector: OpenBankingConnector,
-    originExtraInfo:      OriginExtraInfo,
     requestSupport:       RequestSupport
 )(implicit executionContext: ExecutionContext) {
 
   import requestSupport._
 
   def startOpenBankingJourney: Action[AnyContent] = actions.journeyAction.async { implicit journeyRequest: JourneyRequest[AnyContent] =>
     val journey: Journey[JourneySpecificData] = journeyRequest.journey
-    val createSessionDataRequest: CreateSessionDataRequest =
-      originExtraInfo
-        .lift(journey.origin)
+    val createSessionDataRequest: CreateSessionDataRequest = {
+      journey
+        .origin
+        .lift
         .openBankingOriginSpecificSessionData(journey.journeySpecificData)
         .map(originSpecificSessionData => CreateSessionDataRequest(journeyRequest.journey.getAmountInPence, originSpecificSessionData, journeyRequest.journey.futureDatedPayment))
         .getOrElse(throw new RuntimeException("Unable to build createSessionDataRequest, so cannot start an OB journey"))
+    }
 
     openBankingConnector.startOpenBankingJourney(createSessionDataRequest)
       .map(createSessionDataResponse => Redirect(createSessionDataResponse.nextUrl))

app/uk/gov/hmrc/cardpaymentfrontend/controllers/PaymentCompleteController.scala

@@ -16,18 +16,19 @@
 
 package uk.gov.hmrc.cardpaymentfrontend.controllers
 
-import payapi.cardpaymentjourney.model.journey.{Journey, JourneySpecificData}
+import payapi.cardpaymentjourney.model.journey.{Journey, JourneySpecificData, JsdAlcoholDuty}
 import payapi.corcommon.model.barclays.CardCategories
 import play.api.i18n.Messages
 import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
 import play.twirl.api.Html
 import uk.gov.hmrc.cardpaymentfrontend.actions.{Actions, JourneyRequest}
+import uk.gov.hmrc.cardpaymentfrontend.models.extendedorigins.ExtendedOrigin.OriginExtended
 import uk.gov.hmrc.cardpaymentfrontend.models.{EmailAddress, creditCardCommissionRate}
 import uk.gov.hmrc.cardpaymentfrontend.requests.RequestSupport
 import uk.gov.hmrc.cardpaymentfrontend.services.EmailService
 import uk.gov.hmrc.cardpaymentfrontend.session.JourneySessionSupport._
 import uk.gov.hmrc.cardpaymentfrontend.util.SafeEquals.EqualsOps
-import uk.gov.hmrc.cardpaymentfrontend.utils.{DateStringBuilder, OriginExtraInfo}
+import uk.gov.hmrc.cardpaymentfrontend.utils.DateStringBuilder
 import uk.gov.hmrc.cardpaymentfrontend.views.html.PaymentCompletePage
 import uk.gov.hmrc.govukfrontend.views.Aliases.{HtmlContent, Text, Value}
 import uk.gov.hmrc.govukfrontend.views.viewmodels.summarylist.{Key, SummaryListRow}
@@ -39,7 +40,6 @@ import scala.concurrent.{ExecutionContext, Future}
 class PaymentCompleteController @Inject() (
     actions:             Actions,
     emailService:        EmailService,
-    originExtraInfo:     OriginExtraInfo,
     mcc:                 MessagesControllerComponents,
     paymentCompletePage: PaymentCompletePage,
     requestSupport:      RequestSupport
@@ -67,7 +67,7 @@ class PaymentCompleteController @Inject() (
       taxReference      = journeyRequest.journey.getReference,
       summaryListRows   = PaymentCompleteController.buildSummaryListRows(
         journey = journeyRequest.journey,
-        taxType = originExtraInfo.lift(journeyRequest.journey.origin).taxNameMessageKey
+        taxType = journeyRequest.journey.origin.lift.taxNameMessageKey
       ),
       maybeEmailAddress = maybeEmailFromSession,
       maybeReturnUrl    = journeyRequest.journey.navigation.flatMap(_.returnUrl.map(_.value))
@@ -78,7 +78,7 @@ class PaymentCompleteController @Inject() (
 object PaymentCompleteController {
 
   def buildSummaryListRows(journey: Journey[JourneySpecificData], taxType: String)(implicit messages: Messages): Seq[SummaryListRow] = {
-    Seq(
+    val consistentRows = Seq(
       SummaryListRow(
         key   = Key(Text(messages("payment-complete.summary-list.tax"))),
         value = Value(Text(messages(taxType)))
@@ -87,7 +87,25 @@ object PaymentCompleteController {
         key   = Key(Text(messages("payment-complete.summary-list.date"))),
         value = Value(Text(messages(DateStringBuilder.getDateAsString(journey.getPaidOn))))
       )
-    ) ++ buildAmountsSummaryListRow(journey)
+    )
+
+    val taxSpecificRows: Seq[SummaryListRow] = journey.journeySpecificData match {
+      case JsdAlcoholDuty(_, alcoholDutyChargeReference, _) =>
+        alcoholDutyChargeReference.fold[Seq[SummaryListRow]](Seq.empty[SummaryListRow]) { alcoholDutyChargeReference =>
+          Seq(
+            SummaryListRow(
+              key   = Key(Text(messages("check-your-details.AlcoholDuty.charge-reference"))),
+              value = Value(Text(alcoholDutyChargeReference.canonicalizedValue))
+            )
+          )
+        }
+
+      case _ => Seq.empty[SummaryListRow]
+    }
+
+    val amountRows = buildAmountsSummaryListRow(journey)
+
+    consistentRows ++ taxSpecificRows ++ amountRows
   }
 
   def buildAmountsSummaryListRow(journey: Journey[JourneySpecificData])(implicit messages: Messages): Seq[SummaryListRow] = {

app/uk/gov/hmrc/cardpaymentfrontend/controllers/PaymentFailedController.scala

@@ -20,8 +20,9 @@ import payapi.corcommon.model.{Origin, Origins}
 import play.api.data.Form
 import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
 import uk.gov.hmrc.cardpaymentfrontend.forms.ChooseAPaymentMethodForm
-import uk.gov.hmrc.cardpaymentfrontend.utils.PaymentMethods.OpenBanking
-import uk.gov.hmrc.cardpaymentfrontend.utils.{OriginExtraInfo, PaymentMethod}
+import uk.gov.hmrc.cardpaymentfrontend.models.PaymentMethod
+import uk.gov.hmrc.cardpaymentfrontend.models.PaymentMethod.OpenBanking
+import uk.gov.hmrc.cardpaymentfrontend.models.extendedorigins.ExtendedOrigin.OriginExtended
 import uk.gov.hmrc.cardpaymentfrontend.views.html.PaymentFailedPage
 import uk.gov.hmrc.play.bootstrap.frontend.controller.FrontendController
 
@@ -30,12 +31,11 @@ import javax.inject.{Inject, Singleton}
 @Singleton
 class PaymentFailedController @Inject() (
     mcc:               MessagesControllerComponents,
-    paymentFailedPage: PaymentFailedPage,
-    originExtraInfo:   OriginExtraInfo
+    paymentFailedPage: PaymentFailedPage
 ) extends FrontendController(mcc) {
 
   def renderPage(origin: Origin): Action[AnyContent] = Action { implicit request =>
-    val liftedOrigin = originExtraInfo.lift(origin)
+    val liftedOrigin = origin.lift
     val paymentMethods: Set[PaymentMethod] = liftedOrigin.paymentMethods()
     Ok(paymentFailedPage(origin.toTaxType.toString, paymentMethods.contains(OpenBanking), ChooseAPaymentMethodForm.form))
   }

app/uk/gov/hmrc/cardpaymentfrontend/forms/ChooseAPaymentMethodForm.scala

@@ -19,6 +19,7 @@ package uk.gov.hmrc.cardpaymentfrontend.forms
 import play.api.data.Form
 import play.api.data.Forms.{mapping, optional, text}
 
+//todo use enum/adt instead of string.
 final case class ChooseAPaymentMethodForm(chosenMethod: Option[String])
 
 object ChooseAPaymentMethodForm {

app/uk/gov/hmrc/cardpaymentfrontend/models/CheckYourAnswersRow.scala

@@ -54,5 +54,3 @@ object CheckYourAnswersRow {
     }
   }
 }
-
-//No Json as this is not going over the wire

app/uk/gov/hmrc/cardpaymentfrontend/models/PaymentMethod.scala

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2024 HM Revenue & Customs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package uk.gov.hmrc.cardpaymentfrontend.models
+
+sealed trait PaymentMethod
+
+object PaymentMethod {
+
+  case object Card extends PaymentMethod
+
+  case object OpenBanking extends PaymentMethod
+
+  case object OneOffDirectDebit extends PaymentMethod
+
+  case object VariableDirectDebit extends PaymentMethod
+
+  case object PrintableDirectDebit extends PaymentMethod
+
+  case object Bacs extends PaymentMethod
+}