Merge pull request #2879 from DFE-Digital/AQTS-1164-dev-public-email-domain-blocking-eligibility-checker

Author: Hassanmir92

app/controllers/concerns/enforce_eligibility_question_order.rb

@@ -8,14 +8,26 @@ module EnforceEligibilityQuestionOrder
   def redirect_by_status
     return if current_page_is_allowed?
 
-    expected_path = paths[eligibility_check.status(includes_prioritisation:)]
+    expected_path =
+      paths[
+        eligibility_check.status(
+          includes_prioritisation:,
+          includes_email_domains_for_referees:,
+        )
+      ]
     redirect_to(expected_path) if expected_path && expected_path != request.path
   end
 
   private
 
   def current_page_is_allowed?
-    order = paths.keys.index(eligibility_check.status(includes_prioritisation:))
+    order =
+      paths.keys.index(
+        eligibility_check.status(
+          includes_prioritisation:,
+          includes_email_domains_for_referees:,
+        ),
+      )
     current_position = paths.values.index(request.path)
     current_position && order && current_position <= order
   end
@@ -27,16 +39,27 @@ def paths
       qualification: eligibility_interface_qualifications_path,
       degree: eligibility_interface_degree_path,
       work_experience: eligibility_interface_work_experience_path,
+      work_experience_referee:
+        eligibility_interface_work_experience_referee_path,
       misconduct: eligibility_interface_misconduct_path,
       work_experience_in_england:
         eligibility_interface_work_experience_in_england_path,
       teach_children: eligibility_interface_teach_children_path,
       qualified_for_subject: eligibility_interface_qualified_for_subject_path,
       result: eligibility_interface_result_path,
-    }.slice(*eligibility_check.status_route(includes_prioritisation:))
+    }.slice(
+      *eligibility_check.status_route(
+        includes_prioritisation:,
+        includes_email_domains_for_referees:,
+      ),
+    )
   end
 
   def includes_prioritisation
     FeatureFlags::FeatureFlag.active?(:prioritisation)
   end
+
+  def includes_email_domains_for_referees
+    FeatureFlags::FeatureFlag.active?(:email_domains_for_referees)
+  end
 end

app/controllers/eligibility_interface/result_controller.rb

@@ -6,6 +6,18 @@ class EligibilityInterface::ResultController < EligibilityInterface::BaseControl
   def show
     eligibility_check.complete! if eligibility_check.persisted?
 
-    render eligibility_check.eligible? ? "eligible" : "ineligible"
+    render(
+      if eligibility_check.eligible?(includes_email_domains_for_referees:)
+        "eligible"
+      else
+        "ineligible"
+      end,
+    )
+  end
+
+  private
+
+  def includes_email_domains_for_referees
+    FeatureFlags::FeatureFlag.active?(:email_domains_for_referees)
   end
 end

app/controllers/eligibility_interface/work_experience_controller.rb

@@ -14,7 +14,11 @@ def new
     def create
       @form = WorkExperienceForm.new(form_params.merge(eligibility_check:))
       if @form.save
-        redirect_to %i[eligibility_interface misconduct]
+        if FeatureFlags::FeatureFlag.active?(:email_domains_for_referees)
+          redirect_to %i[eligibility_interface work_experience_referee]
+        else
+          redirect_to %i[eligibility_interface misconduct]
+        end
       else
         render :new, status: :unprocessable_entity
       end

app/controllers/eligibility_interface/work_experience_referee_controller.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module EligibilityInterface
+  class WorkExperienceRefereeController < BaseController
+    include EnforceEligibilityQuestionOrder
+
+    def new
+      @form =
+        WorkExperienceRefereeForm.new(
+          eligibility_check: eligibility_check,
+          work_experience_referee: eligibility_check.work_experience_referee,
+        )
+    end
+
+    def create
+      @form =
+        WorkExperienceRefereeForm.new(form_params.merge(eligibility_check:))
+      if @form.save
+        redirect_to %i[eligibility_interface misconduct]
+      else
+        render :new, status: :unprocessable_entity
+      end
+    end
+
+    private
+
+    def form_params
+      params.require(
+        :eligibility_interface_work_experience_referee_form,
+      ).permit(:work_experience_referee)
+    end
+  end
+end

app/forms/eligibility_interface/work_experience_referee_form.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class EligibilityInterface::WorkExperienceRefereeForm
+  include ActiveModel::Model
+  include ActiveModel::Attributes
+
+  attr_accessor :eligibility_check
+  attribute :work_experience_referee, :boolean
+
+  validates :eligibility_check, presence: true
+  validates :work_experience_referee, inclusion: { in: [true, false] }
+
+  def save
+    return false unless valid?
+
+    eligibility_check.update!(work_experience_referee:)
+  end
+end

app/models/eligibility_check.rb

@@ -14,6 +14,7 @@
 #  qualified_for_subject               :boolean
 #  teach_children                      :boolean
 #  work_experience                     :string
+#  work_experience_referee             :boolean
 #  created_at                          :datetime         not null
 #  updated_at                          :datetime         not null
 #  region_id                           :bigint
@@ -89,6 +90,10 @@ def skip_additional_questions?
     country&.eligibility_skip_questions || false
   end
 
+  def reduced_evidence_accepted?
+    region&.reduced_evidence_accepted || false
+  end
+
   def ineligible_reasons
     work_experience_ineligible = work_experience_under_9_months?
 
@@ -118,16 +123,21 @@ def ineligible_reasons
       (:qualified_for_subject if qualified_for_subject_ineligible),
       (:misconduct if free_of_sanctions == false),
       (:work_experience if work_experience_ineligible),
+      (:work_experience_referee if work_experience_referee == false),
     ].compact
   end
 
-  def eligible?
+  def eligible?(includes_email_domains_for_referees: false)
     if skip_additional_questions? && region.present? && qualification
       return true
     end
 
     region.present? && qualification && degree && teach_children? &&
-      free_of_sanctions && !work_experience_under_9_months?
+      free_of_sanctions && !work_experience_under_9_months? &&
+      (
+        work_experience_referee? || reduced_evidence_accepted? ||
+          !includes_email_domains_for_referees
+      )
   end
 
   def country_eligibility_status
@@ -155,7 +165,10 @@ def completed?
     completed_at.present?
   end
 
-  def status(includes_prioritisation: false)
+  def status(
+    includes_prioritisation: false,
+    includes_email_domains_for_referees: false
+  )
     return :country if country_code.blank?
 
     return :result if country_eligibility_status == :ineligible
@@ -167,6 +180,12 @@ def status(includes_prioritisation: false)
       return :degree if degree.nil?
 
       return :work_experience if work_experience.blank?
+
+      if includes_email_domains_for_referees && !reduced_evidence_accepted? &&
+           work_experience_referee.nil?
+        return :work_experience_referee
+      end
+
       return :misconduct if free_of_sanctions.nil?
 
       if includes_prioritisation && eligible_work_experience_in_england.nil?
@@ -184,13 +203,23 @@ def status(includes_prioritisation: false)
     :result
   end
 
-  def status_route(includes_prioritisation: false)
+  def status_route(
+    includes_prioritisation: false,
+    includes_email_domains_for_referees: false
+  )
     if country_code.present? && country_eligibility_status == :ineligible
       %i[country result]
     elsif skip_additional_questions? && qualification
       %i[country region qualification result]
     else
-      %i[country region qualification degree work_experience misconduct] +
+      %i[country region qualification degree work_experience] +
+        (
+          if includes_email_domains_for_referees && !reduced_evidence_accepted?
+            %i[work_experience_referee]
+          else
+            []
+          end
+        ) + %i[misconduct] +
         (
           if includes_prioritisation
             %i[work_experience_in_england]

app/views/eligibility_interface/misconduct/new.html.erb

@@ -1,5 +1,9 @@
+<%
+  back_link_url = FeatureFlags::FeatureFlag.active?(:email_domains_for_referees) && !@region.reduced_evidence_accepted ? eligibility_interface_work_experience_referee_path : eligibility_interface_work_experience_path
+%>
+
 <% content_for :page_title, title_with_error_prefix("Do you have any sanctions or restrictions on your employment record?", error: @form.errors.any?) %>
-<% content_for :back_link_url, eligibility_interface_work_experience_path %>
+<% content_for :back_link_url, back_link_url %>
 
 <%= form_with model: @form, url: [:eligibility_interface, :misconduct] do |f| %>
   <%= f.govuk_error_summary %>

app/views/eligibility_interface/start/show.erb

@@ -43,6 +43,9 @@
   <li>completed all mandatory induction processes to gain full teacher registration in the country where you qualified</li>
   <li>qualifications to show you can teach children aged anywhere between 5 and 16 years old</li>
   <li>at least one school year (9 months) of experience employed as a teacher in any country, but must be from after you first became qualified to teach</li>
+  <% if FeatureFlags::FeatureFlag.active?(:email_domains_for_referees) %>
+    <li>references that can confirm your work history and have an email address that uses the school’s domain, for example, name@school.edu</li>
+  <% end %>
 </ul>
 
 <p class="govuk-body">Depending on the country that you trained to teach in, you may be required to have:</p>

app/views/eligibility_interface/work_experience/new.html.erb

@@ -27,7 +27,7 @@
     hint: { text: hint.html_safe }
   ) %>
 
-  <% unless @region.reduced_evidence_accepted %>
+  <% unless @region.reduced_evidence_accepted || FeatureFlags::FeatureFlag.active?(:email_domains_for_referees) %>
     <p class="govuk-body">You’ll need to provide references from your places of employment so we can verify your teaching work history.</p>
   <% end %>
 

app/views/eligibility_interface/work_experience_referee/new.html.erb

@@ -0,0 +1,37 @@
+<%
+  hint = "
+    You’ll need to provide references from your places of employment so we can verify your teaching work history. They must meet all of the following requirements:
+    <ul class='govuk-list govuk-list--bullet govuk-hint'>
+      <li>they have an email address that uses the institution’s domain, for example, name@institution.edu</li>
+      <li>they are a senior member of staff that is still working at this institution (either a headteacher/principal, an assistant/deputy head, or an institution business manager)</li>
+      <li>they are able to provide a reference in English</li>
+      <li>they only comment on teaching work that you did after becoming a qualified teacher</li>
+    </ul>
+  ".html_safe
+%>
+
+<% content_for :page_title, title_with_error_prefix(t("helpers.legend.eligibility_interface_work_experience_referee_form.work_experience_referee"), error: @form.errors.any?) %>
+<% content_for :back_link_url, eligibility_interface_work_experience_path %>
+
+<%= form_with model: @form, url: [:eligibility_interface, :work_experience_referee] do |f| %>
+  <%= f.govuk_error_summary %>
+
+  <%= f.govuk_collection_radio_buttons(
+    :work_experience_referee,
+    [
+      OpenStruct.new(label: 'Yes', value: true),
+      OpenStruct.new(label: 'No', value: false)
+    ],
+    :value,
+    :label,
+    legend: { size: 'l', tag: 'h1' },
+    hint: { text: hint.html_safe }
+  ) %>
+
+  <%= govuk_details(summary_text: "About your references’ email addresses") do %>
+    <p>A domain is the part of an email address that shows who provides it. It comes after the @ symbol. For example, in name@institution.edu the domain is institution.edu.</p>
+    <p>We only accept references from official email addresses to verify they are genuine staff members of a recognised institution. To verify your work history, we will also check that the email domain is listed on the institution’s website.</p>
+  <% end %>
+
+  <%= f.govuk_submit %>
+<% end %>