Class: ZendeskAPI::Middleware::Request::RaiseRateLimited

Inherits:
Faraday::Middleware
  • Object
show all
Defined in:
lib/zendesk_api/middleware/request/raise_rate_limited.rb

Overview

Faraday middleware to handle HTTP Status 429 (rate limiting) / 503 (maintenance)

Constant Summary collapse

ERROR_CODES = 
[429, 503].freeze

Instance Method Summary collapse

Constructor Details

#initialize(app, options = {}) ⇒ RaiseRateLimited

Returns a new instance of RaiseRateLimited.



13
14
15
16
 
# File 'lib/zendesk_api/middleware/request/raise_rate_limited.rb', line 13

def initialize(app, options = {})
  super(app)
  @logger = options[:logger]
end

Instance Method Details

#call(env) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
 
# File 'lib/zendesk_api/middleware/request/raise_rate_limited.rb', line 18

def call(env)
  response = @app.call(env)

  if ERROR_CODES.include?(response.env[:status])
    @logger&.warn 'You have been rate limited. Raising error...'
    raise Error::RateLimited, env
  else
    response
  end
end