mirror of
https://github.com/we-promise/sure.git
synced 2026-05-08 13:14:58 +00:00
* feat(api): expose budget state * fix(api): guard malformed budget ids * fix(api): address budget state review * fix(api): address budget state review * fix(api): document budget id formats * fix(api): align budget category docs auth * fix(api): lighten budget category index payload * fix(api): use shared pagination clamp * fix(api): centralize budget filter handling
142 lines
4.4 KiB
Ruby
142 lines
4.4 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "test_helper"
|
|
|
|
class Api::V1::BudgetsControllerTest < ActionDispatch::IntegrationTest
|
|
setup do
|
|
@user = users(:family_admin)
|
|
@family = @user.family
|
|
@user.api_keys.active.destroy_all
|
|
|
|
@api_key = ApiKey.create!(
|
|
user: @user,
|
|
name: "Test Read Key",
|
|
scopes: [ "read" ],
|
|
source: "web",
|
|
display_key: "test_read_#{SecureRandom.hex(8)}"
|
|
)
|
|
|
|
@budget = @family.budgets.create!(
|
|
start_date: 3.months.ago.beginning_of_month.to_date,
|
|
end_date: 3.months.ago.end_of_month.to_date,
|
|
budgeted_spending: 3000,
|
|
expected_income: 5000,
|
|
currency: "USD"
|
|
)
|
|
|
|
category = categories(:food_and_drink)
|
|
@budget_category = @budget.budget_categories.create!(
|
|
category: category,
|
|
budgeted_spending: 500,
|
|
currency: "USD"
|
|
)
|
|
|
|
other_family = families(:empty)
|
|
@other_budget = other_family.budgets.create!(
|
|
start_date: 4.months.ago.beginning_of_month.to_date,
|
|
end_date: 4.months.ago.end_of_month.to_date,
|
|
budgeted_spending: 1000,
|
|
expected_income: 2000,
|
|
currency: "USD"
|
|
)
|
|
end
|
|
|
|
test "lists budgets scoped to the current family" do
|
|
get api_v1_budgets_url, headers: api_headers(@api_key)
|
|
|
|
assert_response :success
|
|
response_data = JSON.parse(response.body)
|
|
assert response_data.key?("budgets")
|
|
assert response_data.key?("pagination")
|
|
assert_includes response_data["budgets"].map { |budget| budget["id"] }, @budget.id
|
|
assert_not_includes response_data["budgets"].map { |budget| budget["id"] }, @other_budget.id
|
|
|
|
budget_response = response_data["budgets"].find { |budget| budget["id"] == @budget.id }
|
|
%w[
|
|
actual_spending
|
|
actual_spending_cents
|
|
actual_income
|
|
actual_income_cents
|
|
available_to_spend
|
|
available_to_spend_cents
|
|
available_to_allocate
|
|
available_to_allocate_cents
|
|
].each do |derived_field|
|
|
assert_not budget_response.key?(derived_field), "Expected budget index to omit #{derived_field}"
|
|
end
|
|
end
|
|
|
|
test "shows a budget" do
|
|
get api_v1_budget_url(@budget.id), headers: api_headers(@api_key)
|
|
|
|
assert_response :success
|
|
response_data = JSON.parse(response.body)
|
|
assert_equal @budget.id, response_data["id"]
|
|
assert_equal @budget.start_date.to_s, response_data["start_date"]
|
|
assert_equal "USD", response_data["currency"]
|
|
assert_equal true, response_data["initialized"]
|
|
assert_kind_of Integer, response_data["budgeted_spending_cents"]
|
|
assert_kind_of Integer, response_data["actual_spending_cents"]
|
|
assert_kind_of Integer, response_data["actual_income_cents"]
|
|
assert_kind_of Integer, response_data["available_to_spend_cents"]
|
|
assert_kind_of Integer, response_data["available_to_allocate_cents"]
|
|
end
|
|
|
|
test "returns not found for another family's budget" do
|
|
get api_v1_budget_url(@other_budget.id), headers: api_headers(@api_key)
|
|
|
|
assert_response :not_found
|
|
response_data = JSON.parse(response.body)
|
|
assert_equal "record_not_found", response_data["error"]
|
|
end
|
|
|
|
test "returns not found for malformed budget id" do
|
|
get api_v1_budget_url("not-a-uuid"), headers: api_headers(@api_key)
|
|
|
|
assert_response :not_found
|
|
response_data = JSON.parse(response.body)
|
|
assert_equal "record_not_found", response_data["error"]
|
|
end
|
|
|
|
test "filters budgets by date range" do
|
|
get api_v1_budgets_url,
|
|
params: { start_date: @budget.start_date.to_s, end_date: @budget.end_date.to_s },
|
|
headers: api_headers(@api_key)
|
|
|
|
assert_response :success
|
|
response_data = JSON.parse(response.body)
|
|
assert_includes response_data["budgets"].map { |budget| budget["id"] }, @budget.id
|
|
end
|
|
|
|
test "rejects invalid date filters" do
|
|
get api_v1_budgets_url, params: { start_date: "03/01/2024" }, headers: api_headers(@api_key)
|
|
|
|
assert_response :unprocessable_entity
|
|
response_data = JSON.parse(response.body)
|
|
assert_equal "validation_failed", response_data["error"]
|
|
end
|
|
|
|
test "requires authentication" do
|
|
get api_v1_budgets_url
|
|
|
|
assert_response :unauthorized
|
|
end
|
|
|
|
test "requires read scope" do
|
|
api_key_without_read = ApiKey.new(
|
|
user: @user,
|
|
name: "No Read Key",
|
|
scopes: [],
|
|
source: "mobile",
|
|
display_key: "no_read_#{SecureRandom.hex(8)}"
|
|
)
|
|
api_key_without_read.save!(validate: false)
|
|
|
|
get api_v1_budgets_url, headers: api_headers(api_key_without_read)
|
|
|
|
assert_response :forbidden
|
|
ensure
|
|
api_key_without_read&.destroy
|
|
end
|
|
end
|