Pods 9662 simpler opt srn

app/connectors/PensionSchemeVarianceLockConnector.scala

@@ -29,23 +29,24 @@ import uk.gov.hmrc.http.HttpClient
 
 import scala.concurrent.{ExecutionContext, Future}
 import scala.util.{Failure, Try}
+import models.SchemeReferenceNumber
 
 @ImplementedBy(classOf[PensionSchemeVarianceLockConnectorImpl])
 trait PensionSchemeVarianceLockConnector {
 
-  def lock(psaId: String, srn: String)
+  def lock(psaId: String, srn: SchemeReferenceNumber)
           (implicit hc: HeaderCarrier, ec: ExecutionContext): Future[Lock]
 
-  def getLock(psaId: String, srn: String)
+  def getLock(psaId: String, srn: SchemeReferenceNumber)
              (implicit hc: HeaderCarrier, ec: ExecutionContext): Future[Option[SchemeVariance]]
 
   def getLockByPsa(psaId: String)
                   (implicit hc: HeaderCarrier, ec: ExecutionContext): Future[Option[SchemeVariance]]
 
-  def isLockByPsaIdOrSchemeId(psaId: String, srn: String)
+  def isLockByPsaIdOrSchemeId(psaId: String, srn: SchemeReferenceNumber)
                              (implicit hc: HeaderCarrier, ec: ExecutionContext): Future[Option[Lock]]
 
-  def releaseLock(psaId: String, srn: String)
+  def releaseLock(psaId: String, srn: SchemeReferenceNumber)
                  (implicit hc: HeaderCarrier, ec: ExecutionContext): Future[Unit]
 
 }
@@ -56,10 +57,10 @@ class PensionSchemeVarianceLockConnectorImpl @Inject()(http: HttpClient, config:
 
   private val logger  = Logger(classOf[PensionSchemeVarianceLockConnectorImpl])
 
-  override def lock(psaId: String, srn: String)
+  override def lock(psaId: String, srn: SchemeReferenceNumber)
                    (implicit hc: HeaderCarrier, ec: ExecutionContext): Future[Lock] = {
 
-    implicit val headerCarrier: HeaderCarrier = hc.withExtraHeaders("psaId" -> psaId, "srn" -> srn)
+    implicit val headerCarrier: HeaderCarrier = hc.withExtraHeaders("psaId" -> psaId, "srn" -> srn.id)
 
     val url = s"${config.updateSchemeDetailsUrl}/lock"
 
@@ -77,10 +78,10 @@ class PensionSchemeVarianceLockConnectorImpl @Inject()(http: HttpClient, config:
     } andThen logExceptions("Unable to get the lock")
   }
 
-  override def getLock(psaId: String, srn: String)
+  override def getLock(psaId: String, srn: SchemeReferenceNumber)
                       (implicit hc: HeaderCarrier, ec: ExecutionContext): Future[Option[SchemeVariance]] = {
 
-    implicit val headerCarrier: HeaderCarrier = hc.withExtraHeaders("psaId" -> psaId, "srn" -> srn)
+    implicit val headerCarrier: HeaderCarrier = hc.withExtraHeaders("psaId" -> psaId, "srn" -> srn.id)
 
     val url = s"${config.updateSchemeDetailsUrl}/getLock"
 
@@ -124,10 +125,10 @@ class PensionSchemeVarianceLockConnectorImpl @Inject()(http: HttpClient, config:
   }
 
 
-  override def isLockByPsaIdOrSchemeId(psaId: String, srn: String)
+  override def isLockByPsaIdOrSchemeId(psaId: String, srn: SchemeReferenceNumber)
                                       (implicit hc: HeaderCarrier, ec: ExecutionContext): Future[Option[Lock]] = {
 
-    implicit val headerCarrier: HeaderCarrier = hc.withExtraHeaders("psaId" -> psaId, "srn" -> srn)
+    implicit val headerCarrier: HeaderCarrier = hc.withExtraHeaders("psaId" -> psaId, "srn" -> srn.id)
 
     val url = s"${config.updateSchemeDetailsUrl}/isLockByPsaOrScheme"
 
@@ -151,10 +152,10 @@ class PensionSchemeVarianceLockConnectorImpl @Inject()(http: HttpClient, config:
     case Failure(t: Throwable) => logger.error(msg, t)
   }
 
-  override def releaseLock(psaId: String, srn: String)
+  override def releaseLock(psaId: String, srn: SchemeReferenceNumber)
                           (implicit hc: HeaderCarrier, ec: ExecutionContext): Future[Unit] = {
 
-    implicit val headerCarrier: HeaderCarrier = hc.withExtraHeaders("psaId" -> psaId, "srn" -> srn)
+    implicit val headerCarrier: HeaderCarrier = hc.withExtraHeaders("psaId" -> psaId, "srn" -> srn.id)
 
     val url = s"${config.updateSchemeDetailsUrl}/release-lock"
 

app/connectors/PensionsSchemeConnector.scala

@@ -28,6 +28,7 @@ import uk.gov.hmrc.http.{HttpClient, HttpResponse, HeaderCarrier}
 import utils.{UserAnswers, HttpResponseHelper}
 
 import scala.concurrent.{ExecutionContext, Future}
+import models.SchemeReferenceNumber
 
 @ImplementedBy(classOf[PensionsSchemeConnectorImpl])
 trait PensionsSchemeConnector {
@@ -39,7 +40,7 @@ trait PensionsSchemeConnector {
   def updateSchemeDetails(psaId: String, pstr: String, answers: UserAnswers)
                          (implicit hc: HeaderCarrier, ec: ExecutionContext): Future[Unit]
 
-  def checkForAssociation(userId: String, srn: String, isPsa: Boolean = true)
+  def checkForAssociation(userId: String, srn: SchemeReferenceNumber, isPsa: Boolean = true)
                          (implicit headerCarrier: HeaderCarrier,
                           ec: ExecutionContext, request: RequestHeader): Future[Either[HttpResponse, Boolean]]
 }
@@ -84,11 +85,11 @@ class PensionsSchemeConnectorImpl @Inject()(http: HttpClient, config: FrontendAp
     }
   }
 
-  def checkForAssociation(userId: String, srn: String, isPsa: Boolean)
+  def checkForAssociation(userId: String, srn: SchemeReferenceNumber, isPsa: Boolean)
                          (implicit headerCarrier: HeaderCarrier,
                           ec: ExecutionContext, request: RequestHeader): Future[Either[HttpResponse, Boolean]] = {
     val headers: Seq[(String, String)] =
-      Seq((if(isPsa) "psaId" else "pspId", userId), ("schemeReferenceNumber", srn), ("Content-Type", "application/json"))
+      Seq((if(isPsa) "psaId" else "pspId", userId), ("schemeReferenceNumber", srn.id), ("Content-Type", "application/json"))
 
     implicit val hc: HeaderCarrier = headerCarrier.withExtraHeaders(headers: _*)
 

app/connectors/SchemeDetailsConnector.scala

@@ -27,13 +27,14 @@ import utils.{HttpResponseHelper, UserAnswers}
 
 import scala.concurrent.{ExecutionContext, Future}
 import scala.util.Failure
+import models.SchemeReferenceNumber
 
 @ImplementedBy(classOf[SchemeDetailsConnectorImpl])
 trait SchemeDetailsConnector {
   def getSchemeDetails(psaId: String, schemeIdType: String, idNumber: String, refreshData: Option[Boolean] = None)
                       (implicit hc: HeaderCarrier, ec: ExecutionContext): Future[UserAnswers]
 
-  def getPspSchemeDetails(pspId: String, srn: String, refreshData: Option[Boolean] = None)
+  def getPspSchemeDetails(pspId: String, srn: SchemeReferenceNumber, refreshData: Option[Boolean] = None)
                          (implicit hc: HeaderCarrier, ec: ExecutionContext): Future[UserAnswers]
 }
 
@@ -65,11 +66,11 @@ class SchemeDetailsConnectorImpl @Inject()(http: HttpClient, config: FrontendApp
     }
   }
 
-  override def getPspSchemeDetails(pspId: String, srn: String, refreshData: Option[Boolean])
+  override def getPspSchemeDetails(pspId: String, srn: SchemeReferenceNumber, refreshData: Option[Boolean])
                                   (implicit hc: HeaderCarrier, ec: ExecutionContext): Future[UserAnswers] = {
 
     val url = config.pspSchemeDetailsUrl
-    val schemeHc = hc.withExtraHeaders("srn" -> srn,
+    val schemeHc = hc.withExtraHeaders("srn" -> srn.id,
     "pspId" -> pspId,
     "refreshData" -> refreshData.map(_.toString).getOrElse("false"))
 

app/controllers/AdviserCheckYourAnswersController.scala

@@ -20,8 +20,9 @@ import config.FrontendAppConfig
 import connectors._
 import controllers.actions._
 import identifiers._
+
 import javax.inject.Inject
-import models.{CheckMode, NormalMode}
+import models.{CheckMode, EmptyOptionalSchemeReferenceNumber, NormalMode}
 import navigators.Navigator
 import play.api.i18n.{I18nSupport, MessagesApi}
 import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
@@ -60,11 +61,11 @@ class AdviserCheckYourAnswersController @Inject()(appConfig: FrontendAppConfig,
       }
       val vm = CYAViewModel(
         answerSections = seqAnswerSection,
-        href = controllers.routes.PsaSchemeTaskListController.onPageLoad(NormalMode, None),
+        href = controllers.routes.PsaSchemeTaskListController.onPageLoad(NormalMode, EmptyOptionalSchemeReferenceNumber),
         schemeName = existingSchemeName,
         returnOverview = false,
         hideEditLinks = request.viewOnly,
-        srn = None,
+        srn = EmptyOptionalSchemeReferenceNumber,
         hideSaveAndContinueButton = request.viewOnly,
         title = Message("checkYourAnswers.hs.title"),
         h1 = Message("checkYourAnswers.hs.title")

app/controllers/AnyMoreChangesController.scala

@@ -18,13 +18,13 @@ package controllers
 
 import java.time.LocalDate
 import java.time.format.DateTimeFormatter
-
 import config.FrontendAppConfig
 import controllers.actions._
 import forms.AnyMoreChangesFormProvider
 import identifiers.AnyMoreChangesId
+
 import javax.inject.Inject
-import models.UpdateMode
+import models.{OptionalSchemeReferenceNumber, SchemeReferenceNumber, UpdateMode}
 import navigators.Navigator
 import play.api.data.Form
 import play.api.i18n.{I18nSupport, MessagesApi}
@@ -51,13 +51,13 @@ class AnyMoreChangesController @Inject()(appConfig: FrontendAppConfig,
   private val form: Form[Boolean] = formProvider()
   private val postCall = controllers.routes.AnyMoreChangesController.onSubmit _
 
-  def onPageLoad(srn: Option[String]): Action[AnyContent] = (authenticate() andThen getData(UpdateMode, srn) andThen
+  def onPageLoad(srn: OptionalSchemeReferenceNumber): Action[AnyContent] = (authenticate() andThen getData(UpdateMode, srn) andThen
     allowAccess(srn) andThen requireData).async {
     implicit request =>
       Future.successful(Ok(view(form, existingSchemeName, dateToCompleteDeclaration, postCall(srn), srn)))
   }
 
-  def onSubmit(srn: Option[String]): Action[AnyContent] = (authenticate() andThen getData(UpdateMode, srn) andThen
+  def onSubmit(srn: OptionalSchemeReferenceNumber): Action[AnyContent] = (authenticate() andThen getData(UpdateMode, srn) andThen
     requireData).async {
     implicit request =>
       form.bindFromRequest().fold(

app/controllers/BeforeYouStartController.scala

@@ -18,6 +18,8 @@ package controllers
 
 import connectors.PensionAdministratorConnector
 import controllers.actions._
+import models.EmptyOptionalSchemeReferenceNumber
+
 import javax.inject.Inject
 import play.api.i18n.{I18nSupport, MessagesApi}
 import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
@@ -36,7 +38,7 @@ class BeforeYouStartController @Inject()(override val messagesApi: MessagesApi,
                                         )(implicit val executionContext: ExecutionContext) extends
   FrontendBaseController with I18nSupport {
 
-  def onPageLoad(): Action[AnyContent] = (authenticate() andThen getData() andThen allowAccess(None)).async {
+  def onPageLoad(): Action[AnyContent] = (authenticate() andThen getData() andThen allowAccess(EmptyOptionalSchemeReferenceNumber)).async {
     implicit request =>
       pensionAdministratorConnector.getPSAName.flatMap { psaName =>
         Future.successful(Ok(view(psaName)))

app/controllers/BenefitsSecuredByInsuranceController.scala

@@ -20,8 +20,9 @@ import config.FrontendAppConfig
 import controllers.actions._
 import forms.BenefitsSecuredByInsuranceFormProvider
 import identifiers.{BenefitsSecuredByInsuranceId, SchemeNameId}
+
 import javax.inject.Inject
-import models.Mode
+import models.{Mode, OptionalSchemeReferenceNumber, SchemeReferenceNumber}
 import navigators.Navigator
 import play.api.data.Form
 import play.api.i18n.{I18nSupport, Messages, MessagesApi}
@@ -48,9 +49,9 @@ class BenefitsSecuredByInsuranceController @Inject()(appConfig: FrontendAppConfi
                                                     )(implicit val executionContext: ExecutionContext) extends
   FrontendBaseController with I18nSupport with Retrievals {
 
-  val postCall: (Mode, Option[String]) => Call = routes.BenefitsSecuredByInsuranceController.onSubmit
+  val postCall: (Mode, OptionalSchemeReferenceNumber) => Call = routes.BenefitsSecuredByInsuranceController.onSubmit
 
-  def onPageLoad(mode: Mode, srn: Option[String]): Action[AnyContent] =
+  def onPageLoad(mode: Mode, srn: OptionalSchemeReferenceNumber): Action[AnyContent] =
     (authenticate() andThen getData(mode, srn) andThen allowAccess(srn) andThen requireData).async {
       implicit request =>
         SchemeNameId.retrieve.map { schemeName =>
@@ -64,7 +65,7 @@ class BenefitsSecuredByInsuranceController @Inject()(appConfig: FrontendAppConfi
 
   private def form(schemeName: String)(implicit messages: Messages): Form[Boolean] = formProvider(schemeName)
 
-  def onSubmit(mode: Mode, srn: Option[String]): Action[AnyContent] = (authenticate() andThen getData(mode, srn)
+  def onSubmit(mode: Mode, srn: OptionalSchemeReferenceNumber): Action[AnyContent] = (authenticate() andThen getData(mode, srn)
     andThen requireData).async {
     implicit request =>
       SchemeNameId.retrieve.map { schemeName =>

app/controllers/CheckYourAnswersBankDetailsController.scala

@@ -19,8 +19,9 @@ package controllers
 import config.FrontendAppConfig
 import controllers.actions._
 import identifiers._
+
 import javax.inject.Inject
-import models.{CheckMode, NormalMode}
+import models.{CheckMode, EmptyOptionalSchemeReferenceNumber, NormalMode}
 import play.api.i18n.{I18nSupport, MessagesApi}
 import play.api.mvc.{Action, AnyContent, MessagesControllerComponents}
 import uk.gov.hmrc.play.bootstrap.frontend.controller.FrontendBaseController
@@ -55,11 +56,11 @@ class CheckYourAnswersBankDetailsController @Inject()(appConfig: FrontendAppConf
 
       val vm = CYAViewModel(
         answerSections = Seq(bankAccountSection),
-        href = controllers.routes.PsaSchemeTaskListController.onPageLoad(NormalMode, None),
+        href = controllers.routes.PsaSchemeTaskListController.onPageLoad(NormalMode, EmptyOptionalSchemeReferenceNumber),
         schemeName = existingSchemeName,
         returnOverview = false,
         hideEditLinks = request.viewOnly,
-        srn = None,
+        srn = EmptyOptionalSchemeReferenceNumber,
         hideSaveAndContinueButton = request.viewOnly,
         title = Message("checkYourAnswers.hs.title"),
         h1 = Message("checkYourAnswers.hs.title")

app/controllers/CheckYourAnswersBeforeYouStartController.scala

@@ -22,6 +22,7 @@ import models.AdministratorOrPractitioner.Practitioner
 
 import javax.inject.Inject
 import models.AuthEntity.PSP
+import models.OptionalSchemeReferenceNumber.toSrn
 import models._
 import models.requests.DataRequest
 import play.api.i18n.{I18nSupport, MessagesApi}
@@ -48,20 +49,20 @@ class CheckYourAnswersBeforeYouStartController @Inject()(override val messagesAp
   FrontendBaseController
   with Enumerable.Implicits with I18nSupport with Retrievals {
 
-  def onPageLoad(mode: Mode, srn: Option[String]): Action[AnyContent] =
+  def onPageLoad(mode: Mode, srn: OptionalSchemeReferenceNumber): Action[AnyContent] =
     (authenticate() andThen getData(mode, srn) andThen allowAccess(srn) andThen requireData).async {
       implicit request =>
 
         Future.successful(Ok(view(vm(mode, srn))))
     }
 
-    def pspOnPageLoad(srn: String): Action[AnyContent] =
-      (authenticate(Some(PSP)) andThen getPspData(srn) andThen allowAccess(Some(srn), allowPsa = true, allowPsp = true) andThen requireData).async {
+    def pspOnPageLoad(srn: SchemeReferenceNumber): Action[AnyContent] =
+      (authenticate(Some(PSP)) andThen getPspData(srn) andThen allowAccess(OptionalSchemeReferenceNumber(Some(srn)), allowPsa = true, allowPsp = true) andThen requireData).async {
         implicit request =>
-          Future.successful(Ok(view(vm(UpdateMode, Some(srn)))))
+          Future.successful(Ok(view(vm(UpdateMode, OptionalSchemeReferenceNumber(Some(srn))))))
       }
 
-  private def vm(mode: Mode, srn: Option[String])(implicit request: DataRequest[AnyContent]): CYAViewModel = {
+  private def vm(mode: Mode, srn: OptionalSchemeReferenceNumber)(implicit request: DataRequest[AnyContent]): CYAViewModel = {
     implicit val userAnswers: UserAnswers = request.userAnswers
 
     val beforeYouStart = AnswerSection(
@@ -76,7 +77,7 @@ class CheckYourAnswersBeforeYouStartController @Inject()(override val messagesAp
     val heading = (titleOrHeading: Message) =>
       if (mode == NormalMode) Message("checkYourAnswers.hs.title") else titleOrHeading
 
-    val returnToTaskListCall:Option[Call] = (request.administratorOrPractitioner, srn) match {
+    val returnToTaskListCall:Option[Call] = (request.administratorOrPractitioner, toSrn(srn)) match {
       case (Practitioner, Some(srn)) => Option(controllers.routes.PspSchemeTaskListController.onPageLoad(srn))
       case _ => None
     }

app/controllers/CheckYourAnswersBenefitsAndInsuranceController.scala

@@ -21,8 +21,9 @@ import identifiers._
 import models.AdministratorOrPractitioner.Practitioner
 import models.AuthEntity.PSP
 import models.Mode._
+import models.OptionalSchemeReferenceNumber.toSrn
 import models.requests.DataRequest
-import models.{CheckUpdateMode, Mode, NormalMode, UpdateMode}
+import models.{CheckUpdateMode, Mode, NormalMode, OptionalSchemeReferenceNumber, SchemeReferenceNumber, UpdateMode}
 import play.api.i18n.{I18nSupport, MessagesApi}
 import play.api.mvc.{Action, AnyContent, Call, MessagesControllerComponents}
 import uk.gov.hmrc.play.bootstrap.frontend.controller.FrontendBaseController
@@ -48,19 +49,19 @@ class CheckYourAnswersBenefitsAndInsuranceController @Inject()(override val mess
   extends FrontendBaseController
     with Enumerable.Implicits with I18nSupport with Retrievals {
 
-  def onPageLoad(mode: Mode, srn: Option[String]): Action[AnyContent] =
+  def onPageLoad(mode: Mode, srn: OptionalSchemeReferenceNumber): Action[AnyContent] =
     (authenticate() andThen getData(mode, srn) andThen allowAccess(srn) andThen requireData) {
       implicit request =>
         Ok(view(vm(mode, srn)))
     }
 
-  def pspOnPageLoad(srn: String): Action[AnyContent] =
-    (authenticate(Some(PSP)) andThen getPspData(srn) andThen allowAccess(Some(srn), allowPsa = true, allowPsp = true) andThen requireData) {
+  def pspOnPageLoad(srn: SchemeReferenceNumber): Action[AnyContent] =
+    (authenticate(Some(PSP)) andThen getPspData(srn) andThen allowAccess(OptionalSchemeReferenceNumber(Some(srn)), allowPsa = true, allowPsp = true) andThen requireData) {
       implicit request =>
-        Ok(view(vm(UpdateMode, Some(srn))))
+        Ok(view(vm(UpdateMode, OptionalSchemeReferenceNumber(Some(srn)))))
     }
 
-  private def vm(mode: Mode, srn: Option[String])(implicit request: DataRequest[AnyContent]): CYAViewModel = {
+  private def vm(mode: Mode, srn: OptionalSchemeReferenceNumber)(implicit request: DataRequest[AnyContent]): CYAViewModel = {
 
       implicit val userAnswers: UserAnswers = request.userAnswers
       val benefitsAndInsuranceSection = AnswerSection(
@@ -78,7 +79,7 @@ class CheckYourAnswersBenefitsAndInsuranceController @Inject()(override val mess
       val heading = (name: String) => if (mode == NormalMode) Message("checkYourAnswers.hs.title") else
         Message("messages__benefitsAndInsuranceDetailsFor", name)
 
-      val returnToTaskListCall:Option[Call] = (request.administratorOrPractitioner, srn) match {
+      val returnToTaskListCall:Option[Call] = (request.administratorOrPractitioner, toSrn(srn)) match {
         case (Practitioner, Some(srn)) => Option(controllers.routes.PspSchemeTaskListController.onPageLoad(srn))
         case _ => None
       }