add bulk upload csv user journey

Gemfile

@@ -61,6 +61,8 @@ gem "auto_strip_attributes"
 # Use sidekiq for background processing
 gem "sidekiq"
 
+gem "ruby-filemagic"
+
 group :development, :test do
   # Check gems for known vulnerabilities
   gem "bundler-audit"

Gemfile.lock

@@ -370,6 +370,7 @@ GEM
       rubocop (~> 1.0)
     rubocop-rspec (2.7.0)
       rubocop (~> 1.19)
+    ruby-filemagic (0.7.3)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     rubyzip (2.3.2)
@@ -475,6 +476,7 @@ DEPENDENCIES
   rubocop-govuk (= 4.3.0)
   rubocop-performance
   rubocop-rails
+  ruby-filemagic
   selenium-webdriver
   sentry-rails
   sentry-ruby

app/controllers/bulk_upload_lettings_logs_controller.rb

@@ -39,12 +39,14 @@ private
                 Forms::BulkUploadLettings::PrepareYourFile.new(form_params)
               when "upload-your-file"
                 Forms::BulkUploadLettings::UploadYourFile.new(form_params)
+              when "checking-file"
+                Forms::BulkUploadLettings::CheckingFile.new(form_params)
               else
                 raise "Page not found for path #{params[:id]}"
               end
   end
 
   def form_params
-    params.fetch(:form, {}).permit(:year)
+    params.fetch(:form, {}).permit(:year, :file)
   end
 end

app/controllers/bulk_upload_sales_logs_controller.rb

@@ -39,12 +39,14 @@ private
                 Forms::BulkUploadSales::PrepareYourFile.new(form_params)
               when "upload-your-file"
                 Forms::BulkUploadSales::UploadYourFile.new(form_params)
+              when "checking-file"
+                Forms::BulkUploadSales::CheckingFile.new(form_params)
               else
                 raise "Page not found for path #{params[:id]}"
               end
   end
 
   def form_params
-    params.fetch(:form, {}).permit(:year)
+    params.fetch(:form, {}).permit(:year, :file)
   end
 end

app/models/forms/bulk_upload_lettings/checking_file.rb

@@ -0,0 +1,23 @@
+module Forms
+  module BulkUploadLettings
+    class CheckingFile
+      include ActiveModel::Model
+      include ActiveModel::Attributes
+      include Rails.application.routes.url_helpers
+
+      attribute :year, :integer
+
+      def view_path
+        "bulk_upload_lettings_logs/forms/checking_file"
+      end
+
+      def back_path
+        bulk_upload_lettings_log_path(id: "start")
+      end
+
+      def year_combo
+        "#{year}/#{year + 1 - 2000}"
+      end
+    end
+  end
+end

app/models/forms/bulk_upload_lettings/upload_your_file.rb

@@ -6,6 +6,10 @@ module Forms
       include Rails.application.routes.url_helpers
 
       attribute :year, :integer
+      attribute :file
+
+      validates :file, presence: true
+      validate :validate_file_is_csv
 
       def view_path
         "bulk_upload_lettings_logs/forms/upload_your_file"
@@ -14,6 +18,24 @@ module Forms
       def back_path
         bulk_upload_lettings_log_path(id: "prepare-your-file", form: { year: })
       end
+
+      def year_combo
+        "#{year}/#{year + 1 - 2000}"
+      end
+
+      def next_path
+        bulk_upload_lettings_log_path(id: "checking-file", form: { year: })
+      end
+
+    private
+
+      def validate_file_is_csv
+        return unless file
+
+        unless FileMagic.new(FileMagic::MAGIC_MIME).file(file.path).include?("text/csv")
+          errors.add(:file, :not_csv)
+        end
+      end
     end
   end
 end

app/models/forms/bulk_upload_sales/checking_file.rb

@@ -0,0 +1,23 @@
+module Forms
+  module BulkUploadSales
+    class CheckingFile
+      include ActiveModel::Model
+      include ActiveModel::Attributes
+      include Rails.application.routes.url_helpers
+
+      attribute :year, :integer
+
+      def view_path
+        "bulk_upload_sales_logs/forms/checking_file"
+      end
+
+      def back_path
+        bulk_upload_sales_log_path(id: "start")
+      end
+
+      def year_combo
+        "#{year}/#{year + 1 - 2000}"
+      end
+    end
+  end
+end

app/models/forms/bulk_upload_sales/upload_your_file.rb

@@ -6,6 +6,10 @@ module Forms
       include Rails.application.routes.url_helpers
 
       attribute :year, :integer
+      attribute :file
+
+      validates :file, presence: true
+      validate :validate_file_is_csv
 
       def view_path
         "bulk_upload_sales_logs/forms/upload_your_file"
@@ -14,6 +18,24 @@ module Forms
       def back_path
         bulk_upload_sales_log_path(id: "prepare-your-file", form: { year: })
       end
+
+      def year_combo
+        "#{year}/#{year + 1 - 2000}"
+      end
+
+      def next_path
+        bulk_upload_sales_log_path(id: "checking-file", form: { year: })
+      end
+
+    private
+
+      def validate_file_is_csv
+        return unless file
+
+        unless FileMagic.new(FileMagic::MAGIC_MIME).file(file.path).include?("text/csv")
+          errors.add(:file, :not_csv)
+        end
+      end
     end
   end
 end

app/views/bulk_upload_lettings_logs/forms/checking_file.html.erb

@@ -0,0 +1,28 @@
+<% content_for :before_content do %>
+  <%= govuk_back_link href: @form.back_path %>
+<% end %>
+
+<div class="govuk-grid-row">
+  <div class="govuk-grid-column-two-thirds">
+    <%= form_with model: @form, scope: :form, url: bulk_upload_lettings_log_path(id: "prepare-your-file"), method: :patch do |f| %>
+      <%= f.hidden_field :year %>
+
+      <span class="govuk-caption-l">Upload lettings logs in bulk (<%= @form.year_combo %>)</span>
+      <h1 class="govuk-heading-l">We’re checking the file</h1>
+
+      <h2 class="govuk-heading-m">Once this is done, we’ll email you the outcome.</h2>
+
+      <p class="govuk-body">
+        We’re checking for any missing data, issues or errors. Depending on the file size, this could take a few minutes.
+      </p>
+
+      <p class="govuk-body">
+        If there are errors we will email you a link to view all the errors.
+      </p>
+
+      <p class="govuk-body">
+        If there are no errors we will email you to let you know the upload is complete and that your logs have been created.
+      </p>
+    <% end %>
+  </div>
+</div>

app/views/bulk_upload_lettings_logs/forms/upload_your_file.html.erb

@@ -2,16 +2,24 @@
   <%= govuk_back_link href: @form.back_path %>
 <% end %>
 
-<%= form_with model: @form, scope: :form, url: bulk_upload_lettings_log_path(id: "upload-your-file"), method: :patch do |f| %>
-  <%= f.govuk_error_summary %>
+<div class="govuk-grid-row">
+  <div class="govuk-grid-column-two-thirds">
+    <%= form_with model: @form, scope: :form, url: bulk_upload_lettings_log_path(id: "upload-your-file"), method: :patch do |f| %>
+      <%= f.hidden_field :year %>
 
-  <div>
-    Upload your file goes here
-  </div>
+      <%= f.govuk_error_summary %>
 
-  <div>
-    year selected <%= @form.year %>
-  </div>
+      <span class="govuk-caption-l">Upload lettings logs in bulk (<%= @form.year_combo %>)</span>
+      <h1 class="govuk-heading-l">Upload your file</h1>
 
-  <%= f.govuk_submit %>
-<% end %>
+      <p class="govuk-body">
+        All data must be complete and formatted correctly (CSV <strong>only</strong>) - if not, we will reject the entired file.
+      </p>
+
+      <%= f.govuk_file_field :file,
+        label: { text: "Upload file" } %>
+
+      <%= f.govuk_submit "Upload" %>
+    <% end %>
+  </div>
+</div>

app/views/bulk_upload_sales_logs/forms/checking_file.html.erb

@@ -0,0 +1,28 @@
+<% content_for :before_content do %>
+  <%= govuk_back_link href: @form.back_path %>
+<% end %>
+
+<div class="govuk-grid-row">
+  <div class="govuk-grid-column-two-thirds">
+    <%= form_with model: @form, scope: :form, url: bulk_upload_sales_log_path(id: "prepare-your-file"), method: :patch do |f| %>
+      <%= f.hidden_field :year %>
+
+      <span class="govuk-caption-l">Upload sales logs in bulk (<%= @form.year_combo %>)</span>
+      <h1 class="govuk-heading-l">We’re checking the file</h1>
+
+      <h2 class="govuk-heading-m">Once this is done, we’ll email you the outcome.</h2>
+
+      <p class="govuk-body">
+        We’re checking for any missing data, issues or errors. Depending on the file size, this could take a few minutes.
+      </p>
+
+      <p class="govuk-body">
+        If there are errors we will email you a link to view all the errors.
+      </p>
+
+      <p class="govuk-body">
+        If there are no errors we will email you to let you know the upload is complete and that your logs have been created.
+      </p>
+    <% end %>
+  </div>
+</div>

app/views/bulk_upload_sales_logs/forms/upload_your_file.html.erb

@@ -2,16 +2,24 @@
   <%= govuk_back_link href: @form.back_path %>
 <% end %>
 
-<%= form_with model: @form, scope: :form, url: bulk_upload_sales_log_path(id: "upload-your-file"), method: :patch do |f| %>
-  <%= f.govuk_error_summary %>
+<div class="govuk-grid-row">
+  <div class="govuk-grid-column-two-thirds">
+    <%= form_with model: @form, scope: :form, url: bulk_upload_sales_log_path(id: "upload-your-file"), method: :patch do |f| %>
+      <%= f.hidden_field :year %>
 
-  <div>
-    Upload your file goes here
-  </div>
+      <%= f.govuk_error_summary %>
 
-  <div>
-    year selected <%= @form.year %>
-  </div>
+      <span class="govuk-caption-l">Upload sales logs in bulk (<%= @form.year_combo %>)</span>
+      <h1 class="govuk-heading-l">Upload your file</h1>
 
-  <%= f.govuk_submit %>
-<% end %>
+      <p class="govuk-body">
+        All data must be complete and formatted correctly (CSV <strong>only</strong>) - if not, we will reject the entired file.
+      </p>
+
+      <%= f.govuk_file_field :file,
+        label: { text: "Upload file" } %>
+
+      <%= f.govuk_submit "Upload" %>
+    <% end %>
+  </div>
+</div>

config/locales/en.yml

@@ -49,6 +49,16 @@ en:
           attributes:
             year:
               blank: You must select a collection period to upload for
+        forms/bulk_upload_lettings/upload_your_file:
+          attributes:
+            file:
+              blank: Select which file to upload
+              not_csv: Your file must be in CSV format
+        forms/bulk_upload_sales/upload_your_file:
+          attributes:
+            file:
+              blank: Select which file to upload
+              not_csv: Your file must be in CSV format
 
   activerecord:
     errors:

spec/features/bulk_upload_lettings_logs_spec.rb

@@ -30,6 +30,20 @@ RSpec.describe "Bulk upload lettings log" do
         click_button("Continue")
 
         expect(page).to have_content("Upload your file")
+        click_button("Upload")
+
+        expect(page).to have_content("Select which file to upload")
+        attach_file "file", file_fixture("2021_22_lettings_bulk_upload.xlsx")
+        click_button("Upload")
+
+        expect(page).to have_content("Your file must be in CSV format")
+        attach_file "file", file_fixture("blank_bulk_upload_sales.csv")
+        click_button("Upload")
+
+        expect(page).to have_content("Once this is done")
+        click_link("Back")
+
+        expect(page).to have_content("Upload lettings logs in bulk")
       end
     end
   end

spec/features/bulk_upload_sales_logs_spec.rb

@@ -30,6 +30,20 @@ RSpec.describe "Bulk upload sales log" do
         click_button("Continue")
 
         expect(page).to have_content("Upload your file")
+        click_button("Upload")
+
+        expect(page).to have_content("Select which file to upload")
+        attach_file "file", file_fixture("2021_22_lettings_bulk_upload.xlsx")
+        click_button("Upload")
+
+        expect(page).to have_content("Your file must be in CSV format")
+        attach_file "file", file_fixture("blank_bulk_upload_sales.csv")
+        click_button("Upload")
+
+        expect(page).to have_content("Once this is done")
+        click_link("Back")
+
+        expect(page).to have_content("Upload sales logs in bulk")
       end
     end
   end

spec/fixtures/files/blank_bulk_upload_sales.csv

@@ -0,0 +1,118 @@
+Question,What is the purchaser code?,What is the day of the sale completion date? - DD,What is the month of the sale completion date? - MM,What is the year of the sale completion date? - YY,[BLANK],Was the buyer interviewed for any of the answers you will provide on this log?,Age of Buyer 1,Age of Buyer 2 or Person 2,Age of Person 3,Age of Person 4,Age of Person 5,Age of Person 6,Gender identity of Buyer 1,Gender identity of Buyer 2 or Person 2,Gender identity of Person 3,Gender identity of Person 4,Gender identity of Person 5,Gender identity of Person 6,Person 2's relationship to lead tenant,Person 3's relationship to lead tenant,Person 4's relationship to lead tenant,Person 5's relationship to lead tenant,Person 6's relationship to lead tenant,Working situation of Buyer 1,Working situation of Buyer 2 or Person 2,Working situation of Person 3,Working situation of Person 4,Working situation of Person 5,Working situation of Person 6,What is the buyer 1's ethnic group?,What is buyer 1's nationality?,What is buyer 1's gross annual income?,What is buyer 2's gross annual income?,Was buyer 1's income used for a mortgage application?,Was buyer 2's income used for a mortgage application?,"What is the total amount the buyers had in savings before they paid any deposit for the property?
+
+To the nearest £10",Have any of the buyers previously owned a property?,[BLANK],What was buyer 1's previous tenure?,What is the local authority of buyer 1's last settled home,Part 1 of postcode of buyer 1's last settled home,Part 2 of postcode of buyer 1's last settled home,Do you know the postcode of buyer 1's last settled home?,Was the buyer registered with their PRP (HA)?,Was the buyer registered with the local authority?,Was the buyer registered with a Help to Buy agent?,Was the buyer registered with another PRP (HA)?,Does anyone in the household consider themselves to have a disability?,Does anyone in the household use a wheelchair?,How many bedrooms does the property have?,What type of unit is the property?,Which type of building is the property?,What is the local authority of the property?,Part 1 of postcode of property,Part 2 of postcode of property,Is the property built or adapted to wheelchair-user standards?,What is the type of shared ownership sale?,"Is this a resale?
+
+Shared ownership","What is the day of the practical completion or handover date? - DD
+
+Shared ownership","What is the month of the practical completion or handover date? - MM
+
+Shared ownership","What is the year of the practical completion or handover date? - YY
+
+Shared ownership","What is the day of the exchange of contracts date? - DD
+
+Shared ownership","What is the month of the exchange of contracts date? - MM
+
+Shared ownership","What is the year of the exchange of contracts date? - YY
+
+Shared ownership","Was the household re-housed under a local authority nominations agreement?
+
+Shared ownership","How many bedrooms did the buyer's previous property have?
+
+Shared ownership","What was the type of the buyer's previous property?
+
+Shared ownership","What was the full purchase price?
+
+Shared ownership","What was the initial percentage equity stake purchased?
+
+Shared ownership","What is the mortgage amount?
+
+Shared ownership","Does this include any extra borrowing?
+
+Shared ownership","How much was the cash deposit paid on the property?
+
+Shared ownership","How much cash discount was given through Social Homebuy?
+
+Shared ownership","What is the basic monthly rent?
+
+Shared ownership","What are the total monthly leasehold charges for the property?
+
+Shared ownership",What is the type of discounted ownership sale?,"What was the full purchase price?
+
+Discounted ownership","What was the amount of any loan, grant, discount or subsidy given?
+
+Discounted ownership","What was the percentage discount?
+
+Discounted ownership","What is the mortgage amount?
+
+Discounted ownership","Does this include any extra borrowing?
+
+Discounted ownership","How much was the cash deposit paid on the property?
+
+Discounted ownership","What are the total monthly leasehold charges for the property?
+
+Discounted ownership",What is the type of outright sale?,"What is the 'other' type of outright sale?
+
+Outright sale",[BLANK],"What is the full purchase price?
+
+Outright sale","What is the mortgage amount?
+
+Outright sale","Does this include any extra borrowing?
+
+Outright sale","How much was the cash deposit paid on the property?
+
+Outright sale","What are the total monthly leasehold charges for the property?
+
+Outright sale","Which organisation owned this property before the sale?
+
+Organisation's CORE ID",Username,BLANK,Has the buyer ever served in the UK Armed Forces and for how long?,[BLANK],Are any of the buyers a spouse or civil partner of a UK Armed Forces regular who died in service within the last 2 years?,"What is the name of the mortgage lender?
+
+Shared ownership","What is the name of the 'other' mortgage lender?
+
+Shared ownership","What is the name of the mortgage lender?
+
+Discounted ownership","What is the name of the 'other' mortgage lender?
+
+Discounted ownership","What is the name of the mortgage lender?
+
+Outright sale","What is the name of the 'other' mortgage lender?
+
+Outright sale",Were the buyers receiving any of these housing-related benefits immediately before buying this property?,"What is the length of the mortgage in years?
+
+Shared ownership","What is the length of the mortgage in years?
+
+Discounted ownership","What is the length of the mortgage in years?
+
+Outright sale","How long have the buyers been living in the property before the purchase?
+
+Discounted ownership",Are there more than two joint purchasers of this property?,"How long have the buyers been living in the property before the purchase?
+
+Shared ownership",Is this a staircasing transaction?,Data Protection question,Was this purchase made through an ownership scheme?,"Is the buyer a company?
+
+Outright sale",Will the buyers live in the property?,Is this a joint purchase?,Will buyer 1 live in the property?,Will buyer 2 live in the property?,"Besides the buyers, how many people live in the property?","What percentage of the property has been bought in this staircasing transaction?
+
+Shared ownership","What percentage of the property does the buyer now own in total?
+
+Shared ownership","What was the rent type of the buyer's previous property?
+
+Shared ownership","Was a mortgage used for the purchase of this property?
+
+Shared ownership","Was a mortgage used for the purchase of this property?
+
+Discounted ownership","Was a mortgage used for the purchase of this property?
+
+Outright sale"
+Values,Max 9 digits,1 - 31,1 - 12,19 - 23,,1 or null,"15 - 110
+or R",1 - 110 or R,,,,,"M, F, X or R",,,,,,"P, C, X or R",,,,,0 - 10,,,,,,1 - 19,"12 -13, 17 -19",0 - 99999,,1 or 2,1 or 2,0 - 999990,1 - 3,,1 - 7 or 9,ONS CODE - E + 9 digits,XXX(X),XXX,1 or null,,,,,1 - 3,1 - 3,1 - 9,1 - 4 or 9,1 or 2,ONS CODE E + 9 digits,XXX(X),XXX,1 - 3,"2, 16, 18, 24, 28 or 30-31",1 or 2,1 - 31,1 - 12,19 - 23,1 - 31,1 - 12,19 - 23,1 - 3,1 - 9,1 - 4 or 9,0 - 999999,0 - 100,0 - 999999,1 - 3,0 - 999999,,0 - 999.99,,"8, 9, 14, 21, 22, 27 or 29",0 - 999999,,0 - 100,0 - 999999,1 - 3,0 - 999999,0 - 999.99,10 or 12,,,0 - 999999,,1-3,0 - 999999,0-999.99,Up to 7 digits,Username of CORE account this sales log should be assigned to,,3 - 8,,4 - 7,1 - 40,,1 - 40,,1 - 40,,1 - 4, Integer <=60, Integer <=60, Integer <=60, Integer <=80,1 - 3, Integer <=80,1 - 3,1,1 - 3,1 - 2,1 - 2,1 - 2,1 - 2,1 - 2,0 - 5,1 - 100,1 - 100,1-3 or 9-10,1 - 2,1 - 2,1 - 2
+Can be Null?,No,,,,,No,No,"If fields 14, 19 and 25 are all also null","If fields 15, 20 and 26 are all also null","If fields 16, 21 and 27 are all also null","If fields 17, 22 and 28 are all also null","If fields 18, 23 and 29 are all also null",No,"If fields 8, 19 and 25 are all also null","If fields 9, 20 and 26 are also null","If fields 10, 21 and 27 are all also null","If fields 11, 22 and 28 are all also null","If fields 12, 23 and 29 are all also null","If fields 8, 14 and 25 are all also null","If fields 9, 15 and 26 are all also null","If fields 10, 16 and 27 are all also null","If fields 11, 17 and 28 are all also null","If fields 12, 18 and 29 are all also null",If field 6 = 1,"If fields 8, 14 and 19 are all also null","If fields 9, 15 and 20 are all also null","If fields 10, 16 and 21 are all also null","If fields 11, 17 and 22 are all also null","If fields 12, 18 and 23 are all also null",If field 6 =  1,,,If field 116 = 2,If field 32  is null,If field 116 = 2,If field 6 = 1,,,If field 6 = 1,No,If field 43 = 1,,If fields 41 and 42 BOTH have valid entries,Yes,,,,If field 6 = 1,,No,,,,,,,If field 113 = 2 or 3,,,,,,,,,"If field 113 = 2 or 3
+OR
+field 39 = 3 - 7 or 9",,If field 113 = 2 or 3,,,,,"If field 57 is null, 2, 16, 24 or 28",If field 113 = 2 or 3,,If field 113 = 1 or 3,If field 76 is null,"If field 76 is null, 9 or 14","If field 76 is null, 8, 21 or 22",If field 113 = 1 or 3,,,,If field 113 = 1 or 2,If field 84 is null or 10,,If field 113 = 1 or 2,,,,,No,Yes,,No,,No,If field 113 = 2 or 3,"If field 113 = 2 or 3
+OR
+If field 98 is not 40",If field 113 = 1 or 3,"If field 113 = 1 or 3
+OR
+If field 100 is not 40",If field 113 = 1 or 2,"If field 113 = 1 or 2
+OR
+If field 102 is not 40",No,If field 113 = 2 or 3,If field 113 = 1 or 3,If field 113 = 1 or 2,If field 113 = 1 or 3,If field 116 = 2,If field 113 = 2 or 3,If field 113 = 2 or 3,No,No,If field 113 = 1 or 2,If field 113 = 1 or 2,No,No,If field 116 = 2,No,If field 113 = 2 or 3,If field 113 = 2 or 3,"If field 113 = 1 or 2
+OR
+If field 39 = 3 - 9",If field 113 = 2 or 3,If field 113 = 1 or 3,If field 113 = 1 or 2
+Bulk upload format and duplicate check,Yes,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+Field number,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125