HTTPI provides a common interface for Ruby HTTP libraries.
HTTPI is available through Rubygems and can be installed via:
$ gem install httpi
In order to provide a common interface, HTTPI provides the HTTPI::Request object for you to
configure your request. Here's a very simple GET request.
request = HTTPI::Request.new("http://example.com")
HTTPI.get requestTo execute a POST request, you may want to specify a payload.
request = HTTPI::Request.new
request.url = "http://post.example.com"
request.body = "some data"
HTTPI.post requestThe HTTPI module uses one of the available adapters to execute HTTP requests.
HTTPI.get(request, adapter = nil)
HTTPI.get(url, adapter = nil)HTTPI.post(request, adapter = nil)
HTTPI.post(url, body, adapter = nil)HTTPI.head(request, adapter = nil)
HTTPI.head(url, adapter = nil)HTTPI.put(request, adapter = nil)
HTTPI.put(url, body, adapter = nil)HTTPI.delete(request, adapter = nil)
HTTPI.delete(url, adapter = nil)- You can specify the adapter to use per request
- And request methods always return an
HTTPI::Response
If you need more control over the request, you can access the HTTP client instance represented by your adapter in a block:
HTTPI.post request do |http|
http.use_ssl = true # Curb example
endHTTPI uses adapters to support multiple HTTP libraries. It currently contains adapters for:
- httpclient
- curb
- net/http
- em_http (since v1.2.0) also requires em-synchrony
You can manually specify the adapter to use via:
HTTPI.adapter = :curb # or one of [:httpclient, :net_http, :em_http]If you don't specify which adapter to use, HTTPI will try to load HTTPClient, then Curb and finally NetHTTP.
HTTPI does not force you to install any of these libraries. If you'd like to use on of the more advanced libraries (HTTPClient or Curb), you have to make sure they're in your LOAD_PATH. HTTPI will then load the library when executing HTTP requests.
request.url = "http://example.com"
request.url # => #<URI::HTTP:0x101c1ab18 URL:http://example.com>request.proxy = "http://example.com"
request.proxy # => #<URI::HTTP:0x101c1ab18 URL:http://example.com>request.headers["Accept-Charset"] = "utf-8"
request.headers = { "Accept-Charset" => "utf-8" }
request.headers # => { "Accept-Charset" => "utf-8" }request.body = "some data"
request.body # => "some data"request.open_timeout = 30 # secrequest.read_timeout = 30 # secHTTPI::Auth supports HTTP basic, digest and Negotiate/SPNEGO authentication.
request.auth.basic("username", "password") # HTTP basic auth credentials
request.auth.digest("username", "password") # HTTP digest auth credentials
request.auth.gssnegotiate # HTTP Negotiate/SPNEGO (aka Kerberos)HTTP Negotiate only works when using Curb.
For experimental NTLM authentication, please use the httpi-ntlm gem and provide feedback.
request.auth.ntlm("username", "password") # NTLM auth credentialsHTTPI::Auth::SSL manages SSL client authentication.
request.auth.ssl.cert_key_file = "client_key.pem" # the private key file to use
request.auth.ssl.cert_key_password = "C3rtP@ssw0rd" # the key file's password
request.auth.ssl.cert_file = "client_cert.pem" # the certificate file to use
request.auth.ssl.ca_cert_file = "ca_cert.pem" # the ca certificate file to use
request.auth.ssl.verify_mode = :none # or one of [:peer, :fail_if_no_peer_cert, :client_once]
request.auth.ssl.ssl_version = :TLSv1 # or one of [:SSLv2, :SSLv3]Every request returns an HTTPI::Response. It contains the response code, headers and body.
response = HTTPI.get request
response.code # => 200
response.headers # => { "Content-Encoding" => "gzip" }
response.body # => "<!DOCTYPE HTML PUBLIC ...>"The response.body handles gzipped and DIME encoded responses.
- Return the original
HTTPI::Requestfor debugging purposes - Return the time it took to execute the request
HTTPI by default logs each HTTP request to STDOUT using a log level of :debug.
HTTPI.log = false # disable logging
HTTPI.logger = MyLogger # change the logger
HTTPI.log_level = :info # change the log level