dvla-application_helper 5.1.5

data/lib/dvla/application_helper/builders/V1/application_builder.rb

@@ -0,0 +1,298 @@
+require_relative('../photo_builder_mixin.rb')
+
+module DVLA
+  module Application
+    class ApplicationBuilder
+      # Including all properties and methods needed to support photos
+      include DVLA::Application::PhotoBuilderMixin
+
+      # Creates a new instance of the application builder
+      def initialize
+        @applicant = nil
+        @application_id = SecureRandom::uuid
+        @application_status = 'Preparing'
+        @bfpo_address = false
+        @change_of_address = false
+        @customer_id = nil
+        @driver_id = nil
+        @eligible_for_photo_renew = true
+        @extend_application_deadline = false
+        @free_key_address = false
+        @no_fee_application = false
+        @organ_donor = nil
+        @payments = nil
+        @processable = false
+        @product_type = 'Driving Licence'
+        @phone_number = false
+        @update_reason = nil
+        @unique_images = false
+        @welsh_language = false
+        init_photo_properties
+      end
+
+      # Some builder methods are automatically included from PhotoBuilderMixin
+
+      # Marks the application as processable, doing this will ensure that real services are used to create the
+      # application. For example, the channel api will process the tasks rather than stub data being provided.
+      # Whilst this results in a more complete application, this option is more expensive.
+      # Avoid excessive use in QA tests.
+      # @return [ApplicationBuilder]
+      def processable
+        @processable = true
+        self
+      end
+
+      # Marks the application as non-processable. This will result in the application being created using the test application endpoint.
+      # These applications cannot be actioned via the task service.
+      # This is typically the default option to be used.
+      # @return [ApplicationBuilder]
+      def non_processable
+        @processable = false
+        self
+      end
+
+      # APE uses very specific generated uuid to test with, the inspectable hooks filter the last 12 integers to return specific responses
+      # @param application_id [UUID]
+      def with_application_id(application_id)
+        @application_id = application_id
+        self
+      end
+
+      # The application will contain unique imageIds
+      # Allows images to be interacted with during test, e.g. deleted
+      def unique_images
+        @unique_images = true
+        self
+      end
+
+      # The application will contain a specific application status.
+      # How this state is reached will depend on if the application has been marked as processable or not.
+      # If processable is used here, we will also contain all actions.
+      # @param application_status [String] The application status the application should be in.
+      # @param update_reason [String] The reason for the change in status.
+      # @return [ApplicationBuilder]
+      def with_application_status(application_status, update_reason = nil)
+        @application_status = application_status
+        @update_reason = update_reason
+        self
+      end
+
+      # The application will contain a change of address.
+      # @return [ApplicationBuilder]
+      def with_change_of_address
+        @change_of_address = true
+        self
+      end
+
+      # The application will contain a bfpo address.
+      # @return [ApplicationBuilder]
+      def with_bfpo_address
+        @bfpo_address = true
+        self
+      end
+
+      # Allows specific product type to be passed in
+      # Used during APE testing for inspectable hooks
+      # @param product [Enum] one of: [Vehicles,Driving Licence,Test]
+      # @return [ApplicationBuilder]
+      def with_product_type(product)
+        @product_type = if Settings.test.product_type.include?(product)
+                          product
+                        else
+                          DVLA::Application.logger.info("Unknown Product_type: #{product}, must be one of: #{Settings.test.product_type}\n Reverting product_type to 'Driving Licence'".red)
+                          'Driving Licence'
+                        end
+        self
+      end
+
+      # The application will contain a free key address.
+      # @return [ApplicationBuilder]
+      def with_free_key_address
+        @free_key_address = true
+        self
+      end
+
+      # The application will contain a phone number.
+      # @return [ApplicationBuilder]
+      def has_phone_number
+        @phone_number = true
+        self
+      end
+
+      # Sets the organ donor status of the application.
+      # By default, no organ donation is made
+      # Passing true will cause all_organs to be selected.
+      # Passing false will ensure no organs are selected.
+      # @param donor [boolean] Organ donor status.
+      # @return [ApplicationBuilder]
+      def is_organ_donor(donor)
+        @organ_donor = donor
+        self
+      end
+
+      def is_welsh_language
+        @welsh_language = true
+        self
+      end
+
+      # The application will contain the provided payments.
+      # @param payments [PaymentObject] Payment status.
+      # @return [ApplicationBuilder]
+      def with_payments(payments)
+        @payments = payments
+        self
+      end
+
+      # The application will contain the provided applicant data.
+      # @param applicant [ApplicantObject] Application data.
+      # @return [ApplicationBuilder]
+      def with_applicant(applicant)
+        @applicant = applicant
+        self
+      end
+
+      # The application will be made for the given customer
+      # @param customer_id [String] The customer ID to use
+      # @return [ApplicationBuilder]
+      def with_customer_id(customer_id)
+        @customer_id = customer_id
+        self
+      end
+
+      # The application will be made for the given driver
+      # @param driver_id [String] The driver ID to use
+      # @return [ApplicationBuilder]
+      def with_driver_id(driver_id)
+        @driver_id = driver_id
+        self
+      end
+
+      # The application will be a no fee application
+      # @param no_fee [Boolean] If the application should be no-fee. Defaults to true.
+      # @return [ApplicationBuilder]
+      def set_no_fee_application(no_fee: true)
+        @no_fee_application = no_fee
+        self
+      end
+
+      # The application will be updated with a call to action field which is used to extend an application
+      def extend_application_deadline
+        @extend_application_deadline = true
+        self
+      end
+
+      # Builds the Application base on the current criteria.
+      # @return [RetrieveApplicationResponse]
+      def build
+        # Sense check to ensure AWS credentials are present.
+        DVLA::Application.check_aws_credentials
+
+        factory = if @processable
+                    FM[:uodl_processable_application]
+                  else
+                    FM[:application]
+                  end
+
+        images = generate_photo_images(@processable, @unique_images)
+
+        app = factory.build do |b|
+          b.application_id = @application_id
+          b.customer_id = @customer_id if @customer_id
+          b.images = images
+          b.no_fee_application = true if @no_fee_application
+
+          if @eligible_for_photo_renew
+            b.data.driving_licence_actions[:renewLicence] = { reason: 'Photo Expiry' }
+          else
+            # update driverId static uuid if not eligible for TYR for use in next if statement
+            b.data.was_required_at_time_of_submission = false
+          end
+
+          # 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 @eligible_for_photo_renew
+                           Settings.test.driver_id.mandatory_tyr
+                         else
+                           Settings.test.driver_id.optional_cop
+                         end
+          end
+
+          if @processable && @driver_id
+            b.driver_id = @driver_id
+          elsif !@processable
+            b.product_id = @driver_id
+            b.product_key = @driver_id
+          end
+
+          if !@processable
+            b.data_schema = Settings.application.v1_schema
+            b.application_type = 'Photo Renewal'
+            b.product_type = @product_type
+          end
+
+          if @change_of_address || @free_key_address || !@eligible_for_photo_renew
+            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
+          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
+
+          if !@processable && !@payments.nil?
+            b.payments = @payments
+          end
+
+          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
+                               b.data.organ_donor = set_any_organs(any_organs_bool: @organ_donor)
+                             else
+                               b.data.organ_donor = {}
+                             end
+          elsif @processable && @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, 'TYRApplicationBuilder#build', 2025, 12)
+    end
+  end
+end

data/lib/dvla/application_helper/builders/V1/codl_application_builder.rb

@@ -0,0 +1,205 @@
+require_relative('../photo_signature_builder_mixin.rb')
+
+module DVLA
+  module Application
+    class CODLApplicationBuilder
+      # Including all properties and methods needed to support photos and signatures
+      include DVLA::Application::PhotoSignatureBuilderMixin
+
+      # Creates a new instance of the application builder
+      def initialize
+        @applicant = nil
+        @application_status = 'Preparing'
+        @customer_id = nil
+        @extend_application_deadline = false
+        @identity_confidence_level = 'MEDIUM'
+        @organ_donor = nil
+        @payments = nil
+        @processable = false
+        @phone_number = false
+        @unique_images = false
+        @update_reason = nil
+        init_photo_signature_properties
+      end
+
+      # Some builder methods are automatically included from PhotoSignatureBuilderMixin
+
+      # Marks the application as processable, doing this will ensure that real services are used to create the
+      # application. For example, the channel api will process the tasks rather than stub data being provided.
+      # Whilst this results in a more complete application, this option is more expensive.
+      # Avoid excessive use in QA tests.
+      # @return [ApplicationBuilder]
+      def processable
+        @processable = true
+        self
+      end
+
+      # Marks the application as non-processable. This will result in the application being created using the test application endpoint.
+      # These applications cannot be actioned via the task service.
+      # This is typically the default option to be used.
+      # @return [ApplicationBuilder]
+      def non_processable
+        @processable = false
+        self
+      end
+
+      def with_low_confidence_level
+        @identity_confidence_level = 'LOW'
+        self
+      end
+
+      # The application will contain the provided applicant data.
+      # @param applicant [ApplicantObject] Application data.
+      # @return [ApplicationBuilder]
+      def with_applicant(applicant)
+        @applicant = applicant
+        self
+      end
+
+      # The application will contain the provided payments.
+      # @param payments [PaymentObject] Payment status.
+      # @return [ApplicationBuilder]
+      def with_payments(payments)
+        @payments = payments
+        self
+      end
+
+      # The application will contain unique imageIds
+      # Allows images to be interacted with during test, e.g. deleted
+      def unique_images
+        @unique_images = true
+        self
+      end
+
+      # The application will contain a specific application status.
+      # How this state is reached will depend on if the application has been marked as processable or not.
+      # If processable is used here, we will also contain all actions.
+      # @param application_status [String] The application status the application should be in.
+      # @param update_reason [String] The reason for the change in status.
+      # @return [ApplicationBuilder]
+      def with_application_status(application_status, update_reason = nil)
+        @application_status = application_status
+        @update_reason = update_reason
+        self
+      end
+
+      # The application will be made for the given customer
+      # @param customer_id [String] The customer ID to use
+      # @return [ApplicationBuilder]
+      def with_customer_id(customer_id)
+        @customer_id = customer_id
+        self
+      end
+
+      # The application contains passport photo and signature to the applicant to be submitted. Disables user photo and user signature.
+      # @return [ApplicationBuilder]
+      def with_passport_images
+        @with_passport_images = true
+        self
+      end
+
+      def extend_application_deadline
+        @extend_application_deadline = true
+        self
+      end
+
+      # The application will contain a phone number.
+      # @return [ApplicationBuilder]
+      def has_phone_number
+        @phone_number = true
+        self
+      end
+
+      # Sets the organ donor status of the application.
+      # By default, a random selection is made.
+      # Passing true will cause all_organs to be selected.
+      # Passing false will ensure no organs are selected.
+      # @param donor [boolean] Organ donor status.
+      # @return [ApplicationBuilder]
+      def is_organ_donor(donor)
+        @organ_donor = donor
+        self
+      end
+
+      # Builds the Application base on the current criteria.
+      # @return [RetrieveApplicationResponse]
+      def build
+        # Sense check to ensure AWS credentials are present.
+        DVLA::Application.check_aws_credentials
+
+        factory = if @processable
+                    FM[:codl_processable_application]
+                  else
+                    FM[:codl_application]
+                  end
+
+        app = factory.build do |b|
+          b.customer_id = @customer_id if @customer_id
+
+          update_applicant!(b)
+          update_organ_donor!(b)
+
+          if !@processable && !@payments.nil?
+            b.payments = @payments
+          end
+
+          calculate_default_update_reason!
+
+          b.images = generate_photo_signature_images(@processable, @unique_images)
+        end
+
+        process_application_and_tasks(app)
+
+        extend_deadline(app) if @extend_application_deadline
+
+        DVLA::Application::ApplicationDomain.retrieve_application_by_app_id(application_id: app.application_id)
+      end
+
+    private
+
+      def calculate_default_update_reason!
+        if !@application_status.nil?
+          @update_reason = if @application_status == 'Cancelled'
+                             @update_reason || 'Timed out'
+                           else
+                             nil
+                           end
+        end
+      end
+
+      def update_applicant!(app)
+        app.data.applicant = @applicant if @applicant
+        app.data.applicant[:phoneNumber] = Faker::PhoneNumber.phone_number if @phone_number
+        app.data.applicant[:identityTokenData][:confidenceLevel] = @identity_confidence_level
+      end
+
+      def update_organ_donor!(app)
+        app.data.organ_donor = if @organ_donor
+                                 set_any_organs(any_organs_bool: @organ_donor)
+                               elsif @application_status == 'Rejected'
+                                 FM[:organ_donor_d90_response].build(attributes: { kidneys: true })
+                               elsif @application_status == 'Returned'
+                                 FM[:organ_donor_d90_response].build(attributes: { cornea: true })
+                               elsif @application_status == 'Unapproved'
+                                 FM[:organ_donor_d90_response].build(attributes: { heart: true })
+                               else
+                                 {}
+                               end
+      end
+
+      def process_application_and_tasks(app)
+        if @processable
+          process_photo_signature_tasks(app)
+        elsif !@processable && !@application_status.nil?
+          DVLA::Application::ApplicationStatusProcessor.process_to(app.application_id, @application_status, update_reason: @update_reason)
+        end
+      end
+
+      def extend_deadline(app)
+        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
+    end
+  end
+end