Files
sure/app/models/indexa_capital_item.rb
David Gil 28d99a2b0d Include newer providers in automatic family sync (#934)
* Include newer providers in automatic family sync

Coinbase, CoinStats, Mercury, and SnapTrade all implement Syncable
and have Syncer classes but were not listed in child_syncables,
meaning their data only refreshed on manual sync button clicks.

* refactor(syncer): Open/Closed principle for provider sync

- Adding new providers requires modifying child_syncables (violates O/C)
- plaid_items missing .active scope (bug: syncs deleted items)
- snaptrade_items can exist without user registration → fails on sync
- Scattered knowledge about 'ready to sync' logic

1. **Registry pattern**: SYNCABLE_ITEM_ASSOCIATIONS constant lists all
   provider associations that participate in family sync

2. **Encapsulated sync-readiness**: Each item model defines its own
   `syncable` scope that knows when it's ready for auto-sync:
   - Most providers: `syncable = active` (not scheduled for deletion)
   - SnapTrade: `syncable = active + user_registered` (has API creds)

3. **Single loop**: child_syncables iterates the registry, calling
   `.syncable` on each association

- Adding a provider = add to registry + define syncable scope
- Each model owns its 'ready to sync' business logic
- Fixes plaid_items bug (now uses .active via .syncable)
- Fixes snaptrade auto-sync failures (filters unregistered items)
- Easy to extend with new conditions per provider

- family/syncer.rb: Registry + dynamic collection
- *_item.rb (7 files): Add `scope :syncable, -> { active }`
- snaptrade_item.rb: Add syncable with user_registered filter

* Fix rubocop bracket spacing in SnaptradeItem syncable scope
2026-02-10 23:42:22 +01:00

182 lines
5.7 KiB
Ruby

# frozen_string_literal: true
class IndexaCapitalItem < ApplicationRecord
include Syncable, Provided, Unlinking
enum :status, { good: "good", requires_update: "requires_update" }, default: :good
# Helper to detect if ActiveRecord Encryption is configured for this app
def self.encryption_ready?
creds_ready = Rails.application.credentials.active_record_encryption.present?
env_ready = ENV["ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY"].present? &&
ENV["ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY"].present? &&
ENV["ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT"].present?
creds_ready || env_ready
end
# Encrypt sensitive credentials if ActiveRecord encryption is configured
if encryption_ready?
encrypts :password, deterministic: true
encrypts :api_token, deterministic: true
end
validates :name, presence: true
validate :credentials_present_on_create, on: :create
belongs_to :family
has_one_attached :logo, dependent: :purge_later
has_many :indexa_capital_accounts, dependent: :destroy
has_many :accounts, through: :indexa_capital_accounts
scope :active, -> { where(scheduled_for_deletion: false) }
scope :syncable, -> { active }
scope :ordered, -> { order(created_at: :desc) }
scope :needs_update, -> { where(status: :requires_update) }
def syncer
IndexaCapitalItem::Syncer.new(self)
end
def destroy_later
update!(scheduled_for_deletion: true)
DestroyJob.perform_later(self)
end
# Override syncing? to include background activities fetch
def syncing?
super || indexa_capital_accounts.where(activities_fetch_pending: true).exists?
end
# Import data from provider API
def import_latest_indexa_capital_data(sync: nil)
provider = indexa_capital_provider
unless provider
Rails.logger.error "IndexaCapitalItem #{id} - Cannot import: provider is not configured"
raise StandardError, I18n.t("indexa_capital_items.errors.provider_not_configured")
end
IndexaCapitalItem::Importer.new(self, indexa_capital_provider: provider, sync: sync).import
rescue => e
Rails.logger.error "IndexaCapitalItem #{id} - Failed to import data: #{e.message}"
raise
end
# Process linked accounts after data import
def process_accounts
return [] if indexa_capital_accounts.empty?
results = []
linked_indexa_capital_accounts.includes(account_provider: :account).each do |indexa_capital_account|
begin
result = IndexaCapitalAccount::Processor.new(indexa_capital_account).process
results << { indexa_capital_account_id: indexa_capital_account.id, success: true, result: result }
rescue => e
Rails.logger.error "IndexaCapitalItem #{id} - Failed to process account #{indexa_capital_account.id}: #{e.message}"
results << { indexa_capital_account_id: indexa_capital_account.id, success: false, error: e.message }
end
end
results
end
# Schedule sync jobs for all linked accounts
def schedule_account_syncs(parent_sync: nil, window_start_date: nil, window_end_date: nil)
return [] if accounts.empty?
results = []
accounts.visible.each do |account|
begin
account.sync_later(
parent_sync: parent_sync,
window_start_date: window_start_date,
window_end_date: window_end_date
)
results << { account_id: account.id, success: true }
rescue => e
Rails.logger.error "IndexaCapitalItem #{id} - Failed to schedule sync for account #{account.id}: #{e.message}"
results << { account_id: account.id, success: false, error: e.message }
end
end
results
end
def upsert_indexa_capital_snapshot!(accounts_snapshot)
assign_attributes(
raw_payload: accounts_snapshot
)
save!
end
def has_completed_initial_setup?
accounts.any?
end
# Linked accounts (have AccountProvider association)
def linked_indexa_capital_accounts
indexa_capital_accounts.joins(:account_provider)
end
# Unlinked accounts (no AccountProvider association)
def unlinked_indexa_capital_accounts
indexa_capital_accounts.left_joins(:account_provider).where(account_providers: { id: nil })
end
def sync_status_summary
total_accounts = total_accounts_count
linked_count = linked_accounts_count
unlinked_count = unlinked_accounts_count
if total_accounts == 0
I18n.t("indexa_capital_items.sync_status.no_accounts")
elsif unlinked_count == 0
I18n.t("indexa_capital_items.sync_status.synced", count: linked_count)
else
I18n.t("indexa_capital_items.sync_status.synced_with_setup", linked: linked_count, unlinked: unlinked_count)
end
end
def linked_accounts_count
indexa_capital_accounts.joins(:account_provider).count
end
def unlinked_accounts_count
indexa_capital_accounts.left_joins(:account_provider).where(account_providers: { id: nil }).count
end
def total_accounts_count
indexa_capital_accounts.count
end
def institution_display_name
institution_name.presence || institution_domain.presence || name
end
def connected_institutions
indexa_capital_accounts.includes(:account)
.where.not(institution_metadata: nil)
.map { |acc| acc.institution_metadata }
.uniq { |inst| inst["name"] || inst["institution_name"] }
end
def institution_summary
institutions = connected_institutions
case institutions.count
when 0
I18n.t("indexa_capital_items.institution_summary.none")
else
I18n.t("indexa_capital_items.institution_summary.count", count: institutions.count)
end
end
private
def credentials_present_on_create
return if credentials_configured?
errors.add(:base, "Either INDEXA_API_TOKEN env var or username/document/password credentials are required")
end
end