class Fbe::Middleware::Quota

License
MIT
Copyright
Copyright © 2024-2025 Zerocracy
Author

Yegor Bugayenko (yegor256@gmail.com)
Faraday Middleware that monitors GitHub API rate limits.

def call(env)

def call(env)
  @requests += 1
  response = @app.call(env)
  if out_of_limit?(env)
    @loog.info("Too much GitHub API quota consumed, pausing for #{@pause} seconds")
    sleep(@pause)
    @requests = 0
  end
  response
end

def initialize(app, loog: Loog::NULL, pause: 60, limit: 100, rate: 5)

def initialize(app, loog: Loog::NULL, pause: 60, limit: 100, rate: 5)
  super(app)
  @requests = 0
  @app = app
  raise 'The "loog" cannot be nil' if loog.nil?
  @loog = loog
  raise 'The "pause" cannot be nil' if pause.nil?
  raise 'The "pause" must be a positive integer' unless pause.positive?
  @pause = pause
  raise 'The "limit" cannot be nil' if limit.nil?
  raise 'The "limit" must be a positive integer' unless limit.positive?
  @limit = limit
  raise 'The "rate" cannot be nil' if rate.nil?
  raise 'The "rate" must be a positive integer' unless rate.positive?
  @rate = rate
end

def out_of_limit?(env)

def out_of_limit?(env)
  remaining = env.response_headers['x-ratelimit-remaining'].to_i
  (@requests % @limit).zero? && remaining < @rate
end