sharpetronics/httpx

Fork 0

mirror of https://github.com/HoneyryderChuck/httpx.git synced 2025-10-04 00:00:37 -04:00

HoneyryderChuck 8970ebec96 some more examples in the cheatsheet

2018-12-01 19:51:45 +00:00

4.7 KiB

Raw Blame History

HTTPX Cheatsheet

This was based on some net-http cheatsheets found around the web:

You are recommended to compare them with this one.

Standard HTTP Request

require "httpx"

response = HTTPX.get("https://google.com/")
# Will print response.body
puts response.to_s

Multiple HTTP Requests

require "httpx"

uri = "https://google.com"

responses = HTTPX.new(uri, uri)

# OR
HTTPX.wrap do |client|
  client.get(uri)
  client.get(uri)
  client.get(uri, uri) # parallel!
end

Headers

HTTPX.headers("user-agent" => "My Ruby Script").get("https://google.com")

HTTP Methods

HTTP.get("https://myapi.com/users/1")
HTTP.post("https://myapi.com/users")
HTTP.patch("https://myapi.com/users/1")
HTTP.put("https://myapi.com/users/1")
HTTP.delete("https://myapi.com/users/1")

HTTP Authentication

require "httpx"

# Basic Auth
response = HTTPX.plugin(:basic_authentication).basic_authentication("username", "password").get("https://google.com")

# Digest Auth
response = HTTPX.plugin(:digest_authentication).digest_authentication("username", "password").get("https://google.com")

# Token Auth
response = HTTPX.plugin(:authentication).authentication("eyrandomtoken").get("https://google.com")

Dealing with response objects

require "httpx"

response = HTTPX.get("https://google.com/")
response.status # => 301
response.headers["location"] #=> "https://www.google.com/"
response.body             # =>  "<HTML><HEAD><meta http-equiv=\"content-type\" ....
response["cache-control"] # => public, max-age=2592000

POST form request

require "httpx"
uri = URI.parse("http://example.com/search")

# Shortcut
response = HTTPX.post(uri, form: {"q" => "My query", "per_page" => "50"})

File upload - input type="file" style

require "httpx"

# uses http_form_data API: https://github.com/httprb/form_data

path = "/path/to/your/testfile.txt"
HTTPX.plugin(:multipart).post("http://something.com/uploads", form: {
  name: HTTP::FormData::File.new(path)
})

SSL/HTTPS request

Update: There are some good reasons why this code example is bad. It introduces a potential security vulnerability if it's essential you use the server certificate to verify the identity of the server you're connecting to. There's a fix for the issue though!

require "httpx"


response = HTTPX.with(ssl: { verify_mode: OpenSSL::SSL::VERIFY_NONE }).get("https://secure.com/")

SSL/HTTPS request with PEM certificate

require "httpx"

pem = File.read("/path/to/my.pem")
HTTPX.with(ssl: {
  cert: OpenSSL::X509::Certificate.new(pem),
  key: OpenSSL::PKey::RSA.new(pem),
  verify_mode: OpenSSL::SSL::VERIFY_PEER
}).get("https://secure.com/")

Cookies

require "httpx"

HTTPX.plugin(:cookies).wrap do |client|
  session_response = client.get("https://translate.google.com/")
  response_cookies = session_response.cookie_jar
  response = client.cookies(response_cookies).get("https://translate.google.com/#auto|en|Pardon")
  puts response
end

Compression

require "httpx"

response = HTTPX.plugin(:compression).get("https://www.google.com")
puts response.headers["content-encoding"] #=> "gzip"

Proxy

require "httpx"

HTTPX.plugin(:proxy).with_proxy(uri: "http://myproxy.com:8080", username: "proxy_user", password: "proxy_pass").get("https://google.com")

# also supports SOCKS4, SOCKS4a, SOCKS5 proxy:
HTTPX.plugin(:proxy).with_proxy(uri: "socks5://socksproxyexample.com:8888").get("https://google.com")

DNS-over-HTTPS

# export HTTPX_RESOLVER=https before opening the console
require "httpx"
HTTPX.get("https://google.com")

# OR

require "httpx"
HTTPX.with(resolver_class: :https).get("https://google.com")


# by default it uses cloudflare DoH server.
# This example switches the resolver to Quad9's DoH server

HTTPX.with(resolver_class: :https, resolver_options: {uri: "https://9.9.9.9/dns-query"}).get("https://google.com")

Follow Redirects

require "httpx"

HTTPX.plugin(:follow_redirects).with(follow_insecure_redirects: false, max_redirects: 4).get("https://www.google.com")

Timeouts

require "httpx"

HTTPX.with(timeout: {connect_timeout: 10, operation_timeout: 3}).get("https://google.com")

Retries

require "httpx"
HTTPX.plugin(:retries).max_retries(5).get("https://www.google.com")

Logging/Debugging

# export HTTPX_DEBUG=1 before opening the console
require "httpx"

HTTPX.get("https://google.com") #=>  udp://10.0.1.2:53...

# OR

HTTPX.with(debug_level: 1, debug: $stderr).get("https://google.com")

4.7 KiB Raw Blame History