Add consent fields to qualification requests

app/models/document.rb

@@ -68,7 +68,8 @@ def allow_multiple_uploads?
   end
 
   def optional?
-    written_statement? && application_form.written_statement_optional
+    (signed_consent? && !documentable.signed_consent_document_required) ||
+      (written_statement? && application_form.written_statement_optional)
   end
 
   def for_further_information_request?

app/models/qualification_request.rb

@@ -5,13 +5,16 @@
 # Table name: qualification_requests
 #
 #  id                                   :bigint           not null, primary key
+#  consent_received_at                  :datetime
+#  consent_requested_at                 :datetime
 #  expired_at                           :datetime
 #  location_note                        :text             default(""), not null
 #  received_at                          :datetime
 #  requested_at                         :datetime
 #  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
@@ -39,10 +42,37 @@ class QualificationRequest < ApplicationRecord
 
   belongs_to :qualification
 
+  scope :consent_required, -> { where(signed_consent_document_required: true) }
+  scope :consent_requested, -> { where.not(consent_requested_at: nil) }
+  scope :consent_received, -> { where.not(consent_received_at: nil) }
+  scope :consent_respondable,
+        -> do
+          consent_required
+            .consent_requested
+            .where(consent_received_at: nil)
+            .merge(ApplicationForm.assessable)
+        end
+
   scope :order_by_role, -> { order("qualifications.start_date": :desc) }
   scope :order_by_user, -> { order("qualifications.created_at": :asc) }
 
   def expires_after
     6.weeks
   end
+
+  def consent_requested!
+    update!(consent_requested_at: Time.zone.now)
+  end
+
+  def consent_requested?
+    consent_requested_at != nil
+  end
+
+  def consent_received!
+    update!(consent_received_at: Time.zone.now)
+  end
+
+  def consent_received?
+    consent_received_at != nil
+  end
 end

config/analytics.yml

@@ -208,6 +208,8 @@
     - part_of_university_degree
   :qualification_requests:
     - assessment_id
+    - consent_received_at
+    - consent_requested_at
     - created_at
     - expired_at
     - id
@@ -218,6 +220,7 @@
     - review_note
     - review_passed
     - reviewed_at
+    - signed_consent_document_required
     - unsigned_consent_document_downloaded
     - updated_at
     - verified_at

db/migrate/20240208101256_add_consent_to_qualification_requests.rb

@@ -0,0 +1,9 @@
+class AddConsentToQualificationRequests < ActiveRecord::Migration[7.1]
+  def change
+    change_table :qualification_requests, bulk: true do |t|
+      t.datetime :consent_received_at
+      t.datetime :consent_requested_at
+      t.boolean :signed_consent_document_required, default: false, null: false
+    end
+  end
+end

spec/components/check_your_answers_summary_component_spec.rb

@@ -29,7 +29,7 @@
       custom_key: "Custom key value",
       nil_value: nil,
       boolean: true,
-      document: create(:document, :with_upload),
+      document: create(:document, :with_upload, document_type: :identification),
       array: %w[a b c],
       translatable_document:,
     )

spec/factories/qualification_requests.rb

@@ -5,13 +5,16 @@
 # Table name: qualification_requests
 #
 #  id                                   :bigint           not null, primary key
+#  consent_received_at                  :datetime
+#  consent_requested_at                 :datetime
 #  expired_at                           :datetime
 #  location_note                        :text             default(""), not null
 #  received_at                          :datetime
 #  requested_at                         :datetime
 #  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

spec/models/qualification_request_spec.rb

@@ -5,13 +5,16 @@
 # Table name: qualification_requests
 #
 #  id                                   :bigint           not null, primary key
+#  consent_received_at                  :datetime
+#  consent_requested_at                 :datetime
 #  expired_at                           :datetime
 #  location_note                        :text             default(""), not null
 #  received_at                          :datetime
 #  requested_at                         :datetime
 #  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
@@ -43,6 +46,9 @@
   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) }
+
     context "when received" do
       subject { build(:qualification_request, :received) }
 
@@ -54,4 +60,28 @@
     subject(:expires_after) { described_class.new.expires_after }
     it { is_expected.to eq(6.weeks) }
   end
+
+  describe "#consent_requested!" do
+    let(:call) { subject.consent_requested! }
+
+    it "sets the consent requested at date" do
+      freeze_time do
+        expect { call }.to change(subject, :consent_requested_at).from(nil).to(
+          Time.zone.now,
+        )
+      end
+    end
+  end
+
+  describe "#consent_received!" do
+    let(:call) { subject.consent_received! }
+
+    it "sets the consent received at date" do
+      freeze_time do
+        expect { call }.to change(subject, :consent_received_at).from(nil).to(
+          Time.zone.now,
+        )
+      end
+    end
+  end
 end