dscf-banking 0.5.3 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0086738f163c88e967b2850c3b0c2e29804725e059996dd2edfd152a98c874b5'
-  data.tar.gz: 2bc163e912db1cb78a491610f88efc8d99f8455f034ed90f64031628bce1375c
+  metadata.gz: e91b4944ed5da04e89193cc1e06db5150ea053f3f4cd4a8098a576f25585c8c9
+  data.tar.gz: 0c1ef04c3785327d68b9d87d6a62ad228329a9fde73e68b6893253614b31284a
 SHA512:
-  metadata.gz: 970cd3f5b838bcd3a5c74a9b2511569cd4ec7eeb7ecf28d90e32d9efda437707214514088d562a2e35bff1a43f7dc8b89a5abff66c56071a5ff3f2e2f3abc832
-  data.tar.gz: 29f3c5f3299b0b1dc1da0cfb11594f22a0c2970865482701097bd0492552165a90a76817b8acef394f63e4de15a5758571635236edd482f633ed700117af684f
+  metadata.gz: a9f07e8d19d474514261bb9189ed89b804525f34839b3ea55704861647a37aa69b840a5ad995b4d3e53c5d6d89237384db92f262173a5021f312257d3abd392e
+  data.tar.gz: af083b3874ca0b5e8161125409ed7c06974b8ccf3404f615d0e044bfe434e66022e4f691e6450f7f63a5cd5e15b49061151f4fa27c28ba0acb83aceb330c0a70

data/app/models/dscf/banking/interest_configuration.rb

@@ -4,16 +4,21 @@ module Dscf::Banking
     belongs_to :virtual_account_product, class_name: "Dscf::Banking::VirtualAccountProduct"
     has_many :interest_rate_tiers, class_name: "Dscf::Banking::InterestRateTier", dependent: :destroy
 
-    validates :annual_interest_rate, presence: true, numericality: { greater_than: 0, less_than_or_equal_to: 1 }
-    validates :income_tax_rate, presence: true, numericality: { greater_than_or_equal_to: 0, less_than_or_equal_to: 1 }
-    validates :minimum_balance_for_interest, presence: true, numericality: { greater_than_or_equal_to: 0 }
-    validates :calculation_method, presence: true
-
-    validates :interest_basis, presence: true
-    validates :accrual_frequency, presence: true
-    validates :rounding_rule, presence: true
-    validates :calculation_timing, presence: true
-    validates :is_active, inclusion: { in: [ true, false ] }
+    before_validation :normalize_rate_attributes
+    validate :interest_free_configuration_guidance
+
+    with_options unless: :interest_free_configuration_request? do
+      validates :annual_interest_rate, presence: true, numericality: { greater_than: 0, less_than_or_equal_to: 1 }
+      validates :income_tax_rate, presence: true, numericality: { greater_than_or_equal_to: 0, less_than_or_equal_to: 1 }
+      validates :minimum_balance_for_interest, presence: true, numericality: { greater_than_or_equal_to: 0 }
+      validates :calculation_method, presence: true
+
+      validates :interest_basis, presence: true
+      validates :accrual_frequency, presence: true
+      validates :rounding_rule, presence: true
+      validates :calculation_timing, presence: true
+      validates :is_active, inclusion: { in: [ true, false ] }
+    end
     validate :promotional_dates_consistency
 
     enum :calculation_method, {
@@ -59,6 +64,49 @@ module Dscf::Banking
 
     private
 
+    def interest_free_configuration_guidance
+      return unless no_interest_requested?
+      return unless required_calculation_fields_missing?
+
+      errors.add(
+        :base,
+        "Interest-free products should not have an interest configuration. Skip interest configuration creation for interest-free products."
+      )
+    end
+
+    def interest_free_configuration_request?
+      no_interest_requested? && required_calculation_fields_missing?
+    end
+
+    def normalize_rate_attributes
+      self.annual_interest_rate = normalize_rate_value(annual_interest_rate_before_type_cast)
+      self.income_tax_rate = normalize_rate_value(income_tax_rate_before_type_cast)
+    end
+
+    def normalize_rate_value(value)
+      return value if value.blank?
+
+      sanitized = value.to_s.strip
+      return value if sanitized.blank?
+
+      percentage_input = sanitized.end_with?("%")
+      decimal = BigDecimal(sanitized.delete("%").tr(",", "."))
+
+      percentage_input || decimal > 1 ? decimal / 100 : decimal
+    rescue ArgumentError
+      value
+    end
+
+    def no_interest_requested?
+      annual_interest_rate.blank? || BigDecimal(annual_interest_rate.to_s) <= 0
+    rescue ArgumentError
+      false
+    end
+
+    def required_calculation_fields_missing?
+      calculation_method.blank? || interest_basis.blank? || accrual_frequency.blank? || rounding_rule.blank? || calculation_timing.blank?
+    end
+
     def promotional_dates_consistency
       return unless promotional_start_date.present? || promotional_end_date.present?
 

data/app/services/dscf/banking/interest_simulation_service.rb

@@ -3,9 +3,8 @@ require "date"
 
 module Dscf::Banking
   class InterestSimulationService
-    DEFAULT_ANNUAL_INTEREST_RATE = BigDecimal("0.05")
-    # Fallback tax rate when no product-level tax is configured.
-    DEFAULT_TAX_RATE = BigDecimal("0.15")
+    NO_INTEREST_RATE = BigDecimal("0")
+    NO_TAX_RATE = BigDecimal("0")
 
     def initialize(account:, initial_balance:, start_date:, end_date:, transactions: [])
       @account = account
@@ -72,17 +71,23 @@ module Dscf::Banking
     end
 
     def annual_interest_rate
+      return NO_INTEREST_RATE unless interest_configuration
+
       configured = interest_configuration&.annual_interest_rate
-      configured.present? ? decimal(configured) : DEFAULT_ANNUAL_INTEREST_RATE
+      configured.present? ? decimal(configured) : NO_INTEREST_RATE
     end
 
     def annual_interest_rate_for(balance)
+      return annual_interest_rate unless interest_configuration
+
       interest_rate_tier_for(balance)&.yield_self { |tier| decimal(tier.interest_rate) } || annual_interest_rate
     end
 
     def tax_rate
+      return NO_TAX_RATE unless interest_configuration
+
       configured = interest_configuration&.income_tax_rate
-      configured.present? ? decimal(configured) : DEFAULT_TAX_RATE
+      configured.present? ? decimal(configured) : NO_TAX_RATE
     end
 
     def day_basis

data/db/seeds.rb

@@ -1,115 +1,225 @@
-# db/seeds.rb
-# This file should contain all the record creation needed to seed the database with its default values.
-# The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup).
-#
-# Examples:
-#
-#   movies = Movie.create([{ name: "Star Wars" }, { name: "Lord of the Rings" }])
-#   Character.create(name: "Luke", movie: movies.first)
-
-# Seed roles based on RBAC documentation
-puts "Seeding roles..."
-user_role = Dscf::Core::Role.find_or_create_by(name: "User")
-officer_role = Dscf::Core::Role.find_or_create_by(name: "Virtual Account Officer")
-manager_role = Dscf::Core::Role.find_or_create_by(name: "Virtual Account Manager")
-kyc_officer_role = Dscf::Core::Role.find_or_create_by(name: "KYC Officer")
-branch_manager_role = Dscf::Core::Role.find_or_create_by(name: "Branch Manager")
-puts "Roles seeded successfully."
-
-# Seed users with roles
-puts "Seeding users..."
-# Create users and assign roles
-user1 = Dscf::Core::User.create(name: "Abebe Kebede", email: "abebe@example.com", password: "SecurePassword123!")
-user1.roles << user_role
-puts "Created user: #{user1.name}"
-
-user2 = Dscf::Core::User.create(name: "Tigist Haile", email: "tigist@example.com", password: "SecurePassword123!")
-user2.roles << officer_role
-puts "Created user: #{user2.name}"
-
-user3 = Dscf::Core::User.create(name: "Dawit Mekonnen", email: "dawit@example.com", password: "SecurePassword123!")
-user3.roles << manager_role
-puts "Created user: #{user3.name}"
-
-# Additional users for testing
-user4 = Dscf::Core::User.create(name: "Hirut Assefa", email: "hirut@example.com", password: "SecurePassword123!")
-user4.roles << [ user_role, officer_role ]  # User with multiple roles if supported
-puts "Created user: #{user4.name}"
-
-user5 = Dscf::Core::User.create(name: "Solomon Tesfaye", email: "solomon@example.com", password: "SecurePassword123!")
-user5.roles << manager_role
-puts "Created user: #{user5.name}"
-
-user6 = Dscf::Core::User.create(name: "Mulugeta Bekele", email: "mulugeta@example.com", password: "SecurePassword123!")
-user6.roles << kyc_officer_role
-puts "Created user: #{user6.name}"
-
-user7 = Dscf::Core::User.create(name: "Fikirte Alemayehu", email: "fikirte@example.com", password: "SecurePassword123!")
-user7.roles << branch_manager_role
-puts "Created user: #{user7.name}"
+# This file should contain all the record creation needed to seed the banking engine
+# with deterministic, idempotent sample data.
+
+puts "Seeding DSCF Banking data..."
+
+seed_timestamp = Time.current
+
+roles_data = [
+  { code: "USER", name: "User" },
+  { code: "ADMIN", name: "Administrator" },
+  { code: "KYC_OFFICER", name: "KYC Officer" },
+  { code: "BRANCH_MANAGER", name: "Branch Manager" },
+  { code: "VIRTUAL_ACCOUNT_OFFICER", name: "Virtual Account Officer" },
+  { code: "VIRTUAL_ACCOUNT_MANAGER", name: "Virtual Account Manager" },
+  { code: "REGULAR_USER", name: "Regular User" }
+].freeze
+
+users_data = [
+  { email: "admin@dscf.com", phone: "+251911000001", roles: %w[ADMIN], password: "password123" },
+  { email: "kyc1@dscf.com", phone: "+251911000002", roles: %w[KYC_OFFICER], password: "password123" },
+  { email: "kyc2@dscf.com", phone: "+251911000003", roles: %w[KYC_OFFICER], password: "password123" },
+  { email: "kyc3@dscf.com", phone: "+251911000004", roles: %w[KYC_OFFICER], password: "password123" },
+  { email: "manager1@dscf.com", phone: "+251911000005", roles: %w[BRANCH_MANAGER], password: "password123" },
+  { email: "manager2@dscf.com", phone: "+251911000006", roles: %w[BRANCH_MANAGER], password: "password123" },
+  { email: "va_officer1@dscf.com", phone: "+251911000007", roles: %w[VIRTUAL_ACCOUNT_OFFICER], password: "password123" },
+  { email: "va_officer2@dscf.com", phone: "+251911000008", roles: %w[VIRTUAL_ACCOUNT_OFFICER], password: "password123" },
+  { email: "va_manager1@dscf.com", phone: "+251911000009", roles: %w[VIRTUAL_ACCOUNT_MANAGER], password: "password123" },
+  { email: "va_manager2@dscf.com", phone: "+251911000010", roles: %w[VIRTUAL_ACCOUNT_MANAGER], password: "password123" },
+  { email: "user1@example.com", phone: "+251911000011", roles: %w[USER REGULAR_USER], password: "password123" },
+  { email: "user2@example.com", phone: "+251911000012", roles: %w[USER REGULAR_USER], password: "password123" },
+  { email: "user3@example.com", phone: "+251911000013", roles: %w[USER REGULAR_USER], password: "password123" },
+  { email: "user4@example.com", phone: "+251911000014", roles: %w[USER REGULAR_USER], password: "password123" },
+  { email: "user5@example.com", phone: "+251911000015", roles: %w[USER REGULAR_USER], password: "password123" },
+  { email: "user6@example.com", phone: "+251911000016", roles: %w[USER REGULAR_USER], password: "password123" },
+  { email: "user7@example.com", phone: "+251911000017", roles: %w[USER REGULAR_USER], password: "password123" },
+  { email: "user8@example.com", phone: "+251911000018", roles: %w[USER REGULAR_USER], password: "password123" },
+  { email: "user9@example.com", phone: "+251911000019", roles: %w[USER REGULAR_USER], password: "password123" },
+  { email: "user10@example.com", phone: "+251911000020", roles: %w[USER REGULAR_USER], password: "password123" }
+].freeze
+
+transaction_types_data = [
+  { code: "DEPOSIT", name: "Deposit", description: "Deposit transaction - money coming into account" },
+  { code: "WITHDRAWAL", name: "Withdrawal", description: "Withdrawal transaction - money going out of account" },
+  { code: "TRANSFER", name: "Transfer", description: "Transfer transaction - money moving between accounts" },
+  { code: "VOUCHER", name: "Voucher", description: "Voucher issuance and redemption transactions" }
+].freeze
+
+system_accounts_data = [
+  { name: "System Deposit Account" },
+  { name: "System Withdrawal Account" },
+  { name: "Voucher Settlement Account" }
+].freeze
+
+product_categories_data = [
+  { name: "Checking Account", description: "Day-to-day transaction accounts" },
+  { name: "Savings Account", description: "Standard savings accounts for retail customers" },
+  { name: "Fixed Deposit", description: "Time-bound deposit products with fixed returns" },
+  { name: "Business Account", description: "Accounts for small and medium business operations" }
+].freeze
+
+interest_rate_types_data = [
+  { code: "STANDARD", name: "Standard Rate", description: "Default interest rate for standard products" },
+  { code: "PROMOTIONAL", name: "Promotional Rate", description: "Temporary promotional rate for campaigns" },
+  { code: "TIERED", name: "Tiered Rate", description: "Interest rate that varies by product tier" }
+].freeze
+
+virtual_account_products_data = [
+  {
+    product_code: "CHK-001",
+    product_name: "Standard Checking",
+    category_name: "Checking Account",
+    description: "Everyday checking account for regular transactions."
+  },
+  {
+    product_code: "SVG-001",
+    product_name: "Standard Savings",
+    category_name: "Savings Account",
+    description: "Savings account for customers who want interest on available balances."
+  },
+  {
+    product_code: "FD-001",
+    product_name: "12-Month Fixed Deposit",
+    category_name: "Fixed Deposit",
+    description: "Fixed-term deposit product with a one-year investment period."
+  },
+  {
+    product_code: "BUS-001",
+    product_name: "SME Business Account",
+    category_name: "Business Account",
+    description: "Business operating account designed for small and medium enterprises."
+  }
+].freeze
+
+interest_rates_by_category = {
+  "Savings Account" => 0.035,
+  "Fixed Deposit" => 0.06,
+  "Business Account" => 0.025
+}.freeze
 
-# Seed transaction types
-puts "Seeding transaction types..."
-deposit_type = Dscf::Banking::TransactionType.find_or_create_by(code: "DEPOSIT") do |tt|
-  tt.name = "Deposit"
-  tt.description = "Deposit transaction - money coming into account"
+puts "Seeding roles..."
+roles = roles_data.each_with_object({}) do |role_data, memo|
+  role = Dscf::Core::Role.find_or_initialize_by(code: role_data[:code])
+  role.name = role_data[:name]
+  role.active = true
+  role.save!
+
+  memo[role_data[:code]] = role
+  puts "  Seeded role: #{role.code}"
 end
-puts "Created transaction type: #{deposit_type.name}"
 
-withdrawal_type = Dscf::Banking::TransactionType.find_or_create_by(code: "WITHDRAWAL") do |tt|
-  tt.name = "Withdrawal"
-  tt.description = "Withdrawal transaction - money going out of account"
+puts "Seeding users..."
+users = users_data.each_with_object({}) do |user_data, memo|
+  user = Dscf::Core::User.find_or_initialize_by(email: user_data[:email])
+  user.phone = user_data[:phone]
+  user.password = user_data[:password] if user.new_record? || user.password_digest.blank?
+  user.temp_password = false
+  user.verified_at ||= seed_timestamp
+  user.save!
+
+  user_data[:roles].each do |role_code|
+    Dscf::Core::UserRole.find_or_create_by!(user: user, role: roles.fetch(role_code))
+  end
+
+  memo[user_data[:email]] = user
+  puts "  Seeded user: #{user.email}"
 end
-puts "Created transaction type: #{withdrawal_type.name}"
 
-transfer_type = Dscf::Banking::TransactionType.find_or_create_by(code: "TRANSFER") do |tt|
-  tt.name = "Transfer"
-  tt.description = "Transfer transaction - money moving between accounts"
-end
-puts "Created transaction type: #{transfer_type.name}"
+admin_user = users.fetch("admin@dscf.com")
 
-voucher_type = Dscf::Banking::TransactionType.find_or_create_by(code: "VOUCHER") do |tt|
-  tt.name = "Voucher"
-  tt.description = "Voucher issuance and redemption transactions"
+puts "Seeding transaction types..."
+transaction_types_data.each do |transaction_type_data|
+  transaction_type = Dscf::Banking::TransactionType.find_or_initialize_by(code: transaction_type_data[:code])
+  transaction_type.name = transaction_type_data[:name]
+  transaction_type.description = transaction_type_data[:description]
+  transaction_type.save!
+
+  puts "  Seeded transaction type: #{transaction_type.code}"
 end
-puts "Created transaction type: #{voucher_type.name}"
 
-# Seed system accounts for transaction processing
 puts "Seeding system accounts..."
-system_deposit_account = Dscf::Banking::Account.find_or_create_by(
-  name: "System Deposit Account",
-  system_account: true
-) do |account|
+system_accounts_data.each do |account_data|
+  account = Dscf::Banking::Account.find_or_initialize_by(
+    name: account_data[:name],
+    system_account: true
+  )
   account.currency = "ETB"
   account.status = :active
   account.current_balance = 0
   account.available_balance = 0
   account.minimum_balance = 0
+  account.active = true
+  account.save!
+
+  puts "  Seeded system account: #{account.name}"
 end
-puts "Created system deposit account: #{system_deposit_account.name}"
 
-system_withdrawal_account = Dscf::Banking::Account.find_or_create_by(
-  name: "System Withdrawal Account",
-  system_account: true
-) do |account|
-  account.currency = "ETB"
-  account.status = :active
-  account.current_balance = 0
-  account.available_balance = 0
-  account.minimum_balance = 0
+puts "Seeding product categories..."
+product_categories = product_categories_data.each_with_object({}) do |category_data, memo|
+  category = Dscf::Banking::ProductCategory.find_or_initialize_by(name: category_data[:name])
+  category.description = category_data[:description]
+  category.is_active = true
+  category.save!
+
+  memo[category_data[:name]] = category
+  puts "  Seeded product category: #{category.name}"
 end
-puts "Created system withdrawal account: #{system_withdrawal_account.name}"
 
-voucher_settlement_account = Dscf::Banking::Account.find_or_create_by(
-  name: "Voucher Settlement Account",
-  system_account: true
-) do |account|
-  account.currency = "ETB"
-  account.status = :active
-  account.current_balance = 0
-  account.available_balance = 0
-  account.minimum_balance = 0
+puts "Seeding interest rate types..."
+interest_rate_types = interest_rate_types_data.each_with_object([]) do |rate_type_data, memo|
+  rate_type = Dscf::Banking::InterestRateType.find_or_initialize_by(code: rate_type_data[:code])
+  rate_type.name = rate_type_data[:name]
+  rate_type.description = rate_type_data[:description]
+  rate_type.save!
+
+  memo << rate_type
+  puts "  Seeded interest rate type: #{rate_type.code}"
+end
+
+puts "Seeding virtual account products..."
+virtual_account_products = virtual_account_products_data.each_with_object([]) do |product_data, memo|
+  product = Dscf::Banking::VirtualAccountProduct.find_or_initialize_by(product_code: product_data[:product_code])
+  product.product_name = product_data[:product_name]
+  product.product_category = product_categories.fetch(product_data[:category_name])
+  product.description = product_data[:description]
+  product.document_reference = "DOC-#{product_data[:product_code]}"
+  product.status = :approved
+  product.created_by = admin_user
+  product.approved_by = admin_user
+  product.approved_at ||= seed_timestamp
+  product.is_active = true
+  product.save!
+
+  memo << product
+  puts "  Seeded virtual account product: #{product.product_code}"
+end
+
+puts "Seeding interest configurations..."
+virtual_account_products.each_with_index do |product, index|
+  category_name = product.product_category&.name
+
+  if category_name == "Checking Account"
+    puts "  Skipped interest configuration for: #{product.product_code}"
+    next
+  end
+
+  interest_configuration = Dscf::Banking::InterestConfiguration.find_or_initialize_by(
+    virtual_account_product: product,
+    interest_rate_type: interest_rate_types[index % interest_rate_types.length]
+  )
+  interest_configuration.annual_interest_rate = interest_rates_by_category.fetch(category_name, 0.02)
+  interest_configuration.income_tax_rate = 0.05
+  interest_configuration.minimum_balance_for_interest = 1000.0
+  interest_configuration.calculation_method = :simple
+  interest_configuration.compounding_period = :monthly
+  interest_configuration.interest_basis = :actual_365
+  interest_configuration.accrual_frequency = :monthly
+  interest_configuration.rounding_rule = :nearest_cent
+  interest_configuration.calculation_timing ||= seed_timestamp
+  interest_configuration.is_active = true
+  interest_configuration.save!
+
+  puts "  Seeded interest configuration for: #{product.product_code}"
 end
-puts "Created voucher settlement account: #{voucher_settlement_account.name}"
 
-puts "Seeding completed successfully."
+puts "DSCF Banking seed completed successfully."

data/lib/dscf/banking/version.rb

@@ -1,5 +1,5 @@
 module Dscf
   module Banking
-    VERSION = "0.5.3"
+    VERSION = "0.5.5"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dscf-banking
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.5
 platform: ruby
 authors:
 - Asrat Efrem
 bindir: bin
 cert_chain: []
-date: 2026-03-16 00:00:00.000000000 Z
+date: 2026-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails