dvla-application_helper 5.1.5

data/scripts/seed_application.rb

@@ -0,0 +1,268 @@
+require './lib/dvla/application_helper.rb'
+require 'json'
+require 'bundler/setup'
+require 'rspec'
+include RSpec::Matchers
+Bundler.require
+
+def environment
+  ENV.fetch('ENVIRONMENT')
+end
+
+def is_dev_environment
+  environment.include?('dev')
+end
+
+DVLA::Application.config do |config|
+  config.environment = environment
+end
+
+DVLA::Customer::Helper.configure do |attr|
+  attr.environment = environment
+  attr.yaml_override_path = "./config/settings/#{environment}"
+end
+
+ARGUMENT_PREFIX = 'build_'.freeze
+
+def execute
+  options = extract_arguments
+  build_options = options[:build_options]
+  validate_options(build_options)
+  DVLA::Application.logger.info("Creating #{options[:type]} application in #{environment} with build options: #{build_options}")
+
+  builder = case options[:type]
+            when '', nil, 'uodl'
+              DVLA::Application::ApplicationBuilder.new
+            when 'uodl-v2'
+              DVLA::Application::UODLV2ApplicationBuilder.new
+            when 'cop'
+              DVLA::Application::COPV2ApplicationBuilder.new
+            when 'exc'
+              DVLA::Application::EXCV2ApplicationBuilder.new
+            when 'dup'
+              DVLA::Application::DUPV2ApplicationBuilder.new
+            when 'rep'
+              DVLA::Application::REPV2ApplicationBuilder.new
+            when 'codl'
+              DVLA::Application::CODLApplicationBuilder.new
+            when 'csudl'
+              DVLA::Application::CSUDLApplicationBuilder.new
+            when 'tyr-v3'
+              DVLA::Application::TYRV3ApplicationBuilder.new
+            when 'cop-v3'
+              DVLA::Application::COPV3ApplicationBuilder.new
+            when 'exc-v3'
+              DVLA::Application::EXCV3ApplicationBuilder.new
+            when 'dup-v3'
+              DVLA::Application::DUPV3ApplicationBuilder.new
+            when 'rep-v3'
+              DVLA::Application::REPV3ApplicationBuilder.new
+            else
+              raise "Invalid '#{options[:type]}' application type"
+            end
+
+  apply_build_options!(builder, build_options)
+
+  app = if is_dev_environment
+          create_app_dev(builder)
+        else
+          create_app_link(builder)
+        end
+  DVLA::Application.logger.info("customerID = #{app.customer_id.inspect.green}")
+  DVLA::Application.logger.info("applicationID = #{app.application_id.green}")
+end
+
+def validate_options(build_options)
+  is_non_processable = build_options.has_key?(:non_processable) || !build_options.has_key?(:processable)
+  if is_non_processable && !is_dev_environment
+    raise 'Non processable applications should be created just in a dev environment'
+  end
+
+  forbidden_build_options_in_link = %i[with_customer_id with_driver_id with_applicant]
+  using_forbidden_option = forbidden_build_options_in_link.any? { |forbidden| build_options.has_key?(forbidden) }
+  if !is_dev_environment && using_forbidden_option
+    raise 'Specified build option is forbidden for use in Link'
+  end
+end
+
+# Extracts the environment variables starting with "build_" as options for seeding application
+# "build_type" is the application type to build
+# All the remaining env variables are transformed to build options, e.g. "build_processable" will set the processable build option
+def extract_arguments
+  arguments = ENV.select { |var| var.start_with?(ARGUMENT_PREFIX) }
+  arguments.transform_keys! { |var_name| var_name.delete_prefix(ARGUMENT_PREFIX) }.transform_keys!(&:to_sym)
+  build_options = arguments.reject { |arg| arg == :type }.transform_values { |val| parse_build_option_values(val) }
+  {
+    type: arguments[:type],
+    build_options:,
+  }
+end
+
+# Parses the values of the build options
+#   An empty string or a dash will be `nil` and will result in a build option with no parameters
+#   A string of ":val" will be transformed to a normal symbol `:val`
+#   If the string is a valid json it is parsed as so
+#   Otherwise any other value is kept as a normal string
+def parse_build_option_values(option_value)
+  return nil if ['', '-'].include?(option_value)
+  return [option_value.slice(1..-1).to_sym] if option_value.start_with?(':')
+
+  parsed_option_values = option_value
+  begin
+    parsed_option_values = JSON.parse(option_value)
+  rescue JSON::ParserError, TypeError
+    # When JSON parsing fails we treat value as a normal string
+  end
+
+  [parsed_option_values]
+end
+
+# Calls a method of the builder for each build_option specified, passing the relevant parameter
+def apply_build_options!(builder, build_options)
+  build_options.each_pair do |build_option, option_params|
+    unless builder.respond_to?(build_option)
+      DVLA::Application.logger.error("Build option '#{build_option}' is not valid for the specified application type")
+      raise "Invalid '#{build_option}' build option"
+    end
+    if option_params.nil?
+      builder.send build_option
+    else
+      builder.send build_option, *option_params
+    end
+  end
+  builder
+end
+
+# create an application in the dev space
+#   takes the builder specified by the script invocation
+def create_app_dev(builder)
+  app = builder.build
+  generate_customer_using_application_data_hash(app.to_hash) if app.to_hash.has_key?(:customer_id)
+  app
+end
+
+# create an application in the link space
+#   takes the builder specified by the script invocation
+def create_app_link(builder)
+  customer_info = if paper_licence_application(builder)
+                    seed_driver_with_paper
+                  else
+                    seed_driver
+                  end
+
+  applicant = DVLA::Application::PersonFactory.new.build_person_using_identity(customer_info[:identity]).to_applicant
+
+  if builder.instance_of?(DVLA::Application::CODLApplicationBuilder)
+    builder
+      .with_customer_id(customer_info[:customer_id])
+      .with_applicant(applicant)
+      .build
+  else
+    builder
+      .with_customer_id(customer_info[:customer_id])
+      .with_driver_id(customer_info[:driver_id])
+      .with_applicant(applicant)
+      .build
+  end
+end
+
+# seed a driver based on the DriverRecord model in Customer Account
+def seed_driver
+  driver_record = DVLA::Customer::Helper::Models::DriverRecord.new
+  response = DVLA::Customer::Helper::Seeders::Driver.seed_driver_with_customer_account(driver_record:)
+  {
+    customer_id: response[:customer_id],
+    driver_id: driver_record.record[:driverId],
+    identity: response[:driver_record].identity,
+  }
+end
+
+# seed a paper-based driver based on the DriverRecord model in Customer Account
+def seed_driver_with_paper
+  driver_record = DVLA::Customer::Helper::Models::DriverRecord.new(identity: create_paper_identity)
+  response = DVLA::Customer::Helper::Seeders::Driver.seed_customer_with_paper_licence(driver_record:)
+  {
+    customer_id: response[:customer_id],
+    driver_id: driver_record.record[:driverId],
+    identity: response[:driver_record].identity,
+  }
+end
+
+# create a valid identity that can be used for a paper-based customer
+def create_paper_identity
+  identity = DVLA::Poirot.create_identity_builder
+                         .younger_than(years: 69)
+                         .older_than(years: 28)
+                         .experian_pass
+                         .alive
+                         .gbr_citizen
+                         .dwp_pass
+                         .hmpo_pass
+                         .home_office_pass
+                         .has_valid_photo
+                         .has_valid_signature
+                         .domestic_gb_address
+                         .country_of_birth(%w(England Wales Scotland).sample)
+
+  built = identity.build
+  begin
+    built.save
+  rescue StandardError => e
+    puts "Failed to save poirot record: #{e}".red
+    raise e
+  end
+  built
+end
+
+def generate_customer_using_application_data_hash(application, with_account_deleted: false)
+  customer_id = application[:customerId]
+
+  retrieve_customer_request = {
+    customerId: customer_id,
+  }
+
+  begin
+    retrieve_customer_response = DVLA::Customer::Helper::Service::CustomerDomain.retrieve_customer(request: retrieve_customer_request)
+    existing_customer = retrieve_customer_response.body if retrieve_customer_response.code == 200
+  rescue StandardError
+    # Catching 404 errors, the existing_customer variable will be nil
+  end
+
+  unless existing_customer.nil?
+    DVLA::Application.logger.info("Customer with id '#{customer_id.green}' already exists")
+    return
+  end
+
+  create_customer_request = {
+    customerId: customer_id,
+    emailAddress: application[:data][:applicant][:emailAddress],
+    identityId: SecureRandom.uuid,
+    lastName: application[:data][:applicant][:lastName],
+    dateOfBirth: application[:data][:applicant][:dateOfBirth],
+    address: application[:data][:applicant][:address],
+    contactPreferences: [
+      {
+        contactType: 'Default',
+        contactPreference: 'Email',
+        consentDate: '2021-01-01',
+      },
+    ],
+  }
+  if with_account_deleted
+    create_customer_request.delete(:emailAddress)
+    create_customer_request.delete(:identityId)
+  end
+
+  DVLA::Customer::Helper::Service::CustomerDomain.create_customer(request: create_customer_request)
+end
+
+def paper_licence_application(builder)
+  builder.instance_of?(DVLA::Application::EXCV2ApplicationBuilder) ||
+    (builder.instance_of?(DVLA::Application::REPV2ApplicationBuilder) && builder.get_eligible_paper_to_plastic == true) ||
+    (builder.instance_of?(DVLA::Application::DUPV2ApplicationBuilder) && builder.get_eligible_paper_to_plastic == true) ||
+    builder.instance_of?(DVLA::Application::EXCV3ApplicationBuilder) ||
+    (builder.instance_of?(DVLA::Application::REPV3ApplicationBuilder) && builder.get_eligible_paper_to_plastic == true) ||
+    (builder.instance_of?(DVLA::Application::DUPV3ApplicationBuilder) && builder.get_eligible_paper_to_plastic == true)
+end
+
+execute

data/sonar-project.properties

@@ -0,0 +1,4 @@
+sonar.projectBaseDir=./
+sonar.ruby.coverage.reportPaths=coverage/coverage.json
+sonar.sources=lib
+sonar.tests=spec

metadata

@@ -0,0 +1,343 @@
+--- !ruby/object:Gem::Specification
+name: dvla-application_helper
+version: !ruby/object:Gem::Version
+  version: 5.1.5
+platform: ruby
+authors:
+- Paul Lewis
+- David Sambucci
+- Shaun Beynon-Thomas
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-states
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.64'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.64'
+- !ruby/object:Gem::Dependency
+  name: block_repeater
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: dvla-application-diary-openapi-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: dvla-application-domain-openapi-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: dvla-application-process-engine-openapi-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: dvla-aws
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: dvla-driving-licence-channel-api-openapi-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: dvla-herodotus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: dvla-poirot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: faker_maker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: httpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Generates fake application data that can be used in testing
+email:
+- pauldavid.lewis@dvla.gov.uk
+- david.sambucci.contractor@dvla.gov.uk
+- shaun.beynon-thomas.contractor@dvla.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".drone.yml"
+- ".env.template"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- README.md
+- Rakefile
+- config/settings.yml
+- config/settings/drone-dev.yml
+- config/settings/drone-ext.yml
+- config/settings/drone-link.yml
+- config/settings/drone-perf.yml
+- config/settings/local-dev.yml
+- config/settings/local-ext.yml
+- config/settings/local-link.yml
+- config/settings/local-perf.yml
+- config/yarp.yml
+- functional-tests/Rakefile
+- functional-tests/chutney.yml
+- functional-tests/features/codl.feature
+- functional-tests/features/codl_image_review_states.feature
+- functional-tests/features/csudl.feature
+- functional-tests/features/csudl_image_review_states.feature
+- functional-tests/features/step_definitions/app_domain_steps.rb
+- functional-tests/features/step_definitions/application_creation_steps.rb
+- functional-tests/features/step_definitions/image_steps.rb
+- functional-tests/features/step_definitions/state_machine_steps.rb
+- functional-tests/features/support/data/artefacts.rb
+- functional-tests/features/support/data/image_helpers.rb
+- functional-tests/features/support/data/schema_helpers.rb
+- functional-tests/features/support/data/string_manipulation.rb
+- functional-tests/features/support/env.rb
+- functional-tests/features/support/hooks.rb
+- functional-tests/features/support/yarp_integration/yarp_helpers.rb
+- functional-tests/features/uodl_image_review_states.feature
+- functional-tests/features/uodl_non_processable.feature
+- functional-tests/features/uodl_processable.feature
+- lib/dvla/application_helper.rb
+- lib/dvla/application_helper/builders/V1/application_builder.rb
+- lib/dvla/application_helper/builders/V1/codl_application_builder.rb
+- lib/dvla/application_helper/builders/V1/csudl_application_builder.rb
+- lib/dvla/application_helper/builders/V2/base_uodl_v2_application_builder.rb
+- lib/dvla/application_helper/builders/V2/cop_v2_application_builder.rb
+- lib/dvla/application_helper/builders/V2/dup_v2_application_builder.rb
+- lib/dvla/application_helper/builders/V2/exc_v2_application_builder.rb
+- lib/dvla/application_helper/builders/V2/rep_v2_application_builder.rb
+- lib/dvla/application_helper/builders/V2/tyr_v2_application_builder.rb
+- lib/dvla/application_helper/builders/V2/uodl_v2_application_builder.rb
+- lib/dvla/application_helper/builders/V3/base_uodl_v3_application_builder.rb
+- lib/dvla/application_helper/builders/V3/cop_v3_application_builder.rb
+- lib/dvla/application_helper/builders/V3/dup_v3_application_builder.rb
+- lib/dvla/application_helper/builders/V3/exc_v3_application_builder.rb
+- lib/dvla/application_helper/builders/V3/rep_v3_application_builder.rb
+- lib/dvla/application_helper/builders/V3/tyr_v3_application_builder.rb
+- lib/dvla/application_helper/builders/dup_rep_builder_mixin.rb
+- lib/dvla/application_helper/builders/photo_builder_mixin.rb
+- lib/dvla/application_helper/builders/photo_signature_builder_mixin.rb
+- lib/dvla/application_helper/configuration.rb
+- lib/dvla/application_helper/constants.rb
+- lib/dvla/application_helper/enums/review_state.rb
+- lib/dvla/application_helper/enums/unable_to_prove_licence_possession_reasons.rb
+- lib/dvla/application_helper/factories/address.rb
+- lib/dvla/application_helper/factories/application_details.rb
+- lib/dvla/application_helper/factories/casework.rb
+- lib/dvla/application_helper/factories/csudl_photo_signature_image.rb
+- lib/dvla/application_helper/factories/csudl_photo_signature_images.rb
+- lib/dvla/application_helper/factories/organ_donor.rb
+- lib/dvla/application_helper/factories/person.rb
+- lib/dvla/application_helper/factories/photo_image.rb
+- lib/dvla/application_helper/factories/photo_images.rb
+- lib/dvla/application_helper/factories/photo_signature_image.rb
+- lib/dvla/application_helper/factories/photo_signature_images.rb
+- lib/dvla/application_helper/fixtures/photo/comparison_image.jpeg
+- lib/dvla/application_helper/fixtures/photo/passport_image.jpg
+- lib/dvla/application_helper/fixtures/photo/photocard_back.jpg
+- lib/dvla/application_helper/fixtures/photo/photocard_front.jpg
+- lib/dvla/application_helper/fixtures/photo/rejected_user_uploaded_image.jpeg
+- lib/dvla/application_helper/fixtures/photo/user_uploaded_image.jpg
+- lib/dvla/application_helper/fixtures/signature/csudl_signature_image.tiff
+- lib/dvla/application_helper/fixtures/signature/passport_image.jpg
+- lib/dvla/application_helper/fixtures/signature/rejected_user_uploaded_image.jpg
+- lib/dvla/application_helper/fixtures/signature/user_uploaded_image.jpg
+- lib/dvla/application_helper/processors/application_status.rb
+- lib/dvla/application_helper/processors/application_task.rb
+- lib/dvla/application_helper/services/application_diary.rb
+- lib/dvla/application_helper/services/application_domain.rb
+- lib/dvla/application_helper/services/application_process_engine.rb
+- lib/dvla/application_helper/services/check_aws_credentials.rb
+- lib/dvla/application_helper/services/driving_licence_channel_api.rb
+- lib/dvla/application_helper/services/image_service.rb
+- lib/dvla/application_helper/services/image_utility.rb
+- lib/dvla/application_helper/services/state_machine_helpers.rb
+- lib/dvla/application_helper/version.rb
+- renovate.json
+- scripts/application-login.sh
+- scripts/drone-aws-login.sh
+- scripts/seed_application.rb
+- sonar-project.properties
+homepage: https://www.dvla.gov.uk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.dvla.gov.uk
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Gem to generate and submit application data
+test_files: []