module WarpEngine::AdminApi::RateLimiter

A fixed-window request counter per Principal, in Rails.cache, following Configuration#rate_limit ({ to:, within: }, within in seconds).

Public Instance Methods

exceeded? (principal, cache: Rails.cache, now: Time.current)

Source

# File lib/warp_engine/admin_api/rate_limiter.rb, line 13
def exceeded?(principal, cache: Rails.cache, now: Time.current)
  limit = AdminApi.config.rate_limit
  return false if limit.blank? || principal.nil?

  within = limit[:within].to_i
  return false if within <= 0

  window = now.to_i / within
  key = "warp_engine:admin_api:rate:#{principal.rate_limit_key}:#{window}"
  count = cache.increment(key, 1, expires_in: within)
  count.to_i > limit[:to].to_i
end

Counts one request of principal in the current window and returns whether it went over the limit. Always false without a configured limit or principal.

cache: the cache store holding the counters
now: the current time

retry_after (now: Time.current)

Source

# File lib/warp_engine/admin_api/rate_limiter.rb, line 27
def retry_after(now: Time.current)
  within = AdminApi.config.rate_limit[:within].to_i
  within - (now.to_i % within)
end

The seconds left in the current window, for the Retry-After header.