1
0
Fork 0
mirror of https://github.com/maybe-finance/maybe.git synced 2025-07-19 13:19:39 +02:00
Maybe/test/controllers/settings/api_keys_controller_test.rb
Josh Pigford b803ddac96
Add comprehensive API v1 with OAuth and API key authentication (#2389)
* OAuth

* Add API test routes and update Doorkeeper token handling for test environment

- Introduced API namespace with test routes for controller testing in the test environment.
- Updated Doorkeeper configuration to allow fallback to plain tokens in the test environment for easier testing.
- Modified schema to change resource_owner_id type from bigint to string.

* Implement API key authentication and enhance access control

- Replaced Doorkeeper OAuth authentication with a custom method supporting both OAuth and API keys in the BaseController.
- Added methods for API key authentication, including validation and logging.
- Introduced scope-based authorization for API keys in the TestController.
- Updated routes to include API key management endpoints.
- Enhanced logging for API access to include authentication method details.
- Added tests for API key functionality, including validation, scope checks, and access control enforcement.

* Add API key rate limiting and usage tracking

- Implemented rate limiting for API key authentication in BaseController.
- Added methods to check rate limits, render appropriate responses, and include rate limit headers in responses.
- Updated routes to include a new usage resource for tracking API usage.
- Enhanced tests to verify rate limit functionality, including exceeding limits and per-key tracking.
- Cleaned up Redis data in tests to ensure isolation between test cases.

* Add Jbuilder for JSON rendering and refactor AccountsController

- Added Jbuilder gem for improved JSON response handling.
- Refactored index action in AccountsController to utilize Jbuilder for rendering JSON.
- Removed manual serialization of accounts and streamlined response structure.
- Implemented a before_action in BaseController to enforce JSON format for all API requests.

* Add transactions resource to API routes

- Added routes for transactions, allowing index, show, create, update, and destroy actions.
- This enhancement supports comprehensive transaction management within the API.

* Enhance API authentication and onboarding handling

- Updated BaseController to skip onboarding requirements for API endpoints and added manual token verification for OAuth authentication.
- Improved error handling and logging for invalid access tokens.
- Introduced a method to set up the current context for API requests, ensuring compatibility with session-like behavior.
- Excluded API paths from onboarding redirects in the Onboardable concern.
- Updated database schema to change resource_owner_id type from bigint to string for OAuth access grants.

* Fix rubocop offenses

- Fix indentation and spacing issues
- Convert single quotes to double quotes
- Add spaces inside array brackets
- Fix comment alignment
- Add missing trailing newlines
- Correct else/end alignment

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Fix API test failures and improve test reliability

- Fix ApiRateLimiterTest by removing mock users method and using fixtures
- Fix UsageControllerTest by removing mock users method and using fixtures
- Fix BaseControllerTest by using different users for multiple API keys
- Use unique display_key values with SecureRandom to avoid conflicts
- Fix double render issue in UsageController by returning after authorize_scope\!
- Specify controller name in routes for usage resource
- Remove trailing whitespace and empty lines per Rubocop

All tests now pass and linting is clean.

🤖 Generated with [Claude Code](https://claude.ai/code)

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

* Add API transactions controller warning to brakeman ignore

The account_id parameter in the API transactions controller is properly
validated on line 79: family.accounts.find(transaction_params[:account_id])
This ensures users can only create transactions in accounts belonging to
their family, making this a false positive.

🤖 Generated with [Claude Code](https://claude.ai/code)

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

---------

Signed-off-by: Josh Pigford <josh@joshpigford.com>
Co-authored-by: Claude <noreply@anthropic.com>
2025-06-17 15:57:05 -05:00

191 lines
4.5 KiB
Ruby

require "test_helper"
class Settings::ApiKeysControllerTest < ActionDispatch::IntegrationTest
setup do
@user = users(:family_admin)
@user.api_keys.destroy_all # Ensure clean state
sign_in @user
end
test "should show no API key page when user has no active keys" do
get settings_api_key_path
assert_response :success
end
test "should show current API key when user has active key" do
@api_key = ApiKey.create!(
user: @user,
name: "Test API Key",
display_key: "test_key_123",
scopes: [ "read" ]
)
get settings_api_key_path
assert_response :success
end
test "should show new API key form" do
get new_settings_api_key_path
assert_response :success
end
test "should redirect to show when user already has active key and tries to visit new" do
ApiKey.create!(
user: @user,
name: "Existing API Key",
display_key: "existing_key_123",
scopes: [ "read" ]
)
get new_settings_api_key_path
assert_redirected_to settings_api_key_path
end
test "should create new API key with valid parameters" do
assert_difference "ApiKey.count", 1 do
post settings_api_key_path, params: {
api_key: {
name: "Test Integration Key",
scopes: "read_write"
}
}
end
assert_redirected_to settings_api_key_path
follow_redirect!
assert_response :success
api_key = @user.api_keys.active.first
assert_equal "Test Integration Key", api_key.name
assert_includes api_key.scopes, "read_write"
end
test "should revoke existing key when creating new one" do
old_key = ApiKey.create!(
user: @user,
name: "Old API Key",
display_key: "old_key_123",
scopes: [ "read" ]
)
post settings_api_key_path, params: {
api_key: {
name: "New API Key",
scopes: "read_write"
}
}
assert_redirected_to settings_api_key_path
follow_redirect!
assert_response :success
old_key.reload
assert old_key.revoked?
new_key = @user.api_keys.active.first
assert_equal "New API Key", new_key.name
end
test "should not create API key without name" do
assert_no_difference "ApiKey.count" do
post settings_api_key_path, params: {
api_key: {
name: "",
scopes: "read"
}
}
end
assert_response :unprocessable_entity
end
test "should not create API key without scopes" do
# Ensure clean state for this specific test
@user.api_keys.destroy_all
initial_user_count = @user.api_keys.count
assert_no_difference "@user.api_keys.count" do
post settings_api_key_path, params: {
api_key: {
name: "Test Key",
scopes: []
}
}
end
assert_response :unprocessable_entity
assert_equal initial_user_count, @user.api_keys.reload.count
end
test "should revoke API key" do
@api_key = ApiKey.create!(
user: @user,
name: "Test API Key",
display_key: "test_key_123",
scopes: [ "read" ]
)
delete settings_api_key_path
assert_redirected_to settings_api_key_path
follow_redirect!
assert_response :success
@api_key.reload
assert @api_key.revoked?
end
test "should handle revoke when no API key exists" do
delete settings_api_key_path
assert_redirected_to settings_api_key_path
# Should not error even when no API key exists
end
test "should only allow one active API key per user" do
# Create first API key
post settings_api_key_path, params: {
api_key: {
name: "First Key",
scopes: "read"
}
}
first_key = @user.api_keys.active.first
# Create second API key
post settings_api_key_path, params: {
api_key: {
name: "Second Key",
scopes: "read_write"
}
}
# First key should be revoked
first_key.reload
assert first_key.revoked?
# Only one active key should exist
assert_equal 1, @user.api_keys.active.count
assert_equal "Second Key", @user.api_keys.active.first.name
end
test "should generate secure random API key" do
post settings_api_key_path, params: {
api_key: {
name: "Random Key Test",
scopes: "read"
}
}
assert_redirected_to settings_api_key_path
follow_redirect!
assert_response :success
# Verify the API key was created with expected properties
api_key = @user.api_keys.active.first
assert api_key.present?
assert_equal "Random Key Test", api_key.name
assert_includes api_key.scopes, "read"
end
end