Sha256: d185078f098fb1bced95bbec59c0d1e9453c35bebb8ac6bc5f930aa2747b2478
Contents?: true
Size: 1.75 KB
Versions: 54
Compression:
Stored size: 1.75 KB
Contents
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
Version data entries
54 entries across 37 versions & 3 rubygems