This commit is contained in:
@@ -0,0 +1,52 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
module Octokit
|
||||
class Client
|
||||
# Methods for API rate limiting info
|
||||
#
|
||||
# @see https://developer.github.com/v3/#rate-limiting
|
||||
module RateLimit
|
||||
# Get rate limit info from last response if available
|
||||
# or make a new request to fetch rate limit
|
||||
#
|
||||
# @see https://developer.github.com/v3/rate_limit/#rate-limit
|
||||
# @return [Octokit::RateLimit] Rate limit info
|
||||
def rate_limit(_options = {})
|
||||
return rate_limit! if last_response.nil?
|
||||
|
||||
Octokit::RateLimit.from_response(last_response)
|
||||
end
|
||||
alias ratelimit rate_limit
|
||||
|
||||
# Get number of rate limted requests remaining
|
||||
#
|
||||
# @see https://developer.github.com/v3/rate_limit/#rate-limit
|
||||
# @return [Integer] Number of requests remaining in this period
|
||||
def rate_limit_remaining(_options = {})
|
||||
octokit_warn 'Deprecated: Please use .rate_limit.remaining'
|
||||
rate_limit.remaining
|
||||
end
|
||||
alias ratelimit_remaining rate_limit_remaining
|
||||
|
||||
# Refresh rate limit info by making a new request
|
||||
#
|
||||
# @see https://developer.github.com/v3/rate_limit/#rate-limit
|
||||
# @return [Octokit::RateLimit] Rate limit info
|
||||
def rate_limit!(_options = {})
|
||||
get 'rate_limit'
|
||||
Octokit::RateLimit.from_response(last_response)
|
||||
end
|
||||
alias ratelimit! rate_limit!
|
||||
|
||||
# Refresh rate limit info and get number of rate limted requests remaining
|
||||
#
|
||||
# @see https://developer.github.com/v3/rate_limit/#rate-limit
|
||||
# @return [Integer] Number of requests remaining in this period
|
||||
def rate_limit_remaining!(_options = {})
|
||||
octokit_warn 'Deprecated: Please use .rate_limit!.remaining'
|
||||
rate_limit!.remaining
|
||||
end
|
||||
alias ratelimit_remaining! rate_limit_remaining!
|
||||
end
|
||||
end
|
||||
end
|
||||
Reference in New Issue
Block a user