metadata_presenter 2.18.6 → 2.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d8abb52822dee49505be01d36fcf044cdf1428e5f0b4858c79e955f735b4b85
-  data.tar.gz: 0405e28449fd23187d2304811b3c47f782d1b17d901d5bc0ed36d8045f9f59a7
+  metadata.gz: d631aa0b87b76c112abb7c67a554da2cd7a7292c234b078590647ad455740bb7
+  data.tar.gz: ae914cf8380a19707d30e98700a4bf5bb884f81c5b547b0a03cf9f96971a47ec
 SHA512:
-  metadata.gz: 37e4e33318dfa07794042dddedc4141e759a1e8dbf7edac35322f4c9633a9b4513dbcd304b8641fc7e70677fdcd66c1f43f01dead8b1b0236061f509bfde9187
-  data.tar.gz: 1adf2259573f08bcb44ba00bd6b6e4ffc635332ccc25ff556a50f8cb9d7affe93eb96b43cbd5ca10215385480155f0e69656ef9ebc7ac0a797f94edf14cb307c
+  metadata.gz: 936ac69f86688086114f8cda9b8042150e17885cef1b30e4d0b41a7cfd9e631911c2c863143ccf8a708b857ff0d54d38bb02e926526488e5b9b1fa0c131af4aa
+  data.tar.gz: 86b7554f3d012c0d9d70babcf531d2afc5923424bccf418ad6958e5f0fa72cd9dc2997ec7dfcdf441a506d87ab6eb393a09f0d6cb628e640d63c9fa935efe386

data/README.md

@@ -95,6 +95,8 @@ The `autocomplete_items` takes the components on a page and retrieves any items
 
 `payment_link_url` method will present the payment link url. For the Runner this is the value of the `ENV['PAYMENT_LINK']` variable. In the Editor the value comes from the `ServiceConfiguration` table.
 
+`save_and_return_enabled?` method checks whether save and return is enabled in the Runner or Editor app. In the Runner save and return is enabled when the `ENV['SAVE_AND_RETURN']` environment variable is present. In the Editor, save and return enabled can be ascertained by checking the `ServiceConfiguration` table.
+
 ## Generate documentation
 
 Run `rake doc` and open the doc/index.html

data/app/controllers/metadata_presenter/answers_controller.rb

@@ -6,6 +6,12 @@ module MetadataPresenter
       @previous_answers = reload_user_data.deep_dup
       @page_answers = PageAnswers.new(page, answers_params, autocomplete_items(page.components))
 
+      if params[:save_for_later].present?
+        save_user_data
+        # NOTE: if the user is on a file upload page, files will not be uploaded before redirection
+        redirect_to save_path(page_slug: params[:page_slug]) and return
+      end
+
       upload_files if upload?
 
       if @page_answers.validate_answers
@@ -49,6 +55,7 @@ module MetadataPresenter
     end
 
     def answers_params
+      params.permit(:page_slug, :save_for_later)
       params[:answers] ? params[:answers].permit! : {}
     end
 

data/app/controllers/metadata_presenter/engine_controller.rb

@@ -21,6 +21,24 @@ module MetadataPresenter
       end
     end
 
+    def get_saved_progress(uuid)
+      if defined? super
+        super(uuid)
+      end
+    end
+
+    def increment_record_counter(uuid)
+      if defined? super
+        super(uuid)
+      end
+    end
+
+    def invalidate_record(uuid)
+      if defined? super
+        super(uuid)
+      end
+    end
+
     def back_link
       previous_page = PreviousPage.new(
         service:,

data/app/controllers/metadata_presenter/save_and_return_controller.rb

@@ -1,31 +1,42 @@
 module MetadataPresenter
   class SaveAndReturnController < EngineController
-    helper_method :secret_questions, :page_slug, :confirmed_email
+    helper_method :secret_questions, :page_slug, :confirmed_email, :get_service_name, :get_uuid, :label_text
 
     def show
       @saved_form = SavedForm.new
     end
 
     def page_slug
+      if session['returning_slug'].present?
+        return session['returning_slug']
+      end
       if session['saved_form'].present?
-        session['saved_form']['page_slug']
+        return session['saved_form']['page_slug']
+      end
+      if params['saved_form'].present?
+        return params['saved_form']['page_slug']
       end
+
       params[:page_slug]
     end
 
     def confirmed_email
-      session['saved_form']['email']
-      # TODO: clear session data after submission is successful
+      email = session['saved_form']['email']
+      session[:saved_form] = nil
+
+      email
     end
 
     def create
       @saved_form = SavedForm.new
       @saved_form.populate_param_values(saved_form_params)
-      @saved_form.secret_question = text_for(params['saved_form']['secret_question'])
+      @saved_form.secret_question_text = text_for(params['saved_form']['secret_question'])
+      @saved_form.secret_question = params['saved_form']['secret_question']
       @saved_form.populate_service_values(service)
       @saved_form.populate_session_values(session)
       if @saved_form.valid?
         # put in session until we have confirmed email address
+        @saved_form.secret_question = @saved_form.secret_question_text
         session[:saved_form] = @saved_form
         redirect_to '/save/email_confirmation'
       else
@@ -35,37 +46,137 @@ module MetadataPresenter
 
     def email_confirmation
       @saved_form = session[:saved_form]
-      @email_confirmation = EmailConfirmation.new
+      @email_confirmation = EmailConfirmation.new(@saved_form['email'])
     end
 
     def confirm_email
-      @email_confirmation = EmailConfirmation.new
-      @email_confirmation.assign_attributes(confirmation_params[:email_confirmation], session['saved_form']['email'])
+      @email_confirmation = EmailConfirmation.new(confirmation_params[:email_confirmation])
 
       if @email_confirmation.valid?
+        session['saved_form']['email'] = @email_confirmation.email_confirmation
         response = save_form_progress
-        if response.status != 200
+        if response.status == 500
           internal_server_error and return
         end
 
-        # send_email(response.body['id'], confirmation_params[:email_confirmation])
+        payload = response.body.merge(email: @email_confirmation.email_confirmation).deep_symbolize_keys
+        create_save_and_return_submission(payload)
+
         redirect_to '/save/progress_saved'
       else
         render :email_confirmation, status: :unprocessable_entity
       end
     end
 
-    # def return
-    #   uuid = params[:uuid]
-    #   response = get_saved_progress(uuid)
+    def return
+      response = get_saved_progress(get_uuid)
+
+      if response.status == 404
+        redirect_to '/record_error' and return
+      end
+
+      if response.status == 400
+        redirect_to '/record_failure' and return
+      end
+
+      if response.status == 422
+        redirect_to '/already_used' and return
+      end
+
+      @saved_form = SavedForm.new.from_json(response.body.to_json)
+      @resume_form = ResumeForm.new(@saved_form.secret_question)
+    end
+
+    def get_uuid
+      if params[:uuid].present?
+        return params[:uuid]
+      end
+
+      params[:resume_form][:uuid].presence
+    end
 
-    #   session[:user_id] = response['user_id']
-    #   session[:user_token] = response['user_token']
+    # rubocop:disable Style/RescueStandardError
+    def submit_secret_answer
+      response = get_saved_progress(get_uuid)
 
-    #   Rails.logger.info('returning to form')
-    #   Rails.logger.info('session')
-    #   redirect_to '/check-answers'
-    # end
+      if response.status != 200
+        if response.status == 400
+          redirect_to '/record_failure' and return
+        end
+
+        redirect_to '/record_error' and return
+      end
+
+      @saved_form = SavedForm.new.from_json(response.body.to_json)
+      @resume_form = ResumeForm.new(@saved_form.secret_question)
+      @resume_form.secret_answer = resume_form_params[:resume_form][:secret_answer]
+      @resume_form.recorded_answer = @saved_form.secret_answer
+      @resume_form.attempts_remaining = 2 - @saved_form.attempts.to_i
+
+      if @resume_form.valid?
+        # redirect back to right place in form
+        session[:user_id] = @saved_form.user_id
+        session[:user_token] = @saved_form.user_token
+        session[:returning_slug] = @saved_form.page_slug
+
+        invalidate_record(@saved_form.id)
+
+        if @saved_form.service_version == service.version_id
+          redirect_to '/resume_progress' and return
+        else
+          redirect_to '/resume_from_start' and return
+        end
+      else
+        if @resume_form.attempts_remaining <= 0
+          begin
+            increment_record_counter(@saved_form.id)
+          rescue => e
+            Rails.logger.info(e)
+            redirect_to '/record_failure' and return
+          end
+          redirect_to '/record_failure' and return
+        end
+
+        increment_record_counter(@saved_form.id)
+
+        render :return, params: { uuid: @saved_form.id }
+      end
+    end
+    # rubocop:enable Style/RescueStandardError
+
+    def resume_progress
+      @user_data = load_user_data
+
+      @page ||= service.find_page_by_url('check-answers')
+
+      if @page
+        @page_answers = PageAnswers.new(@page, @answered_pages)
+
+        render template: 'metadata_presenter/save_and_return/resume_progress'
+      else
+        not_found
+      end
+    end
+
+    def save_progress
+      session['saved_form']['user_id'] = nil
+      session['saved_form']['user_token'] = nil
+      session['user_id'] = nil
+      session['user_token'] = nil
+    end
+
+    def answered_pages
+      TraversedPages.new(service, @user_data, @page).all
+    end
+
+    def pages_presenters
+      PageAnswersPresenter.map(
+        view: view_context,
+        pages: answered_pages,
+        answers: @user_data
+      )
+    end
+    helper_method :pages_presenters
 
     def secret_questions
       [
@@ -98,10 +209,19 @@ module MetadataPresenter
       )
     end
 
-    private
+    def resume_form_params
+      params.permit(
+        { resume_form: %i[secret_answer uuid] },
+        :authenticity_token
+      )
+    end
+
+    def get_service_name
+      service.service_name
+    end
 
-    def check_feature_flag
-      redirect_to '/' and return if ENV['SAVE_AND_RETURN'] != 'enabled'
+    def label_text(text)
+      "<h2 class='govuk-heading-m'>#{text}</h2>"
     end
   end
 end

data/app/controllers/metadata_presenter/submissions_controller.rb

@@ -21,5 +21,16 @@ module MetadataPresenter
         super
       end
     end
+
+    def create_save_and_return_submission(payload)
+      # The runner is the only app that sends the save and return submission.
+      # and it is not needed on the editor app (editing & previewing).
+      # So in the Runner we defined the #create_save_and_return_submission in the parent
+      # controller and in the Editor we don't.
+      #
+      if defined?(super)
+        super
+      end
+    end
   end
 end

data/app/models/metadata_presenter/email_confirmation.rb

@@ -2,16 +2,12 @@ module MetadataPresenter
   class EmailConfirmation
     include ActiveModel::Model
 
-    attr_accessor :email_confirmation,
-                  :session_email
+    attr_accessor :email_confirmation
 
     validates_with EmailConfirmationValidator
 
-    def initialize; end
-
-    def assign_attributes(email_confirmation, session_email)
-      @email_confirmation = email_confirmation
-      @session_email = session_email
+    def initialize(email)
+      self.email_confirmation = email
     end
   end
 end

data/app/models/metadata_presenter/page.rb

@@ -19,11 +19,13 @@ module MetadataPresenter
       page.confirmation
       page.multiplequestions
       page.exit
+      save_and_return.resume_progress
     ].freeze
     END_OF_ROUTE_PAGES = %w[
       page.checkanswers
       page.confirmation
       page.exit
+      save_and_return.resume_progress
     ].freeze
 
     def editable_attributes

data/app/models/metadata_presenter/resume_form.rb

@@ -0,0 +1,16 @@
+module MetadataPresenter
+  class ResumeForm
+    include ActiveModel::Model
+
+    attr_accessor :secret_question,
+                  :secret_answer,
+                  :recorded_answer,
+                  :attempts_remaining
+
+    validates_with SecretAnswerValidator
+
+    def initialize(secret_question)
+      self.secret_question = secret_question
+    end
+  end
+end

data/app/models/metadata_presenter/saved_form.rb

@@ -1,10 +1,13 @@
 module MetadataPresenter
   class SavedForm
     include ActiveModel::Model
+    include ActiveModel::Serializers::JSON
+
     validates_with SavedProgressValidator
 
     attr_accessor :email,
                   :secret_question,
+                  :secret_question_text,
                   :secret_answer,
                   :page_slug,
                   :service_slug,
@@ -13,9 +16,13 @@ module MetadataPresenter
                   :user_token,
                   :user_data_payload,
                   :attempts,
-                  :active
+                  :active,
+                  :id,
+                  :created_at,
+                  :updated_at
+
+    validates :secret_question, :secret_answer, :service_slug, :page_slug, :service_version, :user_id, :user_token, presence: { message: 'Enter an answer for "%{attribute}"' }, allow_blank: false
 
-    validates :secret_question, :secret_answer, :service_slug, :page_slug, :service_version, :user_id, :user_token, presence: true, allow_blank: false
     def initialize; end
 
     def populate_param_values(params)
@@ -28,12 +35,21 @@ module MetadataPresenter
     def populate_session_values(session)
       self.user_id           = session[:user_id]
       self.user_token        = session[:user_token]
-      self.user_data_payload = session[:user_data]
     end
 
     def populate_service_values(service)
       self.service_slug    = service.service_slug
       self.service_version = service.version_id
     end
+
+    def attributes=(hash)
+      hash.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    def attributes
+      instance_values
+    end
   end
 end

data/app/validators/email_confirmation_validator.rb

@@ -1,7 +1,8 @@
 class EmailConfirmationValidator < ActiveModel::Validator
   def validate(record)
-    if record.email_confirmation != record.session_email
-      record.errors.add(:email_confirmation, I18n.t('presenter.save_and_return.validation.email_not_matched'))
+    regex = URI::MailTo::EMAIL_REGEXP
+    if record.email_confirmation.match(regex).nil?
+      record.errors.add(:email_confirmation, I18n.t('presenter.save_and_return.validation.email'))
     end
   end
 end

data/app/validators/saved_progress_validator.rb

@@ -4,5 +4,9 @@ class SavedProgressValidator < ActiveModel::Validator
     if record.email.match(regex).nil?
       record.errors.add(:email, I18n.t('presenter.save_and_return.validation.email'))
     end
+
+    if record.secret_answer.length > 100
+      record.errors.add(:secret_answer, I18n.t('presenter.save_and_return.validation.answer_too_long', attribute: 'Secret answer'))
+    end
   end
 end

data/app/validators/secret_answer_validator.rb

@@ -0,0 +1,7 @@
+class SecretAnswerValidator < ActiveModel::Validator
+  def validate(record)
+    if record.secret_answer.strip.downcase != record.recorded_answer.strip.downcase
+      record.errors.add(:secret_answer, I18n.t('presenter.save_and_return.validation.answer_not_matched', attempts: record.attempts_remaining))
+    end
+  end
+end

data/app/views/errors/404.html

@@ -1,67 +1,7 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>The page you were looking for doesn't exist (404)</title>
-  <meta name="viewport" content="width=device-width,initial-scale=1">
-  <style>
-  .rails-default-error-page {
-    background-color: #EFEFEF;
-    color: #2E2F30;
-    text-align: center;
-    font-family: arial, sans-serif;
-    margin: 0;
-  }
+<div>
+  <h1>Page not found</h1>
+  <p>If you typed the web address, check it is correct.</p>
+  <p>If you pasted the web address, check you copied the entire address.</p>
+  <p>If the problem persists, <a href="https://moj-forms.service.justice.gov.uk/contact/">contact the MoJ Forms team.</a></p>
+</div>
 
-  .rails-default-error-page div.dialog {
-    width: 95%;
-    max-width: 33em;
-    margin: 4em auto 0;
-  }
-
-  .rails-default-error-page div.dialog > div {
-    border: 1px solid #CCC;
-    border-right-color: #999;
-    border-left-color: #999;
-    border-bottom-color: #BBB;
-    border-top: #B00100 solid 4px;
-    border-top-left-radius: 9px;
-    border-top-right-radius: 9px;
-    background-color: white;
-    padding: 7px 12% 0;
-    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
-  }
-
-  .rails-default-error-page h1 {
-    font-size: 100%;
-    color: #730E15;
-    line-height: 1.5em;
-  }
-
-  .rails-default-error-page div.dialog > p {
-    margin: 0 0 1em;
-    padding: 1em;
-    background-color: #F7F7F7;
-    border: 1px solid #CCC;
-    border-right-color: #999;
-    border-left-color: #999;
-    border-bottom-color: #999;
-    border-bottom-left-radius: 4px;
-    border-bottom-right-radius: 4px;
-    border-top-color: #DADADA;
-    color: #666;
-    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
-  }
-  </style>
-</head>
-
-<body class="rails-default-error-page">
-  <!-- This file lives in public/404.html -->
-  <div class="dialog">
-    <div>
-      <h1>The page you were looking for doesn't exist.</h1>
-      <p>You may have mistyped the address or the page may have moved.</p>
-    </div>
-    <p>If you are the application owner check the logs for more information.</p>
-  </div>
-</body>
-</html>

data/app/views/metadata_presenter/page/checkanswers.html.erb

@@ -84,9 +84,16 @@
                    content_components: @page.supported_content_components
                  } %>
 
-        <button <%= 'disabled' if editable? %> data-prevent-double-click="true" class="fb-block fb-block-actions govuk-button" data-module="govuk-button" data-block-id="actions" data-block-type="actions">
-          <%= t('presenter.actions.submit') -%>
-        </button> 
+        <div class="govuk-button-group">
+          <button <%= 'disabled' if editable? %> data-prevent-double-click="true" class="fb-block fb-block-actions govuk-button" data-module="govuk-button" data-block-id="actions" data-block-type="actions">
+            <%= t('presenter.actions.submit') -%>
+            <% if save_and_return_enabled? %>
+            <% if editor_preview? || editable? %>
+              <%= button_to t('presenter.save_and_return.save'), '/', params: { page_slug:request.env['PATH_INFO'] }, method: :post, class: "govuk-button govuk-button--secondary", name: 'save_for_later', disabled: true %>
+            <% else %>
+              <%= button_to t('presenter.save_and_return.save'), '/', params: { page_slug:request.env['PATH_INFO'] }, method: :post, class: "govuk-button govuk-button--secondary", name: 'save_for_later'%>
+            <% end %>
+          <% end %>        </div>
       <% end %>
 
     </div>

data/app/views/metadata_presenter/page/content.html.erb

@@ -25,7 +25,15 @@
                      content_components: @page.supported_content_components
                    } %>
 
-        <%= f.govuk_submit(disabled: editable?) %> 
+        <div class="govuk-button-group">
+          <%= f.govuk_submit(disabled: editable?) %>
+          <% if save_and_return_enabled? %>
+            <% if editor_preview? || editable? %>
+              <%= button_to t('presenter.save_and_return.save'), '/', params: { page_slug:request.env['PATH_INFO'] }, method: :post, class: "govuk-button govuk-button--secondary", name: 'save_for_later', disabled: true %>
+            <% else %>
+              <%= button_to t('presenter.save_and_return.save'), '/', params: { page_slug:request.env['PATH_INFO'] }, method: :post, class: "govuk-button govuk-button--secondary", name: 'save_for_later'%>
+            <% end %>
+          <% end %>        </div>
       <% end %>
     </div>
   </div>

data/app/views/metadata_presenter/page/multiplequestions.html.erb

@@ -17,8 +17,15 @@
             content_components: @page.supported_content_components
           }
         %>
-
-        <%= f.govuk_submit(disabled: editable?) %> 
+        <div class="govuk-button-group">
+          <%= f.govuk_submit(disabled: editable?) %>
+          <% if save_and_return_enabled? %>
+            <% if editor_preview? || editable? %>
+              <%= button_to t('presenter.save_and_return.save'), '/', params: { page_slug:request.env['PATH_INFO'] }, method: :post, class: "govuk-button govuk-button--secondary", name: 'save_for_later', disabled: true %>
+            <% else %>
+              <%= button_to t('presenter.save_and_return.save'), '/', params: { page_slug:request.env['PATH_INFO'] }, method: :post, class: "govuk-button govuk-button--secondary", name: 'save_for_later'%>
+            <% end %>
+          <% end %>        </div>
       <% end %>
     </div>
   </div>

data/app/views/metadata_presenter/page/singlequestion.html.erb

@@ -20,7 +20,17 @@
           </div>
         <% end %>
 
-        <%= f.govuk_submit(disabled: editable?) %> <% if ENV['SAVE_AND_RETURN'] == 'enabled' %><a href="<%= save_path(:page_slug=>request.env['PATH_INFO']) %>" class="govuk-button" data-module="govuk-button" data-component="save-button"><%= t('presenter.save_and_return.save') %></a><% end %>
+        <div class="govuk-button-group">
+          <%= f.govuk_submit(disabled: editable?) %>
+
+          <% if save_and_return_enabled? %>
+            <% if editor_preview? || editable? %>
+              <%= button_to t('presenter.save_and_return.save'), '/', params: { page_slug:request.env['PATH_INFO'] }, method: :post, class: "govuk-button govuk-button--secondary", name: 'save_for_later', disabled: true %>
+            <% else %>
+              <%= button_to t('presenter.save_and_return.save'), '/', params: { page_slug:request.env['PATH_INFO'] }, method: :post, class: "govuk-button govuk-button--secondary", name: 'save_for_later'%>
+            <% end %>
+          <% end %>
+        </div>
       <% end %>
     </div>
   </div>

data/app/views/metadata_presenter/save_and_return/email_confirmation.html.erb

@@ -1,22 +1,25 @@
 <div class="fb-main-grid-wrapper">
   <div class="govuk-grid-row">
     <div class="govuk-grid-column-two-thirds">
-    <h1 id="page-heading" class="govuk-heading-xl"><%= t('presenter.save_and_return.confirm_email.heading') %></h1>
-    <%= form_for @email_confirmation do |f| %>
-      <%= f.govuk_error_summary %>
-      <div class="govuk-form-group">
-        <%=
-        f.govuk_email_field :email_confirmation,
-          label: { text: t('presenter.save_and_return.show.email_confirmation') },
-          name: "email_confirmation",
-          spellcheck: "false",
-          autocomplete: "email"
-        %>
-      </div>
-      
-      <p class="mojf-settings-screen__description"><%= t('presenter.save_and_return.confirm_email.description') %></p>
-
-      <%= f.govuk_submit t('presenter.save_and_return.show.continue') %><% end %> <%= link_to t('presenter.save_and_return.show.cancel'), page_slug, class: "govuk-button govuk-button--secondary" %>
+      <a class="govuk-back-link" href="<%= :back %>"><%= t('presenter.back') %></a>
+      <%= form_for @email_confirmation do |f| %>
+        <%= f.govuk_error_summary %>
+        <div class="govuk-form-group">
+          <%=
+          f.govuk_email_field :email_confirmation,
+            label: { size: 'l', text: t('presenter.save_and_return.confirm_email.heading') },
+            name: "email_confirmation",
+            spellcheck: "false",
+            autocomplete: "email"
+          %>
+        </div>
+        
+        <p class="mojf-settings-screen__description"><%= t('presenter.save_and_return.confirm_email.description') %></p>
+        <br/>
+        <div class="govuk-button-group">
+          <%= f.govuk_submit t('presenter.save_and_return.show.continue') %> <%= link_to t('presenter.save_and_return.show.cancel'), page_slug, class: "govuk-button govuk-button--secondary" %>
+        <div class="govuk-button-group">
+      <% end %>
     </div>
   </div>
 </div>

data/app/views/metadata_presenter/save_and_return/record_error.html.erb

@@ -0,0 +1,9 @@
+<div class="fb-main-grid-wrapper">
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+    <h1 id="page-heading" class="govuk-heading-xl"><%= t('presenter.save_and_return.resume.errors.generic_problem.heading') %></h1>
+    <p><%= t('presenter.save_and_return.resume.errors.generic_problem.info_1') %></p>
+    <p><%= t('presenter.save_and_return.resume.errors.generic_problem.info_2') %></p>
+    </div>
+  </div>
+</div>

data/app/views/metadata_presenter/save_and_return/record_failure.html.erb

@@ -0,0 +1,9 @@
+<div class="fb-main-grid-wrapper">
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+    <h1 id="page-heading" class="govuk-heading-xl"><%= t('presenter.save_and_return.resume.errors.failure.heading') %></h1>
+    <p><%= t('presenter.save_and_return.resume.errors.failure.info_1') %></p>
+    <p><%= t('presenter.save_and_return.resume.errors.failure.info_2') %></p>
+    </div>
+  </div>
+</div>

data/app/views/metadata_presenter/save_and_return/record_link_expired.html.erb

@@ -0,0 +1,9 @@
+<div class="fb-main-grid-wrapper">
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+    <h1 id="page-heading" class="govuk-heading-xl"><%= t('presenter.save_and_return.resume.errors.expired.heading') %></h1>
+    <p><%= t('presenter.save_and_return.resume.errors.expired.info_1') %></p>
+    <p><%= t('presenter.save_and_return.resume.errors.expired.info_2') %></p>
+    </div>
+  </div>
+</div>

data/app/views/metadata_presenter/save_and_return/record_link_used.html.erb

@@ -0,0 +1,9 @@
+<div class="fb-main-grid-wrapper">
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+    <h1 id="page-heading" class="govuk-heading-xl"><%= t('presenter.save_and_return.resume.errors.link_used.heading') %></h1>
+    <p><%= t('presenter.save_and_return.resume.errors.link_used.info_1') %></p>
+    <p><%= t('presenter.save_and_return.resume.errors.link_used.info_2') %></p>
+    </div>
+  </div>
+</div>

data/app/views/metadata_presenter/save_and_return/resume_from_start.html.erb

@@ -0,0 +1,11 @@
+<div class="fb-main-grid-wrapper">
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+    <h1 id="page-heading" class="govuk-heading-xl"><%= t('presenter.save_and_return.resume.from_start.heading', service_name: service.service_name) %></h1>
+    <p class="govuk-hint"><%= t('presenter.save_and_return.resume.from_start.info_1') %></p>
+    <br/>
+    <p class="govuk-hint"><%= t('presenter.save_and_return.resume.from_start.info_2') %></p>
+    <%= link_to t('presenter.save_and_return.resume.from_start.continue'), root_path, class: "govuk-button" %>
+    </div>
+  </div>
+</div>

data/app/views/metadata_presenter/save_and_return/resume_progress.html.erb

@@ -0,0 +1,50 @@
+<div class="fb-main-grid-wrapper" data-fb-pagetype="resume_progress">
+  <h1 class="fb-editable govuk-heading-xl"
+  data-fb-content-type="element">
+  <%= t('presenter.save_and_return.resume.progress.heading', service_name: get_service_name) %>
+  </h1>
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+      <p><%= t('presenter.save_and_return.resume.progress.content_1') %></p>
+      <p><%= t('presenter.save_and_return.resume.progress.content_2') %></p>
+      <%= form_for @page, url: reserved_submissions_path, html: { id: 'answers-form' } do |f| %>
+        <dl class="fb-block fb-block-answers govuk-summary-list">
+          <% pages_presenters.each do |page_answers_presenters| %>
+            <% page_answers_presenters.each_with_index do |page_answers_presenter, index| %>
+
+              <% if !page_answers_presenter.answer.empty? %>
+
+              <div class="govuk-summary-list__row">
+                <dt class="govuk-summary-list__key">
+                  <%= page_answers_presenter.humanised_title %>
+                </dt>
+
+                <dd class="govuk-summary-list__value">
+                  <%= page_answers_presenter.answer %>
+                </dd>
+                <dd class="govuk-summary-list__actions">
+                  <%= link_to(
+                    editable? ? '#' : page_answers_presenter.url,
+                    class: 'govuk-link'
+                  ) do %>
+                    Change<span class="govuk-visually-hidden"> Your answer for <%= page_answers_presenter.humanised_title %></span>
+                  <% end %>
+                </dd>
+              </div>
+
+              <% if page_answers_presenter.last_multiple_question?(index, page_answers_presenters.size) %>
+              <% end %>
+        </dl>
+        <dl class="fb-block fb-block-answers govuk-summary-list">
+              <% end %>
+            <% end %>
+          <% end %>
+        </dl>
+
+        <div class="govuk-button-group">
+          <%= link_to t('presenter.save_and_return.resume.progress.continue'), page_slug, class: "govuk-button" %> <a href="<%= save_path(:page_slug=>page_slug) %>" class="govuk-button govuk-button--secondary" data-module="govuk-button" data-component="save-button"><%= t('presenter.save_and_return.save') %></a>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/metadata_presenter/save_and_return/return.html.erb

@@ -0,0 +1,26 @@
+<div class="fb-main-grid-wrapper">
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+    <h1 id="page-heading" class="govuk-heading-xl"><%= t('presenter.save_and_return.resume.heading', service_name: get_service_name) %></h1>
+    <p><%= t('presenter.save_and_return.resume.content') %></p>
+    <%= form_for @resume_form do |f| %>
+      <%= f.govuk_error_summary %>
+      <%= f.hidden_field(:uuid, value: get_uuid) %>
+      <div class="govuk-form-group">
+      <%=
+        f.govuk_text_field :secret_answer,
+        label: { text: to_html(label_text(f.object.secret_question)) }
+      %>
+      </div>
+      
+      <div class="govuk-warning-text">
+        <span class="govuk-warning-text__icon" aria-hidden="true">!</span>
+        <strong class="govuk-warning-text__text">
+          <span class="govuk-warning-text__assistive">Warning</span>
+          <%= t('presenter.save_and_return.resume.information') %>
+        </strong>
+      </div>
+      <%= f.govuk_submit t('presenter.save_and_return.resume.continue') %><% end %>
+    </div>
+  </div>
+</div>

data/app/views/metadata_presenter/save_and_return/save_progress.html.erb

@@ -3,11 +3,11 @@
     <div class="govuk-grid-column-two-thirds">
     <h1 id="page-heading" class="govuk-heading-xl"><%= t('presenter.save_and_return.saved.heading') %></h1>
     <p class="mojf-settings-screen__description"><%= t('presenter.save_and_return.saved.success', email: confirmed_email) %></p>
-    <p class="govuk-hint"><%= t('presenter.save_and_return.saved.info_1') %></p>
+    <p><%= t('presenter.save_and_return.saved.info_1') %></p>
     <br/>
-    <p class="govuk-hint"><%= t('presenter.save_and_return.saved.info_2') %></p>
+    <p><%= t('presenter.save_and_return.saved.info_2') %></p>
     <br/>
-    <p class="govuk-hint"><%= t('presenter.save_and_return.saved.info_3') %></p>
+    <p><%= t('presenter.save_and_return.saved.info_3') %></p>
     </div>
   </div>
 </div>

data/app/views/metadata_presenter/save_and_return/show.html.erb

@@ -4,41 +4,44 @@
     <h1 id="page-heading" class="govuk-heading-xl"><%= t('presenter.save_and_return.show.heading') %></h1>
     <p class="mojf-settings-screen__description"><%= t('presenter.save_and_return.show.description') %></p>
 
-    <%= form_for @saved_form do |f| %>
-      <%= f.govuk_error_summary %>
-      <div class="govuk-form-group">
-      <%= f.hidden_field(:page_slug, value: page_slug) %>
-        <%=
-        f.govuk_email_field :email,
-          label: { text: t('presenter.save_and_return.show.email') },
-          hint: {
-            data: { "fb-default-text" => default_text('hint') },
-            text: t('presenter.save_and_return.show.email_hint')
-          },
-          name: "email",
-          spellcheck: "false",
-          autocomplete: "email"
-        %>
-        <%=
-        f.govuk_collection_radio_buttons :secret_question,
-          secret_questions,
-          :id,
-          :name,
-          legend: { text: t('presenter.save_and_return.show.secret_question') },
-          hint: {
-            data: { "fb-default-text" => default_text('hint') },
-            text: t('presenter.save_and_return.show.secret_question_hint') 
-          },
-          bold_labels: false
-        %>
-        <%=
-        f.govuk_text_field :secret_answer,
-          label: { text: t('presenter.save_and_return.show.secret_answer') },
+      <%= form_for @saved_form do |f| %>
+        <%= f.govuk_error_summary %>
+        <div class="govuk-form-group">
+        <%= f.hidden_field(:page_slug, value: page_slug) %>
+          <%=
+          f.govuk_email_field :email,
+            label: { text: to_html(label_text(t('presenter.save_and_return.show.email'))) },
+            hint: {
+              data: { "fb-default-text" => default_text('hint') },
+              text: t('presenter.save_and_return.show.email_hint')
+            },
+            name: "email",
+            spellcheck: "false",
+            autocomplete: "email"
+          %>
+          <%=
+          f.govuk_collection_radio_buttons :secret_question,
+            secret_questions,
+            :id,
+            :name,
+            legend: { text: t('presenter.save_and_return.show.secret_question') },
+            hint: {
+              data: { "fb-default-text" => default_text('hint') },
+              text: t('presenter.save_and_return.show.secret_question_hint') 
+            },
+            bold_labels: false
+          %>
+          <%=
+          f.govuk_text_field :secret_answer,
+          label: { text: to_html(label_text(t('presenter.save_and_return.show.secret_answer'))) },
           name: "secret_answer"
-        %>
-      </div>
-
-      <%= f.govuk_submit t('presenter.save_and_return.show.continue') %><% end %> <%= link_to t('presenter.save_and_return.show.cancel'), page_slug, class: "govuk-button govuk-button--secondary" %>
+          %>
+        </div>
+          
+        <div class="govuk-button-group">
+          <%= f.govuk_submit t('presenter.save_and_return.show.continue') %> <%= link_to t('presenter.save_and_return.show.cancel'), page_slug, class: "govuk-button govuk-button--secondary" %>
+        </div>
+      <% end %>
     </div>
   </div>
 </div>

data/config/locales/en.yml

@@ -1,5 +1,6 @@
 en:
   presenter:
+    back: 'Back'
     actions:
       start: Start now
       continue: Continue
@@ -42,7 +43,7 @@ en:
         heading: 'Save for later'
         description: 'We will send you a one-off link that you can use to resume this form within 28 days.'
         email: 'Email address'
-        email_hint: 'Where we will send the link'
+        email_hint: 'We will only use this to send you a link to your form'
         secret_question: 'Pick a security question'
         secret_question_hint: 'We will use this to verify your identity when you return'
         secret_answer: 'The answer to your security question'
@@ -60,10 +61,44 @@ en:
       validation:
         email: 'Enter an email address in the correct format, like name@example.com'
         email_not_matched: 'Does not match'
+        answer_not_matched: 'Your answer is incorrect. You have %{attempts} attempts remaining.'
+        answer_too_long: 'Your answer for %{attribute} must be 100 characters or fewer.'
       secret_questions:
         one: "What is your mother's maiden name?"
         two: 'What is the last name of your favourite teacher?'
         three: 'What is the name of the hospital where you were born?'
+      resume:
+        heading: "Continue with \"%{service_name}\""
+        continue: 'Continue'
+        content: 'To retrieve your information, enter the answer to your security question that you set when saving your progress.'
+        information: 'This will use up your save link. To save your progress again, you will need to repeat the save process and generate another link.'
+        errors:
+          generic_problem:
+            heading: 'There is a problem with your link'
+            info_1: 'Please try again. If you copied and pasted the link into your browser, check you copied the entire link.'
+            info_2: 'If this problem persists, you will need to start the form again. Your saved answers will be securely deleted after 28 days.'
+          expired:
+            heading: 'Your link has expired'
+            info_1: 'It has been more than 28 days since you saved your progress on this form and the link is no longer valid.'
+            info_2: 'Your saved answers have been be securely deleted.'
+          link_used:
+            heading: 'That link has already been used'
+            info_1: 'Links to resume a form only work once. If you have saved your progress more than once, check for a more recent link.'
+            info_2: 'Otherwise, you will need to start the form again. Your saved answers will be securely deleted after 28 days.'
+          failure:
+            heading: 'Your information cannot be retrieved'
+            info_1: 'The answer to your security question was incorrect and you have run out of attempts to retrieve your information.'
+            info_2: 'You will need to start the form again. Your saved answers will be securely deleted.'
+        from_start:
+          heading: "\"%{service_name}\" has been updated"
+          info_1: 'Your information has been successfully retrieved. However, the form has been updated since your last visit.'
+          info_2: 'Please check from the beginning in case anything has changed, such as new requirements or questions.'
+          continue: 'Continue'
+        progress:
+          heading: '%{service_name}'
+          content_1: 'You have sucessfuly retrieved your saved information.'
+          content_2: 'Here are the answers you have provided so far.'
+          continue: 'Continue'
     footer:
       cookies:
         heading: "Cookies"

data/config/routes.rb

@@ -15,7 +15,14 @@ MetadataPresenter::Engine.routes.draw do
   get 'save/email_confirmation', to: 'save_and_return#email_confirmation'
   post 'email_confirmations', to: 'save_and_return#confirm_email'
   get 'save/progress_saved', to: 'save_and_return#save_progress'
-  # get 'return/:service_slug/:uuid', to: 'save_and_return#return'
+  get '/return/:uuid', to: 'save_and_return#return'
+  post 'resume_forms', to: 'save_and_return#submit_secret_answer'
+  get 'record_error', to: 'save_and_return#record_error'
+  get 'record_failure', to: 'save_and_return#record_failure'
+  get 'expired', to: 'save_and_return#record_link_expired'
+  get 'already_used', to: 'save_and_return#record_link_used'
+  get 'resume_from_start', to: 'save_and_return#resume_from_start'
+  get 'resume_progress', to: 'save_and_return#resume_progress'
 
   post '/', to: 'answers#create'
   match '*path', to: 'answers#create', via: :post

data/lib/metadata_presenter/version.rb

@@ -1,3 +1,3 @@
 module MetadataPresenter
-  VERSION = '2.18.6'.freeze
+  VERSION = '2.19'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 2.18.6
+  version: '2.19'
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2023-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -72,6 +72,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 6.2.0
+- !ruby/object:Gem::Dependency
+  name: sassc-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: better_errors
   requirement: !ruby/object:Gem::Requirement
@@ -287,6 +301,7 @@ files:
 - app/models/metadata_presenter/page_answers.rb
 - app/models/metadata_presenter/page_warning.rb
 - app/models/metadata_presenter/previous_page.rb
+- app/models/metadata_presenter/resume_form.rb
 - app/models/metadata_presenter/route.rb
 - app/models/metadata_presenter/row_number.rb
 - app/models/metadata_presenter/saved_form.rb
@@ -325,6 +340,7 @@ files:
 - app/validators/metadata_presenter/virus_scan_validator.rb
 - app/validators/metadata_presenter/word_count.rb
 - app/validators/saved_progress_validator.rb
+- app/validators/secret_answer_validator.rb
 - app/views/errors/404.html
 - app/views/errors/500.html
 - app/views/layouts/metadata_presenter/application.html.erb
@@ -365,6 +381,13 @@ files:
 - app/views/metadata_presenter/page/standalone.html.erb
 - app/views/metadata_presenter/page/start.html.erb
 - app/views/metadata_presenter/save_and_return/email_confirmation.html.erb
+- app/views/metadata_presenter/save_and_return/record_error.html.erb
+- app/views/metadata_presenter/save_and_return/record_failure.html.erb
+- app/views/metadata_presenter/save_and_return/record_link_expired.html.erb
+- app/views/metadata_presenter/save_and_return/record_link_used.html.erb
+- app/views/metadata_presenter/save_and_return/resume_from_start.html.erb
+- app/views/metadata_presenter/save_and_return/resume_progress.html.erb
+- app/views/metadata_presenter/save_and_return/return.html.erb
 - app/views/metadata_presenter/save_and_return/save_progress.html.erb
 - app/views/metadata_presenter/save_and_return/show.html.erb
 - app/views/metadata_presenter/session/_timeout_fallback.html.erb