|
| 1 | +package com.ps.person.api.domain.model |
| 2 | + |
| 3 | +import java.util.* |
| 4 | + |
| 5 | +/** |
| 6 | + * Constants for banking validation |
| 7 | + */ |
| 8 | +private object BankingValidationConstants { |
| 9 | + // Modulo validation constants |
| 10 | + const val MODULO_DIVISOR = 97 |
| 11 | + const val MODULO_EXPECTED_REMAINDER = 1 |
| 12 | + const val SMALL_DIGIT_FACTOR = 10 |
| 13 | + const val LARGE_DIGIT_FACTOR = 100 |
| 14 | + const val SMALL_DIGIT_THRESHOLD = 10 |
| 15 | + const val BASE_36 = 36 |
| 16 | + |
| 17 | + // IBAN validation constants |
| 18 | + const val IBAN_MIN_LENGTH = 15 |
| 19 | + const val IBAN_MAX_LENGTH = 34 |
| 20 | + const val IBAN_COUNTRY_CODE_LENGTH = 2 |
| 21 | + const val IBAN_MIN_REMAINING_CHARS = 13 |
| 22 | + const val IBAN_MAX_REMAINING_CHARS = 32 |
| 23 | + const val IBAN_PREFIX_LENGTH = 4 |
| 24 | + const val IBAN_CHUNK_SIZE = 4 |
| 25 | + |
| 26 | + // BIC validation constants |
| 27 | + const val BIC_LENGTH_SHORT = 8 |
| 28 | + const val BIC_LENGTH_LONG = 11 |
| 29 | + const val BIC_BANK_CODE_LENGTH = 4 |
| 30 | + const val BIC_COUNTRY_CODE_LENGTH = 2 |
| 31 | + const val BIC_LOCATION_CODE_LENGTH = 2 |
| 32 | + const val BIC_BRANCH_CODE_LENGTH = 3 |
| 33 | +} |
| 34 | + |
| 35 | +data class BankingInfo( |
| 36 | + val id: BankingInfoId, |
| 37 | + val accountType: AccountType, |
| 38 | + val iban: IBAN? = null, |
| 39 | + val bic: BIC? = null, |
| 40 | +) { |
| 41 | + init { |
| 42 | + // Ensure that appropriate fields are provided based on account type |
| 43 | + when (accountType) { |
| 44 | + AccountType.IBAN -> require(iban != null) { "IBAN must be provided for IBAN account type" } |
| 45 | + } |
| 46 | + } |
| 47 | + |
| 48 | + companion object { |
| 49 | + @Factory |
| 50 | + fun createWithIBAN(iban: IBAN, bic: BIC? = null): Result<BankingInfo> = runCatching { |
| 51 | + BankingInfo( |
| 52 | + id = BankingInfoId(UUID.randomUUID()), |
| 53 | + accountType = AccountType.IBAN, |
| 54 | + iban = iban, |
| 55 | + bic = bic, |
| 56 | + ) |
| 57 | + } |
| 58 | + } |
| 59 | +} |
| 60 | + |
| 61 | +@JvmInline |
| 62 | +value class BankingInfoId(val value: UUID) { |
| 63 | + override fun toString(): String = value.toString() |
| 64 | +} |
| 65 | + |
| 66 | +enum class AccountType { |
| 67 | + IBAN, |
| 68 | +} |
| 69 | + |
| 70 | +/** |
| 71 | + * Value object for International Bank Account Number (IBAN) |
| 72 | + * Enforces validation rules for IBAN format |
| 73 | + */ |
| 74 | +@JvmInline |
| 75 | +value class IBAN private constructor(val value: String) { |
| 76 | + companion object { |
| 77 | + @Factory |
| 78 | + fun create(value: String): Result<IBAN> = runCatching { |
| 79 | + require(value.isNotBlank()) { "IBAN cannot be blank" } |
| 80 | + |
| 81 | + // Remove spaces for validation |
| 82 | + val normalizedValue = value.replace(" ", "") |
| 83 | + |
| 84 | + // Basic format validation (more comprehensive validation could be added) |
| 85 | + require( |
| 86 | + normalizedValue.length >= BankingValidationConstants.IBAN_MIN_LENGTH && |
| 87 | + normalizedValue.length <= BankingValidationConstants.IBAN_MAX_LENGTH, |
| 88 | + ) { |
| 89 | + "IBAN must be between ${BankingValidationConstants.IBAN_MIN_LENGTH} and ${BankingValidationConstants.IBAN_MAX_LENGTH} characters" |
| 90 | + } |
| 91 | + require( |
| 92 | + normalizedValue.matches( |
| 93 | + Regex( |
| 94 | + "^[A-Z]{${BankingValidationConstants.IBAN_COUNTRY_CODE_LENGTH}}" + |
| 95 | + "[0-9A-Z]{${BankingValidationConstants.IBAN_MIN_REMAINING_CHARS},${BankingValidationConstants.IBAN_MAX_REMAINING_CHARS}}$", |
| 96 | + ), |
| 97 | + ), |
| 98 | + ) { |
| 99 | + "IBAN must start with ${BankingValidationConstants.IBAN_COUNTRY_CODE_LENGTH} letters followed by " + |
| 100 | + "${BankingValidationConstants.IBAN_MIN_REMAINING_CHARS}-${BankingValidationConstants.IBAN_MAX_REMAINING_CHARS} alphanumeric characters" |
| 101 | + } |
| 102 | + |
| 103 | + val bban = normalizedValue.substring(BankingValidationConstants.IBAN_PREFIX_LENGTH) + |
| 104 | + normalizedValue.substring(0, BankingValidationConstants.IBAN_PREFIX_LENGTH) |
| 105 | + val result = bban.validateModulo97() |
| 106 | + |
| 107 | + require(result) { "Invalid IBAN" } |
| 108 | + |
| 109 | + IBAN(normalizedValue) |
| 110 | + } |
| 111 | + } |
| 112 | + |
| 113 | + /** |
| 114 | + * Returns formatted IBAN with spaces for readability |
| 115 | + */ |
| 116 | + fun formatted(): String { |
| 117 | + return value.chunked(BankingValidationConstants.IBAN_CHUNK_SIZE).joinToString(" ") |
| 118 | + } |
| 119 | + |
| 120 | + override fun toString(): String = value |
| 121 | +} |
| 122 | + |
| 123 | +/** |
| 124 | + * Value object for Bank Identifier Code (BIC/SWIFT) |
| 125 | + * Enforces validation rules for BIC format |
| 126 | + */ |
| 127 | +@JvmInline |
| 128 | +value class BIC private constructor(val value: String) { |
| 129 | + companion object { |
| 130 | + @Factory |
| 131 | + fun create(value: String): Result<BIC> = runCatching { |
| 132 | + require(value.isNotBlank()) { "BIC cannot be blank" } |
| 133 | + |
| 134 | + // Remove spaces for validation |
| 135 | + val normalizedValue = value.replace(" ", "") |
| 136 | + |
| 137 | + // BIC format validation |
| 138 | + require( |
| 139 | + normalizedValue.length == BankingValidationConstants.BIC_LENGTH_SHORT || |
| 140 | + normalizedValue.length == BankingValidationConstants.BIC_LENGTH_LONG, |
| 141 | + ) { |
| 142 | + "BIC must be either ${BankingValidationConstants.BIC_LENGTH_SHORT} or ${BankingValidationConstants.BIC_LENGTH_LONG} characters" |
| 143 | + } |
| 144 | + require( |
| 145 | + normalizedValue.matches( |
| 146 | + Regex( |
| 147 | + "^[A-Z]{${BankingValidationConstants.BIC_BANK_CODE_LENGTH}}" + |
| 148 | + "[A-Z]{${BankingValidationConstants.BIC_COUNTRY_CODE_LENGTH}}" + |
| 149 | + "[A-Z0-9]{${BankingValidationConstants.BIC_LOCATION_CODE_LENGTH}}" + |
| 150 | + "([A-Z0-9]{${BankingValidationConstants.BIC_BRANCH_CODE_LENGTH}})?$", |
| 151 | + ), |
| 152 | + ), |
| 153 | + ) { |
| 154 | + "BIC must follow the pattern: ${BankingValidationConstants.BIC_BANK_CODE_LENGTH} letters (bank code) + " + |
| 155 | + "${BankingValidationConstants.BIC_COUNTRY_CODE_LENGTH} letters (country code) + " + |
| 156 | + "${BankingValidationConstants.BIC_LOCATION_CODE_LENGTH} alphanumeric (location code) + " + |
| 157 | + "optional ${BankingValidationConstants.BIC_BRANCH_CODE_LENGTH} alphanumeric (branch code)" |
| 158 | + } |
| 159 | + |
| 160 | + BIC(normalizedValue) |
| 161 | + } |
| 162 | + } |
| 163 | + |
| 164 | + override fun toString(): String = value |
| 165 | +} |
| 166 | + |
| 167 | +/** |
| 168 | + * Extension function to validate a string using modulo 97 check. |
| 169 | + * The algorithm converts the alphanumeric string to a numeric value and checks if it's divisible by 97. |
| 170 | + * @return true if the string passes the modulo 97 check, false otherwise |
| 171 | + */ |
| 172 | +private fun String.validateModulo97(): Boolean { |
| 173 | + return this.toCharArray() |
| 174 | + .map { it.code } |
| 175 | + .fold(0) { previousMod: Int, char: Int -> |
| 176 | + val value = Integer.parseInt(char.toChar().toString(), BankingValidationConstants.BASE_36) |
| 177 | + val factor = if (value < BankingValidationConstants.SMALL_DIGIT_THRESHOLD) { |
| 178 | + BankingValidationConstants.SMALL_DIGIT_FACTOR |
| 179 | + } else { |
| 180 | + BankingValidationConstants.LARGE_DIGIT_FACTOR |
| 181 | + } |
| 182 | + (factor * previousMod + value) % BankingValidationConstants.MODULO_DIVISOR |
| 183 | + } == BankingValidationConstants.MODULO_EXPECTED_REMAINDER |
| 184 | +} |
0 commit comments