mirror of
https://github.com/we-promise/sure.git
synced 2026-09-05 14:51:15 +00:00
* Add RentCast and Realie AVM providers for property valuation Adds Automated Valuation Model (AVM) provider support so self-hosted users can create property accounts from a US address lookup instead of entering details manually: - Provider::Rentcast and Provider::Realie clients, each fetching the property record (type, year built, square footage) and value estimate in a single API request, registered under a new :property_valuations registry concept - API key fields (encrypted, ENV-overridable) with monthly usage display in Settings > Self-Hosting under "Property Valuation Providers" - New property flow: when a provider key is configured, the method selector offers "Add via RentCast/Realie" alongside manual entry; the lookup form reuses the manual flow's localized address fields and creates the account active with fetched attributes, valuation as balance, and the address saved - SyncPropertyValuationsJob refreshes linked property valuations once a day (never hourly) via config/schedule.yml; each provider enforces its monthly request cap (RentCast 50, Realie 25) with a calendar-month counter shared between creation lookups and refreshes Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Allow ENV override of AVM provider monthly request caps The RentCast (50/month) and Realie (25/month) budgets default to the free tier limits but can now be raised for paid plans via RENTCAST_MAX_REQUESTS_PER_MONTH / REALIE_MAX_REQUESTS_PER_MONTH, mirroring the AlphaVantage and Tiingo request limit overrides. The settings descriptions and usage display reflect the effective cap. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Address review feedback: durable request counters, safer refresh job - Move monthly AVM request counters from Rails.cache to a new provider_request_counts table with atomic upsert increments, so the hard budget caps survive cache eviction, restarts, and Redis flushes - SyncPropertyValuationsJob: only mark a property synced when the balance update succeeds (wrapped in a transaction), process stalest valuations first so a tight budget goes where it matters, and report failures via DebugLogEntry.capture instead of Rails.logger - Realie: reject lookups whose returned city/ZIP contradict the entered address (street+state queries can match the wrong city); document that numeric use codes are unpublished and leave the subtype unset - Add Faraday open/request timeouts to both provider clients - Localize all user-facing provider error messages (config/locales/models/provider/en.yml) - Add a check constraint restricting properties.avm_provider to known providers - Use the min-h-80 scale token instead of min-h-[320px] - Tests: exact-argument expectations on the lookup stub, provider stubs in the no-provider test, RentCast/Realie API key update tests, ProviderRequestCount unit tests, failed-balance regression test Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Stub AVM provider registry lookups in settings system test Settings::HostingsController#show now resolves the RentCast and Realie providers for usage display; the system test's partial get_provider stubbing treats the new lookups as unexpected invocations without these. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Address second-round review: candidate scan, provider reuse, shared row partial - Realie: when the address lookup returns multiple candidates, pick the first one consistent with the entered city/ZIP instead of judging only the first array element; the location-mismatch error now only fires when no candidate matches - SyncPropertyValuationsJob: resolve one provider instance per key for the whole run, so the per-instance request throttle actually spaces requests across properties instead of resetting on each iteration - Extract the AVM method selector row into a shared partial so the manual and provider options render one shape Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Add retry middleware and sync index from review feedback - Both AVM clients now retry transient connection failures (same Faraday retry config as Tiingo) so a network blip doesn't burn one of the tight monthly budget's requests - Partial index on properties(avm_provider, avm_last_synced_on) backing the daily sync job's filter and stalest-first ordering Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Key the AVM sync index on avm_last_synced_on The daily job orders by avm_last_synced_on ASC NULLS FIRST across all AVM-linked properties, so leading the partial index with avm_provider prevented it from serving the sort. Rekeyed on avm_last_synced_on with matching null ordering; the partial predicate still covers the filter. Amended in place since the migration is unmerged. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Map Realie numeric use codes; skip incomplete addresses in sync job - Realie documents its numeric use codes at docs.realie.ai/api-reference/feature-key (earlier skip reason was wrong — the table exists). Map the residential/land/agricultural codes to Property subtypes, leaving codes without a subtype equivalent (e.g. 1006 mobile/manufactured) unset like the RentCast mapping. - The daily job now skips properties whose address is missing a street or state before resolving a provider, logging a warn-level DebugLogEntry, so a malformed address can't burn a monthly-budget request every day. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Guard currency mismatches in refresh; reset AVM keys in test teardown - The daily job now skips (with a warn-level DebugLogEntry) properties whose account currency no longer matches the provider's valuation currency, checked via the concept's valuation_currency before spending a request — writing a USD valuation into a re-currencied account would corrupt the balance - Hostings controller test teardown now clears rentcast_api_key and realie_api_key alongside the other cached global settings Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Validate AVM lookup inputs before spending a provider request The form marks name and address fields required, but a forged or JS-less submission bypasses that and would burn one of the tight monthly-budget requests on a lookup that can't produce a property. Property::AvmImport now validates name and the full address locally (localized error) before calling the provider. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Add preview-and-confirm step to the AVM property lookup RentCast's AVM endpoint is location-based: a plausible but nonexistent address still geocodes and returns an area-derived estimate with no property record behind it. Instead of silently creating an account from that, the lookup now shows what the provider returned — type, year built, area (each "Unknown" when missing), and the estimated value — with an explicit notice when no property record was found, and only the user's confirmation creates the account. The confirm step reuses the fetched data via the form (sanitized server-side), so the flow still costs exactly one provider request. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Require a complete US address before daily valuation refresh The job's guard only required street and state, but a later-blanked city or ZIP silently disables the Realie wrong-city check (blank entered fields count as "no mismatch"), so a refresh could accept another property's valuation. The guard now mirrors the import-time completeness check and also skips addresses edited to a non-US country. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Sign the AVM preview payload; blur valuation in privacy mode - The confirm step now rebuilds everything from a signed, 1-hour message-verifier token generated at lookup time, proving the lookup (and its counted provider request) actually ran — a direct confirm POST with fabricated data can no longer create provider-linked properties that the daily refresh job would then spend quota on. Forged/expired tokens re-render the lookup form with a clear error. - The preview's market value now carries the privacy-sensitive class so privacy mode blurs it like other account amounts. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Treat zero Realie valuations as absent; bind preview token to family Review follow-ups from PR #2727: - Realie returns modelValue: 0 when it can't produce an AVM estimate; zero now falls back to the assessed market value instead of syncing a $0 balance, and an all-zero record errors out. - Monetary values now parse via BigDecimal(value.to_s) rather than Float#to_d, avoiding binary float rounding artifacts in balances. - The signed AVM preview token's purpose is scoped to the family that ran the lookup, so a leaked token can't be replayed cross-family. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * Refresh AVM property valuations monthly instead of daily Per @jjmata's review on #2727: valuations change slowly and providers enforce tight monthly request caps, so a daily cron adds no value. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
186 lines
7.0 KiB
Ruby
186 lines
7.0 KiB
Ruby
require "test_helper"
|
|
|
|
class Provider::RealieTest < ActiveSupport::TestCase
|
|
setup do
|
|
@provider = Provider::Realie.new("test_api_key")
|
|
@provider.stubs(:throttle_request)
|
|
end
|
|
|
|
def address_lookup_body(overrides = {})
|
|
{
|
|
"property" => {
|
|
"useCode" => "Single Family Residential",
|
|
"yearBuilt" => 1985,
|
|
"buildingArea" => 1500.0,
|
|
"modelValue" => 420_000.0,
|
|
"modelValueMin" => 390_000.0,
|
|
"modelValueMax" => 450_000.0,
|
|
"totalMarketValue" => 400_000,
|
|
"city" => "LOS ANGELES",
|
|
"state" => "CA",
|
|
"zipCode" => "90001"
|
|
}.merge(overrides)
|
|
}.to_json
|
|
end
|
|
|
|
test "fetches valuation and property attributes in a single request" do
|
|
stub = stub_request(:get, "https://app.realie.ai/api/public/property/address/")
|
|
.with(
|
|
query: { "address" => "123 Main Street", "state" => "CA" },
|
|
headers: { "Authorization" => "test_api_key" }
|
|
)
|
|
.to_return(status: 200, body: address_lookup_body)
|
|
|
|
response = @provider.fetch_property_valuation(
|
|
line1: "123 Main Street",
|
|
locality: "Los Angeles",
|
|
region: "CA",
|
|
postal_code: "90001"
|
|
)
|
|
|
|
assert response.success?
|
|
data = response.data
|
|
assert_equal 420_000, data.valuation
|
|
assert_equal "USD", data.currency
|
|
assert_equal "single_family_home", data.property_type
|
|
assert_equal 1985, data.year_built
|
|
assert_equal 1500, data.area_value
|
|
assert_equal "sqft", data.area_unit
|
|
assert_requested stub
|
|
end
|
|
|
|
test "falls back to the assessed market value when no model value is present" do
|
|
stub_request(:get, "https://app.realie.ai/api/public/property/address/")
|
|
.with(query: hash_including("address" => "123 Main Street"))
|
|
.to_return(status: 200, body: address_lookup_body("modelValue" => nil))
|
|
|
|
response = @provider.fetch_property_valuation(line1: "123 Main Street", region: "CA")
|
|
|
|
assert response.success?
|
|
assert_equal 400_000, response.data.valuation
|
|
end
|
|
|
|
test "treats a zero model value as absent and falls back to the market value" do
|
|
stub_request(:get, "https://app.realie.ai/api/public/property/address/")
|
|
.with(query: hash_including("address" => "123 Main Street"))
|
|
.to_return(status: 200, body: address_lookup_body("modelValue" => 0))
|
|
|
|
response = @provider.fetch_property_valuation(line1: "123 Main Street", region: "CA")
|
|
|
|
assert response.success?
|
|
assert_equal 400_000, response.data.valuation
|
|
end
|
|
|
|
test "returns an error when both model and market values are zero" do
|
|
stub_request(:get, "https://app.realie.ai/api/public/property/address/")
|
|
.with(query: hash_including("address" => "123 Main Street"))
|
|
.to_return(status: 200, body: address_lookup_body("modelValue" => 0, "totalMarketValue" => 0))
|
|
|
|
response = @provider.fetch_property_valuation(line1: "123 Main Street", region: "CA")
|
|
|
|
assert_not response.success?
|
|
assert_match(/valuation/i, response.error.message)
|
|
end
|
|
|
|
test "picks the candidate matching the entered city and ZIP from multiple results" do
|
|
wrong_city = { "useCode" => "Commercial", "yearBuilt" => 1970, "buildingArea" => 9_000.0, "modelValue" => 2_000_000.0, "city" => "SACRAMENTO", "state" => "CA", "zipCode" => "95814" }
|
|
right_city = { "useCode" => "Single Family Residential", "yearBuilt" => 1985, "buildingArea" => 1500.0, "modelValue" => 420_000.0, "city" => "LOS ANGELES", "state" => "CA", "zipCode" => "90001" }
|
|
|
|
stub_request(:get, "https://app.realie.ai/api/public/property/address/")
|
|
.with(query: hash_including("address" => "123 Main Street"))
|
|
.to_return(status: 200, body: { "property" => [ wrong_city, right_city ] }.to_json)
|
|
|
|
response = @provider.fetch_property_valuation(
|
|
line1: "123 Main Street",
|
|
locality: "Los Angeles",
|
|
region: "CA",
|
|
postal_code: "90001"
|
|
)
|
|
|
|
assert response.success?
|
|
assert_equal 420_000, response.data.valuation
|
|
assert_equal "single_family_home", response.data.property_type
|
|
assert_equal 1985, response.data.year_built
|
|
end
|
|
|
|
test "rejects a property matched in a different city or ZIP" do
|
|
stub_request(:get, "https://app.realie.ai/api/public/property/address/")
|
|
.with(query: hash_including("address" => "123 Main Street"))
|
|
.to_return(status: 200, body: address_lookup_body("city" => "SACRAMENTO", "zipCode" => "95814"))
|
|
|
|
response = @provider.fetch_property_valuation(
|
|
line1: "123 Main Street",
|
|
locality: "Los Angeles",
|
|
region: "CA",
|
|
postal_code: "90001"
|
|
)
|
|
|
|
assert_not response.success?
|
|
assert_match(/different city or zip/i, response.error.message)
|
|
end
|
|
|
|
test "returns a friendly error when no property matches the address" do
|
|
stub_request(:get, "https://app.realie.ai/api/public/property/address/")
|
|
.with(query: hash_including("address" => "1 Nowhere Ln"))
|
|
.to_return(status: 404, body: { "detail" => "Not found" }.to_json)
|
|
|
|
response = @provider.fetch_property_valuation(line1: "1 Nowhere Ln", region: "CA")
|
|
|
|
assert_not response.success?
|
|
assert_match(/could not find a property/i, response.error.message)
|
|
end
|
|
|
|
test "maps documented numeric use codes to property subtypes" do
|
|
{
|
|
"1001" => "single_family_home",
|
|
"1002" => "townhouse",
|
|
"1004" => "condominium",
|
|
"1101" => "multi_family_home",
|
|
"1104" => "apartment",
|
|
"7001" => "agri_land",
|
|
"8001" => "plot",
|
|
"1006" => nil, # mobile/manufactured — no subtype equivalent
|
|
"9999" => nil # unknown numeric code
|
|
}.each do |use_code, expected|
|
|
actual = @provider.send(:subtype_for_use_code, use_code)
|
|
if expected.nil?
|
|
assert_nil actual, "expected #{use_code.inspect} to map to nil"
|
|
else
|
|
assert_equal expected, actual, "expected #{use_code.inspect} to map to #{expected.inspect}"
|
|
end
|
|
end
|
|
end
|
|
|
|
test "maps use codes to property subtypes by keyword" do
|
|
{
|
|
"Single Family Residential" => "single_family_home",
|
|
"Duplex (2 units)" => "multi_family_home",
|
|
"Residential Condominium" => "condominium",
|
|
"Townhouse" => "townhouse",
|
|
"Vacant Land" => "plot",
|
|
"Commercial Office" => "commercial",
|
|
"Agricultural" => "agri_land",
|
|
"Something Unrecognized" => nil
|
|
}.each do |use_code, expected|
|
|
actual = @provider.send(:subtype_for_use_code, use_code)
|
|
if expected.nil?
|
|
assert_nil actual, "expected #{use_code.inspect} to map to nil"
|
|
else
|
|
assert_equal expected, actual, "expected #{use_code.inspect} to map to #{expected.inspect}"
|
|
end
|
|
end
|
|
end
|
|
|
|
test "stops issuing requests once the monthly limit is reached" do
|
|
ProviderRequestCount.create!(provider_key: "realie", period: ProviderRequestCount.current_period, count: Provider::Realie::MAX_REQUESTS_PER_MONTH)
|
|
|
|
assert_not @provider.requests_remaining?
|
|
|
|
response = @provider.fetch_property_valuation(line1: "123 Main Street", region: "CA")
|
|
|
|
assert_not response.success?
|
|
assert_instance_of Provider::Realie::RateLimitError, response.error
|
|
assert_not_requested :get, %r{app\.realie\.ai}
|
|
end
|
|
end
|