bscf-core 0.3.93 → 0.3.98

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84b5c589f1ce2635fdc88e79472dd27f93c1f102f117c60615c68419e3dab328
-  data.tar.gz: 0a338ac130227acf7963a58afce6ad0eae43f3a094c480ce31b5fbc78eb9676a
+  metadata.gz: 5d6e29a6fe52791c63a6ac04626a7b35f11b4648fcd554c8c4d5e8241b4107fa
+  data.tar.gz: 6f5fe2859090c771bd496335e49969fcff65800e3173918a8714a3b1f1eedd5e
 SHA512:
-  metadata.gz: d211bfe802dc0fc51ef9457cb382704056079a89b0b17860d52af71e20574f771042363bebada28a572af6555c707e075a699ba93573201a512b946fc17f346e
-  data.tar.gz: 6d38b373ce071de2e81354199709c5c3a9491b17275da28484d82304f2d59d59c265a00249849ee2cad3d3f2bf46a4e33fb9af7a24dea160dd3e9c93f6db5855
+  metadata.gz: ebd0b053b1456de1e56d3a369441c1d5fb134531f35c70cbab87430063979a6ea0fa9117ed85d4fcad8bb65cb0bdfe00cd85fe34d6ef20afdc0d89aab288c045
+  data.tar.gz: 6265ca3093db1bae9d6205b5e0eee1d97b583b42cc8d13b3d17abadcf9d46e4ead1f202fdacb09320f33e9cdbb82e62485b1ce5ceca46002f11b656b33945183

data/app/models/bscf/core/business.rb

@@ -4,7 +4,7 @@ module Bscf
       belongs_to :user
 
       validates :business_name, presence: true
-      validates :tin_number, presence: true, uniqueness: { case_sensitive: false }
+      validates :tin_number, uniqueness: { case_sensitive: false }
       validates :business_type, presence: true
       validates :verification_status, presence: true
 

data/app/models/bscf/core/delivery_order.rb

@@ -1,6 +1,6 @@
 module Bscf::Core
   class DeliveryOrder < ApplicationRecord
-    belongs_to :order
+    has_many :orders
     belongs_to :pickup_address, class_name: "Bscf::Core::Address"
     belongs_to :dropoff_address, class_name: "Bscf::Core::Address"
     belongs_to :driver, class_name: "Bscf::Core::User", optional: true

data/app/models/bscf/core/order.rb

@@ -4,6 +4,7 @@ module Bscf
       belongs_to :ordered_by, class_name: "Bscf::Core::User", optional: true
       belongs_to :ordered_to, class_name: "Bscf::Core::User", optional: true
       belongs_to :quotation, optional: true
+      belongs_to :delivery_order, optional: true 
       has_many :order_items, dependent: :destroy
       validates :order_type, :status, presence: true
 

data/app/models/bscf/core/user.rb

@@ -5,6 +5,9 @@ module Bscf
 
       has_one :user_profile
       has_one :user_role
+      has_one :business
+      has_one :vehicle, foreign_key: :driver_id
+      has_one :virtual_account
       has_many :user_roles
       has_many :roles, through: :user_roles
       has_many :orders_placed, class_name: "Bscf::Core::Order", foreign_key: "ordered_by_id"

data/app/models/bscf/core/user_profile.rb

@@ -7,8 +7,6 @@ module Bscf
 
       validates :date_of_birth, presence: true
       validates :nationality, presence: true
-      validates :occupation, presence: true
-      validates :source_of_funds, presence: true
       validates :gender, presence: true
 
       enum :gender, {

data/app/models/bscf/core/virtual_account.rb

@@ -9,12 +9,18 @@ module Bscf
       validates :account_number, presence: true, uniqueness: true
       validates :cbs_account_number, presence: true, uniqueness: true
       validates :balance, presence: true, numericality: { greater_than_or_equal_to: 0 }
+      validates :locked_amount, presence: true, numericality: { greater_than_or_equal_to: 0 }
       validates :interest_rate, presence: true, numericality: { greater_than_or_equal_to: 0 }
       validates :interest_type, presence: true
       validates :branch_code, presence: true
       validates :product_scheme, presence: true, inclusion: { in: PRODUCT_SCHEMES }
       validates :voucher_type, presence: true, inclusion: { in: VOUCHER_TYPES }
       validates :status, presence: true
+      validate :available_balance_sufficient
+      has_many :sent_transactions, class_name: "Bscf::Core::VirtualAccountTransaction",
+            foreign_key: "from_account_id", dependent: :restrict_with_error
+      has_many :received_transactions, class_name: "Bscf::Core::VirtualAccountTransaction",
+            foreign_key: "to_account_id", dependent: :restrict_with_error
 
       enum :interest_type, {
         simple: 0,
@@ -34,8 +40,39 @@ module Bscf
       scope :by_branch, ->(code) { where(branch_code: code) }
       scope :by_product, ->(scheme) { where(product_scheme: scheme) }
 
+      def available_balance
+        balance - locked_amount
+      end
+
+      def lock_amount!(amount)
+        return false if amount <= 0
+        return false if amount > available_balance
+
+        transaction do
+          self.locked_amount += amount
+          save!
+        end
+      end
+
+      def unlock_amount!(amount)
+        return false if amount <= 0
+        return false if amount > locked_amount
+
+        transaction do
+          self.locked_amount -= amount
+          save!
+        end
+      end
+
       private
 
+      def available_balance_sufficient
+        return unless balance && locked_amount
+        if locked_amount > balance
+          errors.add(:locked_amount, "cannot exceed balance")
+        end
+      end
+
       def generate_account_number
         return if account_number.present?
 
@@ -44,10 +81,17 @@ module Bscf
         self.account_number = "#{branch_code}#{product_scheme}#{voucher_type}#{seq}"
       end
 
-      has_many :sent_transactions, class_name: "Bscf::Core::VirtualAccountTransaction",
-               foreign_key: "from_account_id", dependent: :restrict_with_error
-      has_many :received_transactions, class_name: "Bscf::Core::VirtualAccountTransaction",
-               foreign_key: "to_account_id", dependent: :restrict_with_error
+      def transfer_to!(to_account, amount)
+        transaction = VirtualAccountTransaction.new(
+          from_account: self,
+          to_account: to_account,
+          amount: amount,
+          transaction_type: :transfer
+        )
+        
+        transaction.process!
+      end
     end
   end
 end
+

data/app/models/bscf/core/voucher.rb

@@ -0,0 +1,134 @@
+module Bscf
+  module Core
+    class Voucher < ApplicationRecord
+      belongs_to :issued_by, class_name: 'Bscf::Core::User'
+
+      validates :full_name, presence: true
+      validates :phone_number, presence: true
+      validates :amount, presence: true, numericality: { greater_than: 0 }
+      validates :code, presence: true, uniqueness: true
+      validate :issuer_has_sufficient_balance, on: :create
+
+      enum :status, {
+        pending: 0,
+        active: 1,
+        redeemed: 2,
+        expired: 3,
+        returned: 4,
+        cancelled: 5
+      }
+
+      before_validation :generate_code, on: :create
+      before_create :set_default_expiry
+      after_create :lock_issuer_amount
+      after_commit :unlock_issuer_amount, on: [:update], if: :should_unlock_amount?
+
+      def redeem!(to_account)
+        return false unless active?
+        return false if expired? || returned? || cancelled?
+
+        from_account = issued_by.virtual_account
+        success = false
+
+        ActiveRecord::Base.transaction do
+          transaction = VirtualAccountTransaction.new(
+            from_account: from_account,
+            to_account: to_account,
+            amount: amount,
+            transaction_type: :transfer
+          )
+
+          unless transaction.process!
+            errors.add(:base, "Voucher redemption failed due to transaction processing error.")
+            raise ActiveRecord::Rollback
+          end
+
+          unless from_account.unlock_amount!(amount)
+            errors.add(:base, "Failed to unlock amount from issuer after successful transfer.")
+            raise ActiveRecord::Rollback
+          end
+
+          update!(status: :redeemed, redeemed_at: Time.current)
+          success = true
+        end
+
+        success
+      rescue ActiveRecord::RecordInvalid => e
+        errors.add(:base, "Voucher redemption failed: #{e.message}")
+        false
+      rescue ActiveRecord::Rollback
+        false
+      end
+
+      def return!
+        return false unless can_return?
+        update!(status: :returned, returned_at: Time.current)
+        true
+      rescue ActiveRecord::RecordInvalid
+        false
+      end
+
+      def cancel!
+        return false unless can_cancel?
+        update!(status: :cancelled, returned_at: Time.current)
+        true
+      rescue ActiveRecord::RecordInvalid
+        false
+      end
+
+      def can_return?
+        !redeemed? && !returned? && !cancelled? && !expired?
+      end
+
+      def can_cancel?
+        (pending? || active?) && !expired? && !returned? && !redeemed?
+      end
+
+      private
+
+      def generate_code
+        self.code ||= SecureRandom.hex(8).upcase
+      end
+
+      def set_default_expiry
+        self.expires_at ||= 30.days.from_now
+      end
+
+      def lock_issuer_amount
+        issuer_account = issued_by.virtual_account
+        unless issuer_account.available_balance >= amount
+          errors.add(:amount, "exceeds available balance")
+          return false
+        end
+
+        if issuer_account.lock_amount!(amount)
+          update!(status: :active)
+          true
+        else
+          errors.add(:amount, "could not be locked")
+          false
+        end
+      end
+
+      def unlock_issuer_amount
+        issued_by.virtual_account.unlock_amount!(amount) if amount_should_be_unlocked?
+      end
+
+      def should_unlock_amount?
+        (returned? || cancelled?) && status_previously_changed?
+      end
+
+      def amount_should_be_unlocked?
+        returned? || cancelled?
+      end
+
+      def issuer_has_sufficient_balance
+        return unless amount && issued_by&.virtual_account
+        unless issued_by.virtual_account.available_balance >= amount
+          errors.add(:amount, "exceeds available balance")
+          throw :abort
+        end
+      end
+    end
+  end
+end

data/db/migrate/20250521084935_update_not_null_constraints_in_businesses.rb

@@ -0,0 +1,7 @@
+class UpdateNotNullConstraintsInBusinesses < ActiveRecord::Migration[8.0]
+  def change
+    change_column_null :bscf_core_user_profiles, :source_of_funds, false
+    change_column_null :bscf_core_user_profiles, :occupation, false
+    change_column_null :bscf_core_businesses, :tin_number, false
+  end
+end

data/db/migrate/20250524073441_remove_order_id_from_delivery_orders_and_add_delivery_order_id_to_orders.rb

@@ -0,0 +1,6 @@
+class RemoveOrderIdFromDeliveryOrdersAndAddDeliveryOrderIdToOrders < ActiveRecord::Migration[8.0]
+  def change
+    remove_reference :bscf_core_delivery_orders, :order, foreign_key: { to_table: :bscf_core_orders }, index: true
+    add_reference :bscf_core_orders, :delivery_order, foreign_key: { to_table: :bscf_core_delivery_orders }, index: true, null: true
+  end
+end

data/db/migrate/20250524081221_create_bscf_core_vouchers.rb

@@ -0,0 +1,19 @@
+class CreateBscfCoreVouchers < ActiveRecord::Migration[8.0]
+  def change
+    create_table :bscf_core_vouchers do |t|
+      t.string :full_name, null: false
+      t.string :phone_number, null: false
+      t.decimal :amount, null: false
+      t.string :reason
+      t.string :code, null: false
+      t.integer :status, null: false, default: 0
+      t.datetime :expires_at
+      t.references :issued_by, null: false, foreign_key: {to_table: :bscf_core_users}
+      t.datetime :redeemed_at
+      t.datetime :returned_at
+
+      t.timestamps
+    end
+    add_index :bscf_core_vouchers, :code
+  end
+end

data/db/migrate/20250524151346_add_locked_amount_to_virtual_accounts.rb

@@ -0,0 +1,5 @@
+class AddLockedAmountToVirtualAccounts < ActiveRecord::Migration[8.0]
+  def change
+    add_column :bscf_core_virtual_accounts, :locked_amount, :decimal
+  end
+end

data/lib/bscf/core/version.rb

@@ -1,5 +1,5 @@
 module Bscf
   module Core
-    VERSION = "0.3.93"
+    VERSION = "0.3.98"
   end
 end

data/spec/factories/bscf/core/delivery_orders.rb

@@ -1,6 +1,5 @@
 FactoryBot.define do
   factory :delivery_order, class: 'Bscf::Core::DeliveryOrder' do
-    association :order
     association :pickup_address, factory: :address
     association :dropoff_address, factory: :address
     driver { nil }
@@ -30,5 +29,11 @@ FactoryBot.define do
       delivery_start_time { 2.hours.ago }
       delivery_end_time { Time.current }
     end
+
+    trait :with_orders do
+      after(:create) do |delivery_order|
+        create_list(:order, 2, delivery_order: delivery_order)
+      end
+    end
   end
 end

data/spec/factories/bscf/core/orders.rb

@@ -6,5 +6,6 @@ FactoryBot.define do
     order_type { :order_from_quote }
     status { :draft }
     total_amount { Faker::Number.between(from: 100, to: 1000) }
+    delivery_order { nil } 
   end
 end

data/spec/factories/bscf/core/virtual_accounts.rb

@@ -1,7 +1,7 @@
 FactoryBot.define do
   factory :virtual_account, class: 'Bscf::Core::VirtualAccount' do
     association :user, factory: :user
-
+    
     sequence(:cbs_account_number) { |n| "CBS#{n.to_s.rjust(8, '0')}" }
     branch_code { "BR001" }
     product_scheme { "SAVINGS" }
@@ -10,6 +10,7 @@ FactoryBot.define do
     interest_rate { 2.5 }
     interest_type { :simple }
     active { true }
+    locked_amount { 0.0 }
     status { :pending }
 
     trait :active_status do
@@ -34,5 +35,11 @@ FactoryBot.define do
       product_scheme { "LOAN" }
       interest_rate { 12.5 }
     end
+
+
+    trait :with_locked_amount do
+      locked_amount { Faker::Number.decimal(l_digits: 3, r_digits: 2) }
+      balance { locked_amount + Faker::Number.decimal(l_digits: 3, r_digits: 2) }
+    end
   end
 end

data/spec/factories/bscf/core/vouchers.rb

@@ -0,0 +1,51 @@
+FactoryBot.define do
+  factory :voucher, class: 'Bscf::Core::Voucher' do
+    association :issued_by, factory: :user
+    
+    after(:build) do |voucher|
+      create(:virtual_account, user: voucher.issued_by, balance: 1000.0) unless voucher.issued_by.virtual_account
+    end
+    
+    full_name { Faker::Name.name }
+    phone_number { Faker::PhoneNumber.cell_phone }
+    amount { Faker::Number.decimal(l_digits: 3, r_digits: 2) }
+    expires_at { 30.days.from_now }
+    status { :pending }
+
+    trait :active do
+      status { :active }
+      after(:create) do |voucher|
+        voucher.issued_by.virtual_account.update!(balance: voucher.amount + 1000)
+        voucher.send(:lock_issuer_amount)
+      end
+    end
+
+    trait :redeemed do
+      status { :redeemed }
+      redeemed_at { Time.current }
+    end
+
+    trait :expired do
+      status { :expired }
+      expires_at { 1.day.ago }
+    end
+
+    trait :returned do
+      status { :returned }
+      returned_at { Time.current }
+    end
+
+    trait :cancelled do
+      status { :cancelled }
+      returned_at { Time.current }
+    end
+
+    trait :with_sufficient_balance do
+      after(:build) do |voucher|
+        voucher.issued_by.virtual_account.update!(balance: voucher.amount + 1000)
+      end
+    end
+
+    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bscf-core
 version: !ruby/object:Gem::Version
-  version: 0.3.93
+  version: 0.3.98
 platform: ruby
 authors:
 - Asrat
@@ -308,6 +308,7 @@ files:
 - app/models/bscf/core/vehicle.rb
 - app/models/bscf/core/virtual_account.rb
 - app/models/bscf/core/virtual_account_transaction.rb
+- app/models/bscf/core/voucher.rb
 - app/models/bscf/core/wholesaler_product.rb
 - app/services/bscf/core/token_service.rb
 - config/database.yml
@@ -339,6 +340,10 @@ files:
 - db/migrate/20250410181145_add_actual_delivery_time_to_delivery_orders.rb
 - db/migrate/20250410181146_modify_user_email_and_password.rb
 - db/migrate/20250425055419_add_delivery_price_to_delivery_orders.rb
+- db/migrate/20250521084935_update_not_null_constraints_in_businesses.rb
+- db/migrate/20250524073441_remove_order_id_from_delivery_orders_and_add_delivery_order_id_to_orders.rb
+- db/migrate/20250524081221_create_bscf_core_vouchers.rb
+- db/migrate/20250524151346_add_locked_amount_to_virtual_accounts.rb
 - lib/bscf/core.rb
 - lib/bscf/core/engine.rb
 - lib/bscf/core/version.rb
@@ -367,6 +372,8 @@ files:
 - spec/factories/bscf/core/vehicles.rb
 - spec/factories/bscf/core/virtual_account_transactions.rb
 - spec/factories/bscf/core/virtual_accounts.rb
+- spec/factories/bscf/core/voucher.rb
+- spec/factories/bscf/core/vouchers.rb
 - spec/factories/bscf/core/wholesaler_products.rb
 homepage: https://mksaddis.com/
 licenses: