Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@ Manipulate HTTP request headers with Ferrum:

``` ruby
page.driver.browser.headers.get # => {}
page.driver.browser.headers.set("User-Agent" => "Cuprite")
page.driver.browser.headers.set("X-Trace" => "1")
page.driver.browser.headers.add({ "Referer" => "https://example.com" })
page.driver.browser.headers.get # => { "User-Agent" => "Cuprite", "Referer" => "https://example.com" }
page.driver.browser.headers.get # => { "X-Trace" => "1", "Referer" => "https://example.com" }
```

Notice that `set` will overwrite already set headers. You should use `add` if
Expand Down
2 changes: 1 addition & 1 deletion docs/1-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Capybara has no API for what you need:

```ruby
browser = page.driver.browser
browser.headers.set("Accept-Language" => "de")
browser.network.emulate(accept_language: "de")
browser.cookies.set(name: "stealth", value: "omg")
browser.network.wait_for_idle
browser.network.traffic.last.response.status # => 200
Expand Down
15 changes: 12 additions & 3 deletions docs/11-headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ They are cleared at the end of every test.
```ruby
headers = page.driver.browser.headers
headers.get # => {}
headers.set("User-Agent" => "Cuprite")
headers.add({ "Accept-Language" => "de" })
headers.get # => { "User-Agent" => "Cuprite", "Accept-Language" => "de" }
headers.set("X-Trace" => "1")
headers.add({ "X-Tenant" => "acme" })
headers.get # => { "X-Trace" => "1", "X-Tenant" => "acme" }
```

`set` overwrites already set headers, `add` merges into them. A `Referer`
Expand All @@ -23,3 +23,12 @@ it to `go_to`:
```ruby
page.driver.browser.go_to("/landing", referrer: "https://example.com")
```

To change the user agent or the language use Ferrum's
[network.emulate](/docs/ferrum/network), which overrides the `User-Agent` and
`Accept-Language` headers together with what `navigator` reports. It is reset
at the end of every test too:

```ruby
page.driver.browser.network.emulate(user_agent: "Cuprite", accept_language: "de")
```
2 changes: 1 addition & 1 deletion docs/2-customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Cuprite-specific options are:
* `:emulate` (Symbol) - Device to emulate, one of those listed in Chrome DevTools' device toolbar, such as
`:iphone_16`, `:pixel_9`, `:samsung_galaxy_a55` or `:ipad_mini`, see `Capybara::Cuprite::Devices::LIST`. It sets
the device's `:window_size`, `:scale_factor` and `:mobile`, options passed explicitly take precedence, and its
user agent, unless a `User-Agent` is set with [headers](/docs/cuprite/headers).
user agent, unless one is set with `network.emulate(user_agent:)`, see [headers](/docs/cuprite/headers).
* `:mobile` (Boolean) - Emulate a mobile device: honor `<meta name="viewport">` and enable touch events, `false`
by default. Kept across window resizes.
* `:scale_factor` (Numeric) - Device scale factor (`window.devicePixelRatio`) to emulate, `0` (browser default)
Expand Down
Loading