Add submission attachments controller and view

Adds a submission attachments controller, where a form submission_format
can be set to blank, csv or json.

If the json_submission_enabled feature flag is not turned on, it will
return a 404 when accessing the controller's actions.

A success message is played if the form's submission_format has been
changed - depending on what it has been changed to.

Author: SamJamCul

app/controllers/forms/submission_attachments_controller.rb

@@ -0,0 +1,47 @@
+module Forms
+  class SubmissionAttachmentsController < WebController
+    before_action :json_submission_enabled?
+    after_action :verify_authorized
+
+    def new
+      authorize current_form, :can_view_form?
+      @submission_attachments_input = SubmissionAttachmentsInput.new(form: current_form).assign_form_values
+    end
+
+    def create
+      authorize current_form, :can_view_form?
+      @submission_attachments_input = SubmissionAttachmentsInput.new(submission_attachments_input_params)
+
+      if @submission_attachments_input.submit
+        redirect_to form_path(current_form.id), success: success_message(current_form)
+      else
+        render :new, status: :unprocessable_content
+      end
+    end
+
+  private
+
+    def submission_attachments_input_params
+      params.require(:forms_submission_attachments_input).permit(submission_format: []).merge(form: current_form)
+    end
+
+    def json_submission_enabled?
+      redirect_to error_404_path unless Settings.features.json_submission_enabled
+    end
+
+    def success_message(form)
+      return nil unless form.submission_format_previously_changed?
+
+      case form.submission_format
+      when []
+        t("banner.success.form.receive_no_attachments")
+      when %w[csv]
+        t("banner.success.form.receive_csv_enabled")
+      when %w[json]
+        t("banner.success.form.receive_json_enabled")
+      when %w[csv json]
+        t("banner.success.form.receive_csv_and_json_enabled")
+      end
+    end
+  end
+end

app/views/forms/submission_attachments/new.html.erb

@@ -0,0 +1,25 @@
+<% set_page_title(title_with_error_prefix(t(".title"), @submission_attachments_input.errors.any?)) %>
+<% content_for :back_link, govuk_back_link_to(form_path, t("back_link.form_create")) %>
+
+<div class="govuk-grid-row">
+  <div class="govuk-grid-column-two-thirds">
+    <%= form_with(model: @submission_attachments_input, url: submission_attachments_create_path) do |f| %>
+      <% if @submission_attachments_input&.errors.any? %>
+        <%= f.govuk_error_summary %>
+      <% end %>
+
+      <span class="govuk-caption-l"><%= @submission_attachments_input.form.name %></span>
+      <h1 class="govuk-heading-l">
+        <%= t(".title") %>
+      </h1>
+
+      <%= t(".body_html") %>
+
+      <%= f.govuk_check_boxes_fieldset :submission_format, legend: { tag: 'h2', size: 'm' } do %>
+        <%= f.govuk_check_box :submission_format, "csv" %>
+        <%= f.govuk_check_box :submission_format, "json" %>
+      <% end %>
+      <%= f.govuk_submit t(".submit") %>
+    <% end %>
+  </div>
+</div>

config/locales/en.yml

@@ -75,16 +75,14 @@ en:
         forms/delete_confirmation_input:
           blank: Select ‘Yes’ to delete the draft
         forms/submission_attachments_input:
-          invalid_submission_format: Choose if you want to get completed forms as CSV or JSON files
           attributes:
             submission_format:
               blank: Choose if you want to get completed forms as CSV or JSON files
+          invalid_submission_format: Choose if you want to get completed forms as CSV or JSON files
         forms/submission_type_input:
           attributes:
             submission_type:
               blank: Choose if you want to get completed forms as CSV files
-        forms/submission_attachments_input:
-          invalid_submission_format: Choose if you want to get completed forms as CSV or JSON files
         group_member_input:
           attributes:
             member_email_address:
@@ -226,8 +224,11 @@ en:
         payment_link_removed: Your payment link has been removed
         payment_link_saved: Your payment link has been saved
         privacy_details_saved: Your privacy information link has been saved
+        receive_csv_and_json_enabled: Completed form emails will include a CSV and a JSON file
         receive_csv_disabled: Completed form emails will not include a CSV file
         receive_csv_enabled: Completed form emails will include a CSV file
+        receive_json_enabled: Completed form emails will include a JSON file
+        receive_no_attachments: Completed form emails will not include a CSV or JSON file
         share_preview_completed: The preview task has been completed
         support_details_saved: Your contact details for support have been saved
         welsh_translation_saved: The Welsh version of your form has been saved
@@ -390,6 +391,21 @@ en:
           <p>If you select this option, a CSV file will be attached to each completed form email.</p>
         submit: Save and continue
         title: Get completed forms as CSV files
+    submission_attachments:
+      new:
+        body_html: |
+          <p>When your form’s completed, the answers provided will be sent in the body of an email to the email address you set.</p>
+
+          <p>You can also get the answers in:</p>
+
+          <ul class="govuk-list govuk-list--bullet">
+            <li>A CSV file - this lists all the answers in plain text, separated by commas. It can be easily imported into a spreadsheet or database application.</li>
+            <li>a JSON file - this is a plain text format for exchanging and storing data. It can make it easier to use automated processing for your form submissions.</li>
+          </ul>
+
+          <p>If you select one or both of these options, the files will be attached to each completed form email.</p>
+        submit: Save and continue
+        title: Get a CSV or JSON file of each completed form
     task_list_create:
       create_form_section:
         declaration: Add a declaration for people to agree to
@@ -826,6 +842,10 @@ en:
         confirm: Are you sure you want to make your draft live?
       forms_make_live_input:
         confirm: Are you sure you want to make your form live?
+      forms_submission_attachments_input:
+        submission_format_options:
+          csv: Get a CSV file of each completed form
+          json: Get a JSON file of each completed form
       forms_submission_type_input:
         submission_type_options:
           email_with_csv: Get CSV files
@@ -972,6 +992,8 @@ en:
     legend:
       account_terms_of_use_input:
         agreed: Do you agree to these terms?
+      forms_submission_attachments_input:
+        submission_format: Do you want to get a CSV or JSON file of each completed form?
       forms_submission_type_input:
         submission_type: Do you want to get completed forms as CSV files?
       mou_signature:

spec/requests/forms/submission_attachments_controller_spec.rb

@@ -0,0 +1,143 @@
+require "rails_helper"
+
+RSpec.describe Forms::SubmissionAttachmentsController, type: :request do
+  let(:form) { create(:form, :live, submission_format: original_submission_format) }
+  let(:original_submission_format) { [] }
+
+  before do
+    login_as_super_admin_user
+  end
+
+  describe "#new" do
+    context "when the json_submission_enabled feature flag is off" do
+      before do
+        allow(Settings.features).to receive(:json_submission_enabled).and_return(false)
+
+        get submission_attachments_path(form_id: form.id)
+      end
+
+      it "returns a 404 page" do
+        expect(response).to redirect_to :error_404
+      end
+    end
+
+    context "when the json_submission_enabled feature flag is on" do
+      before do
+        allow(Settings.features).to receive(:json_submission_enabled).and_return(true)
+
+        get submission_attachments_path(form_id: form.id)
+      end
+
+      it "renders the submission attachments view" do
+        expect(response).to have_rendered :new
+      end
+
+      it "uses the form submission attachments input" do
+        expect(assigns).to include submission_attachments_input: an_instance_of(Forms::SubmissionAttachmentsInput)
+      end
+    end
+  end
+
+  describe "#create" do
+    let(:params) { { forms_submission_attachments_input: { submission_format: } } }
+
+    context "when the json_submission_enabled feature flag is off" do
+      before do
+        allow(Settings.features).to receive(:json_submission_enabled).and_return(false)
+      end
+
+      it "returns a 404 page" do
+        post submission_attachments_path(form_id: form.id)
+        expect(response).to redirect_to :error_404
+      end
+    end
+
+    context "when the json_submission_enabled feature flag is on" do
+      before do
+        allow(Settings.features).to receive(:json_submission_enabled).and_return(true)
+      end
+
+      context "when params are valid" do
+        let(:submission_format) { %w[csv json] }
+
+        it "updates the form submission format" do
+          expect {
+            post(submission_attachments_path(form_id: form.id), params:)
+          }.to change { form.reload.submission_format }.to(submission_format)
+        end
+
+        it "redirects you to the form overview page" do
+          post(submission_attachments_path(form_id: form.id), params:)
+          expect(response).to redirect_to(form_path(form.id))
+        end
+
+        context "when submission format has changed to 'csv'" do
+          let(:submission_format) { %w[csv] }
+
+          it "displays a success flash message" do
+            post(submission_attachments_path(form_id: form.id), params:)
+            expect(flash[:success]).to eq(I18n.t("banner.success.form.receive_csv_enabled"))
+          end
+        end
+
+        context "when submission format has changed to 'json'" do
+          let(:submission_format) { %w[json] }
+
+          it "displays a success flash message" do
+            post(submission_attachments_path(form_id: form.id), params:)
+            expect(flash[:success]).to eq(I18n.t("banner.success.form.receive_json_enabled"))
+          end
+        end
+
+        context "when submission format has changed to 'csv json'" do
+          let(:submission_format) { %w[csv json] }
+
+          it "displays a success flash message" do
+            post(submission_attachments_path(form_id: form.id), params:)
+            expect(flash[:success]).to eq(I18n.t("banner.success.form.receive_csv_and_json_enabled"))
+          end
+        end
+
+        context "when submission format has changed to blank" do
+          let(:original_submission_format) { %w[csv json] }
+          let(:submission_format) { %w[] }
+
+          it "displays a success flash message" do
+            post(submission_attachments_path(form_id: form.id), params:)
+            expect(flash[:success]).to eq(I18n.t("banner.success.form.receive_no_attachments"))
+          end
+        end
+
+        context "when submission format has not changed" do
+          let(:submission_format) { %w[] }
+
+          it "does not display a flash message" do
+            post(submission_attachments_path(form_id: form.id), params:)
+            expect(flash[:success]).to be_nil
+          end
+        end
+      end
+
+      context "when params are invalid" do
+        let(:submission_format) { %w[apple] }
+
+        it "returns 422" do
+          post(submission_attachments_path(form_id: form.id), params:)
+          expect(response).to have_http_status(:unprocessable_content)
+        end
+
+        it "does not update the form" do
+          expect {
+            post(submission_attachments_path(form_id: form.id), params:)
+          }.not_to(change { form.reload.submission_format })
+        end
+
+        it "re-renders the page with an error" do
+          post(submission_attachments_path(form_id: form.id), params:)
+          expect(response).to render_template("new")
+          expect(response.body).to include(I18n.t("activemodel.errors.models.forms/submission_attachments_input.invalid_submission_format"))
+        end
+      end
+    end
+  end
+end