wreq-rb

KO | EN

gitlite — search

#react #ai #go #android #rust #deep-learning #linux #nodejs #macos #awesome #kubernetes #vue #pytorch #ios

(★ 9)

Ruby HTTP client featuring TLS fingerprint emulation, HTTP/2 support, cookie handling, and proxy support.

wreq-rb 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# wreq-rb

Ruby bindings for the [wreq](https://github.com/0x676e67/wreq) Rust HTTP client — featuring TLS fingerprint emulation, HTTP/2 support, cookie handling, and proxy support.

## Installation

Add to your Gemfile:

```ruby
gem "wreq-rb"
```

Then run:

```bash
bundle install
```

> **Build prerequisites:** You need Rust (1.85+), Clang, CMake, and Perl installed, since wreq compiles BoringSSL from source. See [wreq's build guide](https://github.com/0x676e67/wreq#building) for details.

## Quick Start

```ruby
require "wreq-rb"

# Simple GET request
resp = Wreq.get("https://httpbin.org/get")
puts resp.status   # => 200
puts resp.text     # => response body as string
puts resp.json     # => parsed Ruby Hash

# POST with JSON body
resp = Wreq.post("https://httpbin.org/post", json: { name: "wreq", version: 1 })

# POST with form data
resp = Wreq.post("https://httpbin.org/post", form: { key: "value" })

# Custom headers
resp = Wreq.get("https://httpbin.org/headers",
  headers: { "X-Custom" => "value", "Accept" => "application/json" })

# Query parameters
resp = Wreq.get("https://httpbin.org/get", query: { foo: "bar", page: "1" })

# Authentication
resp = Wreq.get("https://httpbin.org/bearer", bearer: "my-token")
resp = Wreq.get("https://httpbin.org/basic-auth/user/pass", basic: ["user", "pass"])

# Browser emulation (enabled by default)
resp = Wreq.get("https://tls.peet.ws/api/all", emulation: "chrome_148")
```

## Using a Client

For best performance, create a `Wreq::Client` and reuse it across requests (connections are pooled internally):

```ruby
client = Wreq::Client.new(
  user_agent: "MyApp/1.0",
  timeout: 30,                 # total timeout in seconds
  connect_timeout: 5,          # connection timeout
  read_timeout: 15,            # read timeout
  redirect: 10,                # follow up to 10 redirects (false to disable)
  cookie_store: true,          # enable cookie jar
  proxy: "http://proxy:8080",  # proxy URL (supports http, https, socks5)
  proxy_user: "user",          # proxy auth
  proxy_pass: "pass",
  no_proxy: true,              # disable all proxies (including env-vars)
  https_only: false,           # restrict to HTTPS
  verify_host: true,           # verify TLS hostname (default: true)
  verify_cert: true,           # verify TLS certificate (default: true)
  http1_only: false,           # force HTTP/1.1 only
  http2_only: false,           # force HTTP/2 only
  gzip: true,                  # enable gzip decompression
  brotli: true,                # enable brotli decompression
  deflate: true,               # enable deflate decompression
  zstd: true,                  # enable zstd decompression
  emulation: "chrome_143",     # browser emulation (enabled by default)
  emulation_os: "windows",     # OS emulation: windows, macos (default), linux, android, ios
  header_order: [              # wire order of headers (names only, case-sensitive)
    "host",                    # listed headers appear first in the given order, remaining
    "user-agent",              # emulation headers follow.
    "accept",
  ],
  headers: {                   # default headers for all requests
    "Accept" => "application/json"
  },
  referer: true,               # auto-set Referer header on redirects (default: true)
  pool_max_idle_per_host: 10,  # max idle connections per host
  pool_max_size: 100,          # max total connections in the pool
  tcp_nodelay: true,           # disable Nagle algorithm (default: true)
  tcp_keepalive: 15,           # SO_KEEPALIVE interval in seconds (default: 15)
  local_address: "1.2.3.4",    # bind outgoing connections to this source IP
  tls_sni: true,               # send SNI in TLS handshake (default: true)
  min_tls_version: "tls1.2",   # minimum TLS version: tls1.0, tls1.1, tls1.2, tls1.3
  max_tls_version: "tls1.3",   # maximum TLS version
)

resp = client.get("https://api.example.com/data")
resp = client.post("https://api.example.com/data", json: { key: "value" })
```

## HTTP Methods

All methods are available on both `Wreq` (module-level) and `Wreq::Client` (instance-level):

| Method | Usage |
|--------|-------|
| `get(url, **opts)` | GET request |
| `post(url, **opts)` | POST request |
| `put(url, **opts)` | PUT request |
| `patch(url, **opts)` | PATCH request |
| `delete(url, **opts)` | DELETE request |
| `head(url, **opts)` | HEAD request |
| `options(url, **opts)` | OPTIONS request |

### Cancelling Requests

Call `cancel` on a client to interrupt all in-flight requests immediately:

```ruby
client = Wreq::Client.new

# From another thread:
t = Thread.new { client.get("https://slow.example.com/big-download") }
sleep 1
client.cancel  # all in-flight requests raise Wreq::Error with "request interrupted"
```

### Per-Request Options

Pass an options hash as the second argument to any HTTP method:

| Option | Type | Description |
|--------|------|-------------|
| `headers` | Hash | Request headers |
| `body` | String | Raw request body |
| `json` | Hash/Array | JSON-serialized body (sets Content-Type) |
| `form` | Hash | URL-encoded form body |
| `query` | Hash | URL query parameters |
| `timeout` | Float | Per-request timeout (seconds) |
| `auth` | String | Raw Authorization header |
| `bearer` | String | Bearer token |
| `basic` | Array | `[username, password]` for Basic auth |
| `proxy` | String | Per-request proxy URL |
| `emulation` | String/Boolean | Per-request emulation override |
| `emulation_os` | String | OS emulation: `windows`, `macos`, `linux`, `android`, `ios` |

## Browser Emulation

wreq-rb emulates real browser TLS fingerprints, HTTP/2 settings, and headers by default. **The latest supported Chrome is used when no emulation is specified.**

```ruby
resp = Wreq.get("https://tls.peet.ws/api/all")

# Explicit browser emulation
client = Wreq::Client.new(emulation: "firefox_151")
client = Wreq::Client.new(emulation: "safari_18.5")
client = Wreq::Client.new(emulation: "edge_148")

# Disable emulation entirely
client = Wreq::Client.new(emulation: false)

# Emulate a specific OS (default is macOS)
client = Wreq::Client.new(emulation: "chrome_148", emulation_os: "windows")
client = Wreq::Client.new(emulation: "chrome_148", emulation_os: "linux")

# Emulation + custom user-agent (user_agent overrides emulation's UA)
client = Wreq::Client.new(emulation: "chrome_148", user_agent: "MyBot/1.0")

# Per-request emulation override
resp = client.get("https://example.com", emulation: "safari_26.2")
```

### Supported Browsers

| Browser | Example values |
|---------|---------------|
| Chrome | `chrome_100` .. `chrome_148` |
| Firefox | `firefox_109` .. `firefox_151`, `firefox_private_135` |
| Safari | `safari_15.3` .. `safari_26.4`, `safari_ios_26`, `safari_ipad_18` |
| Edge | `edge_101` .. `edge_148` |
| Opera | `opera_116` .. `opera_131` |
| OkHttp | `okhttp_3.9` .. `okhttp_5` |

## Response

The `Wreq::Response` object provides:

| Method | Returns | Description |
|--------|---------|-------------|
| `status` / `code` | Integer | HTTP status code |
| `text` / `body` | String | Response body as string |
| `body_bytes` | Array | Raw bytes |
| `headers` | Hash | Response headers |
| `json` | Hash/Array | JSON-parsed body |
| `url` | String | Final URL (after redirects) |
| `version` | String | HTTP version |
| `content_length` | Integer/nil | Content length if known |
| `transfer_size` | Integer/nil | Bytes transferred over the wire |
| `success?` | Boolean | Status 2xx? |
| `redirect?` | Boolean | Status 3xx? |
| `client_error?` | Boolean | Status 4xx? |
| `server_error?` | Boolean | Status 5xx? |

## Building from Source

```bash
bundle install
bundle exec rake compile
bundle exec rake test
```

## License

wreq-rb is released under the [Apache License, Version 2.0](LICENSE).

wreq-rb

wreq-rb 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

wreq-rb

wreq-rb 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README