playwright-ruby-client 1.28.1 → 1.29.0

data/documentation/docs/api/playwright.md

@@ -4,6 +4,7 @@ sidebar_position: 10
 
 # Playwright
 
+
 Playwright module provides a method to launch a browser instance. The following is a typical example of using Playwright
 to drive automation:
 
@@ -22,14 +23,14 @@ Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwrig
 end
 ```
 
-
-
 ## chromium
 
+
 This object can be used to launch or connect to Chromium, returning instances of [Browser](./browser).
 
 ## devices
 
+
 Returns a dictionary of devices to be used with [Browser#new_context](./browser#new_context) or [Browser#new_page](./browser#new_page).
 
 ```ruby
@@ -48,16 +49,18 @@ Playwright.create(playwright_cli_executable_path: 'npx playwright') do |playwrig
 end
 ```
 
-
 ## firefox
 
+
 This object can be used to launch or connect to Firefox, returning instances of [Browser](./browser).
 
 ## selectors
 
-Selectors can be used to install custom selector engines. See [Working with selectors](https://playwright.dev/python/docs/selectors) for more
-information.
+
+Selectors can be used to install custom selector engines. See
+[extensibility](https://playwright.dev/python/docs/extensibility) for more information.
 
 ## webkit
 
+
 This object can be used to launch or connect to WebKit, returning instances of [Browser](./browser).

data/documentation/docs/api/request.md

@@ -4,6 +4,7 @@ sidebar_position: 10
 
 # Request
 
+
 Whenever the page sends a request for a network resource the following sequence of events are emitted by [Page](./page):
 - [`event: Page.request`] emitted when the request is issued by the page.
 - [`event: Page.response`] emitted when/if the response status and headers are received for the request.
@@ -12,8 +13,8 @@ Whenever the page sends a request for a network resource the following sequence
 If request fails at some point, then instead of `'requestfinished'` event (and possibly instead of 'response' event),
 the  [`event: Page.requestFailed`] event is emitted.
 
-> NOTE: HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will
-complete with `'requestfinished'` event.
+**NOTE**: HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete
+with `'requestfinished'` event.
 
 If request gets a 'redirect' response, the request is successfully finished with the `requestfinished` event, and a new
 request is  issued to a redirected url.
@@ -24,6 +25,7 @@ request is  issued to a redirected url.
 def all_headers
 ```
 
+
 An object with all the request HTTP headers associated with this request. The header names are lower-cased.
 
 ## failure
@@ -32,22 +34,24 @@ An object with all the request HTTP headers associated with this request. The he
 def failure
 ```
 
+
 The method returns `null` unless this request has failed, as reported by `requestfailed` event.
 
+**Usage**
+
 Example of logging of all the failed requests:
 
 ```ruby
 page.on("requestfailed", ->(request) { puts "#{request.url} #{request.failure}" })
 ```
 
-
-
 ## frame
 
 ```
 def frame
 ```
 
+
 Returns the [Frame](./frame) that initiated this request.
 
 ## headers
@@ -56,9 +60,10 @@ Returns the [Frame](./frame) that initiated this request.
 def headers
 ```
 
-An object with the request HTTP headers. The header names are lower-cased. Note that this method does not return
-security-related headers, including cookie-related ones. You can use [Request#all_headers](./request#all_headers) for complete list of
-headers that include `cookie` information.
+
+An object with the request HTTP headers. The header names are lower-cased.
+Note that this method does not return security-related headers, including cookie-related ones.
+You can use [Request#all_headers](./request#all_headers) for complete list of headers that include `cookie` information.
 
 ## headers_array
 
@@ -66,8 +71,9 @@ headers that include `cookie` information.
 def headers_array
 ```
 
-An array with all the request HTTP headers associated with this request. Unlike [Request#all_headers](./request#all_headers), header
-names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+
+An array with all the request HTTP headers associated with this request. Unlike [Request#all_headers](./request#all_headers), header names are NOT lower-cased.
+Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
 
 ## header_value
 
@@ -75,6 +81,7 @@ names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`,
 def header_value(name)
 ```
 
+
 Returns the value of the header matching the name. The name is case insensitive.
 
 ## navigation_request?
@@ -83,6 +90,7 @@ Returns the value of the header matching the name. The name is case insensitive.
 def navigation_request?
 ```
 
+
 Whether this request is driving frame's navigation.
 
 ## method
@@ -91,6 +99,7 @@ Whether this request is driving frame's navigation.
 def method
 ```
 
+
 Request's method (GET, POST, etc.)
 
 ## post_data
@@ -99,6 +108,7 @@ Request's method (GET, POST, etc.)
 def post_data
 ```
 
+
 Request's post body, if any.
 
 ## post_data_buffer
@@ -107,6 +117,7 @@ Request's post body, if any.
 def post_data_buffer
 ```
 
+
 Request's post body in a binary form, if any.
 
 ## post_data_json
@@ -115,6 +126,7 @@ Request's post body in a binary form, if any.
 def post_data_json
 ```
 
+
 Returns parsed request's body for `form-urlencoded` and JSON as a fallback if any.
 
 When the response is `application/x-www-form-urlencoded` then a key/value object of the values will be returned.
@@ -126,12 +138,15 @@ Otherwise it will be parsed as JSON.
 def redirected_from
 ```
 
+
 Request that was redirected by the server to this one, if any.
 
 When the server responds with a redirect, Playwright creates a new [Request](./request) object. The two requests are connected by
 [redirected_from](./request#redirected_from) and [redirected_to](./request#redirected_to) methods. When multiple server redirects has happened, it is possible to
 construct the whole redirect chain by repeatedly calling [redirected_from](./request#redirected_from).
 
+**Usage**
+
 For example, if the website `http://github.com` redirects to `https://github.com`:
 
 ```ruby
@@ -147,30 +162,30 @@ response = page.goto("https://google.com")
 puts response.request.redirected_from&.url # => nil
 ```
 
-
-
 ## redirected_to
 
 ```
 def redirected_to
 ```
 
+
 New request issued by the browser if the server responded with redirect.
 
+**Usage**
+
 This method is the opposite of [Request#redirected_from](./request#redirected_from):
 
 ```ruby
 request.redirected_from.redirected_to # equals to request
 ```
 
-
-
 ## resource_type
 
 ```
 def resource_type
 ```
 
+
 Contains the request's resource type as it was perceived by the rendering engine. ResourceType will be one of the
 following: `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`,
 `websocket`, `manifest`, `other`.
@@ -181,6 +196,7 @@ following: `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttr
 def response
 ```
 
+
 Returns the matching [Response](./response) object, or `null` if the response was not received due to error.
 
 ## sizes
@@ -189,6 +205,7 @@ Returns the matching [Response](./response) object, or `null` if the response wa
 def sizes
 ```
 
+
 Returns resource size information for given request.
 
 ## timing
@@ -197,10 +214,13 @@ Returns resource size information for given request.
 def timing
 ```
 
+
 Returns resource timing information for given request. Most of the timing values become available upon the response,
 `responseEnd` becomes available when request finishes. Find more information at
 [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
 
+**Usage**
+
 ```ruby
 request = page.expect_event("requestfinished") do
   page.goto("https://example.com")
@@ -208,12 +228,11 @@ end
 puts request.timing
 ```
 
-
-
 ## url
 
 ```
 def url
 ```
 
+
 URL of the request.

data/documentation/docs/api/response.md

@@ -4,6 +4,7 @@ sidebar_position: 10
 
 # Response
 
+
 [Response](./response) class represents responses which are received by page.
 
 ## all_headers
@@ -12,6 +13,7 @@ sidebar_position: 10
 def all_headers
 ```
 
+
 An object with all the response HTTP headers associated with this response.
 
 ## body
@@ -20,6 +22,7 @@ An object with all the response HTTP headers associated with this response.
 def body
 ```
 
+
 Returns the buffer with response body.
 
 ## finished
@@ -28,6 +31,7 @@ Returns the buffer with response body.
 def finished
 ```
 
+
 Waits for this response to finish, returns always `null`.
 
 ## frame
@@ -36,6 +40,7 @@ Waits for this response to finish, returns always `null`.
 def frame
 ```
 
+
 Returns the [Frame](./frame) that initiated this response.
 
 ## from_service_worker
@@ -44,8 +49,8 @@ Returns the [Frame](./frame) that initiated this response.
 def from_service_worker
 ```
 
-Indicates whether this Response was fulfilled by a Service Worker's Fetch Handler (i.e. via
-[FetchEvent.respondWith](https://developer.mozilla.org/en-US/docs/Web/API/FetchEvent/respondWith)).
+
+Indicates whether this Response was fulfilled by a Service Worker's Fetch Handler (i.e. via [FetchEvent.respondWith](https://developer.mozilla.org/en-US/docs/Web/API/FetchEvent/respondWith)).
 
 ## headers
 
@@ -53,9 +58,10 @@ Indicates whether this Response was fulfilled by a Service Worker's Fetch Handle
 def headers
 ```
 
-An object with the response HTTP headers. The header names are lower-cased. Note that this method does not return
-security-related headers, including cookie-related ones. You can use [Response#all_headers](./response#all_headers) for complete list
-of headers that include `cookie` information.
+
+An object with the response HTTP headers. The header names are lower-cased.
+Note that this method does not return security-related headers, including cookie-related ones.
+You can use [Response#all_headers](./response#all_headers) for complete list of headers that include `cookie` information.
 
 ## headers_array
 
@@ -63,8 +69,9 @@ of headers that include `cookie` information.
 def headers_array
 ```
 
-An array with all the request HTTP headers associated with this response. Unlike [Response#all_headers](./response#all_headers), header
-names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+
+An array with all the request HTTP headers associated with this response. Unlike [Response#all_headers](./response#all_headers), header names are NOT lower-cased.
+Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
 
 ## header_value
 
@@ -72,9 +79,9 @@ names are NOT lower-cased. Headers with multiple entries, such as `Set-Cookie`,
 def header_value(name)
 ```
 
-Returns the value of the header matching the name. The name is case insensitive. If multiple headers have the same name
-(except `set-cookie`), they are returned as a list separated by `, `. For `set-cookie`, the `\n` separator is used. If
-no headers are found, `null` is returned.
+
+Returns the value of the header matching the name. The name is case insensitive. If multiple headers have
+the same name (except `set-cookie`), they are returned as a list separated by `, `. For `set-cookie`, the `\n` separator is used. If no headers are found, `null` is returned.
 
 ## header_values
 
@@ -82,6 +89,7 @@ no headers are found, `null` is returned.
 def header_values(name)
 ```
 
+
 Returns all values of the headers matching the name, for example `set-cookie`. The name is case insensitive.
 
 ## json
@@ -90,6 +98,7 @@ Returns all values of the headers matching the name, for example `set-cookie`. T
 def json
 ```
 
+
 Returns the JSON representation of response body.
 
 This method will throw if the response body is not parsable via `JSON.parse`.
@@ -100,6 +109,7 @@ This method will throw if the response body is not parsable via `JSON.parse`.
 def ok
 ```
 
+
 Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
 
 ## request
@@ -108,6 +118,7 @@ Contains a boolean stating whether the response was successful (status in the ra
 def request
 ```
 
+
 Returns the matching [Request](./request) object.
 
 ## security_details
@@ -116,6 +127,7 @@ Returns the matching [Request](./request) object.
 def security_details
 ```
 
+
 Returns SSL and other security information.
 
 ## server_addr
@@ -124,6 +136,7 @@ Returns SSL and other security information.
 def server_addr
 ```
 
+
 Returns the IP address and port of the server.
 
 ## status
@@ -132,6 +145,7 @@ Returns the IP address and port of the server.
 def status
 ```
 
+
 Contains the status code of the response (e.g., 200 for a success).
 
 ## status_text
@@ -140,6 +154,7 @@ Contains the status code of the response (e.g., 200 for a success).
 def status_text
 ```
 
+
 Contains the status text of the response (e.g. usually an "OK" for a success).
 
 ## text
@@ -148,6 +163,7 @@ Contains the status text of the response (e.g. usually an "OK" for a success).
 def text
 ```
 
+
 Returns the text representation of response body.
 
 ## url
@@ -156,4 +172,5 @@ Returns the text representation of response body.
 def url
 ```
 
+
 Contains the URL of the response.

data/documentation/docs/api/route.md

@@ -4,6 +4,7 @@ sidebar_position: 10
 
 # Route
 
+
 Whenever a network route is set up with [Page#route](./page#route) or [BrowserContext#route](./browser_context#route), the [Route](./route) object
 allows to handle the route.
 
@@ -15,6 +16,7 @@ Learn more about [networking](https://playwright.dev/python/docs/network).
 def abort(errorCode: nil)
 ```
 
+
 Aborts the route's request.
 
 ## continue
@@ -23,8 +25,11 @@ Aborts the route's request.
 def continue(headers: nil, method: nil, postData: nil, url: nil)
 ```
 
+
 Continues route's request with optional overrides.
 
+**Usage**
+
 ```ruby
 def handle(route, request)
   # override headers
@@ -38,18 +43,19 @@ end
 page.route("**/*", method(:handle))
 ```
 
-
-
 ## fallback
 
 ```
 def fallback(headers: nil, method: nil, postData: nil, url: nil)
 ```
 
-When several routes match the given pattern, they run in the order opposite to their registration. That way the last
-registered route can always override all the previous ones. In the example below, request will be handled by the
-bottom-most handler first, then it'll fall back to the previous one and in the end will be aborted by the first
-registered route.
+
+When several routes match the given pattern, they run in the order opposite to their registration.
+That way the last registered route can always override all the previous ones. In the example below,
+request will be handled by the bottom-most handler first, then it'll fall back to the previous one and
+in the end will be aborted by the first registered route.
+
+**Usage**
 
 ```ruby
 page.route("**/*", -> (route,_) { route.abort })  # Runs last.
@@ -57,8 +63,9 @@ page.route("**/*", -> (route,_) { route.fallback })  # Runs second.
 page.route("**/*", -> (route,_) { route.fallback })  # Runs first.
 ```
 
-Registering multiple routes is useful when you want separate handlers to handle different kinds of requests, for example
-API calls vs page resources or GET requests vs POST requests as in the example below.
+Registering multiple routes is useful when you want separate handlers to
+handle different kinds of requests, for example API calls vs page resources or
+GET requests vs POST requests as in the example below.
 
 ```ruby
 # Handle GET requests.
@@ -87,8 +94,8 @@ page.route("**/*", handle_get)
 page.route("**/*", handle_post)
 ```
 
-One can also modify request while falling back to the subsequent handler, that way intermediate route handler can modify
-url, method, headers and postData of the request.
+One can also modify request while falling back to the subsequent handler, that way intermediate
+route handler can modify url, method, headers and postData of the request.
 
 ```ruby
 def handle(route, request)
@@ -100,9 +107,31 @@ def handle(route, request)
 
   route.fallback(headers: headers)
 end
+page.route("**/*", method(:handle))
+```
+
+## fetch
+
+```
+def fetch(headers: nil, method: nil, postData: nil, url: nil)
 ```
 
 
+Performs the request and fetches result without fulfilling it, so that the response
+could be modified and then fulfilled.
+
+**Usage**
+
+```ruby
+def handle(route, request)
+  response = route.fetch
+  json = response.json
+  json["message"]["big_red_dog"] = []
+
+  route.fulfill(response: response, json: json)
+end
+page.route("https://dog.ceo/api/breeds/list/all", method(:handle))
+```
 
 ## fulfill
 
@@ -111,13 +140,17 @@ def fulfill(
       body: nil,
       contentType: nil,
       headers: nil,
+      json: nil,
       path: nil,
       response: nil,
       status: nil)
 ```
 
+
 Fulfills route's request with given response.
 
+**Usage**
+
 An example of fulfilling all requests with 404 responses:
 
 ```ruby
@@ -136,12 +169,11 @@ An example of serving static file:
 page.route("**/xhr_endpoint", ->(route, _) { route.fulfill(path: "mock_data.json") })
 ```
 
-
-
 ## request
 
 ```
 def request
 ```
 
+
 A request to be routed.

data/documentation/docs/api/selectors.md

@@ -4,7 +4,8 @@ sidebar_position: 10
 
 # Selectors
 
-Selectors can be used to install custom selector engines. See [Working with selectors](https://playwright.dev/python/docs/selectors) for more
+
+Selectors can be used to install custom selector engines. See [extensibility](https://playwright.dev/python/docs/extensibility) for more
 information.
 
 ## register
@@ -13,6 +14,9 @@ information.
 def register(name, contentScript: nil, path: nil, script: nil)
 ```
 
+
+**Usage**
+
 An example of registering selector engine that queries elements based on a tag name:
 
 ```ruby
@@ -45,5 +49,3 @@ playwright.chromium.launch do |browser|
   button_count # => 1
 end
 ```
-
-

data/documentation/docs/api/touchscreen.md

@@ -4,6 +4,7 @@ sidebar_position: 10
 
 # Touchscreen
 
+
 The Touchscreen class operates in main-frame CSS pixels relative to the top-left corner of the viewport. Methods on the
 touchscreen can only be used in browser contexts that have been initialized with `hasTouch` set to true.
 
@@ -13,4 +14,5 @@ touchscreen can only be used in browser contexts that have been initialized with
 def tap_point(x, y)
 ```
 
+
 Dispatches a `touchstart` and `touchend` event with a single touch at the position (`x`,`y`).

data/documentation/docs/api/tracing.md

@@ -4,8 +4,8 @@ sidebar_position: 10
 
 # Tracing
 
-API for collecting and saving Playwright traces. Playwright traces can be opened in [Trace Viewer](https://playwright.dev/python/docs/trace-viewer)
-after Playwright script runs.
+
+API for collecting and saving Playwright traces. Playwright traces can be opened in [Trace Viewer](https://playwright.dev/python/docs/trace-viewer) after Playwright script runs.
 
 Start recording a trace before performing actions. At the end, stop tracing and save it to a file.
 
@@ -18,8 +18,6 @@ browser.new_context do |context|
 end
 ```
 
-
-
 ## start
 
 ```
@@ -31,8 +29,11 @@ def start(
       title: nil)
 ```
 
+
 Start tracing.
 
+**Usage**
+
 ```ruby
 context.tracing.start(name: 'trace', screenshots: true, snapshots: true)
 page = context.new_page
@@ -40,17 +41,16 @@ page.goto('https://playwright.dev')
 context.tracing.stop(path: 'trace.zip')
 ```
 
-
-
 ## start_chunk
 
 ```
 def start_chunk(title: nil)
 ```
 
-Start a new trace chunk. If you'd like to record multiple traces on the same [BrowserContext](./browser_context), use
-[Tracing#start](./tracing#start) once, and then create multiple trace chunks with [Tracing#start_chunk](./tracing#start_chunk) and
-[Tracing#stop_chunk](./tracing#stop_chunk).
+
+Start a new trace chunk. If you'd like to record multiple traces on the same [BrowserContext](./browser_context), use [Tracing#start](./tracing#start) once, and then create multiple trace chunks with [Tracing#start_chunk](./tracing#start_chunk) and [Tracing#stop_chunk](./tracing#stop_chunk).
+
+**Usage**
 
 ```ruby
 context.tracing.start(name: "trace", screenshots: true, snapshots: true)
@@ -68,14 +68,13 @@ page.goto("http://example.com")
 context.tracing.stop_chunk(path: "trace2.zip")
 ```
 
-
-
 ## stop
 
 ```
 def stop(path: nil)
 ```
 
+
 Stop tracing.
 
 ## stop_chunk
@@ -84,4 +83,5 @@ Stop tracing.
 def stop_chunk(path: nil)
 ```
 
+
 Stop the trace chunk. See [Tracing#start_chunk](./tracing#start_chunk) for more details about multiple trace chunks.