Files
sure/app/models/up_account.rb
Jake dc2a565b6a feat(up): add Up Bank (AU) provider integration (#2391)
* feat(up): add Up Bank (AU) provider integration

Adds Up Bank as a per-family, token-based bank sync provider, modelled on
the existing Akahu integration. Up uses a JSON:API REST API with a personal
access token (Bearer), cursor pagination via links.next, and returns both
HELD (pending) and SETTLED transactions from one endpoint.

New:
- Provider::Up client (JSON:API unwrap, links.next pagination, retries,
  typed errors, /util/ping) + Provider::UpAdapter (Factory-registered,
  Depository + Loan).
- UpItem / UpAccount models with Provided, Unlinking, Syncer,
  SyncCompleteEvent, Importer, Processor, Transactions::Processor, and
  UpEntry::Processor (amount sign flip, HELD->pending, foreignAmount FX,
  merchant from description, stale-pending pruning).
- Family::UpConnectable, UpItemsController, routes, settings panel + connect
  flow views, accounts index wiring, initializer, en locale, and model tests.

Core wiring:
- "up" added to Transaction::PENDING_PROVIDERS, the three pending-match SQL
  blocks in Account::ProviderImportAdapter, Provider::Metadata::REGISTRY,
  ProviderMerchant/DataEnrichment source enums, ProviderConnectionStatus,
  settings provider panels, and financial data reset.

Migration create_up_items_and_accounts must be run before use. No external
API endpoints added (no OpenAPI changes).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(up): dump up tables to schema and make since filter TZ-safe

The feature commit added the up_items/up_accounts migration but never
re-dumped db/schema.rb, leaving the schema version and tables stale.
Add the two table definitions and foreign keys and bump the schema
version so a fresh DB load matches the migration.

Also format a bare Date `since` as UTC midnight instead of the server's
local zone, so `filter[since]` is deterministic regardless of where the
app runs (previously shifted by the local UTC offset).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(up): address code review feedback

Behavior/correctness:
- Persist skipped accounts via a new up_accounts.ignored flag and a
  needs_setup scope, so skipped accounts stop resurfacing as "needs
  setup" on every sync. Linking clears the flag.
- destroy now checks unlink_all! per-account results and aborts deletion
  (alert) if any unlink failed, instead of swallowing failures.
- render_provider_panel_error redirect uses :see_other (was an invalid
  4xx redirect status).
- Up provider adapter falls back to item institution name/url when
  institution_metadata is absent (early return previously blocked it).

Resilience/security:
- fetch_all_resources guards against an API repeating the same
  links.next cursor (Set#add?), preventing infinite pagination.
- HTTP client validates absolute URLs (from links.next) against Up's
  HTTPS host before sending the bearer token, preventing credential
  leakage to untrusted hosts.

Diagnostics:
- Route provider sync/import failures through DebugLogEntry.capture
  (controller, UpItem, syncer, unlinking) with family/account context.
  Low-level HTTP client and currency-normalization warnings keep
  Rails.logger to match existing provider conventions.

Data integrity:
- up_accounts.name and currency are NOT NULL (align with model presence
  validations); account_id stays nullable (allow_nil uniqueness).

Forms:
- select_existing_account radio is required; controller guards a blank/
  unknown up_account_id with a friendly alert instead of RecordNotFound.

Tests:
- Add UpAccount needs_setup scope test, pagination loop guard test,
  untrusted-host rejection test; tighten filter[since] assertion to the
  exact UTC timestamp.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* fix(up): address second-round review feedback

- Capture sync/import failures via DebugLogEntry so swallowed errors in
  account/transaction fetching and transaction processing surface in
  /settings/debug instead of only Rails.logger.
- Gate UP_DEBUG_RAW raw payload dump to local envs to avoid leaking PII
  (merchant names, amounts, account IDs) in managed/production logs.
- Collapse linked/unlinked/total account counts into one memoized query
  instead of 3 separate COUNTs per rendered item.
- Rename "Set Up Up Accounts" locale title to "Link Up Accounts".

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs(up): add method docstrings and align failed_result keys

Add docstrings to all Up provider source files (controller, models,
providers, concerns) to satisfy the 80% docstring coverage threshold.

Third-round review: failed_result now mirrors import's result shape
(accounts_updated/created/failed, transactions_imported/failed) instead
of the stale accounts_imported key, so failure results stay consistent.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-20 20:33:09 +02:00

94 lines
3.1 KiB
Ruby

class UpAccount < ApplicationRecord
include CurrencyNormalizable, Encryptable
# Maps Up `accountType` values to Sure accountable types/subtypes.
UP_ACCOUNT_TYPE_MAP = {
"TRANSACTIONAL" => { accountable_type: "Depository", subtype: "checking" },
"SAVER" => { accountable_type: "Depository", subtype: "savings" },
"HOME_LOAN" => { accountable_type: "Loan" }
}.freeze
INSTITUTION_NAME = "Up".freeze
INSTITUTION_DOMAIN = "up.com.au".freeze
if encryption_ready?
encrypts :raw_payload
encrypts :raw_transactions_payload
end
belongs_to :up_item
has_one :account_provider, as: :provider, dependent: :destroy
has_one :account, through: :account_provider, source: :account
has_one :linked_account, through: :account_provider, source: :account
validates :name, :currency, presence: true
validates :account_id, uniqueness: { scope: :up_item_id, allow_nil: true }
# Up accounts with no linked Sure account.
scope :unlinked, -> { left_joins(:account_provider).where(account_providers: { id: nil }) }
# Unlinked accounts that still need a setup decision (i.e. not explicitly skipped).
scope :needs_setup, -> { unlinked.where(ignored: false) }
# The linked Sure account, if any.
def current_account
account
end
# Suggested Sure accountable type derived from Up's account type, or nil.
def suggested_account_type
UP_ACCOUNT_TYPE_MAP[account_type.to_s.upcase]&.fetch(:accountable_type)
end
# Suggested Sure subtype (e.g. checking/savings) for this Up account, or nil.
def suggested_subtype
UP_ACCOUNT_TYPE_MAP[account_type.to_s.upcase]&.[](:subtype)
end
# Persist the latest Up account snapshot, normalizing balance/currency/metadata.
def upsert_up_snapshot!(account_snapshot)
snapshot = account_snapshot.with_indifferent_access
balance = snapshot[:balance].is_a?(Hash) ? snapshot[:balance].with_indifferent_access : {}
assign_attributes(
current_balance: parse_balance(balance[:value]),
currency: parse_currency(balance[:currencyCode]) || "AUD",
name: snapshot[:displayName].presence || I18n.t("up_account.fallback"),
account_id: snapshot[:id],
account_status: snapshot[:accountType],
account_type: snapshot[:accountType],
ownership_type: snapshot[:ownershipType],
provider: "up",
institution_metadata: {
name: INSTITUTION_NAME,
domain: INSTITUTION_DOMAIN
}.compact,
raw_payload: account_snapshot
)
save!
end
# Persist the latest raw transactions payload for this account.
def upsert_up_transactions_snapshot!(transactions_snapshot)
assign_attributes(raw_transactions_payload: transactions_snapshot)
save!
end
private
# Parse an Up balance string into a BigDecimal, defaulting to 0 on bad input.
def parse_balance(value)
return 0 if value.blank?
BigDecimal(value.to_s)
rescue ArgumentError
0
end
# CurrencyNormalizable hook: warn when an Up currency code is unrecognized.
def log_invalid_currency(currency_value)
Rails.logger.warn("Invalid currency code '#{currency_value}' for Up account #{id}, defaulting to AUD")
end
end