mirror of
https://github.com/we-promise/sure.git
synced 2026-04-19 03:54:08 +00:00
feat: add valuations API endpoints for managing account reconciliations (#745)
* feat: add valuations API endpoints for managing account reconciliations * refactor: formatting * fix: make account extraction clearer * feat: validation and error handling improvements * feat: transaction * feat: error handling * Add API documentation LLM context * Make it easier for people * feat: transaction in creation * feat: add OpenAPI spec for Valuations API * fix: update notes validation to check for key presence * Prevent double render * All other docs use `apiKeyAuth` * More `apiKeyAuth` * Remove testing assertions from API doc specs * fix: correct valuation entry references --------- Signed-off-by: Juan José Mata <juanjo.mata@gmail.com> Co-authored-by: Juan José Mata <juanjo.mata@gmail.com>
This commit is contained in:
Pere Montpeó
287
spec/requests/api/v1/valuations_spec.rb
Normal file
287
spec/requests/api/v1/valuations_spec.rb
Normal file
@@ -0,0 +1,287 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require 'swagger_helper'
|
||||
|
||||
RSpec.describe 'API V1 Valuations', type: :request do
|
||||
let(:family) do
|
||||
Family.create!(
|
||||
name: 'API Family',
|
||||
currency: 'USD',
|
||||
locale: 'en',
|
||||
date_format: '%m-%d-%Y'
|
||||
)
|
||||
end
|
||||
|
||||
let(:user) do
|
||||
family.users.create!(
|
||||
email: 'api-user@example.com',
|
||||
password: 'password123',
|
||||
password_confirmation: 'password123'
|
||||
)
|
||||
end
|
||||
|
||||
let(:oauth_application) do
|
||||
Doorkeeper::Application.create!(
|
||||
name: 'API Docs',
|
||||
redirect_uri: 'https://example.com/callback',
|
||||
scopes: 'read read_write'
|
||||
)
|
||||
end
|
||||
|
||||
let(:access_token) do
|
||||
Doorkeeper::AccessToken.create!(
|
||||
application: oauth_application,
|
||||
resource_owner_id: user.id,
|
||||
scopes: 'read_write',
|
||||
expires_in: 2.hours,
|
||||
token: SecureRandom.hex(32)
|
||||
)
|
||||
end
|
||||
|
||||
let(:Authorization) { "Bearer #{access_token.token}" }
|
||||
|
||||
let(:account) do
|
||||
Account.create!(
|
||||
family: family,
|
||||
name: 'Investment Account',
|
||||
balance: 10000,
|
||||
currency: 'USD',
|
||||
accountable: Investment.create!
|
||||
)
|
||||
end
|
||||
|
||||
let!(:valuation_entry) do
|
||||
account.entries.create!(
|
||||
name: 'Investment Reconciliation',
|
||||
date: Date.current,
|
||||
amount: 10000,
|
||||
currency: 'USD',
|
||||
entryable: Valuation.new(
|
||||
kind: 'reconciliation'
|
||||
)
|
||||
)
|
||||
end
|
||||
|
||||
let!(:valuation) { valuation_entry.entryable }
|
||||
let!(:valuation_id) { valuation_entry.id }
|
||||
|
||||
path '/api/v1/valuations' do
|
||||
post 'Create valuation' do
|
||||
tags 'Valuations'
|
||||
security [ { apiKeyAuth: [] } ]
|
||||
consumes 'application/json'
|
||||
produces 'application/json'
|
||||
parameter name: :Authorization, in: :header, required: true, schema: { type: :string },
|
||||
description: 'Bearer token with write scope'
|
||||
parameter name: :body, in: :body, required: true, schema: {
|
||||
type: :object,
|
||||
properties: {
|
||||
valuation: {
|
||||
type: :object,
|
||||
properties: {
|
||||
account_id: { type: :string, format: :uuid, description: 'Account ID (required)' },
|
||||
amount: { type: :number, description: 'Valuation amount (required)' },
|
||||
date: { type: :string, format: :date, description: 'Valuation date (required)' },
|
||||
notes: { type: :string, description: 'Additional notes' }
|
||||
},
|
||||
required: %w[account_id amount date]
|
||||
}
|
||||
},
|
||||
required: %w[valuation]
|
||||
}
|
||||
|
||||
let(:body) do
|
||||
{
|
||||
valuation: {
|
||||
account_id: account.id,
|
||||
amount: 15000.00,
|
||||
date: Date.current.to_s
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
response '201', 'valuation created' do
|
||||
schema '$ref' => '#/components/schemas/Valuation'
|
||||
|
||||
run_test! do |response|
|
||||
data = JSON.parse(response.body)
|
||||
created_id = data.fetch('id')
|
||||
get "/api/v1/valuations/#{created_id}", headers: { 'Authorization' => Authorization }
|
||||
expect(response).to have_http_status(:ok)
|
||||
fetched = JSON.parse(response.body)
|
||||
expect(fetched['id']).to eq(created_id)
|
||||
end
|
||||
end
|
||||
|
||||
response '422', 'validation error - missing account_id' do
|
||||
schema '$ref' => '#/components/schemas/ErrorResponse'
|
||||
|
||||
let(:body) do
|
||||
{
|
||||
valuation: {
|
||||
amount: 15000.00,
|
||||
date: Date.current.to_s
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
run_test!
|
||||
end
|
||||
|
||||
response '422', 'validation error - missing amount' do
|
||||
schema '$ref' => '#/components/schemas/ErrorResponse'
|
||||
|
||||
let(:body) do
|
||||
{
|
||||
valuation: {
|
||||
account_id: account.id,
|
||||
date: Date.current.to_s
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
run_test!
|
||||
end
|
||||
|
||||
response '422', 'validation error - missing date' do
|
||||
schema '$ref' => '#/components/schemas/ErrorResponse'
|
||||
|
||||
let(:body) do
|
||||
{
|
||||
valuation: {
|
||||
account_id: account.id,
|
||||
amount: 15000.00
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
run_test!
|
||||
end
|
||||
|
||||
response '404', 'account not found' do
|
||||
schema '$ref' => '#/components/schemas/ErrorResponse'
|
||||
|
||||
let(:body) do
|
||||
{
|
||||
valuation: {
|
||||
account_id: SecureRandom.uuid,
|
||||
amount: 15000.00,
|
||||
date: Date.current.to_s
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
run_test!
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
path '/api/v1/valuations/{id}' do
|
||||
parameter name: :Authorization, in: :header, required: true, schema: { type: :string },
|
||||
description: 'Bearer token'
|
||||
parameter name: :id, in: :path, type: :string, required: true, description: 'Valuation ID (entry ID)'
|
||||
|
||||
get 'Retrieve a valuation' do
|
||||
tags 'Valuations'
|
||||
security [ { apiKeyAuth: [] } ]
|
||||
produces 'application/json'
|
||||
|
||||
let(:id) { valuation_id }
|
||||
|
||||
response '200', 'valuation retrieved' do
|
||||
schema '$ref' => '#/components/schemas/Valuation'
|
||||
|
||||
run_test!
|
||||
end
|
||||
|
||||
response '404', 'valuation not found' do
|
||||
schema '$ref' => '#/components/schemas/ErrorResponse'
|
||||
|
||||
let(:id) { SecureRandom.uuid }
|
||||
|
||||
run_test!
|
||||
end
|
||||
end
|
||||
|
||||
patch 'Update a valuation' do
|
||||
tags 'Valuations'
|
||||
security [ { apiKeyAuth: [] } ]
|
||||
consumes 'application/json'
|
||||
produces 'application/json'
|
||||
|
||||
let(:id) { valuation_id }
|
||||
|
||||
parameter name: :body, in: :body, required: true, schema: {
|
||||
type: :object,
|
||||
properties: {
|
||||
valuation: {
|
||||
type: :object,
|
||||
properties: {
|
||||
amount: { type: :number, description: 'New valuation amount (must provide with date)' },
|
||||
date: { type: :string, format: :date, description: 'New valuation date (must provide with amount)' },
|
||||
notes: { type: :string, description: 'Additional notes' }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
response '200', 'valuation updated with notes' do
|
||||
schema '$ref' => '#/components/schemas/Valuation'
|
||||
|
||||
let(:body) do
|
||||
{
|
||||
valuation: {
|
||||
notes: 'Quarterly valuation update'
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
run_test!
|
||||
end
|
||||
|
||||
response '200', 'valuation updated with amount and date' do
|
||||
schema '$ref' => '#/components/schemas/Valuation'
|
||||
|
||||
let(:body) do
|
||||
{
|
||||
valuation: {
|
||||
amount: 12000.00,
|
||||
date: (Date.current - 1.day).to_s
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
run_test!
|
||||
end
|
||||
|
||||
response '422', 'validation error - only one of amount/date provided' do
|
||||
schema '$ref' => '#/components/schemas/ErrorResponse'
|
||||
|
||||
let(:body) do
|
||||
{
|
||||
valuation: {
|
||||
amount: 12000.00
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
run_test!
|
||||
end
|
||||
|
||||
response '404', 'valuation not found' do
|
||||
schema '$ref' => '#/components/schemas/ErrorResponse'
|
||||
|
||||
let(:id) { SecureRandom.uuid }
|
||||
let(:body) do
|
||||
{
|
||||
valuation: {
|
||||
notes: 'This will fail'
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
run_test!
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
Reference in New Issue
Block a user