Merge pull request #1892 from alphagov/add-user-research-contact-preference

Add user research contact preference

Author: alice-carr

app/controllers/account/contact_for_research_controller.rb

@@ -0,0 +1,39 @@
+module Account
+  class ContactForResearchController < WebController
+    include AfterSignInPathHelper
+
+    skip_before_action :redirect_if_account_not_completed
+
+    def edit
+      @contact_for_research_input = ContactForResearchInput.new(research_contact_status:, user: current_user)
+    end
+
+    def update
+      @contact_for_research_input = ContactForResearchInput.new(account_contact_for_research_params(current_user))
+
+      if @contact_for_research_input.submit
+        redirect_to next_path
+      else
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    def account_contact_for_research_params(user)
+      params.require(:account_contact_for_research_input).permit(:research_contact_status).merge(user:)
+    end
+
+  private
+
+    def redirect_contact_for_research_set
+      redirect_to root_path unless current_user.research_contact_to_be_asked?
+    end
+
+    def research_contact_status
+      current_user.research_contact_status.to_sym if current_user.research_contact_status.in?(ContactForResearchInput::RADIO_OPTIONS)
+    end
+
+    def next_path
+      after_sign_in_next_path
+    end
+  end
+end

app/controllers/reports_controller.rb

@@ -132,6 +132,12 @@ def live_questions_csv
               disposition: "attachment; filename=#{csv_filename('live_questions_report')}"
   end
 
+  def contact_for_research
+    data = Reports::ContactForResearchService.new.contact_for_research_data
+
+    render locals: { data: }
+  end
+
 private
 
   def questions_feature_report(tag, report, questions)

app/input_objects/account/contact_for_research_input.rb

@@ -0,0 +1,19 @@
+class Account::ContactForResearchInput < BaseInput
+  attr_accessor :user, :research_contact_status
+
+  RADIO_OPTIONS = %w[consented declined].freeze
+
+  validates :research_contact_status, presence: true, inclusion: { in: RADIO_OPTIONS }
+
+  def submit
+    return false if invalid?
+
+    user.research_contact_status = research_contact_status
+    user.user_research_opted_in_at = Time.zone.now
+    user.save!
+  end
+
+  def values
+    RADIO_OPTIONS
+  end
+end

app/lib/after_sign_in_path_helper.rb

@@ -8,7 +8,9 @@ def next_account_path
 
     return edit_account_name_path if current_user.name.blank?
 
-    edit_account_terms_of_use_path if current_user.terms_agreed_at.blank?
+    return edit_account_terms_of_use_path if current_user.terms_agreed_at.blank?
+
+    edit_account_contact_for_research_path if current_user.research_contact_to_be_asked?
   end
 
   def store_location(path)

app/models/user.rb

@@ -1,6 +1,5 @@
 class User < ApplicationRecord
   include GDS::SSO::User
-  has_paper_trail only: %i[role organisation_id has_access]
 
   class UserAuthenticationException < StandardError; end
 
@@ -21,6 +20,14 @@ class UserAuthenticationException < StandardError; end
 
   serialize :permissions, coder: YAML, type: Array
 
+  enum :research_contact_status, {
+    consented: "consented",
+    declined: "declined",
+    to_be_asked: "to_be_asked",
+  }, prefix: "research_contact"
+
+  has_paper_trail only: %i[role organisation_id has_access]
+
   enum :role, {
     super_admin: "super_admin",
     organisation_admin: "organisation_admin",

app/services/reports/contact_for_research_service.rb

@@ -0,0 +1,29 @@
+class Reports::ContactForResearchService
+  def contact_for_research_data
+    {
+      caption: I18n.t("reports.contact_for_research.heading"),
+      head: [
+        { text: I18n.t("reports.contact_for_research.table_headings.name") },
+        { text: I18n.t("reports.contact_for_research.table_headings.email") },
+        { text: I18n.t("reports.contact_for_research.table_headings.date_added") },
+      ],
+      rows:,
+    }
+  end
+
+private
+
+  def rows
+    as_data_rows(user_contact_for_research)
+  end
+
+  def as_data_rows(raw_data)
+    raw_data.map do |name, email, user_research_opted_in_at|
+      [{ text: name }, { text: email }, { text: user_research_opted_in_at.to_formatted_s(:long) }]
+    end
+  end
+
+  def user_contact_for_research
+    User.research_contact_consented.order(user_research_opted_in_at: :desc).pluck(:name, :email, :user_research_opted_in_at)
+  end
+end

app/views/account/contact_for_research/edit.html.erb

@@ -0,0 +1,18 @@
+<% set_page_title(title_with_error_prefix(t("page_titles.account_contact_for_research"), @contact_for_research_input.errors.any?)) %>
+
+<div class="govuk-grid-row">
+  <div class="govuk-grid-column-two-thirds">
+    <%= form_with(model: @contact_for_research_input, url: account_contact_for_research_path, method: :patch) do |f| %>
+      <%= f.govuk_error_summary %>
+
+      <h1 class="govuk-heading-l">
+        <%=t("page_titles.account_contact_for_research")%>
+      </h1>
+
+      <%= f.govuk_collection_radio_buttons :research_contact_status, @contact_for_research_input.values, :itself, legend: nil, hint:{ text: @hint } %>
+
+      <%= f.govuk_submit t('continue') %>
+    <% end %>
+  </div>
+</div>
+

app/views/reports/contact_for_research.html.erb

@@ -0,0 +1,11 @@
+<% set_page_title(t(".title")) %>
+<% content_for :back_link, govuk_back_link_to(reports_path, t("reports.back_link")) %>
+<div class="govuk-grid-row">
+  <div class="govuk-grid-column-two-thirds">
+    <h1 class="govuk-heading-l"><%= t(".title") %></h1>
+
+    <%= govuk_table(**data) %>
+
+  </div>
+</div>
+

app/views/reports/index.html.erb

@@ -10,6 +10,7 @@
       <li><%= govuk_link_to t("reports.users.title"), report_users_path %></li>
       <li><%= govuk_link_to t("reports.last_signed_in_at.title"), report_last_signed_in_at_path %></li>
       <li><%= govuk_link_to t("reports.csv_downloads.title"), report_csv_downloads_path %></li>
+      <li><%= govuk_link_to t("reports.contact_for_research.title"), report_contact_for_research_path %></li>
     </ul>
   </div>
 </div>

config/initializers/warden/strategies/user_research.rb

@@ -17,6 +17,8 @@ def prep_user(auth_hash)
       provider: Settings.auth_provider,
       uid: auth_hash[:uid],
       terms_agreed_at: Time.zone.now,
+      research_contact_status: "declined",
+      user_research_opted_in_at: Time.zone.now,
     )
   end