mirror of
https://github.com/we-promise/sure.git
synced 2026-04-12 08:37:22 +00:00
* - Add support for `SIMPLEFIN_INCLUDE_PENDING` to control pending behavior via ENV. - Enhance debug logging for SimpleFin API requests and raw payloads. - Refine pending flag handling in `SimplefinEntry::Processor` based on provider data and inferred conditions. - Improve FX metadata processing for transactions with currency mismatches. - Add new tests for pending detection, FX metadata, and edge cases involving `posted` values. - Add pending indicator UI to transaction view. * Document pending transaction detection, storage, and UI behavior for SimpleFIN and Plaid integrations. Add debug flags for troubleshooting. * Add `pending?` method to `Transaction` model, refactor UI indicator, and centralize SimpleFIN configuration - Introduced `pending?` method in `Transaction` for unified pending state detection. - Refactored transaction pending indicator in the UI to use `pending?` method. - Centralized SimpleFIN configuration in initializer with ENV-backed toggles. - Updated tests for `pending?` behavior and clarified docs for pending detection logic * Add SimpleFIN debug and runtime flags to `.env.local.example` and `.env.test.example` - Introduced `SIMPLEFIN_INCLUDE_PENDING` and `SIMPLEFIN_DEBUG_RAW` flags for controlling pending behavior and debugging. - Updated example environment files with descriptions for new configuration options. * Normalize formatting for `SIMPLEFIN_INCLUDE_PENDING` and `SIMPLEFIN_DEBUG_RAW` flags in `.env.local.example` and `.env.test.example`. --------- Co-authored-by: Josh Waldrep <joshua.waldrep5+github@gmail.com>
189 lines
6.1 KiB
Ruby
189 lines
6.1 KiB
Ruby
require "digest/md5"
|
|
|
|
class SimplefinEntry::Processor
|
|
include CurrencyNormalizable
|
|
# simplefin_transaction is the raw hash fetched from SimpleFin API and converted to JSONB
|
|
def initialize(simplefin_transaction, simplefin_account:)
|
|
@simplefin_transaction = simplefin_transaction
|
|
@simplefin_account = simplefin_account
|
|
end
|
|
|
|
def process
|
|
import_adapter.import_transaction(
|
|
external_id: external_id,
|
|
amount: amount,
|
|
currency: currency,
|
|
date: date,
|
|
name: name,
|
|
source: "simplefin",
|
|
merchant: merchant,
|
|
notes: notes,
|
|
extra: extra_metadata
|
|
)
|
|
end
|
|
|
|
private
|
|
attr_reader :simplefin_transaction, :simplefin_account
|
|
|
|
def extra_metadata
|
|
sf = {}
|
|
# Preserve raw strings from provider so nothing is lost
|
|
sf["payee"] = data[:payee] if data.key?(:payee)
|
|
sf["memo"] = data[:memo] if data.key?(:memo)
|
|
sf["description"] = data[:description] if data.key?(:description)
|
|
# Include provider-supplied extra hash if present
|
|
sf["extra"] = data[:extra] if data[:extra].is_a?(Hash)
|
|
|
|
# Pending detection: honor provider flag or infer from missing/zero posted with present transacted_at
|
|
posted_val = data[:posted]
|
|
posted_missing = posted_val.blank? || posted_val == 0 || posted_val == "0"
|
|
if ActiveModel::Type::Boolean.new.cast(data[:pending]) || (posted_missing && data[:transacted_at].present?)
|
|
sf["pending"] = true
|
|
Rails.logger.debug("SimpleFIN: flagged pending transaction #{external_id}")
|
|
end
|
|
|
|
# FX metadata: when tx currency differs from account currency
|
|
tx_currency = parse_currency(data[:currency])
|
|
acct_currency = account.currency
|
|
if tx_currency.present? && acct_currency.present? && tx_currency != acct_currency
|
|
sf["fx_from"] = tx_currency
|
|
# Prefer transacted_at for fx date, fallback to posted
|
|
fx_d = transacted_date || posted_date
|
|
sf["fx_date"] = fx_d&.to_s
|
|
end
|
|
|
|
return nil if sf.empty?
|
|
{ "simplefin" => sf }
|
|
end
|
|
|
|
def import_adapter
|
|
@import_adapter ||= Account::ProviderImportAdapter.new(account)
|
|
end
|
|
|
|
def account
|
|
simplefin_account.current_account
|
|
end
|
|
|
|
def data
|
|
@data ||= simplefin_transaction.with_indifferent_access
|
|
end
|
|
|
|
def external_id
|
|
id = data[:id].presence
|
|
raise ArgumentError, "SimpleFin transaction missing id: #{data.inspect}" unless id
|
|
"simplefin_#{id}"
|
|
end
|
|
|
|
def name
|
|
# Use SimpleFin's rich, clean data to create informative transaction names
|
|
payee = data[:payee]
|
|
description = data[:description]
|
|
|
|
# Combine payee + description when both are present and different
|
|
if payee.present? && description.present? && payee != description
|
|
"#{payee} - #{description}"
|
|
elsif payee.present?
|
|
payee
|
|
elsif description.present?
|
|
description
|
|
else
|
|
data[:memo] || "Unknown transaction"
|
|
end
|
|
end
|
|
|
|
def amount
|
|
parsed_amount = case data[:amount]
|
|
when String
|
|
BigDecimal(data[:amount])
|
|
when Numeric
|
|
BigDecimal(data[:amount].to_s)
|
|
else
|
|
BigDecimal("0")
|
|
end
|
|
|
|
# SimpleFin uses banking convention (expenses negative, income positive)
|
|
# Maybe expects opposite convention (expenses positive, income negative)
|
|
# So we negate the amount to convert from SimpleFin to Maybe format
|
|
-parsed_amount
|
|
rescue ArgumentError => e
|
|
Rails.logger.error "Failed to parse SimpleFin transaction amount: #{data[:amount].inspect} - #{e.message}"
|
|
raise
|
|
end
|
|
|
|
def currency
|
|
parse_currency(data[:currency]) || account.currency
|
|
end
|
|
|
|
def log_invalid_currency(currency_value)
|
|
Rails.logger.warn("Invalid currency code '#{currency_value}' in SimpleFIN transaction #{external_id}, falling back to account currency")
|
|
end
|
|
|
|
# UI/entry date selection by account type:
|
|
# - Credit cards/loans: prefer transaction date (matches statements), then posted
|
|
# - Others: prefer posted date, then transaction date
|
|
# Epochs parsed as UTC timestamps via DateUtils
|
|
def date
|
|
# Prefer transaction date for revolving debt (credit cards/loans); otherwise prefer posted date
|
|
acct_type = simplefin_account&.account_type.to_s.strip.downcase.tr(" ", "_")
|
|
if %w[credit_card credit loan mortgage].include?(acct_type)
|
|
t = transacted_date
|
|
return t if t
|
|
p = posted_date
|
|
return p if p
|
|
else
|
|
p = posted_date
|
|
return p if p
|
|
t = transacted_date
|
|
return t if t
|
|
end
|
|
Rails.logger.error("SimpleFin transaction missing posted/transacted date: #{data.inspect}")
|
|
raise ArgumentError, "Invalid date format: #{data[:posted].inspect} / #{data[:transacted_at].inspect}"
|
|
end
|
|
|
|
def posted_date
|
|
val = data[:posted]
|
|
# Treat 0 / "0" as missing to avoid Unix epoch 1970-01-01 for pendings
|
|
return nil if val == 0 || val == "0"
|
|
Simplefin::DateUtils.parse_provider_date(val)
|
|
end
|
|
|
|
def transacted_date
|
|
val = data[:transacted_at]
|
|
Simplefin::DateUtils.parse_provider_date(val)
|
|
end
|
|
|
|
def merchant
|
|
# Use SimpleFin's clean payee data for merchant detection
|
|
payee = data[:payee]&.strip
|
|
return nil unless payee.present?
|
|
|
|
@merchant ||= import_adapter.find_or_create_merchant(
|
|
provider_merchant_id: generate_merchant_id(payee),
|
|
name: payee,
|
|
source: "simplefin"
|
|
)
|
|
rescue ActiveRecord::RecordInvalid => e
|
|
Rails.logger.error "SimplefinEntry::Processor - Failed to create merchant '#{payee}': #{e.message}"
|
|
nil
|
|
end
|
|
|
|
def generate_merchant_id(merchant_name)
|
|
# Generate a consistent ID for merchants without explicit IDs
|
|
"simplefin_#{Digest::MD5.hexdigest(merchant_name.downcase)}"
|
|
end
|
|
|
|
def notes
|
|
# Prefer memo if present; include payee when it differs from description for richer context
|
|
memo = data[:memo].to_s.strip
|
|
payee = data[:payee].to_s.strip
|
|
description = data[:description].to_s.strip
|
|
|
|
parts = []
|
|
parts << memo if memo.present?
|
|
if payee.present? && payee != description
|
|
parts << "Payee: #{payee}"
|
|
end
|
|
parts.presence&.join(" | ")
|
|
end
|
|
end
|