Merge pull request #1995 from DFE-Digital/consent-method

Capture consent method more accurately
DFE-Digital · Feb 15, 2024 · 3dfcb47 · 3dfcb47
2 parents a6255d6 + 5e1294f
commit 3dfcb47
Show file tree

Hide file tree

Showing 9 changed files with 61 additions and 12 deletions.
diff --git a/app/mailers/teacher_mailer.rb b/app/mailers/teacher_mailer.rb
@@ -58,7 +58,11 @@ def application_received
 
   def consent_reminder
     @expires_at =
-      assessment.qualification_requests.consent_required.map(&:expires_at).max
+      assessment
+        .qualification_requests
+        .signed_consent_required
+        .map(&:expires_at)
+        .max
 
     view_mail(
       GOVUK_NOTIFY_TEMPLATE_ID,
@@ -69,7 +73,11 @@ def consent_reminder
 
   def consent_requested
     @expires_at =
-      assessment.qualification_requests.consent_required.map(&:expires_at).max
+      assessment
+        .qualification_requests
+        .signed_consent_required
+        .map(&:expires_at)
+        .max
 
     view_mail(
       GOVUK_NOTIFY_TEMPLATE_ID,

diff --git a/app/models/document.rb b/app/models/document.rb
@@ -68,7 +68,7 @@ def allow_multiple_uploads?
   end
 
   def optional?
-    (signed_consent? && !documentable.signed_consent_document_required) ||
+    (signed_consent? && !documentable.signed_consent_required?) ||
       (written_statement? && application_form.written_statement_optional)
   end
 

diff --git a/app/models/qualification_request.rb b/app/models/qualification_request.rb
@@ -5,6 +5,7 @@
 # Table name: qualification_requests
 #
 #  id                                   :bigint           not null, primary key
+#  consent_method                       :string           default("unknown"), not null
 #  consent_received_at                  :datetime
 #  consent_requested_at                 :datetime
 #  expired_at                           :datetime
@@ -14,7 +15,6 @@
 #  review_note                          :string           default(""), not null
 #  review_passed                        :boolean
 #  reviewed_at                          :datetime
-#  signed_consent_document_required     :boolean          default(FALSE), not null
 #  unsigned_consent_document_downloaded :boolean          default(FALSE), not null
 #  verified_at                          :datetime
 #  verify_note                          :text             default(""), not null
@@ -42,7 +42,19 @@ class QualificationRequest < ApplicationRecord
 
   belongs_to :qualification
 
-  scope :consent_required, -> { where(signed_consent_document_required: true) }
+  enum consent_method: {
+         signed_ecctis: "signed_ecctis",
+         signed_institution: "signed_institution",
+         unknown: "unknown",
+         unsigned: "unsigned",
+       },
+       _prefix: true
+
+  scope :signed_consent_required,
+        -> do
+          consent_method_signed_ecctis.or(consent_method_signed_institution)
+        end
+
   scope :consent_requested, -> { where.not(consent_requested_at: nil) }
   scope :consent_received, -> { where.not(consent_received_at: nil) }
   scope :consent_respondable,
@@ -62,6 +74,10 @@ def expires_after
     6.weeks
   end
 
+  def signed_consent_required?
+    consent_method_signed_ecctis? || consent_method_signed_institution?
+  end
+
   def consent_requested!
     update!(consent_requested_at: Time.zone.now)
   end

diff --git a/app/view_objects/teacher_interface/application_form_view_object.rb b/app/view_objects/teacher_interface/application_form_view_object.rb
@@ -156,7 +156,7 @@ def qualification_consent_submitted?
     return false if assessment.nil?
 
     required_qualification_requests =
-      qualification_requests.where(signed_consent_document_required: true)
+      qualification_requests.signed_consent_required
 
     return false if required_qualification_requests.empty?
 

diff --git a/config/analytics.yml b/config/analytics.yml
@@ -208,6 +208,7 @@
     - part_of_university_degree
   :qualification_requests:
     - assessment_id
+    - consent_method
     - consent_received_at
     - consent_requested_at
     - created_at
@@ -220,7 +221,6 @@
     - review_note
     - review_passed
     - reviewed_at
-    - signed_consent_document_required
     - unsigned_consent_document_downloaded
     - updated_at
     - verified_at

diff --git a/db/migrate/20240215085624_add_consent_method_to_qualification_requests.rb b/db/migrate/20240215085624_add_consent_method_to_qualification_requests.rb
@@ -0,0 +1,11 @@
+class AddConsentMethodToQualificationRequests < ActiveRecord::Migration[7.1]
+  def change
+    change_table :qualification_requests, bulk: true do |t|
+      t.remove :signed_consent_document_required,
+               type: :boolean,
+               default: false,
+               null: false
+      t.string :consent_method, default: "unknown", null: false
+    end
+  end
+end
diff --git a/db/schema.rb b/db/schema.rb
diff --git a/spec/factories/qualification_requests.rb b/spec/factories/qualification_requests.rb
@@ -5,6 +5,7 @@
 # Table name: qualification_requests
 #
 #  id                                   :bigint           not null, primary key
+#  consent_method                       :string           default("unknown"), not null
 #  consent_received_at                  :datetime
 #  consent_requested_at                 :datetime
 #  expired_at                           :datetime
@@ -14,7 +15,6 @@
 #  review_note                          :string           default(""), not null
 #  review_passed                        :boolean
 #  reviewed_at                          :datetime
-#  signed_consent_document_required     :boolean          default(FALSE), not null
 #  unsigned_consent_document_downloaded :boolean          default(FALSE), not null
 #  verified_at                          :datetime
 #  verify_note                          :text             default(""), not null
@@ -40,7 +40,7 @@
     association :qualification, :completed
 
     trait :consent_required do
-      signed_consent_document_required { true }
+      consent_method { %i[signed_ecctis signed_institution].sample }
 
       after(:create) do |qualification_request, _evaluator|
         create(

diff --git a/spec/models/qualification_request_spec.rb b/spec/models/qualification_request_spec.rb
@@ -5,6 +5,7 @@
 # Table name: qualification_requests
 #
 #  id                                   :bigint           not null, primary key
+#  consent_method                       :string           default("unknown"), not null
 #  consent_received_at                  :datetime
 #  consent_requested_at                 :datetime
 #  expired_at                           :datetime
@@ -14,7 +15,6 @@
 #  review_note                          :string           default(""), not null
 #  review_passed                        :boolean
 #  reviewed_at                          :datetime
-#  signed_consent_document_required     :boolean          default(FALSE), not null
 #  unsigned_consent_document_downloaded :boolean          default(FALSE), not null
 #  verified_at                          :datetime
 #  verify_note                          :text             default(""), not null
@@ -45,6 +45,20 @@
     subject { create(:qualification_request, :receivable) }
   end
 
+  describe "columns" do
+    it do
+      is_expected.to define_enum_for(:consent_method)
+        .with_values(
+          signed_ecctis: "signed_ecctis",
+          signed_institution: "signed_institution",
+          unknown: "unknown",
+          unsigned: "unsigned",
+        )
+        .with_prefix
+        .backed_by_column_of_type(:string)
+    end
+  end
+
   describe "validations" do
     it { is_expected.to_not validate_presence_of(:consent_requested_at) }
     it { is_expected.to_not validate_presence_of(:consent_received_at) }