Exception: RubyPi::RateLimitError

Inherits:

ApiError

• Object
• StandardError
• Error
• ApiError
• RubyPi::RateLimitError

Defined in:

lib/ruby_pi/errors.rb

Overview

Raised when the API returns a rate limit response (HTTP 429). The caller should back off and retry after the indicated period.

Instance Attribute Summary

• #retry_after ⇒ Float^? readonly

  Suggested retry delay in seconds, if provided by the API.

Attributes inherited from ApiError

#response_body, #status_code

Instance Method Summary

• #initialize(message = nil, retry_after: nil, response_body: nil) ⇒ RateLimitError constructor

  A new instance of RateLimitError.

Constructor Details

#initialize(message = nil, retry_after: nil, response_body: nil) ⇒ RateLimitError

Returns a new instance of RateLimitError.

Parameters:

• message (String) (defaults to: nil) —

  human-readable error description

• retry_after (Float, nil) (defaults to: nil) —

  seconds to wait before retrying

• response_body (String, nil) (defaults to: nil) —

  raw response body

# File 'lib/ruby_pi/errors.rb', line 61

def initialize(message = nil, retry_after: nil, response_body: nil)
  @retry_after = retry_after
  super(message || "Rate limit exceeded", status_code: 429, response_body: response_body)
end

Instance Attribute Details

#retry_after ⇒ Float^? (readonly)

Returns suggested retry delay in seconds, if provided by the API.

Returns:

• (Float, nil) —

  suggested retry delay in seconds, if provided by the API

# File 'lib/ruby_pi/errors.rb', line 56

def retry_after
  @retry_after
end