Exception: GitHub::API::RateLimitExceededError Private

Inherits:
Error
  • Object
show all
Defined in:
utils/github/api.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

Error when the API rate limit is exceeded.

Instance Attribute Summary

Attributes inherited from Error

#github_message

Instance Method Summary collapse

Constructor Details

#initialize(reset, github_message) ⇒ RateLimitExceededError

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns a new instance of RateLimitExceededError.



57
58
59
60
61
62
63
64
 
# File 'utils/github/api.rb', line 57

def initialize(reset, github_message)
  @github_message = github_message
  new_pat_message = ", or:\n#{GitHub.pat_blurb}" if API.credentials.blank?
  super <<~EOS
    GitHub API Error: #{github_message}
    Try again in #{pretty_ratelimit_reset(reset)}#{new_pat_message}
  EOS
end

Instance Method Details

#pretty_ratelimit_reset(reset) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



66
67
68
 
# File 'utils/github/api.rb', line 66

def pretty_ratelimit_reset(reset)
  pretty_duration(Time.at(reset) - Time.now)
end