dvla-application_helper 5.1.5

data/lib/dvla/application_helper/builders/V2/cop_v2_application_builder.rb

@@ -0,0 +1,59 @@
+require_relative('../photo_signature_builder_mixin.rb')
+
+module DVLA
+  module Application
+    class COPV2ApplicationBuilder < BaseUODLV2ApplicationBuilder
+      # Including all properties and methods needed to support photos
+      include DVLA::Application::PhotoBuilderMixin
+
+      def initialize
+        init_photo_properties
+        super
+      end
+
+      # Some builder methods are automatically included from PhotoBuilderMixin
+
+      # -- Overridden methods --
+
+      # Defining the non-processable application factory that the BaseUODLV2ApplicationBuilder will use
+      def non_processable_application_factory
+        FM[:cop_application]
+      end
+
+      # Defining the default driver_id, used to pass the validation in channel-api-stub
+      def default_application_driver_id
+        Settings.test.driver_id.optional_cop
+      end
+
+      def application_driving_licence_actions
+        { renewLicence: { reason: 'Update Photo' } }
+      end
+
+      # Defining the data to put in customer_context
+      def application_customer_context
+        {
+          customerIntent: 'Change of photo',
+          transactionOutcome: 'Change of photo',
+          applicationsEligibilityResponse: [{
+                                              applicationType: 'update-ordinary-licence',
+                                              isRequired: true,
+                                              availableActions: [
+                                                actionType: 'update-photo',
+                                                isRequired: true,
+                                              ],
+                                            }],
+        }
+      end
+
+      # Creating the images that the BaseUODLV2ApplicationBuilder will include in the app
+      def application_images
+        generate_photo_images(@processable, @unique_images)
+      end
+
+      # Advance and submits the tasks based on the photo review state specified
+      def process_application_tasks(app)
+        process_photo_tasks(app) if @processable
+      end
+    end
+  end
+end

data/lib/dvla/application_helper/builders/V2/dup_v2_application_builder.rb

@@ -0,0 +1,84 @@
+require_relative('../photo_signature_builder_mixin.rb')
+require_relative('../dup_rep_builder_mixin.rb')
+
+module DVLA
+  module Application
+    class DUPV2ApplicationBuilder < BaseUODLV2ApplicationBuilder
+      # Including all properties and methods needed to support photos and signatures in the case of a Paper DUP
+      include DVLA::Application::PhotoSignatureBuilderMixin
+      include DVLA::Application::DupRepBuilderMixin
+
+      def initialize
+        dup_rep_init_properties
+        init_photo_signature_properties
+        super
+      end
+
+      # -- Builder methods --
+
+      # Some builder methods are automatically included from PhotoSignatureBuilderMixin and DupRepBuilderMixin
+
+      # Acts as if the licence owner has a paper licence.
+      # The application will be eligible to be changed from a paper licence to a plastic one
+      # It will also upload a photo and a signature with the application, and enable the flags to control these images and their tasks
+      # Sets the driver id to the specific id required for channel api stub to recognise
+      # @return [DUPV2ApplicationBuilder]
+      def with_paper_to_plastic_driver_id
+        @eligibility_paper_to_plastic = true
+        @driver_id = Settings.test.driver_id.paper_duplicate
+        self
+      end
+
+      # -- Overridden methods --
+
+      # Defining the non-processable application factory that the BaseUODLV2ApplicationBuilder will use
+      def non_processable_application_factory
+        FM[:dup_application]
+      end
+
+      # Defining the default driver_id, used to pass the validation in channel-api-stub
+      def default_application_driver_id
+        Settings.test.driver_id.always_duplicate
+      end
+
+      def application_driving_licence_actions
+        # Set a change of address action for all DUP applications
+        { updateAddress: { newAddress: { unstructuredAddress: FM[:application_unstructured_address].build } } }
+      end
+
+      # Defining the data to put in customer_context
+      def application_customer_context
+        {
+          customerIntent: 'Duplicate licence',
+          transactionOutcome: 'Duplicate licence',
+          applicationsEligibilityResponse: [{
+                                              applicationType: 'update-ordinary-licence',
+                                              isRequired: true,
+                                              availableActions: [
+                                                actionType: 'update-photo',
+                                                isRequired: false,
+                                              ],
+                                            }],
+        }
+      end
+
+      def set_application_specific_fields!(app)
+        # Only set unable_to_prove_licence_possession_reason for non-EXCHANGE-PAPER-LICENCE cases
+        unless @driver_id == '21b6e437-8f0c-42ae-8b61-62d53f377841'
+          app.data.unable_to_prove_licence_possession_reason = 'LOST_OR_STOLEN'
+        end
+      
+        unless @unable_to_prove_licence_possession_reason.nil?
+          app.data.unable_to_prove_licence_possession_reason = @unable_to_prove_licence_possession_reason
+        end
+      
+        if @eligibility_paper_to_plastic
+          app.data.customer_context[:applicationsEligibilityResponse][0][:availableActions].push({
+                                                                                                  actionType: 'inform-paper-to-plastic',
+                                                                                                  isRequired: true,
+                                                                                              })
+        end
+      end
+    end
+  end
+end

data/lib/dvla/application_helper/builders/V2/exc_v2_application_builder.rb

@@ -0,0 +1,55 @@
+require_relative('../photo_signature_builder_mixin.rb')
+
+module DVLA
+  module Application
+    class EXCV2ApplicationBuilder < BaseUODLV2ApplicationBuilder
+      # Including all properties and methods needed to support photos and signatures
+      include DVLA::Application::PhotoSignatureBuilderMixin
+
+      def initialize
+        init_photo_signature_properties
+        super
+      end
+
+      # Some builder methods are automatically included from PhotoSignatureBuilderMixin
+
+      # -- Overridden methods --
+
+      # Defining the non-processable application factory that the BaseUODLV2ApplicationBuilder will use
+      def non_processable_application_factory
+        FM[:exc_application]
+      end
+
+      # Defining the default driver_id, used to pass the validation in channel-api-stub
+      def default_application_driver_id
+        Settings.test.driver_id.always_exchange
+      end
+
+      # Defining the data to put in customer_context
+      def application_customer_context
+        {
+            customerIntent: 'Paper to photocard',
+            transactionOutcome: 'Paper to photocard',
+            applicationsEligibilityResponse: [{
+              applicationType: 'update-ordinary-licence',
+              isRequired: true,
+              availableActions: [
+                actionType: 'inform-paper-to-plastic',
+                isRequired: true,
+              ],
+            }],
+        }
+      end
+
+      # Creating the images that the BaseUODLV2ApplicationBuilder will include in the app
+      def application_images
+        generate_photo_signature_images(@processable, @unique_images)
+      end
+
+      # Advance and submits the tasks based on the photo and signature review state specified
+      def process_application_tasks(app)
+        process_photo_signature_tasks(app) if @processable
+      end
+    end
+  end
+end

data/lib/dvla/application_helper/builders/V2/rep_v2_application_builder.rb

@@ -0,0 +1,84 @@
+require_relative('../photo_signature_builder_mixin.rb')
+require_relative('../dup_rep_builder_mixin.rb')
+
+module DVLA
+  module Application
+    class REPV2ApplicationBuilder < BaseUODLV2ApplicationBuilder
+      # Including all properties and methods needed to support photos and signatures in the case of a Paper DUP
+      include DVLA::Application::PhotoSignatureBuilderMixin
+      include DVLA::Application::DupRepBuilderMixin
+
+
+      def initialize
+        @unable_to_prove_licence_possession_reason = nil
+        @eligibility_paper_to_plastic = false
+        init_photo_signature_properties
+        super
+      end
+
+      # -- Builder methods --
+
+      # Some builder methods are automatically included from PhotoSignatureBuilderMixin
+
+
+      # Acts as if the licence owner has a paper licence.
+      # The application will be eligible to be changed from a paper licence to a plastic one and therefore have a normal fee
+      # It will also upload a photo and a signature with the application, and enable the flags to control these images and their tasks
+      # Sets the driver id to the specific id required for channel api stub to recognise
+      # @return [REPV2ApplicationBuilder]
+      def with_paper_to_plastic_driver_id
+        @eligibility_paper_to_plastic = true
+        @driver_id = Settings.test.driver_id.paper_replacement
+        self
+      end
+
+      # -- Overridden methods --
+
+      # Defining the non-processable application factory that the BaseUODLV2ApplicationBuilder will use
+      def non_processable_application_factory
+        FM[:rep_application]
+      end
+
+      # Defining the default driver_id, used to pass the validation in channel-api-stub
+      def default_application_driver_id
+        Settings.test.driver_id.always_replacement
+      end
+
+      def application_driving_licence_actions
+        # Set a change of address action for all REP applications
+        { updateAddress: { newAddress: { unstructuredAddress: FM[:application_unstructured_address].build } } }
+      end
+
+      # Defining the data to put in customer_context
+      def application_customer_context
+        {
+          customerIntent: 'Change of details',
+          transactionOutcome: 'Change of details',
+          applicationsEligibilityResponse: [{
+                                              applicationType: 'update-ordinary-licence',
+                                              isRequired: true,
+                                              availableActions: [
+                                                actionType: 'update-address',
+                                                isRequired: true,
+                                              ],
+                                            }],
+        }
+      end
+
+      def set_application_specific_fields!(app)
+        unless @unable_to_prove_licence_possession_reason.nil?
+          app.data.unable_to_prove_licence_possession_reason = @unable_to_prove_licence_possession_reason
+        end
+
+        app.no_fee_application = true
+
+        if @eligibility_paper_to_plastic
+          app.data.customer_context[:applicationsEligibilityResponse][0][:availableActions].push({
+                                                                                                actionType: 'inform-paper-to-plastic',
+                                                                                                isRequired: true,
+                                                                                              })
+        end
+      end
+    end
+  end
+end

data/lib/dvla/application_helper/builders/V2/tyr_v2_application_builder.rb

@@ -0,0 +1,62 @@
+require_relative('../photo_signature_builder_mixin.rb')
+
+module DVLA
+  module Application
+    class TYRV2ApplicationBuilder < BaseUODLV2ApplicationBuilder
+      # Including all properties and methods needed to support photos
+      include DVLA::Application::PhotoBuilderMixin
+
+      def initialize
+        @no_fee_application = false
+        init_photo_properties
+        super
+      end
+
+      # The application will be a no fee application
+      # @param no_fee [Boolean] If the application should be no-fee. Defaults to true.
+      # @return [TYRV2ApplicationBuilder]
+      def set_no_fee_application(no_fee: true)
+        @no_fee_application = no_fee
+        self
+      end
+
+      # -- Overridden methods --
+
+      def application_images
+        generate_photo_images(@processable, @unique_images)
+      end
+
+      def application_customer_context
+        {
+          customerIntent: 'Ten year renewal',
+          transactionOutcome: 'Ten year renewal',
+          applicationsEligibilityResponse: [{
+                                              applicationType: 'update-ordinary-licence',
+                                              isRequired: true,
+                                              availableActions: [
+                                                actionType: 'update-photo',
+                                                isRequired: true,
+                                              ],
+                                            }],
+        }
+      end
+
+      def non_processable_application_factory
+        FM[:tyr_application]
+      end
+
+      def default_application_driver_id
+        Settings.test.driver_id.mandatory_tyr
+      end
+
+      def application_driving_licence_actions
+        { renewLicence:  { reason: 'Photo Expiry' } }
+      end
+
+      def process_application_tasks(app)
+        process_photo_tasks(app) if @processable
+      end
+
+    end
+  end
+end

data/lib/dvla/application_helper/builders/V2/uodl_v2_application_builder.rb

@@ -0,0 +1,278 @@
+module DVLA
+  module Application
+    class UODLV2ApplicationBuilder < ApplicationBuilder
+      def initialize
+        @change_of_photo = false
+        @duplicate = false
+        @driving_licence_actions = nil
+        @eligibility_paper_to_plastic = false
+        @surrender_entitlement = false
+        @replacement_licence = false
+        @transaction_outcome = nil
+        @unable_to_prove_licence_possession_reason = nil
+        super
+      end
+
+      def change_of_photo
+        @change_of_photo = true
+        @eligible_for_photo_renew = false
+        if @no_fee_application
+          DVLA::Application.logger.info('A Change if photo application must have a FEE'.blue)
+          @no_fee_application = false
+        end
+        self
+      end
+
+      def duplicate_licence
+        @duplicate = true
+        @eligible_for_photo_renew = false
+        if @no_fee_application
+          DVLA::Application.logger.info('A Duplicate application must have a FEE'.blue)
+          @no_fee_application = false
+        end
+        self
+      end
+
+      def eligible_paper_to_plastic
+        @eligibility_paper_to_plastic = true
+        self
+      end
+
+      def replacement_licence
+        @replacement_licence = true
+        @eligible_for_photo_renew = false
+        # a rep application is a free application, so i will ensure this here
+        unless @no_fee_application
+          DVLA::Application.logger.info('A Replacement application must be NO-FEE, no_fee flag will be added'.blue)
+          @no_fee_application = true
+        end
+        self
+      end
+
+      # Adds the customer provided reason for not being able to prove licence possession to the application
+      # @param reason [DVLA::Application::UnableToProveLicencePossessionReasons] the reason for not being able to prove licence possession
+      # @return [UODLV2ApplicationBuilder]
+      def with_unable_to_prove_licence_possession_reason(reason)
+        @unable_to_prove_licence_possession_reason = reason
+        self
+      end
+
+      def with_transaction_outcome(outcome)
+        @transaction_outcome = outcome
+        self
+      end
+
+      def with_driving_licence_actions(action)
+        @driving_licence_actions = action
+        self
+      end
+
+      def build
+        # Sense check to ensure AWS credentials are present.
+        DVLA::Application.check_aws_credentials
+
+        factory = if @processable
+                    FM[:uodl_v2_processable_application]
+                  elsif @replacement_licence && @no_fee_application
+                    FM[:rep_application]
+                  elsif @duplicate
+                    FM[:dup_application]
+                  elsif @change_of_photo
+                    FM[:cop_application]
+                  else
+                    FM[:application]
+                  end
+
+        # this conditional has been added to handle REP (replacement licence)
+        if @replacement_licence || @duplicate
+          images = []
+        else
+          images = generate_photo_images(@processable, @unique_images)
+        end
+
+        # pass in uodl_v2 FM factory to build data attribute
+        app = factory.build(attributes: { data: FM[:uodl_v2_application_data].build, no_fee_application: @no_fee_application }) do |b|
+          b.application_id = @application_id
+          b.customer_id = @customer_id if @customer_id
+          b.data.applicant = @applicant if @applicant
+          b.data.applicant[:phoneNumber] = Faker::PhoneNumber.phone_number if @phone_number
+
+          # if eligible for photo renew, update action accordingly
+          b.data.driving_licence_actions[:renewLicence] = { reason: 'Photo Expiry' } if @eligible_for_photo_renew
+
+          # Adds in updatephoto action for eligible for TYR and change of photo app types
+          # b.data.driving_licence_actions[:updatePhoto] = { photographImageId: '617d6689-e03e-44e7-962d-ceb6e158e031' } if @eligible_for_photo_renew || @change_of_photo
+          b.data.driving_licence_actions[:renewLicence] = { reason: 'Update Photo' } if @change_of_photo
+
+          # changes @driverId to an always cop static id if not eligible for TYR or Replacement_licence flags set
+          if @driver_id.nil?
+            @driver_id = if @duplicate
+                           Settings.test.driver_id.always_duplicate
+                         elsif @replacement_licence
+                           Settings.test.driver_id.always_replacement
+                         elsif !@eligible_for_photo_renew
+                           Settings.test.driver_id.optional_cop
+                         else
+                           Settings.test.driver_id.mandatory_tyr
+                         end
+          end
+
+          if @processable && @driver_id
+            b.driver_id = @driver_id
+          elsif !@processable && @driver_id
+            b.product_id = @driver_id
+            b.product_key = @driver_id
+          end
+
+          unless @processable
+            b.data_schema = Settings.application.v2_schema
+            b.product_type = @product_type
+            if !@processable && !@transaction_outcome.nil?
+              b.data.customer_context[:transactionOutcome] = @transaction_outcome
+              b.data.customer_context[:customerIntent] = @transaction_outcome
+            end
+          end
+
+          unless @driving_licence_actions.nil?
+            b.data.driving_licence_actions = @driving_licence_actions
+          end
+
+        # updates driving licence actions
+          if @change_of_address || @free_key_address || @replacement_licence || @duplicate
+            b.data.driving_licence_actions[:updateAddress] = {
+              newAddress: {
+                unstructuredAddress: FM[:application_unstructured_address].build,
+              },
+            }
+          elsif @bfpo_address
+            b.data.driving_licence_actions[:updateAddress] = {
+              newAddress: {
+                bfpoAddress: FM[:bfpo_address].build,
+              },
+            }
+          end
+
+          # Ensure DUP has a licence possession reason
+          if @duplicate && @unable_to_prove_licence_possession_reason.nil?
+            b.data.unable_to_prove_licence_possession_reason = 'LOST_OR_STOLEN'
+          end
+
+        # builds customer context for rep licence
+          if @replacement_licence
+            b.data.customer_context = {
+              customerIntent: 'Change of details',
+              applicationsEligibilityResponse: [{
+                                                  applicationType: 'update-ordinary-licence',
+                                                  isRequired: true,
+                                                  availableActions: [
+                                                    actionType: 'update-address',
+                                                    isRequired: true,
+                                                  ],
+                                                }],
+              transactionOutcome: 'Change of details',
+            }
+          end
+
+        # builds customer context for dup licence
+          if @duplicate
+            b.data.customer_context = {
+              customerIntent: 'Duplicate licence',
+              applicationsEligibilityResponse: [{
+                                                  applicationType: 'update-ordinary-licence',
+                                                  isRequired: true,
+                                                  availableActions: [
+                                                    actionType: 'update-photo',
+                                                    isRequired: false,
+                                                  ],
+                                                }],
+              transactionOutcome: 'Duplicate licence',
+            }
+          end
+
+          # builds customer context for change of photo
+          if @change_of_photo
+            b.data.customer_context = {
+              customerIntent: 'Change of photo',
+              applicationsEligibilityResponse: [{
+                                                  applicationType: 'update-ordinary-licence',
+                                                  isRequired: true,
+                                                  availableActions: [
+                                                    actionType: 'update-photo',
+                                                    isRequired: true,
+                                                  ],
+                                                }],
+              transactionOutcome: 'Change of photo',
+            }
+          end
+
+          if @eligibility_paper_to_plastic
+            if !@duplicate && !@replacement_licence
+              raise 'Not possible to have a paper-to-plastic for applications that are not REP/DUP'
+            end
+
+            b.data.customer_context[:applicationsEligibilityResponse][0][:availableActions].push({
+                                                                                                  actionType: 'inform-paper-to-plastic',
+                                                                                                  isRequired: true,
+                                                                                                })
+          end
+
+          b.data.applicant = @applicant if @applicant
+          b.data.applicant[:phoneNumber] = Faker::PhoneNumber.phone_number if @phone_number
+
+          if @welsh_language
+            b.data.applicant[:languagePreference] = 'Welsh'
+          end
+
+          unless @unable_to_prove_licence_possession_reason.nil?
+            b.data.unable_to_prove_licence_possession_reason = @unable_to_prove_licence_possession_reason
+          end
+
+          if !@processable && !@payments.nil?
+            b.payments = @payments
+          end
+
+          b.images = images
+
+          if !@processable && !@application_status.nil?
+            @update_reason = if @application_status == 'Cancelled'
+                               @update_reason || 'Timed out'
+                             elsif @application_status == 'Rejected'
+                               b.data.organ_donor = FM[:organ_donor_d90_response].build(attributes: { kidneys: true })
+                             elsif @application_status == 'Returned'
+                               b.data.organ_donor = FM[:organ_donor_d90_response].build(attributes: { cornea: true })
+                             elsif @application_status == 'Unapproved'
+                               b.data.organ_donor = FM[:organ_donor_d90_response].build(attributes: { heart: true })
+                             elsif !@organ_donor.nil? && @organ_donor
+                               # do we want an extra flag to decide any_organs seperate from if they are a donor?
+                               b.data.organ_donor = set_any_organs(any_organs_bool: @organ_donor)
+                             else
+                               b.data.organ_donor = {}
+                             end
+          elsif @processable && !@organ_donor.nil? && @organ_donor
+            b.data.organ_donor = set_any_organs(any_organs_bool: @organ_donor)
+          else
+            b.data.organ_donor = {}
+          end
+        end
+
+        if @processable
+          process_photo_tasks(app)
+        else
+          DVLA::Application::ApplicationStatusProcessor.process_to(app.application_id, @application_status, update_reason: @update_reason)
+        end
+
+        # updates call to action date on domain
+        if @extend_application_deadline
+          extend_date = Time.now + 21.days
+          DVLA::Application.logger.info("Updating application call to action deadline date to: #{extend_date}".blue)
+          DVLA::Application::ApplicationDomain.update_call_to_action_deadline_date(application_id: app.application_id, call_to_action_deadline_date: extend_date.utc.iso8601)
+        end
+
+        DVLA::Application::ApplicationDomain.retrieve_application_by_app_id(application_id: app.application_id)
+      end
+
+      extend Gem::Deprecate
+      deprecate(:build, 'TYRV2ApplicationBuilder#build', 2025, 12)
+    end
+  end
+end