mirror of
https://github.com/maybe-finance/maybe.git
synced 2025-07-19 05:09:38 +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:
parent
13a64a1694
commit
b803ddac96
53 changed files with 4849 additions and 4 deletions
59
app/controllers/api/v1/accounts_controller.rb
Normal file
59
app/controllers/api/v1/accounts_controller.rb
Normal file
|
@ -0,0 +1,59 @@
|
|||
# frozen_string_literal: true
|
||||
|
||||
class Api::V1::AccountsController < Api::V1::BaseController
|
||||
include Pagy::Backend
|
||||
|
||||
# Ensure proper scope authorization for read access
|
||||
before_action :ensure_read_scope
|
||||
|
||||
def index
|
||||
# Test with Pagy pagination
|
||||
family = current_resource_owner.family
|
||||
accounts_query = family.accounts.active.alphabetically
|
||||
|
||||
# Handle pagination with Pagy
|
||||
@pagy, @accounts = pagy(
|
||||
accounts_query,
|
||||
page: safe_page_param,
|
||||
limit: safe_per_page_param
|
||||
)
|
||||
|
||||
@per_page = safe_per_page_param
|
||||
|
||||
# Rails will automatically use app/views/api/v1/accounts/index.json.jbuilder
|
||||
render :index
|
||||
rescue => e
|
||||
Rails.logger.error "AccountsController error: #{e.message}"
|
||||
Rails.logger.error e.backtrace.join("\n")
|
||||
|
||||
render json: {
|
||||
error: "internal_server_error",
|
||||
message: "Error: #{e.message}"
|
||||
}, status: :internal_server_error
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def ensure_read_scope
|
||||
authorize_scope!(:read)
|
||||
end
|
||||
|
||||
|
||||
|
||||
def safe_page_param
|
||||
page = params[:page].to_i
|
||||
page > 0 ? page : 1
|
||||
end
|
||||
|
||||
def safe_per_page_param
|
||||
per_page = params[:per_page].to_i
|
||||
|
||||
# Default to 25, max 100
|
||||
case per_page
|
||||
when 1..100
|
||||
per_page
|
||||
else
|
||||
25
|
||||
end
|
||||
end
|
||||
end
|
269
app/controllers/api/v1/base_controller.rb
Normal file
269
app/controllers/api/v1/base_controller.rb
Normal file
|
@ -0,0 +1,269 @@
|
|||
# frozen_string_literal: true
|
||||
|
||||
class Api::V1::BaseController < ApplicationController
|
||||
include Doorkeeper::Rails::Helpers
|
||||
|
||||
# Skip regular session-based authentication for API
|
||||
skip_authentication
|
||||
|
||||
# Skip onboarding requirements for API endpoints
|
||||
skip_before_action :require_onboarding_and_upgrade
|
||||
|
||||
# Force JSON format for all API requests
|
||||
before_action :force_json_format
|
||||
# Use our custom authentication that supports both OAuth and API keys
|
||||
before_action :authenticate_request!
|
||||
before_action :check_api_key_rate_limit
|
||||
before_action :log_api_access
|
||||
|
||||
|
||||
|
||||
# Override Doorkeeper's default behavior to return JSON instead of redirecting
|
||||
def doorkeeper_unauthorized_render_options(error: nil)
|
||||
{ json: { error: "unauthorized", message: "Access token is invalid, expired, or missing" } }
|
||||
end
|
||||
|
||||
# Error handling for common API errors
|
||||
rescue_from ActiveRecord::RecordNotFound, with: :handle_not_found
|
||||
rescue_from Doorkeeper::Errors::DoorkeeperError, with: :handle_unauthorized
|
||||
rescue_from ActionController::ParameterMissing, with: :handle_bad_request
|
||||
|
||||
private
|
||||
|
||||
# Force JSON format for all API requests
|
||||
def force_json_format
|
||||
request.format = :json
|
||||
end
|
||||
|
||||
# Authenticate using either OAuth or API key
|
||||
def authenticate_request!
|
||||
return if authenticate_oauth
|
||||
return if authenticate_api_key
|
||||
render_unauthorized unless performed?
|
||||
end
|
||||
|
||||
# Try OAuth authentication first
|
||||
def authenticate_oauth
|
||||
return false unless request.headers["Authorization"].present?
|
||||
|
||||
# Manually verify the token (bypassing doorkeeper_authorize! which had scope issues)
|
||||
token_string = request.authorization&.split(" ")&.last
|
||||
access_token = Doorkeeper::AccessToken.by_token(token_string)
|
||||
|
||||
# Check token validity and scope (read_write includes read access)
|
||||
has_sufficient_scope = access_token&.scopes&.include?("read") || access_token&.scopes&.include?("read_write")
|
||||
|
||||
unless access_token && !access_token.expired? && has_sufficient_scope
|
||||
render_json({ error: "unauthorized", message: "Access token is invalid, expired, or missing required scope" }, status: :unauthorized)
|
||||
return false
|
||||
end
|
||||
|
||||
# Set the doorkeeper_token for compatibility
|
||||
@_doorkeeper_token = access_token
|
||||
|
||||
if doorkeeper_token&.resource_owner_id
|
||||
@current_user = User.find_by(id: doorkeeper_token.resource_owner_id)
|
||||
|
||||
# If user doesn't exist, the token is invalid (user was deleted)
|
||||
unless @current_user
|
||||
Rails.logger.warn "API OAuth Token Invalid: Access token resource_owner_id #{doorkeeper_token.resource_owner_id} does not exist"
|
||||
render_json({ error: "unauthorized", message: "Access token is invalid - user not found" }, status: :unauthorized)
|
||||
return false
|
||||
end
|
||||
else
|
||||
Rails.logger.warn "API OAuth Token Invalid: Access token missing resource_owner_id"
|
||||
render_json({ error: "unauthorized", message: "Access token is invalid - missing resource owner" }, status: :unauthorized)
|
||||
return false
|
||||
end
|
||||
|
||||
@authentication_method = :oauth
|
||||
setup_current_context_for_api
|
||||
true
|
||||
rescue Doorkeeper::Errors::DoorkeeperError => e
|
||||
Rails.logger.warn "API OAuth Error: #{e.message}"
|
||||
false
|
||||
end
|
||||
|
||||
# Try API key authentication
|
||||
def authenticate_api_key
|
||||
api_key_value = request.headers["X-Api-Key"]
|
||||
return false unless api_key_value
|
||||
|
||||
@api_key = ApiKey.find_by_value(api_key_value)
|
||||
return false unless @api_key && @api_key.active?
|
||||
|
||||
@current_user = @api_key.user
|
||||
@api_key.update_last_used!
|
||||
@authentication_method = :api_key
|
||||
@rate_limiter = ApiRateLimiter.new(@api_key)
|
||||
setup_current_context_for_api
|
||||
true
|
||||
end
|
||||
|
||||
# Check rate limits for API key authentication
|
||||
def check_api_key_rate_limit
|
||||
return unless @authentication_method == :api_key && @rate_limiter
|
||||
|
||||
if @rate_limiter.rate_limit_exceeded?
|
||||
usage_info = @rate_limiter.usage_info
|
||||
render_rate_limit_exceeded(usage_info)
|
||||
return false
|
||||
end
|
||||
|
||||
# Increment request count for successful API key requests
|
||||
@rate_limiter.increment_request_count!
|
||||
|
||||
# Add rate limit headers to response
|
||||
add_rate_limit_headers(@rate_limiter.usage_info)
|
||||
end
|
||||
|
||||
# Render rate limit exceeded response
|
||||
def render_rate_limit_exceeded(usage_info)
|
||||
response.headers["X-RateLimit-Limit"] = usage_info[:rate_limit].to_s
|
||||
response.headers["X-RateLimit-Remaining"] = "0"
|
||||
response.headers["X-RateLimit-Reset"] = usage_info[:reset_time].to_s
|
||||
response.headers["Retry-After"] = usage_info[:reset_time].to_s
|
||||
|
||||
Rails.logger.warn "API Rate Limit Exceeded: API Key #{@api_key.name} (User: #{@current_user.email}) - #{usage_info[:current_count]}/#{usage_info[:rate_limit]} requests"
|
||||
|
||||
render_json({
|
||||
error: "rate_limit_exceeded",
|
||||
message: "Rate limit exceeded. Try again in #{usage_info[:reset_time]} seconds.",
|
||||
details: {
|
||||
limit: usage_info[:rate_limit],
|
||||
current: usage_info[:current_count],
|
||||
reset_in_seconds: usage_info[:reset_time]
|
||||
}
|
||||
}, status: :too_many_requests)
|
||||
end
|
||||
|
||||
# Add rate limit headers to successful responses
|
||||
def add_rate_limit_headers(usage_info)
|
||||
response.headers["X-RateLimit-Limit"] = usage_info[:rate_limit].to_s
|
||||
response.headers["X-RateLimit-Remaining"] = usage_info[:remaining].to_s
|
||||
response.headers["X-RateLimit-Reset"] = usage_info[:reset_time].to_s
|
||||
end
|
||||
|
||||
# Render unauthorized response
|
||||
def render_unauthorized
|
||||
render_json({ error: "unauthorized", message: "Access token or API key is invalid, expired, or missing" }, status: :unauthorized)
|
||||
end
|
||||
|
||||
# Returns the user that owns the access token or API key
|
||||
def current_resource_owner
|
||||
@current_user
|
||||
end
|
||||
|
||||
# Get current scopes from either authentication method
|
||||
def current_scopes
|
||||
case @authentication_method
|
||||
when :oauth
|
||||
doorkeeper_token&.scopes&.to_a || []
|
||||
when :api_key
|
||||
@api_key&.scopes || []
|
||||
else
|
||||
[]
|
||||
end
|
||||
end
|
||||
|
||||
# Check if the current authentication has the required scope
|
||||
# Implements hierarchical scope checking where read_write includes read access
|
||||
def authorize_scope!(required_scope)
|
||||
scopes = current_scopes
|
||||
|
||||
case required_scope.to_s
|
||||
when "read"
|
||||
# Read access requires either "read" or "read_write" scope
|
||||
has_access = scopes.include?("read") || scopes.include?("read_write")
|
||||
when "write"
|
||||
# Write access requires "read_write" scope
|
||||
has_access = scopes.include?("read_write")
|
||||
else
|
||||
# For any other scope, check exact match (backward compatibility)
|
||||
has_access = scopes.include?(required_scope.to_s)
|
||||
end
|
||||
|
||||
unless has_access
|
||||
Rails.logger.warn "API Insufficient Scope: User #{current_resource_owner&.email} attempted to access #{required_scope} but only has #{scopes}"
|
||||
render_json({ error: "insufficient_scope", message: "This action requires the '#{required_scope}' scope" }, status: :forbidden)
|
||||
return false
|
||||
end
|
||||
true
|
||||
end
|
||||
|
||||
# Consistent JSON response method
|
||||
def render_json(data, status: :ok)
|
||||
render json: data, status: status
|
||||
end
|
||||
|
||||
# Error handlers
|
||||
def handle_not_found(exception)
|
||||
Rails.logger.warn "API Record Not Found: #{exception.message}"
|
||||
render_json({ error: "record_not_found", message: "The requested resource was not found" }, status: :not_found)
|
||||
end
|
||||
|
||||
def handle_unauthorized(exception)
|
||||
Rails.logger.warn "API Unauthorized: #{exception.message}"
|
||||
render_json({ error: "unauthorized", message: "Access token is invalid or expired" }, status: :unauthorized)
|
||||
end
|
||||
|
||||
def handle_bad_request(exception)
|
||||
Rails.logger.warn "API Bad Request: #{exception.message}"
|
||||
render_json({ error: "bad_request", message: "Required parameters are missing or invalid" }, status: :bad_request)
|
||||
end
|
||||
|
||||
# Log API access for monitoring and debugging
|
||||
def log_api_access
|
||||
return unless current_resource_owner
|
||||
|
||||
auth_info = case @authentication_method
|
||||
when :oauth
|
||||
"OAuth Token"
|
||||
when :api_key
|
||||
"API Key: #{@api_key.name}"
|
||||
else
|
||||
"Unknown"
|
||||
end
|
||||
|
||||
Rails.logger.info "API Request: #{request.method} #{request.path} - User: #{current_resource_owner.email} (Family: #{current_resource_owner.family_id}) - Auth: #{auth_info}"
|
||||
end
|
||||
|
||||
# Family-based access control helper (to be used by subcontrollers)
|
||||
def ensure_current_family_access(resource)
|
||||
return unless resource.respond_to?(:family_id)
|
||||
|
||||
unless resource.family_id == current_resource_owner.family_id
|
||||
Rails.logger.warn "API Forbidden: User #{current_resource_owner.email} attempted to access resource from family #{resource.family_id}"
|
||||
render_json({ error: "forbidden", message: "Access denied to this resource" }, status: :forbidden)
|
||||
return false
|
||||
end
|
||||
|
||||
true
|
||||
end
|
||||
|
||||
# Manual doorkeeper_token accessor for compatibility with manual token verification
|
||||
def doorkeeper_token
|
||||
@_doorkeeper_token
|
||||
end
|
||||
|
||||
# Set up Current context for API requests since we don't use session-based auth
|
||||
def setup_current_context_for_api
|
||||
# For API requests, we need to create a minimal session-like object
|
||||
# or find/create an actual session for this user to make Current.user work
|
||||
if @current_user
|
||||
# Try to find an existing session for this user, or create a temporary one
|
||||
session = @current_user.sessions.first
|
||||
if session
|
||||
Current.session = session
|
||||
else
|
||||
# Create a temporary session for this API request
|
||||
# This won't be persisted but will allow Current.user to work
|
||||
session = @current_user.sessions.build(
|
||||
user_agent: request.user_agent,
|
||||
ip_address: request.ip
|
||||
)
|
||||
Current.session = session
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
47
app/controllers/api/v1/test_controller.rb
Normal file
47
app/controllers/api/v1/test_controller.rb
Normal file
|
@ -0,0 +1,47 @@
|
|||
# frozen_string_literal: true
|
||||
|
||||
# Test controller for API V1 Base Controller functionality
|
||||
# This controller is only used for testing the base controller behavior
|
||||
class Api::V1::TestController < Api::V1::BaseController
|
||||
def index
|
||||
render_json({ message: "test_success", user: current_resource_owner&.email })
|
||||
end
|
||||
|
||||
def not_found
|
||||
# Trigger RecordNotFound error for testing error handling
|
||||
raise ActiveRecord::RecordNotFound, "Test record not found"
|
||||
end
|
||||
|
||||
def family_access
|
||||
# Test family-based access control
|
||||
# Create a mock resource that belongs to a different family
|
||||
mock_resource = OpenStruct.new(family_id: 999) # Different family ID
|
||||
|
||||
# Check family access - if it returns false, it already rendered the error
|
||||
if ensure_current_family_access(mock_resource)
|
||||
# If we get here, access was allowed
|
||||
render_json({ family_id: current_resource_owner.family_id })
|
||||
end
|
||||
end
|
||||
|
||||
def scope_required
|
||||
# Test scope authorization - require write scope
|
||||
return unless authorize_scope!("write")
|
||||
|
||||
render_json({
|
||||
message: "scope_authorized",
|
||||
scopes: current_scopes,
|
||||
required_scope: "write"
|
||||
})
|
||||
end
|
||||
|
||||
def multiple_scopes_required
|
||||
# Test read scope requirement
|
||||
return unless authorize_scope!("read")
|
||||
|
||||
render_json({
|
||||
message: "read_scope_authorized",
|
||||
scopes: current_scopes
|
||||
})
|
||||
end
|
||||
end
|
327
app/controllers/api/v1/transactions_controller.rb
Normal file
327
app/controllers/api/v1/transactions_controller.rb
Normal file
|
@ -0,0 +1,327 @@
|
|||
# frozen_string_literal: true
|
||||
|
||||
class Api::V1::TransactionsController < Api::V1::BaseController
|
||||
include Pagy::Backend
|
||||
|
||||
# Ensure proper scope authorization for read vs write access
|
||||
before_action :ensure_read_scope, only: [ :index, :show ]
|
||||
before_action :ensure_write_scope, only: [ :create, :update, :destroy ]
|
||||
before_action :set_transaction, only: [ :show, :update, :destroy ]
|
||||
|
||||
def index
|
||||
family = current_resource_owner.family
|
||||
transactions_query = family.transactions.active
|
||||
|
||||
# Apply filters
|
||||
transactions_query = apply_filters(transactions_query)
|
||||
|
||||
# Apply search
|
||||
transactions_query = apply_search(transactions_query) if params[:search].present?
|
||||
|
||||
# Include necessary associations for efficient queries
|
||||
transactions_query = transactions_query.includes(
|
||||
{ entry: :account },
|
||||
:category, :merchant, :tags,
|
||||
transfer_as_outflow: { inflow_transaction: { entry: :account } },
|
||||
transfer_as_inflow: { outflow_transaction: { entry: :account } }
|
||||
).reverse_chronological
|
||||
|
||||
# Handle pagination with Pagy
|
||||
@pagy, @transactions = pagy(
|
||||
transactions_query,
|
||||
page: safe_page_param,
|
||||
limit: safe_per_page_param
|
||||
)
|
||||
|
||||
# Make per_page available to the template
|
||||
@per_page = safe_per_page_param
|
||||
|
||||
# Rails will automatically use app/views/api/v1/transactions/index.json.jbuilder
|
||||
render :index
|
||||
|
||||
rescue => e
|
||||
Rails.logger.error "TransactionsController#index error: #{e.message}"
|
||||
Rails.logger.error e.backtrace.join("\n")
|
||||
|
||||
render json: {
|
||||
error: "internal_server_error",
|
||||
message: "Error: #{e.message}"
|
||||
}, status: :internal_server_error
|
||||
end
|
||||
|
||||
def show
|
||||
# Rails will automatically use app/views/api/v1/transactions/show.json.jbuilder
|
||||
render :show
|
||||
|
||||
rescue => e
|
||||
Rails.logger.error "TransactionsController#show error: #{e.message}"
|
||||
Rails.logger.error e.backtrace.join("\n")
|
||||
|
||||
render json: {
|
||||
error: "internal_server_error",
|
||||
message: "Error: #{e.message}"
|
||||
}, status: :internal_server_error
|
||||
end
|
||||
|
||||
def create
|
||||
family = current_resource_owner.family
|
||||
|
||||
# Validate account_id is present
|
||||
unless transaction_params[:account_id].present?
|
||||
render json: {
|
||||
error: "validation_failed",
|
||||
message: "Account ID is required",
|
||||
errors: [ "Account ID is required" ]
|
||||
}, status: :unprocessable_entity
|
||||
return
|
||||
end
|
||||
|
||||
account = family.accounts.find(transaction_params[:account_id])
|
||||
@entry = account.entries.new(entry_params_for_create)
|
||||
|
||||
if @entry.save
|
||||
@entry.sync_account_later
|
||||
@entry.lock_saved_attributes!
|
||||
@entry.transaction.lock_attr!(:tag_ids) if @entry.transaction.tags.any?
|
||||
|
||||
@transaction = @entry.transaction
|
||||
render :show, status: :created
|
||||
else
|
||||
render json: {
|
||||
error: "validation_failed",
|
||||
message: "Transaction could not be created",
|
||||
errors: @entry.errors.full_messages
|
||||
}, status: :unprocessable_entity
|
||||
end
|
||||
|
||||
rescue => e
|
||||
Rails.logger.error "TransactionsController#create error: #{e.message}"
|
||||
Rails.logger.error e.backtrace.join("\n")
|
||||
|
||||
render json: {
|
||||
error: "internal_server_error",
|
||||
message: "Error: #{e.message}"
|
||||
}, status: :internal_server_error
|
||||
end
|
||||
|
||||
def update
|
||||
if @entry.update(entry_params_for_update)
|
||||
@entry.sync_account_later
|
||||
@entry.lock_saved_attributes!
|
||||
@entry.transaction.lock_attr!(:tag_ids) if @entry.transaction.tags.any?
|
||||
|
||||
@transaction = @entry.transaction
|
||||
render :show
|
||||
else
|
||||
render json: {
|
||||
error: "validation_failed",
|
||||
message: "Transaction could not be updated",
|
||||
errors: @entry.errors.full_messages
|
||||
}, status: :unprocessable_entity
|
||||
end
|
||||
|
||||
rescue => e
|
||||
Rails.logger.error "TransactionsController#update error: #{e.message}"
|
||||
Rails.logger.error e.backtrace.join("\n")
|
||||
|
||||
render json: {
|
||||
error: "internal_server_error",
|
||||
message: "Error: #{e.message}"
|
||||
}, status: :internal_server_error
|
||||
end
|
||||
|
||||
def destroy
|
||||
@entry.destroy!
|
||||
@entry.sync_account_later
|
||||
|
||||
render json: {
|
||||
message: "Transaction deleted successfully"
|
||||
}, status: :ok
|
||||
|
||||
rescue => e
|
||||
Rails.logger.error "TransactionsController#destroy error: #{e.message}"
|
||||
Rails.logger.error e.backtrace.join("\n")
|
||||
|
||||
render json: {
|
||||
error: "internal_server_error",
|
||||
message: "Error: #{e.message}"
|
||||
}, status: :internal_server_error
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def set_transaction
|
||||
family = current_resource_owner.family
|
||||
@transaction = family.transactions.find(params[:id])
|
||||
@entry = @transaction.entry
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render json: {
|
||||
error: "not_found",
|
||||
message: "Transaction not found"
|
||||
}, status: :not_found
|
||||
end
|
||||
|
||||
def ensure_read_scope
|
||||
authorize_scope!(:read)
|
||||
end
|
||||
|
||||
def ensure_write_scope
|
||||
authorize_scope!(:write)
|
||||
end
|
||||
|
||||
def apply_filters(query)
|
||||
# Account filtering
|
||||
if params[:account_id].present?
|
||||
query = query.joins(:entry).where(entries: { account_id: params[:account_id] })
|
||||
end
|
||||
|
||||
if params[:account_ids].present?
|
||||
account_ids = Array(params[:account_ids])
|
||||
query = query.joins(:entry).where(entries: { account_id: account_ids })
|
||||
end
|
||||
|
||||
# Category filtering
|
||||
if params[:category_id].present?
|
||||
query = query.where(category_id: params[:category_id])
|
||||
end
|
||||
|
||||
if params[:category_ids].present?
|
||||
category_ids = Array(params[:category_ids])
|
||||
query = query.where(category_id: category_ids)
|
||||
end
|
||||
|
||||
# Merchant filtering
|
||||
if params[:merchant_id].present?
|
||||
query = query.where(merchant_id: params[:merchant_id])
|
||||
end
|
||||
|
||||
if params[:merchant_ids].present?
|
||||
merchant_ids = Array(params[:merchant_ids])
|
||||
query = query.where(merchant_id: merchant_ids)
|
||||
end
|
||||
|
||||
# Date range filtering
|
||||
if params[:start_date].present?
|
||||
query = query.joins(:entry).where("entries.date >= ?", Date.parse(params[:start_date]))
|
||||
end
|
||||
|
||||
if params[:end_date].present?
|
||||
query = query.joins(:entry).where("entries.date <= ?", Date.parse(params[:end_date]))
|
||||
end
|
||||
|
||||
# Amount filtering
|
||||
if params[:min_amount].present?
|
||||
min_amount = params[:min_amount].to_f
|
||||
query = query.joins(:entry).where("entries.amount >= ?", min_amount)
|
||||
end
|
||||
|
||||
if params[:max_amount].present?
|
||||
max_amount = params[:max_amount].to_f
|
||||
query = query.joins(:entry).where("entries.amount <= ?", max_amount)
|
||||
end
|
||||
|
||||
# Tag filtering
|
||||
if params[:tag_ids].present?
|
||||
tag_ids = Array(params[:tag_ids])
|
||||
query = query.joins(:tags).where(tags: { id: tag_ids })
|
||||
end
|
||||
|
||||
# Transaction type filtering (income/expense)
|
||||
if params[:type].present?
|
||||
case params[:type].downcase
|
||||
when "income"
|
||||
query = query.joins(:entry).where("entries.amount < 0")
|
||||
when "expense"
|
||||
query = query.joins(:entry).where("entries.amount > 0")
|
||||
end
|
||||
end
|
||||
|
||||
query
|
||||
end
|
||||
|
||||
def apply_search(query)
|
||||
search_term = "%#{params[:search]}%"
|
||||
|
||||
query.joins(:entry)
|
||||
.left_joins(:merchant)
|
||||
.where(
|
||||
"entries.name ILIKE ? OR entries.notes ILIKE ? OR merchants.name ILIKE ?",
|
||||
search_term, search_term, search_term
|
||||
)
|
||||
end
|
||||
|
||||
def transaction_params
|
||||
params.require(:transaction).permit(
|
||||
:account_id, :date, :amount, :name, :description, :notes, :currency,
|
||||
:category_id, :merchant_id, :nature, tag_ids: []
|
||||
)
|
||||
end
|
||||
|
||||
def entry_params_for_create
|
||||
entry_params = {
|
||||
name: transaction_params[:name] || transaction_params[:description],
|
||||
date: transaction_params[:date],
|
||||
amount: calculate_signed_amount,
|
||||
currency: transaction_params[:currency] || current_resource_owner.family.currency,
|
||||
notes: transaction_params[:notes],
|
||||
entryable_type: "Transaction",
|
||||
entryable_attributes: {
|
||||
category_id: transaction_params[:category_id],
|
||||
merchant_id: transaction_params[:merchant_id],
|
||||
tag_ids: transaction_params[:tag_ids] || []
|
||||
}
|
||||
}
|
||||
|
||||
entry_params.compact
|
||||
end
|
||||
|
||||
def entry_params_for_update
|
||||
entry_params = {
|
||||
name: transaction_params[:name] || transaction_params[:description],
|
||||
date: transaction_params[:date],
|
||||
notes: transaction_params[:notes],
|
||||
entryable_attributes: {
|
||||
id: @entry.entryable_id,
|
||||
category_id: transaction_params[:category_id],
|
||||
merchant_id: transaction_params[:merchant_id],
|
||||
tag_ids: transaction_params[:tag_ids]
|
||||
}.compact_blank
|
||||
}
|
||||
|
||||
# Only update amount if provided
|
||||
if transaction_params[:amount].present?
|
||||
entry_params[:amount] = calculate_signed_amount
|
||||
end
|
||||
|
||||
entry_params.compact
|
||||
end
|
||||
|
||||
def calculate_signed_amount
|
||||
amount = transaction_params[:amount].to_f
|
||||
nature = transaction_params[:nature]
|
||||
|
||||
case nature&.downcase
|
||||
when "income", "inflow"
|
||||
-amount.abs # Income is negative
|
||||
when "expense", "outflow"
|
||||
amount.abs # Expense is positive
|
||||
else
|
||||
amount # Use as provided
|
||||
end
|
||||
end
|
||||
|
||||
def safe_page_param
|
||||
page = params[:page].to_i
|
||||
page > 0 ? page : 1
|
||||
end
|
||||
|
||||
def safe_per_page_param
|
||||
per_page = params[:per_page].to_i
|
||||
case per_page
|
||||
when 1..100
|
||||
per_page
|
||||
else
|
||||
25 # Default
|
||||
end
|
||||
end
|
||||
end
|
38
app/controllers/api/v1/usage_controller.rb
Normal file
38
app/controllers/api/v1/usage_controller.rb
Normal file
|
@ -0,0 +1,38 @@
|
|||
class Api::V1::UsageController < Api::V1::BaseController
|
||||
# GET /api/v1/usage
|
||||
def show
|
||||
return unless authorize_scope!(:read)
|
||||
|
||||
case @authentication_method
|
||||
when :api_key
|
||||
usage_info = @rate_limiter.usage_info
|
||||
render_json({
|
||||
api_key: {
|
||||
name: @api_key.name,
|
||||
scopes: @api_key.scopes,
|
||||
last_used_at: @api_key.last_used_at,
|
||||
created_at: @api_key.created_at
|
||||
},
|
||||
rate_limit: {
|
||||
tier: usage_info[:tier],
|
||||
limit: usage_info[:rate_limit],
|
||||
current_count: usage_info[:current_count],
|
||||
remaining: usage_info[:remaining],
|
||||
reset_in_seconds: usage_info[:reset_time],
|
||||
reset_at: Time.current + usage_info[:reset_time].seconds
|
||||
}
|
||||
})
|
||||
when :oauth
|
||||
# For OAuth, we don't track detailed usage yet, but we can return basic info
|
||||
render_json({
|
||||
authentication_method: "oauth",
|
||||
message: "Detailed usage tracking is available for API key authentication"
|
||||
})
|
||||
else
|
||||
render_json({
|
||||
error: "invalid_authentication_method",
|
||||
message: "Unable to determine usage information"
|
||||
}, status: :bad_request)
|
||||
end
|
||||
end
|
||||
end
|
|
@ -25,6 +25,7 @@ module Onboardable
|
|||
return false if path.starts_with?("/subscription")
|
||||
return false if path.starts_with?("/onboarding")
|
||||
return false if path.starts_with?("/users")
|
||||
return false if path.starts_with?("/api") # Exclude API endpoints from onboarding redirects
|
||||
|
||||
[
|
||||
new_registration_path,
|
||||
|
|
61
app/controllers/settings/api_keys_controller.rb
Normal file
61
app/controllers/settings/api_keys_controller.rb
Normal file
|
@ -0,0 +1,61 @@
|
|||
# frozen_string_literal: true
|
||||
|
||||
class Settings::ApiKeysController < ApplicationController
|
||||
layout "settings"
|
||||
|
||||
before_action :set_api_key, only: [ :show, :destroy ]
|
||||
|
||||
def show
|
||||
@current_api_key = @api_key
|
||||
end
|
||||
|
||||
def new
|
||||
# Allow regeneration by not redirecting if user explicitly wants to create a new key
|
||||
# Only redirect if user stumbles onto new page without explicit intent
|
||||
redirect_to settings_api_key_path if Current.user.api_keys.active.exists? && !params[:regenerate]
|
||||
@api_key = ApiKey.new
|
||||
end
|
||||
|
||||
def create
|
||||
@plain_key = ApiKey.generate_secure_key
|
||||
@api_key = Current.user.api_keys.build(api_key_params)
|
||||
@api_key.key = @plain_key
|
||||
|
||||
# Temporarily revoke existing keys for validation to pass
|
||||
existing_keys = Current.user.api_keys.active
|
||||
existing_keys.each { |key| key.update_column(:revoked_at, Time.current) }
|
||||
|
||||
if @api_key.save
|
||||
flash[:notice] = "Your API key has been created successfully"
|
||||
redirect_to settings_api_key_path
|
||||
else
|
||||
# Restore existing keys if new key creation failed
|
||||
existing_keys.each { |key| key.update_column(:revoked_at, nil) }
|
||||
render :new, status: :unprocessable_entity
|
||||
end
|
||||
end
|
||||
|
||||
def destroy
|
||||
if @api_key&.revoke!
|
||||
flash[:notice] = "API key has been revoked successfully"
|
||||
else
|
||||
flash[:alert] = "Failed to revoke API key"
|
||||
end
|
||||
redirect_to settings_api_key_path
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def set_api_key
|
||||
@api_key = Current.user.api_keys.active.first
|
||||
end
|
||||
|
||||
def api_key_params
|
||||
# Convert single scope value to array for storage
|
||||
permitted_params = params.require(:api_key).permit(:name, :scopes)
|
||||
if permitted_params[:scopes].present?
|
||||
permitted_params[:scopes] = [ permitted_params[:scopes] ]
|
||||
end
|
||||
permitted_params
|
||||
end
|
||||
end
|
|
@ -4,6 +4,7 @@ module SettingsHelper
|
|||
{ name: I18n.t("settings.settings_nav.preferences_label"), path: :settings_preferences_path },
|
||||
{ name: I18n.t("settings.settings_nav.security_label"), path: :settings_security_path },
|
||||
{ name: I18n.t("settings.settings_nav.self_hosting_label"), path: :settings_hosting_path, condition: :self_hosted? },
|
||||
{ name: "API Key", path: :settings_api_key_path },
|
||||
{ name: I18n.t("settings.settings_nav.billing_label"), path: :settings_billing_path, condition: :not_self_hosted? },
|
||||
{ name: I18n.t("settings.settings_nav.accounts_label"), path: :accounts_path },
|
||||
{ name: I18n.t("settings.settings_nav.imports_label"), path: :imports_path },
|
||||
|
|
90
app/models/api_key.rb
Normal file
90
app/models/api_key.rb
Normal file
|
@ -0,0 +1,90 @@
|
|||
class ApiKey < ApplicationRecord
|
||||
belongs_to :user
|
||||
|
||||
# Use Rails built-in encryption for secure storage
|
||||
encrypts :display_key, deterministic: true
|
||||
|
||||
# Validations
|
||||
validates :display_key, presence: true, uniqueness: true
|
||||
validates :name, presence: true
|
||||
validates :scopes, presence: true
|
||||
validate :scopes_not_empty
|
||||
validate :one_active_key_per_user, on: :create
|
||||
|
||||
# Callbacks
|
||||
before_validation :set_display_key
|
||||
|
||||
# Scopes
|
||||
scope :active, -> { where(revoked_at: nil).where("expires_at IS NULL OR expires_at > ?", Time.current) }
|
||||
|
||||
# Class methods
|
||||
def self.find_by_value(plain_key)
|
||||
return nil unless plain_key
|
||||
|
||||
# Find by encrypted display_key (deterministic encryption allows querying)
|
||||
find_by(display_key: plain_key)&.tap do |api_key|
|
||||
return api_key if api_key.active?
|
||||
end
|
||||
end
|
||||
|
||||
def self.generate_secure_key
|
||||
SecureRandom.hex(32)
|
||||
end
|
||||
|
||||
# Instance methods
|
||||
def active?
|
||||
!revoked? && !expired?
|
||||
end
|
||||
|
||||
def revoked?
|
||||
revoked_at.present?
|
||||
end
|
||||
|
||||
def expired?
|
||||
expires_at.present? && expires_at < Time.current
|
||||
end
|
||||
|
||||
def key_matches?(plain_key)
|
||||
display_key == plain_key
|
||||
end
|
||||
|
||||
def revoke!
|
||||
update!(revoked_at: Time.current)
|
||||
end
|
||||
|
||||
def update_last_used!
|
||||
update_column(:last_used_at, Time.current)
|
||||
end
|
||||
|
||||
# Get the plain text API key for display (automatically decrypted by Rails)
|
||||
def plain_key
|
||||
display_key
|
||||
end
|
||||
|
||||
# Temporarily store the plain key for creation flow
|
||||
attr_accessor :key
|
||||
|
||||
private
|
||||
|
||||
def set_display_key
|
||||
if key.present?
|
||||
self.display_key = key
|
||||
end
|
||||
end
|
||||
|
||||
def scopes_not_empty
|
||||
if scopes.blank? || (scopes.is_a?(Array) && (scopes.empty? || scopes.all?(&:blank?)))
|
||||
errors.add(:scopes, "must include at least one permission")
|
||||
elsif scopes.is_a?(Array) && scopes.length > 1
|
||||
errors.add(:scopes, "can only have one permission level")
|
||||
elsif scopes.is_a?(Array) && !%w[read read_write].include?(scopes.first)
|
||||
errors.add(:scopes, "must be either 'read' or 'read_write'")
|
||||
end
|
||||
end
|
||||
|
||||
def one_active_key_per_user
|
||||
if user&.api_keys&.active&.where&.not(id: id)&.exists?
|
||||
errors.add(:user, "can only have one active API key")
|
||||
end
|
||||
end
|
||||
end
|
|
@ -5,6 +5,7 @@ class User < ApplicationRecord
|
|||
belongs_to :last_viewed_chat, class_name: "Chat", optional: true
|
||||
has_many :sessions, dependent: :destroy
|
||||
has_many :chats, dependent: :destroy
|
||||
has_many :api_keys, dependent: :destroy
|
||||
has_many :invitations, foreign_key: :inviter_id, dependent: :destroy
|
||||
has_many :impersonator_support_sessions, class_name: "ImpersonationSession", foreign_key: :impersonator_id, dependent: :destroy
|
||||
has_many :impersonated_support_sessions, class_name: "ImpersonationSession", foreign_key: :impersonated_id, dependent: :destroy
|
||||
|
|
85
app/services/api_rate_limiter.rb
Normal file
85
app/services/api_rate_limiter.rb
Normal file
|
@ -0,0 +1,85 @@
|
|||
class ApiRateLimiter
|
||||
# Rate limit tiers (requests per hour)
|
||||
RATE_LIMITS = {
|
||||
standard: 100,
|
||||
premium: 1000,
|
||||
enterprise: 10000
|
||||
}.freeze
|
||||
|
||||
DEFAULT_TIER = :standard
|
||||
|
||||
def initialize(api_key)
|
||||
@api_key = api_key
|
||||
@redis = Redis.new
|
||||
end
|
||||
|
||||
# Check if the API key has exceeded its rate limit
|
||||
def rate_limit_exceeded?
|
||||
current_count >= rate_limit
|
||||
end
|
||||
|
||||
# Increment the request count for this API key
|
||||
def increment_request_count!
|
||||
key = redis_key
|
||||
current_time = Time.current.to_i
|
||||
window_start = (current_time / 3600) * 3600 # Hourly window
|
||||
|
||||
@redis.multi do |transaction|
|
||||
# Use a sliding window with hourly buckets
|
||||
transaction.hincrby(key, window_start.to_s, 1)
|
||||
transaction.expire(key, 7200) # Keep data for 2 hours to handle sliding window
|
||||
end
|
||||
end
|
||||
|
||||
# Get current request count within the current hour
|
||||
def current_count
|
||||
key = redis_key
|
||||
current_time = Time.current.to_i
|
||||
window_start = (current_time / 3600) * 3600
|
||||
|
||||
count = @redis.hget(key, window_start.to_s)
|
||||
count.to_i
|
||||
end
|
||||
|
||||
# Get the rate limit for this API key's tier
|
||||
def rate_limit
|
||||
tier = determine_tier
|
||||
RATE_LIMITS[tier]
|
||||
end
|
||||
|
||||
# Calculate seconds until the rate limit resets
|
||||
def reset_time
|
||||
current_time = Time.current.to_i
|
||||
next_window = ((current_time / 3600) + 1) * 3600
|
||||
next_window - current_time
|
||||
end
|
||||
|
||||
# Get detailed usage information
|
||||
def usage_info
|
||||
{
|
||||
current_count: current_count,
|
||||
rate_limit: rate_limit,
|
||||
remaining: [ rate_limit - current_count, 0 ].max,
|
||||
reset_time: reset_time,
|
||||
tier: determine_tier
|
||||
}
|
||||
end
|
||||
|
||||
# Class method to get usage for an API key without incrementing
|
||||
def self.usage_for(api_key)
|
||||
new(api_key).usage_info
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def redis_key
|
||||
"api_rate_limit:#{@api_key.id}"
|
||||
end
|
||||
|
||||
def determine_tier
|
||||
# For now, all API keys are standard tier
|
||||
# This can be extended later to support different tiers based on user subscription
|
||||
# or API key configuration
|
||||
DEFAULT_TIER
|
||||
end
|
||||
end
|
17
app/views/api/v1/accounts/index.json.jbuilder
Normal file
17
app/views/api/v1/accounts/index.json.jbuilder
Normal file
|
@ -0,0 +1,17 @@
|
|||
# frozen_string_literal: true
|
||||
|
||||
json.accounts @accounts do |account|
|
||||
json.id account.id
|
||||
json.name account.name
|
||||
json.balance account.balance_money.format
|
||||
json.currency account.currency
|
||||
json.classification account.classification
|
||||
json.account_type account.accountable_type.underscore
|
||||
end
|
||||
|
||||
json.pagination do
|
||||
json.page @pagy.page
|
||||
json.per_page @per_page
|
||||
json.total_count @pagy.count
|
||||
json.total_pages @pagy.pages
|
||||
end
|
76
app/views/api/v1/transactions/_transaction.json.jbuilder
Normal file
76
app/views/api/v1/transactions/_transaction.json.jbuilder
Normal file
|
@ -0,0 +1,76 @@
|
|||
# frozen_string_literal: true
|
||||
|
||||
json.id transaction.id
|
||||
json.date transaction.entry.date
|
||||
json.amount transaction.entry.amount_money.format
|
||||
json.currency transaction.entry.currency
|
||||
json.name transaction.entry.name
|
||||
json.notes transaction.entry.notes
|
||||
json.classification transaction.entry.classification
|
||||
|
||||
# Account information
|
||||
json.account do
|
||||
json.id transaction.entry.account.id
|
||||
json.name transaction.entry.account.name
|
||||
json.account_type transaction.entry.account.accountable_type.underscore
|
||||
end
|
||||
|
||||
# Category information
|
||||
if transaction.category.present?
|
||||
json.category do
|
||||
json.id transaction.category.id
|
||||
json.name transaction.category.name
|
||||
json.classification transaction.category.classification
|
||||
json.color transaction.category.color
|
||||
json.icon transaction.category.lucide_icon
|
||||
end
|
||||
else
|
||||
json.category nil
|
||||
end
|
||||
|
||||
# Merchant information
|
||||
if transaction.merchant.present?
|
||||
json.merchant do
|
||||
json.id transaction.merchant.id
|
||||
json.name transaction.merchant.name
|
||||
end
|
||||
else
|
||||
json.merchant nil
|
||||
end
|
||||
|
||||
# Tags
|
||||
json.tags transaction.tags do |tag|
|
||||
json.id tag.id
|
||||
json.name tag.name
|
||||
json.color tag.color
|
||||
end
|
||||
|
||||
# Transfer information (if this transaction is part of a transfer)
|
||||
if transaction.transfer.present?
|
||||
json.transfer do
|
||||
json.id transaction.transfer.id
|
||||
json.amount transaction.transfer.amount_abs.format
|
||||
json.currency transaction.transfer.inflow_transaction.entry.currency
|
||||
|
||||
# Other transaction in the transfer
|
||||
if transaction.transfer.inflow_transaction == transaction
|
||||
other_transaction = transaction.transfer.outflow_transaction
|
||||
else
|
||||
other_transaction = transaction.transfer.inflow_transaction
|
||||
end
|
||||
|
||||
if other_transaction.present?
|
||||
json.other_account do
|
||||
json.id other_transaction.entry.account.id
|
||||
json.name other_transaction.entry.account.name
|
||||
json.account_type other_transaction.entry.account.accountable_type.underscore
|
||||
end
|
||||
end
|
||||
end
|
||||
else
|
||||
json.transfer nil
|
||||
end
|
||||
|
||||
# Additional metadata
|
||||
json.created_at transaction.created_at.iso8601
|
||||
json.updated_at transaction.updated_at.iso8601
|
12
app/views/api/v1/transactions/index.json.jbuilder
Normal file
12
app/views/api/v1/transactions/index.json.jbuilder
Normal file
|
@ -0,0 +1,12 @@
|
|||
# frozen_string_literal: true
|
||||
|
||||
json.transactions @transactions do |transaction|
|
||||
json.partial! "transaction", transaction: transaction
|
||||
end
|
||||
|
||||
json.pagination do
|
||||
json.page @pagy.page
|
||||
json.per_page @per_page
|
||||
json.total_count @pagy.count
|
||||
json.total_pages @pagy.pages
|
||||
end
|
3
app/views/api/v1/transactions/show.json.jbuilder
Normal file
3
app/views/api/v1/transactions/show.json.jbuilder
Normal file
|
@ -0,0 +1,3 @@
|
|||
# frozen_string_literal: true
|
||||
|
||||
json.partial! "transaction", transaction: @transaction
|
|
@ -6,6 +6,7 @@ nav_sections = [
|
|||
{ label: t(".profile_label"), path: settings_profile_path, icon: "circle-user" },
|
||||
{ label: t(".preferences_label"), path: settings_preferences_path, icon: "bolt" },
|
||||
{ label: t(".security_label"), path: settings_security_path, icon: "shield-check" },
|
||||
{ label: "API Key", path: settings_api_key_path, icon: "key" },
|
||||
{ label: t(".self_hosting_label"), path: settings_hosting_path, icon: "database", if: self_hosted? },
|
||||
{ label: t(".billing_label"), path: settings_billing_path, icon: "circle-dollar-sign", if: !self_hosted? },
|
||||
{ label: t(".accounts_label"), path: accounts_path, icon: "layers" },
|
||||
|
|
94
app/views/settings/api_keys/created.html.erb
Normal file
94
app/views/settings/api_keys/created.html.erb
Normal file
|
@ -0,0 +1,94 @@
|
|||
<%= content_for :page_title, "API Key Created" %>
|
||||
|
||||
<%= settings_section title: "API Key Created Successfully", subtitle: "Your new API key has been generated successfully." do %>
|
||||
<div class="space-y-4">
|
||||
<div class="p-3 shadow-border-xs bg-container rounded-lg">
|
||||
<div class="flex items-start gap-3">
|
||||
<%= render FilledIconComponent.new(
|
||||
icon: "check-circle",
|
||||
rounded: true,
|
||||
size: "lg",
|
||||
variant: :success
|
||||
) %>
|
||||
<div class="flex-1">
|
||||
<h3 class="font-medium text-primary">API Key Created Successfully!</h3>
|
||||
<p class="text-secondary text-sm mt-1">Your new API key "<%= @api_key.name %>" has been created and is ready to use.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-surface-inset rounded-xl p-4">
|
||||
<h4 class="font-medium text-primary mb-3">Your API Key</h4>
|
||||
<p class="text-secondary text-sm mb-3">Copy and store this key securely. You'll need it to authenticate your API requests.</p>
|
||||
|
||||
<div class="bg-container rounded-lg p-3 border border-primary" data-controller="clipboard">
|
||||
<div class="flex items-center justify-between gap-3">
|
||||
<code id="api-key-display" class="font-mono text-sm text-primary break-all" data-clipboard-target="source"><%= @api_key.plain_key %></code>
|
||||
<%= render ButtonComponent.new(
|
||||
text: "Copy API Key",
|
||||
variant: "ghost",
|
||||
icon: "copy",
|
||||
data: { action: "clipboard#copy" }
|
||||
) %>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-surface-inset rounded-xl p-4">
|
||||
<h4 class="font-medium text-primary mb-3">Key Details</h4>
|
||||
<div class="space-y-2 text-sm">
|
||||
<div class="flex justify-between">
|
||||
<span class="text-secondary">Name:</span>
|
||||
<span class="text-primary font-medium"><%= @api_key.name %></span>
|
||||
</div>
|
||||
<div class="flex justify-between">
|
||||
<span class="text-secondary">Permissions:</span>
|
||||
<span class="text-primary">
|
||||
<%= @api_key.scopes.map { |scope|
|
||||
case scope
|
||||
when "read_accounts" then "View Accounts"
|
||||
when "read_transactions" then "View Transactions"
|
||||
when "read_balances" then "View Balances"
|
||||
when "write_transactions" then "Create Transactions"
|
||||
else scope.humanize
|
||||
end
|
||||
}.join(", ") %>
|
||||
</span>
|
||||
</div>
|
||||
<div class="flex justify-between">
|
||||
<span class="text-secondary">Created:</span>
|
||||
<span class="text-primary"><%= @api_key.created_at.strftime("%B %d, %Y at %I:%M %p") %></span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-warning-50 border border-warning-200 rounded-xl p-4">
|
||||
<div class="flex items-start gap-2">
|
||||
<%= icon("alert-triangle", class: "w-5 h-5 text-warning-600 mt-0.5") %>
|
||||
<div>
|
||||
<h4 class="font-medium text-warning-800 text-sm">Important Security Note</h4>
|
||||
<p class="text-warning-700 text-sm mt-1">
|
||||
This is the only time your API key will be displayed. Make sure to copy it now and store it securely.
|
||||
If you lose this key, you'll need to generate a new one.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-surface-inset rounded-xl p-4">
|
||||
<h4 class="font-medium text-primary mb-3">How to use your API key</h4>
|
||||
<p class="text-secondary text-sm mb-3">Include your API key in the X-Api-Key header when making requests:</p>
|
||||
<div class="bg-container rounded-lg p-3 font-mono text-sm text-primary border border-primary">
|
||||
curl -H "X-Api-Key: <%= @api_key.plain_key %>" <%= request.base_url %>/api/v1/accounts
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-end pt-4 border-t border-primary">
|
||||
<%= render LinkComponent.new(
|
||||
text: "Continue to API Key Settings",
|
||||
href: settings_api_key_path,
|
||||
variant: "primary"
|
||||
) %>
|
||||
</div>
|
||||
</div>
|
||||
<% end %>
|
102
app/views/settings/api_keys/created.turbo_stream.erb
Normal file
102
app/views/settings/api_keys/created.turbo_stream.erb
Normal file
|
@ -0,0 +1,102 @@
|
|||
<%= turbo_stream.update "main" do %>
|
||||
<div class="relative max-w-4xl mx-auto flex flex-col w-full h-full">
|
||||
<div class="grow space-y-4 overflow-y-auto -mx-1 px-1 pb-12">
|
||||
<h1 class="text-primary text-3xl md:text-xl font-medium">
|
||||
API Key Created
|
||||
</h1>
|
||||
|
||||
<%= settings_section title: "API Key Created Successfully", subtitle: "Your new API key has been generated successfully." do %>
|
||||
<div class="space-y-4">
|
||||
<div class="p-3 shadow-border-xs bg-container rounded-lg">
|
||||
<div class="flex items-start gap-3">
|
||||
<%= render FilledIconComponent.new(
|
||||
icon: "check-circle",
|
||||
rounded: true,
|
||||
size: "lg",
|
||||
variant: :success
|
||||
) %>
|
||||
<div class="flex-1">
|
||||
<h3 class="font-medium text-primary">API Key Created Successfully!</h3>
|
||||
<p class="text-secondary text-sm mt-1">Your new API key "<%= @api_key.name %>" has been created and is ready to use.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-surface-inset rounded-xl p-4">
|
||||
<h4 class="font-medium text-primary mb-3">Your API Key</h4>
|
||||
<p class="text-secondary text-sm mb-3">Copy and store this key securely. You'll need it to authenticate your API requests.</p>
|
||||
|
||||
<div class="bg-container rounded-lg p-3 border border-primary" data-controller="clipboard">
|
||||
<div class="flex items-center justify-between gap-3">
|
||||
<code id="api-key-display" class="font-mono text-sm text-primary break-all" data-clipboard-target="source"><%= @api_key.plain_key %></code>
|
||||
<%= render ButtonComponent.new(
|
||||
text: "Copy API Key",
|
||||
variant: "ghost",
|
||||
icon: "copy",
|
||||
data: { action: "clipboard#copy" }
|
||||
) %>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-surface-inset rounded-xl p-4">
|
||||
<h4 class="font-medium text-primary mb-3">Key Details</h4>
|
||||
<div class="space-y-2 text-sm">
|
||||
<div class="flex justify-between">
|
||||
<span class="text-secondary">Name:</span>
|
||||
<span class="text-primary font-medium"><%= @api_key.name %></span>
|
||||
</div>
|
||||
<div class="flex justify-between">
|
||||
<span class="text-secondary">Permissions:</span>
|
||||
<span class="text-primary">
|
||||
<%= @api_key.scopes.map { |scope|
|
||||
case scope
|
||||
when "read_accounts" then "View Accounts"
|
||||
when "read_transactions" then "View Transactions"
|
||||
when "read_balances" then "View Balances"
|
||||
when "write_transactions" then "Create Transactions"
|
||||
else scope.humanize
|
||||
end
|
||||
}.join(", ") %>
|
||||
</span>
|
||||
</div>
|
||||
<div class="flex justify-between">
|
||||
<span class="text-secondary">Created:</span>
|
||||
<span class="text-primary"><%= @api_key.created_at.strftime("%B %d, %Y at %I:%M %p") %></span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-warning-50 border border-warning-200 rounded-xl p-4">
|
||||
<div class="flex items-start gap-2">
|
||||
<%= icon("alert-triangle", class: "w-5 h-5 text-warning-600 mt-0.5") %>
|
||||
<div>
|
||||
<h4 class="font-medium text-warning-800 text-sm">Important Security Note</h4>
|
||||
<p class="text-warning-700 text-sm mt-1">
|
||||
This is the only time your API key will be displayed. Make sure to copy it now and store it securely.
|
||||
If you lose this key, you'll need to generate a new one.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-surface-inset rounded-xl p-4">
|
||||
<h4 class="font-medium text-primary mb-3">How to use your API key</h4>
|
||||
<p class="text-secondary text-sm mb-3">Include your API key in the X-Api-Key header when making requests:</p>
|
||||
<div class="bg-container rounded-lg p-3 font-mono text-sm text-primary border border-primary">
|
||||
curl -H "X-Api-Key: <%= @api_key.plain_key %>" <%= request.base_url %>/api/v1/accounts
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-end pt-4 border-t border-primary">
|
||||
<%= render LinkComponent.new(
|
||||
text: "Continue to API Key Settings",
|
||||
href: settings_api_key_path,
|
||||
variant: "primary"
|
||||
) %>
|
||||
</div>
|
||||
</div>
|
||||
<% end %>
|
||||
</div>
|
||||
</div>
|
||||
<% end %>
|
60
app/views/settings/api_keys/new.html.erb
Normal file
60
app/views/settings/api_keys/new.html.erb
Normal file
|
@ -0,0 +1,60 @@
|
|||
<%= content_for :page_title, "Create New API Key" %>
|
||||
|
||||
<%= settings_section title: "Create New API Key", subtitle: "Generate a new API key to access your Maybe data programmatically." do %>
|
||||
<%= styled_form_with model: @api_key, url: settings_api_key_path, class: "space-y-4" do |form| %>
|
||||
<%= form.text_field :name,
|
||||
placeholder: "e.g., My Budget App, Portfolio Tracker",
|
||||
label: "API Key Name",
|
||||
help_text: "Choose a descriptive name to help you identify this key later." %>
|
||||
|
||||
<div>
|
||||
<%= form.label :scopes, "Permissions", class: "block text-sm font-medium text-primary mb-2" %>
|
||||
<p class="text-sm text-secondary mb-3">Select the permissions this API key should have:</p>
|
||||
|
||||
<div class="space-y-2">
|
||||
<% [
|
||||
["read", "Read Only", "View your accounts, transactions, and balances"],
|
||||
["read_write", "Read/Write", "View your data and create new transactions"]
|
||||
].each do |value, label, description| %>
|
||||
<div class="bg-surface-inset rounded-lg p-3 border border-primary">
|
||||
<label class="flex items-start gap-3 cursor-pointer">
|
||||
<%= radio_button_tag "api_key[scopes]", value, (@api_key&.scopes || []).include?(value),
|
||||
class: "mt-1" %>
|
||||
<div class="flex-1">
|
||||
<div class="font-medium text-primary"><%= label %></div>
|
||||
<div class="text-sm text-secondary mt-1"><%= description %></div>
|
||||
</div>
|
||||
</label>
|
||||
</div>
|
||||
<% end %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-warning-50 border border-warning-200 rounded-xl p-4">
|
||||
<div class="flex items-start gap-2">
|
||||
<%= icon("alert-triangle", class: "w-5 h-5 text-warning-600 mt-0.5") %>
|
||||
<div>
|
||||
<h4 class="font-medium text-warning-800 text-sm">Security Warning</h4>
|
||||
<p class="text-warning-700 text-sm mt-1">
|
||||
Your API key will be displayed only once after creation. Make sure to copy and store it securely.
|
||||
Anyone with access to this key can access your data according to the permissions you select.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-end gap-3 pt-4 border-t border-primary">
|
||||
<%= render LinkComponent.new(
|
||||
text: "Cancel",
|
||||
href: settings_api_key_path,
|
||||
variant: "ghost"
|
||||
) %>
|
||||
|
||||
<%= render ButtonComponent.new(
|
||||
text: "Create API Key",
|
||||
variant: "primary",
|
||||
type: "submit"
|
||||
) %>
|
||||
</div>
|
||||
<% end %>
|
||||
<% end %>
|
192
app/views/settings/api_keys/show.html.erb
Normal file
192
app/views/settings/api_keys/show.html.erb
Normal file
|
@ -0,0 +1,192 @@
|
|||
<%= content_for :page_title, "API Key" %>
|
||||
|
||||
<% if @newly_created && @plain_key %>
|
||||
<%= settings_section title: "API Key Created Successfully", subtitle: "Your new API key has been generated successfully." do %>
|
||||
<div class="space-y-4">
|
||||
<div class="p-3 shadow-border-xs bg-container rounded-lg">
|
||||
<div class="flex items-start gap-3">
|
||||
<%= render FilledIconComponent.new(
|
||||
icon: "check-circle",
|
||||
rounded: true,
|
||||
size: "lg",
|
||||
variant: :success
|
||||
) %>
|
||||
<div class="flex-1">
|
||||
<h3 class="font-medium text-primary">API Key Created Successfully!</h3>
|
||||
<p class="text-secondary text-sm mt-1">Your new API key "<%= @current_api_key.name %>" has been created and is ready to use.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-surface-inset rounded-xl p-4">
|
||||
<h4 class="font-medium text-primary mb-3">Your API Key</h4>
|
||||
<p class="text-secondary text-sm mb-3">Copy and store this key securely. You'll need it to authenticate your API requests.</p>
|
||||
|
||||
<div class="bg-container rounded-lg p-3 border border-primary" data-controller="clipboard">
|
||||
<div class="flex items-center justify-between gap-3">
|
||||
<code id="api-key-display" class="font-mono text-sm text-primary break-all" data-clipboard-target="source"><%= @current_api_key.plain_key %></code>
|
||||
<%= render ButtonComponent.new(
|
||||
text: "Copy API Key",
|
||||
variant: "ghost",
|
||||
icon: "copy",
|
||||
data: { action: "clipboard#copy" }
|
||||
) %>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-surface-inset rounded-xl p-4">
|
||||
<h4 class="font-medium text-primary mb-3">How to use your API key</h4>
|
||||
<p class="text-secondary text-sm mb-3">Include your API key in the X-Api-Key header when making requests:</p>
|
||||
<div class="bg-container rounded-lg p-3 font-mono text-sm text-primary border border-primary">
|
||||
curl -H "X-Api-Key: <%= @current_api_key.plain_key %>" <%= request.base_url %>/api/v1/accounts
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-end pt-4 border-t border-primary">
|
||||
<%= render LinkComponent.new(
|
||||
text: "Continue to API Key Settings",
|
||||
href: settings_api_key_path,
|
||||
variant: "primary"
|
||||
) %>
|
||||
</div>
|
||||
</div>
|
||||
<% end %>
|
||||
<% elsif @current_api_key %>
|
||||
<%= settings_section title: "Your API Key", subtitle: "Manage your API key for programmatic access to your Maybe data." do %>
|
||||
<div class="space-y-4">
|
||||
<div class="p-3 shadow-border-xs bg-container rounded-lg flex justify-between items-center">
|
||||
<div class="flex items-center gap-3">
|
||||
<%= render FilledIconComponent.new(
|
||||
icon: "key",
|
||||
rounded: true,
|
||||
size: "lg"
|
||||
) %>
|
||||
|
||||
<div class="text-sm space-y-1">
|
||||
<p class="text-primary font-medium"><%= @current_api_key.name %></p>
|
||||
<p class="text-secondary">
|
||||
Created <%= time_ago_in_words(@current_api_key.created_at) %> ago
|
||||
<% if @current_api_key.last_used_at %>
|
||||
• Last used <%= time_ago_in_words(@current_api_key.last_used_at) %> ago
|
||||
<% else %>
|
||||
• Never used
|
||||
<% end %>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="rounded-md bg-success px-2 py-1">
|
||||
<p class="text-success-foreground font-medium text-xs">Active</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-surface-inset rounded-xl p-4">
|
||||
<h4 class="font-medium text-primary mb-3">Permissions</h4>
|
||||
<div class="flex flex-wrap gap-2">
|
||||
<% @current_api_key.scopes.each do |scope| %>
|
||||
<span class="inline-flex items-center gap-1 px-2 py-1 bg-primary text-primary-foreground rounded-full text-xs font-medium">
|
||||
<%= icon("shield-check", class: "w-3 h-3") %>
|
||||
<%= case scope
|
||||
when "read" then "Read Only"
|
||||
when "read_write" then "Read/Write"
|
||||
else scope.humanize
|
||||
end %>
|
||||
</span>
|
||||
<% end %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-surface-inset rounded-xl p-4">
|
||||
<h4 class="font-medium text-primary mb-3">Your API Key</h4>
|
||||
<p class="text-secondary text-sm mb-3">Copy and store this key securely. You'll need it to authenticate your API requests.</p>
|
||||
|
||||
<div class="bg-container rounded-lg p-3 border border-primary" data-controller="clipboard">
|
||||
<div class="flex items-center justify-between gap-3">
|
||||
<code id="api-key-display" class="font-mono text-sm text-primary break-all" data-clipboard-target="source"><%= @current_api_key.plain_key %></code>
|
||||
<%= render ButtonComponent.new(
|
||||
text: "Copy API Key",
|
||||
variant: "ghost",
|
||||
icon: "copy",
|
||||
data: { action: "clipboard#copy" }
|
||||
) %>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-surface-inset rounded-xl p-4">
|
||||
<h4 class="font-medium text-primary mb-3">How to use your API key</h4>
|
||||
<p class="text-secondary text-sm mb-3">Include your API key in the X-Api-Key header when making requests:</p>
|
||||
<div class="bg-container rounded-lg p-3 font-mono text-sm text-primary border border-primary">
|
||||
curl -H "X-Api-Key: <%= @current_api_key.plain_key %>" <%= request.base_url %>/api/v1/accounts
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="flex flex-col sm:flex-row gap-3 pt-4 border-t border-primary">
|
||||
<%= render LinkComponent.new(
|
||||
text: "Create New Key",
|
||||
href: new_settings_api_key_path(regenerate: true),
|
||||
variant: "secondary"
|
||||
) %>
|
||||
|
||||
<%= render ButtonComponent.new(
|
||||
text: "Revoke Key",
|
||||
href: settings_api_key_path,
|
||||
method: :delete,
|
||||
variant: "destructive",
|
||||
data: {
|
||||
turbo_confirm: "Are you sure you want to revoke this API key?"
|
||||
}
|
||||
) %>
|
||||
</div>
|
||||
</div>
|
||||
<% end %>
|
||||
<% else %>
|
||||
<%= settings_section title: "Create Your API Key", subtitle: "Get programmatic access to your Maybe data" do %>
|
||||
<div class="space-y-4">
|
||||
<div class="p-3 shadow-border-xs bg-container rounded-lg">
|
||||
<div class="flex items-start gap-3">
|
||||
<%= render FilledIconComponent.new(
|
||||
icon: "key",
|
||||
rounded: true,
|
||||
size: "lg"
|
||||
) %>
|
||||
<div class="flex-1">
|
||||
<h3 class="font-medium text-primary">Access your account data programmatically</h3>
|
||||
<p class="text-secondary text-sm mt-1">Generate an API key to integrate with your applications and access your financial data securely.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="bg-surface-inset rounded-xl p-4">
|
||||
<h4 class="font-medium text-primary mb-3">What you can do with API keys:</h4>
|
||||
<ul class="space-y-2 text-sm text-secondary">
|
||||
<li class="flex items-start gap-2">
|
||||
<%= icon("check", class: "w-4 h-4 text-primary mt-0.5") %>
|
||||
<span>Access your accounts and balances</span>
|
||||
</li>
|
||||
<li class="flex items-start gap-2">
|
||||
<%= icon("check", class: "w-4 h-4 text-primary mt-0.5") %>
|
||||
<span>View transaction history</span>
|
||||
</li>
|
||||
<li class="flex items-start gap-2">
|
||||
<%= icon("check", class: "w-4 h-4 text-primary mt-0.5") %>
|
||||
<span>Create new transactions</span>
|
||||
</li>
|
||||
<li class="flex items-start gap-2">
|
||||
<%= icon("check", class: "w-4 h-4 text-primary mt-0.5") %>
|
||||
<span>Integrate with third-party applications</span>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="flex justify-start">
|
||||
<%= render LinkComponent.new(
|
||||
text: "Create API Key",
|
||||
href: new_settings_api_key_path,
|
||||
variant: "primary"
|
||||
) %>
|
||||
</div>
|
||||
</div>
|
||||
<% end %>
|
||||
<% end %>
|
Loading…
Add table
Add a link
Reference in a new issue