mirror of
https://github.com/maybe-finance/maybe.git
synced 2025-07-30 18:49:39 +02:00
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>
This commit is contained in:
Josh Pigford
GitHub
parent
13a64a1694
commit
b803ddac96
53 changed files with 4849 additions and 4 deletions
196
test/system/settings/api_keys_test.rb
Normal file
196
test/system/settings/api_keys_test.rb
Normal file
|
|
@ -0,0 +1,196 @@
|
|||
require "application_system_test_case"
|
||||
|
||||
class Settings::ApiKeysTest < ApplicationSystemTestCase
|
||||
setup do
|
||||
@user = users(:family_admin)
|
||||
@user.api_keys.destroy_all # Ensure clean state
|
||||
login_as @user
|
||||
end
|
||||
|
||||
test "should show no API key state when user has no active keys" do
|
||||
visit settings_api_key_path
|
||||
|
||||
assert_text "Create Your API Key"
|
||||
assert_text "Get programmatic access to your Maybe data"
|
||||
assert_text "Access your account data programmatically"
|
||||
assert_link "Create API Key", href: new_settings_api_key_path
|
||||
end
|
||||
|
||||
test "should navigate to create new API key form" do
|
||||
visit settings_api_key_path
|
||||
click_link "Create API Key"
|
||||
|
||||
assert_current_path new_settings_api_key_path
|
||||
assert_text "Create New API Key"
|
||||
assert_field "API Key Name"
|
||||
assert_text "Read Only"
|
||||
assert_text "Read/Write"
|
||||
end
|
||||
|
||||
test "should create a new API key with selected scopes" do
|
||||
visit new_settings_api_key_path
|
||||
|
||||
fill_in "API Key Name", with: "Test Integration Key"
|
||||
choose "Read/Write"
|
||||
|
||||
click_button "Create API Key"
|
||||
|
||||
# Should redirect to show page with the API key details
|
||||
assert_current_path settings_api_key_path
|
||||
assert_text "Test Integration Key"
|
||||
assert_text "Your API Key"
|
||||
|
||||
# Should show the actual API key value
|
||||
api_key_display = find("#api-key-display")
|
||||
assert api_key_display.text.length > 30 # Should be a long hex string
|
||||
|
||||
# Should show copy buttons
|
||||
assert_button "Copy API Key"
|
||||
assert_link "Create New Key"
|
||||
end
|
||||
|
||||
test "should show current API key details after creation" do
|
||||
# Create an API key first
|
||||
api_key = ApiKey.create!(
|
||||
user: @user,
|
||||
name: "Production API Key",
|
||||
display_key: "test_plain_key_123",
|
||||
scopes: [ "read", "read_write" ]
|
||||
)
|
||||
|
||||
visit settings_api_key_path
|
||||
|
||||
assert_text "Your API Key"
|
||||
assert_text "Production API Key"
|
||||
assert_text "Active"
|
||||
assert_text "Read Only"
|
||||
assert_text "Read/Write"
|
||||
assert_text "Never used"
|
||||
assert_link "Create New Key"
|
||||
assert_button "Revoke Key"
|
||||
end
|
||||
|
||||
test "should show usage instructions and example curl command" do
|
||||
api_key = ApiKey.create!(
|
||||
user: @user,
|
||||
name: "Test API Key",
|
||||
display_key: "test_key_123",
|
||||
scopes: [ "read" ]
|
||||
)
|
||||
|
||||
visit settings_api_key_path
|
||||
|
||||
assert_text "How to use your API key"
|
||||
assert_text "curl -H \"X-Api-Key: test_key_123\""
|
||||
assert_text "/api/v1/accounts"
|
||||
end
|
||||
|
||||
test "should allow regenerating API key" do
|
||||
api_key = ApiKey.create!(
|
||||
user: @user,
|
||||
name: "Old API Key",
|
||||
display_key: "old_key_123",
|
||||
scopes: [ "read" ]
|
||||
)
|
||||
|
||||
visit settings_api_key_path
|
||||
click_link "Create New Key"
|
||||
|
||||
assert_current_path new_settings_api_key_path
|
||||
fill_in "API Key Name", with: "New API Key"
|
||||
choose "Read Only"
|
||||
click_button "Create API Key"
|
||||
|
||||
assert_text "New API Key"
|
||||
|
||||
# Old key should be revoked
|
||||
api_key.reload
|
||||
assert api_key.revoked?
|
||||
end
|
||||
|
||||
test "should allow revoking API key with confirmation" do
|
||||
api_key = ApiKey.create!(
|
||||
user: @user,
|
||||
name: "Test API Key",
|
||||
display_key: "test_key_123",
|
||||
scopes: [ "read" ]
|
||||
)
|
||||
|
||||
visit settings_api_key_path
|
||||
|
||||
# Mock the confirmation dialog
|
||||
accept_confirm "Are you sure you want to revoke this API key?" do
|
||||
click_button "Revoke Key"
|
||||
end
|
||||
|
||||
assert_text "Create Your API Key"
|
||||
assert_no_text "Your API Key"
|
||||
|
||||
# Key should be revoked in the database
|
||||
api_key.reload
|
||||
assert api_key.revoked?
|
||||
end
|
||||
|
||||
test "should redirect to show when user already has active key and tries to visit new" do
|
||||
api_key = ApiKey.create!(
|
||||
user: @user,
|
||||
name: "Existing API Key",
|
||||
display_key: "existing_key_123",
|
||||
scopes: [ "read" ]
|
||||
)
|
||||
|
||||
visit new_settings_api_key_path
|
||||
|
||||
assert_current_path settings_api_key_path
|
||||
end
|
||||
|
||||
test "should show API key in navigation" do
|
||||
visit settings_api_key_path
|
||||
|
||||
within("nav") do
|
||||
assert_text "API Key"
|
||||
end
|
||||
end
|
||||
|
||||
test "should validate API key name is required" do
|
||||
visit new_settings_api_key_path
|
||||
|
||||
# Try to submit without name
|
||||
choose "Read Only"
|
||||
click_button "Create API Key"
|
||||
|
||||
# Should stay on form with validation error
|
||||
assert_current_path settings_api_key_path # POST path
|
||||
assert_field "API Key Name" # Form should still be visible
|
||||
end
|
||||
|
||||
test "should show last used timestamp when API key has been used" do
|
||||
api_key = ApiKey.create!(
|
||||
user: @user,
|
||||
name: "Used API Key",
|
||||
display_key: "used_key_123",
|
||||
scopes: [ "read" ],
|
||||
last_used_at: 2.hours.ago
|
||||
)
|
||||
|
||||
visit settings_api_key_path
|
||||
|
||||
assert_text "2 hours ago"
|
||||
assert_no_text "Never used"
|
||||
end
|
||||
|
||||
test "should show expiration date when API key has expiration" do
|
||||
api_key = ApiKey.create!(
|
||||
user: @user,
|
||||
name: "Expiring API Key",
|
||||
display_key: "expiring_key_123",
|
||||
scopes: [ "read" ],
|
||||
expires_at: 30.days.from_now
|
||||
)
|
||||
|
||||
visit settings_api_key_path
|
||||
|
||||
# Should show some indication of expiration (exact format may vary)
|
||||
assert_no_text "Never expires"
|
||||
end
|
||||
end
|
||||
Loading…
Add table
Add a link
Reference in a new issue