Home

Awesome

Connect Proxy

CI

A simple implementation of the connect method for HTTP tunnelling. Most commonly used in HTTP proxy servers.

Usage

The most common usage of this shard is to use the crystal ::HTTP::Client via a proxy server

host = URI.parse("https://www.google.com")
response = ConnectProxy::HTTPClient.new(host) do |client|
  client.exec("GET", "/")
end
response.success?

By default the HTTP client will pick up the https_proxy or http_proxy environment variables and use the URLs configured in there. However you can override the environment or provide your own proxy server.

host = URI.parse("https://www.google.com")
client = ConnectProxy::HTTPClient.new(host)
proxy = ConnectProxy.new("134.209.219.234", 80, {username: "admin", password: "pass"})
client.set_proxy(proxy)
response = client.exec("GET", "/")
response.success?

Forcing Proxy Support

It's possible to simply introduce proxy support to any app by including extensions to the core classes. I wouldn't recommend this unless there are too many libs to patch / you don't control the code directly


# Patches ::HTTP::Client
require "connect-proxy/ext/http-client"

# Patches ::HTTP::Websocket
require "connect-proxy/ext/websocket"

This method requires you to use the standard proxy ENV vars