Sha256: 2652ec5d818cffd53eaf81ee9fe5f63347b1700cb24fedae1b3a05eeb13ffd57
Contents?: true
Size: 1.71 KB
Versions: 6
Compression:
Stored size: 1.71 KB
Contents
# The main Redd module.
module Redd
# The class that handles rate limiting for reddit. reddit does supply
# X-Ratelimit headers but using those headers instead would just lead to
# short bursts, so it's better to go at a constant speed and space out
# requests every second.
#
# If you'd rather have short bursts or no rate limiting at all, it's easy to
# write one yourself. A rate limiting class is any class that has an
# {#after_limit} method. The block returns a Faraday::Response object, so you
# can also extract the headers from the response and use those instead. To
# remove rate limiting entirely, follow the example below.
#
# @example No Rate Limiting
# class IWantToGetIPBanned
# def after_limit
# yield
# end
# end
#
# client = Redd.it(..., rate_limit: IWantToGetIPBanned.new)
class RateLimit
# @!attribute [r] last_request_time
# @return [Time] The time when the last request took place.
attr_reader :last_request_time
# @!attribute [rw] gap
# @return [Integer, Float] The minimum time between requests.
attr_accessor :gap
# @param [Float, Integer] gap The minimum time between each request.
def initialize(gap)
# Some time ages ago, because we never made a request.
@last_request_time = Time.at(0)
@gap = gap
end
# Sleep until 2 seconds have passed since the last request and perform the
# given request.
#
# @yield A block.
# @return The return value of the block.
def after_limit
wait_time = @last_request_time + @gap - Time.now
sleep(wait_time) if wait_time > 0
@last_request_time = Time.now
yield
end
end
end
Version data entries
6 entries across 6 versions & 1 rubygems