mirror of
https://github.com/maybe-finance/maybe.git
synced 2025-07-19 05:09:38 +02:00
137 lines
4.7 KiB
Ruby
137 lines
4.7 KiB
Ruby
|
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
|