Exception: CardDB::RateLimitError

Inherits:
Error
  • Object
show all
Defined in:
lib/carddb/errors.rb

Overview

Raised when rate limits are exceeded

Instance Attribute Summary collapse

Attributes inherited from Error

#response

Instance Method Summary collapse

Constructor Details

#initialize(message = nil, retry_after: nil, limit: nil, remaining: nil, reset_at: nil, response: nil) ⇒ RateLimitError

Returns a new instance of RateLimitError.



32
33
34
35
36
37
38
 
# File 'lib/carddb/errors.rb', line 32

def initialize(message = nil, retry_after: nil, limit: nil, remaining: nil, reset_at: nil, response: nil)
  @retry_after = retry_after
  @limit = limit
  @remaining = remaining
  @reset_at = reset_at
  super(message, response: response)
end

Instance Attribute Details

#limit ⇒ Integer? (readonly)

Returns Maximum requests allowed.

Returns:

  • (Integer, nil) —

    Maximum requests allowed



24
25
26
 
# File 'lib/carddb/errors.rb', line 24

def limit
  @limit
end

#remaining ⇒ Integer? (readonly)

Returns Remaining requests in window.

Returns:

  • (Integer, nil) —

    Remaining requests in window



27
28
29
 
# File 'lib/carddb/errors.rb', line 27

def remaining
  @remaining
end

#reset_at ⇒ Time? (readonly)

Returns Time when the rate limit resets.

Returns:

  • (Time, nil) —

    Time when the rate limit resets



30
31
32
 
# File 'lib/carddb/errors.rb', line 30

def reset_at
  @reset_at
end

#retry_after ⇒ Integer? (readonly)

Returns Seconds until rate limit resets.

Returns:

  • (Integer, nil) —

    Seconds until rate limit resets



21
22
23
 
# File 'lib/carddb/errors.rb', line 21

def retry_after
  @retry_after
end