Merge pull request #3687 from nhsuk/gias-download

Add GIAS download command to deployed envs

Author: misaka

Gemfile

@@ -44,6 +44,7 @@ gem "govuk_design_system_formbuilder"
 gem "govuk_markdown"
 gem "jsonb_accessor"
 gem "jwt"
+gem "mechanize"
 gem "notifications-ruby-client"
 gem "okcomputer"
 gem "omniauth_openid_connect"
@@ -85,7 +86,6 @@ group :development do
   gem "aws-sdk-rds", "~> 1"
   gem "aws-sdk-s3", "~> 1"
   gem "hotwire-livereload"
-  gem "mechanize"
   gem "prettier_print", require: false
   gem "rladr"
   gem "rubocop-govuk", require: false

app/lib/mavis_cli.rb

@@ -22,4 +22,5 @@ def self.progress_bar(total)
 require_relative "mavis_cli/generate/consents"
 require_relative "mavis_cli/generate/vaccination_records"
 require_relative "mavis_cli/gias/check_import"
+require_relative "mavis_cli/gias/download"
 require_relative "mavis_cli/gias/import"

app/lib/mavis_cli/gias/download.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# To get the latest version of the zip:
+# 1. Go to https://get-information-schools.service.gov.uk/Downloads
+# 2. Check "Establishment fields CSV"
+# 3. Submit
+# 4. Download the zip file
+# 5. Place it in db/data/dfe-schools.zip
+#
+# Alternatively, you can run this task.
+
+module MavisCLI
+  module GIAS
+    class Download < Dry::CLI::Command
+      desc "Download GIAS schools data"
+
+      def call
+        require "mechanize"
+
+        puts "Starting schools data download process..."
+        agent = Mechanize.new
+
+        puts "Visiting the downloads page"
+        page =
+          agent.get("https://get-information-schools.service.gov.uk/Downloads")
+
+        puts "Checking the establishment fields CSV checkbox"
+        form = page.form_with(action: "/Downloads/Collate")
+        form.checkbox_with(id: "establishment-fields-csv-checkbox").check
+
+        puts "Submitting the form"
+        download_page = form.submit
+
+        # There is a meta refresh on the download_page. Mechanize didn't seem to
+        # follow it so we're just refreshing that page manually until the button
+        # shows up below.
+        wait_time = 0
+        until (
+                download_form =
+                  download_page.form_with(action: "/Downloads/Download/Extract")
+              ) || wait_time > 60
+          puts "Waiting for the 'Results.zip' link to appear..."
+          sleep(2)
+          wait_time += 2
+          download_page_uri = download_page.uri
+          download_page = agent.get(download_page_uri)
+        end
+
+        if download_form
+          download_button = download_form.button_with(value: "Results.zip")
+          puts "'Results.zip' link found, downloading the file..."
+          download_file = agent.click(download_button)
+          puts "Overwriting db/data/dfe-schools.zip"
+          download_file.save!("db/data/dfe-schools.zip")
+          puts "File downloaded successfully to db/data/dfe-schools.zip"
+        else
+          puts "Download button never appeared, aborting"
+        end
+      end
+    end
+  end
+
+  register "gias" do |prefix|
+    prefix.register "download", GIAS::Download
+  end
+end

lib/tasks/schools.rake

@@ -1,58 +1,6 @@
 # frozen_string_literal: true
 
 namespace :schools do
-  # To get the latest version of the zip:
-  # 1. Go to https://get-information-schools.service.gov.uk/Downloads
-  # 2. Check "Establishment fields CSV"
-  # 3. Submit
-  # 4. Download the zip file
-  # 5. Place it in db/data/dfe-schools.zip
-  #
-  # Alternatively, you can run this task.
-  desc "Download schools data"
-  task download: :environment do
-    require "mechanize"
-
-    puts "Starting schools data download process..."
-    agent = Mechanize.new
-
-    puts "Visiting the downloads page"
-    page = agent.get("https://get-information-schools.service.gov.uk/Downloads")
-
-    puts "Checking the establishment fields CSV checkbox"
-    form = page.form_with(action: "/Downloads/Collate")
-    form.checkbox_with(id: "establishment-fields-csv-checkbox").check
-
-    puts "Submitting the form"
-    download_page = form.submit
-
-    # There is a meta refresh on the download_page. Mechanize didn't seem to
-    # follow it so we're just refreshing that page manually until the button
-    # shows up below.
-    wait_time = 0
-    until (
-            download_form =
-              download_page.form_with(action: "/Downloads/Download/Extract")
-          ) || wait_time > 60
-      puts "Waiting for the 'Results.zip' link to appear..."
-      sleep(2)
-      wait_time += 2
-      download_page_uri = download_page.uri
-      download_page = agent.get(download_page_uri)
-    end
-
-    if download_form
-      download_button = download_form.button_with(value: "Results.zip")
-      puts "'Results.zip' link found, downloading the file..."
-      download_file = agent.click(download_button)
-      puts "Overwriting db/data/dfe-schools.zip"
-      download_file.save!("db/data/dfe-schools.zip")
-      puts "File downloaded successfully to db/data/dfe-schools.zip"
-    else
-      puts "Download button never appeared, aborting"
-    end
-  end
-
   desc "Add a school to a organisation."
   task :add_to_organisation,
        %i[ods_code team_name] => :environment do |_task, args|