Upload transactions in bulk as CSV

This exposes the functionality of ImportTransactions via a file upload
that accepts CSV. The CSV is parsed in the controller and the resulting
rows fed into the importer, which itself is thoroughly unit-tested.

If any errors occur, then no transactions are imported, and the errors
are displayed to the user. If all the rows are valid, then the
transactions are saved and a success message is displayed.

app/controllers/staff/transaction_uploads_controller.rb

@@ -22,6 +22,25 @@ def show
     response.stream.close
   end
 
+  def update
+    @report_presenter = ReportPresenter.new(@report)
+    rows = parse_transactions_from_upload
+
+    if rows.nil?
+      @errors = []
+      flash.now[:error] = t("action.transaction.upload.file_missing")
+      return
+    end
+
+    importer = ImportTransactions.new(report: @report, uploader: current_user)
+    importer.import(rows)
+    @errors = importer.errors
+
+    if @errors.empty?
+      flash.now[:notice] = t("action.transaction.upload.success")
+    end
+  end
+
   private def authorize_report
     @report = Report.find(params[:report_id])
     authorize @report, :show?
@@ -38,4 +57,13 @@ def show
       activity.roda_identifier_compound,
     ]
   end
+
+  private def parse_transactions_from_upload
+    file = params[:report]&.fetch(:transaction_csv, nil)
+    return nil unless file
+
+    CSV.parse(file.read, headers: true)
+  rescue
+    nil
+  end
 end

app/services/import_transactions.rb

@@ -1,7 +1,11 @@
 require "date"
 
 class ImportTransactions
-  Error = Struct.new(:row, :column, :value, :message)
+  Error = Struct.new(:row, :column, :value, :message) {
+    def csv_row
+      row + 2
+    end
+  }
 
   attr_reader :errors
 

app/views/staff/transaction_uploads/_error_table.html.haml

@@ -0,0 +1,15 @@
+%table.govuk-table
+  %caption.govuk-table__caption List of errors in your uploaded CSV file
+  %thead.govuk-table__head
+    %tr.govuk-table__row
+      %th.govuk-table__header{scope: "col"} Column
+      %th.govuk-table__header{scope: "col"} Row
+      %th.govuk-table__header{scope: "col"} Current Value
+      %th.govuk-table__header{scope: "col"} Error description
+  %tbody.govuk-table__body
+    - @errors.each do |error|
+      %tr.govuk-table__row
+        %td.govuk-table__cell= error.column
+        %td.govuk-table__cell= error.csv_row
+        %td{class: "govuk-table__cell govuk-!-font-weight-bold error-text"}= error.value
+        %td.govuk-table__cell= error.message

app/views/staff/transaction_uploads/_upload_form.html.haml

@@ -0,0 +1,9 @@
+.govuk-grid-row
+  .govuk-grid-column-two-thirds
+    = form_for @report_presenter, url: report_transaction_upload_path(@report_presenter) do |f|
+
+      = f.govuk_file_field :transaction_csv,
+        label: { text: t("form.label.transaction.csv_file") },
+        hint_text: t("form.hint.transaction.csv_file")
+
+      = f.govuk_submit t("action.transaction.upload.button")

app/views/staff/transaction_uploads/new.html.haml

@@ -7,3 +7,5 @@
   .govuk-grid-row
     .govuk-grid-column-full.page-actions
       = link_to t("action.transaction.download.button"), report_transaction_upload_path(@report_presenter, format: :csv), class: "govuk-button govuk-button--secondary govuk-!-margin-left-4"
+
+  = render partial: "upload_form"

app/views/staff/transaction_uploads/update.html.haml

@@ -0,0 +1,12 @@
+%main.govuk-main-wrapper#main-content{ role: "main" }
+  .govuk-grid-row
+    .govuk-grid-column-two-thirds
+      %h1.govuk-heading-xl
+        = t("page_title.transaction.upload")
+
+  - unless @errors.empty?
+    .govuk-grid-row
+      .govuk-grid-column-full
+        = render partial: "error_table"
+
+  = render partial: "upload_form"

config/locales/models/transaction.en.yml

@@ -9,10 +9,14 @@ en:
       download:
         button: Download CSV template
       upload:
+        button: Upload and continue
+        file_missing: Please upload a valid CSV file
         link: Upload actuals
+        success: The transactions were successfully imported.
   form:
     label:
       transaction:
+        csv_file: Transaction spreadsheet
         currency: Currency
         description: Describe the transaction
         disbursement_channel: Disbursement channel (optional)
@@ -31,6 +35,7 @@ en:
         receiving_organisation: Receiving organisation
     hint:
       transaction:
+        csv_file: Upload a spreadsheet containing transaction information in CSV format.
         date: If you're reporting quarterly data, select the last day of the quarter. For example, 31 12 2020
         description: For example, 2020 quarter one spend on the Early Career Research Network project.
         disbursement_channel: The channel through which the funds will flow for this transaction.

config/routes.rb

@@ -25,7 +25,7 @@
 
     resources :reports, only: [:show, :edit, :update, :index] do
       resource :state, only: [:edit, :update], controller: :reports_state
-      resource :transaction_upload, only: [:new, :show]
+      resource :transaction_upload, only: [:new, :show, :update]
       get "variance" => "report_variance#show"
       get "budgets" => "report_budgets#show"
     end

spec/features/staff/users_can_upload_transactions.rb

@@ -51,4 +51,69 @@
       },
     ])
   end
+
+  scenario "not uploading a file" do
+    click_button t("action.transaction.upload.button")
+    expect(Transaction.count).to eq(0)
+    expect(page).to have_text(t("action.transaction.upload.file_missing"))
+  end
+
+  scenario "uploading a valid set of transactions" do
+    ids = [project, sibling_project].map(&:roda_identifier_compound)
+
+    upload_csv <<~CSV
+      Activity RODA Identifier | Date       | Value | Receiving Organisation Name | Receiving Organisation Type | Receiving Organisation IATI Reference | Disbursement Channel | Description
+      #{ids[0]}                | 2020-04-01 | 20    | Example University          | 80                          |                                       | 4                    |
+      #{ids[1]}                | 2020-04-02 | 30    | Example Foundation          | 60                          |                                       | 4                    |
+    CSV
+
+    expect(Transaction.count).to eq(2)
+    expect(page).to have_text(t("action.transaction.upload.success"))
+    expect(page).not_to have_xpath("//tbody/tr")
+  end
+
+  scenario "uploading an invalid set of transactions" do
+    ids = [project, sibling_project].map(&:roda_identifier_compound)
+
+    upload_csv <<~CSV
+      Activity RODA Identifier | Date       | Value | Receiving Organisation Name | Receiving Organisation Type | Receiving Organisation IATI Reference | Disbursement Channel | Description
+      #{ids[0]}                | 2020-04-01 | 0     | Example University          | 80                          |                                       | 4                    |
+      #{ids[1]}                | 2020-04-02 | 30    | Example Foundation          | 61                          |                                       | 5                    |
+    CSV
+
+    expect(Transaction.count).to eq(0)
+    expect(page).not_to have_text(t("action.transaction.upload.success"))
+
+    within "//tbody/tr[1]" do
+      expect(page).to have_xpath("td[1]", text: "Value")
+      expect(page).to have_xpath("td[2]", text: "2")
+      expect(page).to have_xpath("td[3]", text: "0")
+      expect(page).to have_xpath("td[4]", text: t("activerecord.errors.models.transaction.attributes.value.other_than"))
+    end
+
+    within "//tbody/tr[2]" do
+      expect(page).to have_xpath("td[1]", text: "Receiving Organisation Type")
+      expect(page).to have_xpath("td[2]", text: "3")
+      expect(page).to have_xpath("td[3]", text: "61")
+      expect(page).to have_xpath("td[4]", text: t("importer.errors.transaction.invalid_iati_organisation_type"))
+    end
+
+    within "//tbody/tr[3]" do
+      expect(page).to have_xpath("td[1]", text: "Disbursement Channel")
+      expect(page).to have_xpath("td[2]", text: "3")
+      expect(page).to have_xpath("td[3]", text: "5")
+      expect(page).to have_xpath("td[4]", text: t("importer.errors.transaction.invalid_iati_disbursement_channel"))
+    end
+  end
+
+  def upload_csv(content)
+    file = Tempfile.new("transactions.csv")
+    file.write(content.gsub(/ *\| */, ","))
+    file.close
+
+    attach_file "report[transaction_csv]", file.path
+    click_button t("action.transaction.upload.button")
+
+    file.unlink
+  end
 end