ruby-proxifier

Installing

Recommended

gem install proxifier

Edge

git clone https://github.com/samuelkadolph/ruby-proxifier
cd ruby-proxifier && rake install

Rationale

This gem was created for 2 purposes.

First is to enable ruby programmers to use HTTP or SOCKS proxies interchangeably when using TCPSockets. Either manually with Proxifier::Proxy#open or by require "proxifier/env".

The second purpose is to use ruby code that doesn't user proxies for users that have to use proxies.
The pruby and pirb executables are simple wrappers for their respective ruby executables that support proxies from environment variables.

Usage

Executable Wrappers & Environment Variables

proxifier provides two executables: pruby and pirb. They are simple wrappers for your current ruby and irb executables that requires the "proxifier/env" script which installs hooks into TCPSocket which will use the proxy environment variables to proxy any TCPSocket.

The environment variables that proxifier will check are (in order of descending precedence):

Variable Name	Alternatives	Notes
proxy	PROXY	Requires the proxy scheme to be present.
socks_proxy	SOCKS_PROXY socks5_proxy SOCKS5_PROXY	Implies the SOCKS5 proxy scheme.
socks4a_proxy	SOCKS4A_PROXY	Implies the SOCKS4A proxy scheme.
socks4_proxy	PROXY	Implies the SOCKS4 proxy scheme.
http_proxy	HTTP_PROXY	Implies the HTTP proxy scheme.

Ruby

require "proxifier/proxy"

proxy = Proxifier::Proxy("socks://localhost")
socket = proxy.open("www.google.com", 80)
socket << "GET / HTTP/1.1\r\nHost: www.google.com\r\n\r\n"
socket.gets # => "HTTP/1.1 200 OK\r\n"

Environment - patching TCPSocket

require 'proxifier/env'
ENV['PROXY'] = 'http://10.0.0.44:8888' # How to find the proxy
ENV['PROXY_FILTER_REGEX'] = '(10\..*|localhost)' # Do not use proxy for connections inside internal net or localhost
ENV['PROXY_FILTER_LIST'] = '66.211.168.123,207.97.227.239'

Afterwards, any new TCPSocket connections will use the proxy, unless they're excluded either by the specific PROXY_FILTER_LIST or the PROXY_FILTER_REGEX.

PROXY_FILTER_LIST specifies a comma separated list of hostnames or IP addresses (whichever the client code is going to use).

PROXY_FILTER_REGEX is a regular expression, where if the connection hostname (or IP address) matches the regex, connections will be made directly and not through the proxy.

Both PROXY_FILTER_LIST and PROXY_FILTER_REGEX are optional, but only one will be used.

Supported Proxies

Protocol	Formats	Notes
HTTP	http://[username[:password]@]host[:port][?tunnel=false]	The port defaults to 80. This is currently a limitation that may be solved in the future. Appending ?tunnel=false forces the proxy to not use CONNECT.
SOCKS5	socks://[username[:password]@]host[:port] socks5://[username[:password]@]host[:port]	Port defaults to 1080.
SOCKS4A	socks4a://[username@]host[:port]	Not yet implemented.
SOCKS4	socks4://[username@]host[:port]	Currently hangs. Not sure if the problem is with code or server.