Class Irc::Utils::HttpUtil
In: lib/rbot/httputil.rb
Parent: Object

class for making http requests easier (mainly for plugins to use) this class can check the bot proxy configuration to determine if a proxy needs to be used, which includes support for per-url proxy configuration.

Methods

expired?   get   get_cached   get_proxy   head   new   proxy_required   remove_stale_cache  

Public Class methods

Public Instance methods

get(uri_or_str, readtimeout=10, opentimeout=5, max_redir=@bot.config["http.max_redir"], cache=false) {|uri.request_uri() if block_given?| ...}
uri:uri to query (Uri object)
readtimeout:timeout for reading the response
opentimeout:timeout for opening the connection

simple get request, returns (if possible) response body following redirs and caching if requested if a block is given, it yields the urls it gets redirected to TODO we really need something to implement proper caching

get_cached(uri_or_str, readtimeout=10, opentimeout=5, max_redir=@bot.config['http.max_redir'], noexpire=@bot.config['http.no_expire_cache'])

gets a page from the cache if it’s still (assumed to be) valid TODO remove stale cached pages, except when called with noexpire=true

get_proxy(uri)
uri:Uri to create a proxy for

return a net/http Proxy object, which is configured correctly for proxying based on the bot’s proxy configuration. This will include per-url proxy configuration based on the bot config +http_proxy_include/exclude+ options.

proxy_required(uri)

if http_proxy_include or http_proxy_exclude are set, then examine the uri to see if this is a proxied uri the in/excludes are a list of regexps, and each regexp is checked against the server name, and its IP addresses

[Validate]