mirror of
https://github.com/maybe-finance/maybe.git
synced 2025-07-19 13:19: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
136
test/controllers/api/v1/usage_controller_test.rb
Normal file
136
test/controllers/api/v1/usage_controller_test.rb
Normal file
|
|
@ -0,0 +1,136 @@
|
|||
require "test_helper"
|
||||
|
||||
class Api::V1::UsageControllerTest < ActionDispatch::IntegrationTest
|
||||
setup do
|
||||
@user = users(:family_admin)
|
||||
# Destroy any existing active API keys for this user
|
||||
@user.api_keys.active.destroy_all
|
||||
|
||||
@api_key = ApiKey.create!(
|
||||
user: @user,
|
||||
name: "Test API Key",
|
||||
scopes: [ "read" ],
|
||||
display_key: "usage_test_#{SecureRandom.hex(8)}"
|
||||
)
|
||||
|
||||
# Clear any existing rate limit data
|
||||
Redis.new.del("api_rate_limit:#{@api_key.id}")
|
||||
end
|
||||
|
||||
teardown do
|
||||
# Clean up Redis data after each test
|
||||
Redis.new.del("api_rate_limit:#{@api_key.id}")
|
||||
end
|
||||
|
||||
test "should return usage information for API key authentication" do
|
||||
# Make a few requests to generate some usage
|
||||
3.times do
|
||||
get "/api/v1/test", headers: { "X-Api-Key" => @api_key.display_key }
|
||||
assert_response :success
|
||||
end
|
||||
|
||||
# Now check usage
|
||||
get "/api/v1/usage", headers: { "X-Api-Key" => @api_key.display_key }
|
||||
assert_response :success
|
||||
|
||||
response_body = JSON.parse(response.body)
|
||||
|
||||
# Check API key information
|
||||
assert_equal "Test API Key", response_body["api_key"]["name"]
|
||||
assert_equal [ "read" ], response_body["api_key"]["scopes"]
|
||||
assert_not_nil response_body["api_key"]["last_used_at"]
|
||||
assert_not_nil response_body["api_key"]["created_at"]
|
||||
|
||||
# Check rate limit information
|
||||
assert_equal "standard", response_body["rate_limit"]["tier"]
|
||||
assert_equal 100, response_body["rate_limit"]["limit"]
|
||||
assert_equal 4, response_body["rate_limit"]["current_count"] # 3 test requests + 1 usage request
|
||||
assert_equal 96, response_body["rate_limit"]["remaining"]
|
||||
assert response_body["rate_limit"]["reset_in_seconds"] > 0
|
||||
assert_not_nil response_body["rate_limit"]["reset_at"]
|
||||
end
|
||||
|
||||
test "should require read scope for usage endpoint" do
|
||||
# Create an API key without read scope (this shouldn't be possible with current validations, but let's test)
|
||||
api_key_no_read = ApiKey.new(
|
||||
user: @user,
|
||||
name: "No Read Key",
|
||||
scopes: [],
|
||||
display_key: "no_read_key_#{SecureRandom.hex(8)}"
|
||||
)
|
||||
# Skip validations to create invalid key for testing
|
||||
api_key_no_read.save(validate: false)
|
||||
|
||||
begin
|
||||
get "/api/v1/usage", headers: { "X-Api-Key" => api_key_no_read.display_key }
|
||||
assert_response :forbidden
|
||||
|
||||
response_body = JSON.parse(response.body)
|
||||
assert_equal "insufficient_scope", response_body["error"]
|
||||
ensure
|
||||
Redis.new.del("api_rate_limit:#{api_key_no_read.id}")
|
||||
api_key_no_read.destroy
|
||||
end
|
||||
end
|
||||
|
||||
test "should return correct message for OAuth authentication" do
|
||||
# This test would need OAuth setup, but for now we can mock it
|
||||
# For the current implementation, we'll test what happens with no authentication
|
||||
get "/api/v1/usage"
|
||||
assert_response :unauthorized
|
||||
end
|
||||
|
||||
test "should update usage count when accessing usage endpoint" do
|
||||
# Check initial state
|
||||
get "/api/v1/usage", headers: { "X-Api-Key" => @api_key.display_key }
|
||||
assert_response :success
|
||||
|
||||
response_body = JSON.parse(response.body)
|
||||
first_count = response_body["rate_limit"]["current_count"]
|
||||
|
||||
# Make another usage request
|
||||
get "/api/v1/usage", headers: { "X-Api-Key" => @api_key.display_key }
|
||||
assert_response :success
|
||||
|
||||
response_body = JSON.parse(response.body)
|
||||
second_count = response_body["rate_limit"]["current_count"]
|
||||
|
||||
assert_equal first_count + 1, second_count
|
||||
end
|
||||
|
||||
test "should include rate limit headers in usage response" do
|
||||
get "/api/v1/usage", headers: { "X-Api-Key" => @api_key.display_key }
|
||||
assert_response :success
|
||||
|
||||
assert_not_nil response.headers["X-RateLimit-Limit"]
|
||||
assert_not_nil response.headers["X-RateLimit-Remaining"]
|
||||
assert_not_nil response.headers["X-RateLimit-Reset"]
|
||||
|
||||
assert_equal "100", response.headers["X-RateLimit-Limit"]
|
||||
assert_equal "99", response.headers["X-RateLimit-Remaining"]
|
||||
end
|
||||
|
||||
test "should work correctly when approaching rate limit" do
|
||||
# Make 98 requests to get close to the limit
|
||||
98.times do
|
||||
get "/api/v1/test", headers: { "X-Api-Key" => @api_key.display_key }
|
||||
assert_response :success
|
||||
end
|
||||
|
||||
# Check usage - this should be request 99
|
||||
get "/api/v1/usage", headers: { "X-Api-Key" => @api_key.display_key }
|
||||
assert_response :success
|
||||
|
||||
response_body = JSON.parse(response.body)
|
||||
assert_equal 99, response_body["rate_limit"]["current_count"]
|
||||
assert_equal 1, response_body["rate_limit"]["remaining"]
|
||||
|
||||
# One more request should hit the limit
|
||||
get "/api/v1/test", headers: { "X-Api-Key" => @api_key.display_key }
|
||||
assert_response :success
|
||||
|
||||
# Now we should be rate limited
|
||||
get "/api/v1/usage", headers: { "X-Api-Key" => @api_key.display_key }
|
||||
assert_response :too_many_requests
|
||||
end
|
||||
end
|
||||
Loading…
Add table
Add a link
Reference in a new issue