metadata_presenter 2.17.44 → 2.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5b8ce63d6058cd5e21a0db9190fb22fa6a64e56ba6734533b325781f8e7d32e
-  data.tar.gz: 70691c14ccd88fed3192eb0d4677e23d9f515786335ac155c867dbb1fe341bb4
+  metadata.gz: 6f510cf174501cb63991c19c4315d049dbdde45cc1710dc5c0dae3f739c2908a
+  data.tar.gz: e3b761015334f2e86e683e2cc286b1771350920e8ac48d538584db3f26df8586
 SHA512:
-  metadata.gz: '0486169b63d3ca1303a6381db5db2795075e51d6a5de052ae1cce874ec4f70c1b8b35e38569a03d05d73dd5434754fccb9aaf4119b3aba97d9faf77fdf0614f8'
-  data.tar.gz: 1b6da19840195e042a146e43d1f0de9ab6cfc5bbd3aebb4a47e95e657c2a07f4df036114f0e211330eefe97eacf7a8123306bd3cf9bb3ca7c94256eae86b753c
+  metadata.gz: ed4b94152f503bd888a2e767824a60093c802a9ed83cb6b0cdbc1e7f502bda18279f6eb794dceaea8dd6a61f2331428c56cb2208c22087197a286a7ee447afb8
+  data.tar.gz: 19dce7610b5c923d456ea795020755c5f3b95f8fec3071387fe930284f99dbd5210c799438694ebbe51b85afbe888e11ce221264483c9d04274fb34819ad12a7

data/app/controllers/metadata_presenter/engine_controller.rb

@@ -15,6 +15,12 @@ module MetadataPresenter
       end
     end
 
+    def save_form_progress
+      if defined? super
+        super
+      end
+    end
+
     def back_link
       previous_page = PreviousPage.new(
         service:,

data/app/controllers/metadata_presenter/save_and_return_controller.rb

@@ -1,13 +1,68 @@
 module MetadataPresenter
   class SaveAndReturnController < EngineController
-    before_action :check_feature_flag
-    helper_method :secret_questions
+    # before_action :check_feature_flag
+    helper_method :secret_questions, :page_slug, :confirmed_email
 
     def show
       @saved_form = SavedForm.new
     end
 
-    def create; end
+    def page_slug
+      params[:page_slug] || params[:saved_form][:page_slug]
+    end
+
+    def confirmed_email
+      session['saved_form']['email']
+      # TODO: clear session data after submission is successful
+    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.populate_service_values(service)
+      @saved_form.populate_session_values(session)
+      if @saved_form.valid?
+        # put in session until we have confirmed email address
+        session[:saved_form] = @saved_form
+        redirect_to '/save/email_confirmation'
+      else
+        render :show, params: { page_slug: params[:page_slug], status: :unprocessable_entity }
+      end
+    end
+
+    def email_confirmation
+      @saved_form = session[:saved_form]
+      @email_confirmation = EmailConfirmation.new
+    end
+
+    def confirm_email
+      @email_confirmation = EmailConfirmation.new
+      @email_confirmation.assign_attributes(confirmation_params[:email_confirmation], session['saved_form']['email'])
+
+      if @email_confirmation.valid?
+        # save_form_progress returns the uuid of the saved form as 'id'
+        # user to generate email link, for now not assigned because rubocop
+        # save_form_progress.body['id']
+        # TODO: rescue failed POST
+        # send_email(uuid, confirmation_params[:email_confirmation])
+        redirect_to '/save/progress_saved'
+      else
+        render :email_confirmation, status: :unprocessable_entity
+      end
+    end
+
+    # def return
+    #   uuid = params[:uuid]
+    #   response = get_saved_progress(uuid)
+
+    #   session[:user_id] = response['user_id']
+    #   session[:user_token] = response['user_token']
+
+    #   Rails.logger.info('returning to form')
+    #   Rails.logger.info('session')
+    #   redirect_to '/check-answers'
+    # end
 
     def secret_questions
       [
@@ -17,6 +72,29 @@ module MetadataPresenter
       ]
     end
 
+    def text_for(question)
+      return nil if question.blank?
+
+      secret_questions.select { |s| s.id.to_s == question.to_s }.first.name
+    end
+
+    def saved_form_params
+      params.permit(
+        :email,
+        :secret_answer,
+        { saved_form: %i[page_slug secret_question] },
+        :authenticity_token,
+        :page_slug
+      )
+    end
+
+    def confirmation_params
+      params.permit(
+        :email_confirmation,
+        :authenticity_token
+      )
+    end
+
     private
 
     def check_feature_flag

data/app/models/metadata_presenter/email_confirmation.rb

@@ -0,0 +1,17 @@
+module MetadataPresenter
+  class EmailConfirmation
+    include ActiveModel::Model
+
+    attr_accessor :email_confirmation,
+                  :session_email
+
+    validates_with EmailConfirmationValidator
+
+    def initialize; end
+
+    def assign_attributes(email_confirmation, session_email)
+      @email_confirmation = email_confirmation
+      @session_email = session_email
+    end
+  end
+end

data/app/models/metadata_presenter/saved_form.rb

@@ -1,11 +1,39 @@
 module MetadataPresenter
   class SavedForm
     include ActiveModel::Model
+    validates_with SavedProgressValidator
 
     attr_accessor :email,
                   :secret_question,
-                  :secret_answer
+                  :secret_answer,
+                  :page_slug,
+                  :service_slug,
+                  :service_version,
+                  :user_id,
+                  :user_token,
+                  :user_data_payload,
+                  :attempts,
+                  :active
 
+    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)
+      self.email           = params['email']
+      self.page_slug       = params['saved_form']['page_slug']
+      self.secret_question = params['saved_form']['secret_question']
+      self.secret_answer   = params['secret_answer']
+    end
+
+    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
   end
 end

data/app/validators/email_confirmation_validator.rb

@@ -0,0 +1,7 @@
+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'))
+    end
+  end
+end

data/app/validators/saved_progress_validator.rb

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

data/app/views/layouts/metadata_presenter/application.html.erb

@@ -28,6 +28,7 @@
      document.body.className = ((document.body.className) ? document.body.className + ' js-enabled' : 'js-enabled');
     </script>
 
+
     <div class="govuk-modal-dialogue-inert-container">
       <% if show_cookie_request? %>
         <%= render partial: 'metadata_presenter/analytics/cookie_banner_request' %>
@@ -43,7 +44,7 @@
           <% if back_link.present? %>
             <a class="govuk-back-link" href="<%= back_link %>">Back</a>
           <% end %>
-          <% if !in_progress? %>
+          <% if !allowed_page? %>
             <%= render partial: 'metadata_presenter/session/timeout_fallback' %>
           <% end %>
           <%= yield %>
@@ -53,7 +54,7 @@
       <%= render template: 'metadata_presenter/footer/footer' %>
     </div>
 
-    <% if !in_progress? %>
+    <% if !allowed_page? %>
       <%= render partial: 'metadata_presenter/session/timeout_warning_modal' %>
     <% end %>
   </body>

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

@@ -20,7 +20,7 @@
           </div>
         <% end %>
 
-        <%= f.govuk_submit(disabled: editable?) %> 
+        <%= 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 %>
       <% end %>
     </div>
   </div>

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

@@ -0,0 +1,22 @@
+<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'), :back %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,13 @@
+<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.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>
+    <br/>
+    <p class="govuk-hint"><%= t('presenter.save_and_return.saved.info_2') %></p>
+    <br/>
+    <p class="govuk-hint"><%= t('presenter.save_and_return.saved.info_3') %></p>
+    </div>
+  </div>
+</div>

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

@@ -7,6 +7,7 @@
     <%= 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') },

data/config/locales/en.yml

@@ -48,6 +48,18 @@ en:
         secret_answer: 'The answer to your security question'
         continue: 'Continue with saving'
         cancel: 'Cancel saving and resume form'
+      confirm_email:
+        heading: 'Check your email address is correct'
+        description: 'Make sure this is correct before finishing'
+      saved:
+        heading: 'Your form has been saved'
+        success: "We have sent a one-off link to %{email} which you can use to resume this form within 28 days. After that time, your saved information will be deleted."
+        info_1: "If you haven't received the email after a few minutes, check your spam folder."
+        info_2: 'This link will only work once. If you want to save your progress again after resuming the form, you will need to repeat the save process and generate another link'
+        info_3: 'You are now free to close this window or navigate away from this page.'
+      validation:
+        email: 'Enter an email address in the correct format, like name@example.com'
+        email_not_matched: 'Does not match'
       secret_questions:
         one: "What is your mother's maiden name?"
         two: 'What is the last name of your favourite teacher?'

data/config/routes.rb

@@ -12,6 +12,10 @@ MetadataPresenter::Engine.routes.draw do
 
   get 'save', to: 'save_and_return#show'
   post 'saved_forms', to: 'save_and_return#create'
+  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'
 
   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.17.44'.freeze
+  VERSION = '2.18'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata_presenter
 version: !ruby/object:Gem::Version
-  version: 2.17.44
+  version: '2.18'
 platform: ruby
 authors:
 - MoJ Forms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -271,6 +271,7 @@ files:
 - app/models/metadata_presenter/conditional.rb
 - app/models/metadata_presenter/coordinates.rb
 - app/models/metadata_presenter/date_field.rb
+- app/models/metadata_presenter/email_confirmation.rb
 - app/models/metadata_presenter/evaluate_conditionals.rb
 - app/models/metadata_presenter/expression.rb
 - app/models/metadata_presenter/file_uploader.rb
@@ -301,6 +302,7 @@ files:
 - app/operators/metadata_presenter/is_operator.rb
 - app/operators/metadata_presenter/operator.rb
 - app/presenters/metadata_presenter/page_answers_presenter.rb
+- app/validators/email_confirmation_validator.rb
 - app/validators/metadata_presenter/accept_validator.rb
 - app/validators/metadata_presenter/autocomplete_validator.rb
 - app/validators/metadata_presenter/base_validator.rb
@@ -322,6 +324,7 @@ files:
 - app/validators/metadata_presenter/validate_schema.rb
 - app/validators/metadata_presenter/virus_scan_validator.rb
 - app/validators/metadata_presenter/word_count.rb
+- app/validators/saved_progress_validator.rb
 - app/views/errors/404.html
 - app/views/layouts/metadata_presenter/application.html.erb
 - app/views/metadata_presenter/analytics/_cookie_banner_confirmation.html.erb
@@ -360,6 +363,8 @@ files:
 - app/views/metadata_presenter/page/singlequestion.html.erb
 - 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/save_progress.html.erb
 - app/views/metadata_presenter/save_and_return/show.html.erb
 - app/views/metadata_presenter/session/_timeout_fallback.html.erb
 - app/views/metadata_presenter/session/_timeout_warning_modal.html.erb