playwright-ruby-client 1.28.1 → 1.29.1.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6b579547c4cff2fbaf98b5c2796c8689f655f316b391b7127891fd03212cea4
-  data.tar.gz: c32a3787fa3f6c2e874844f94deef249c335cee4f6efcc8d23e8045bfd6346f1
+  metadata.gz: 491e2aebdc4a8d9df333cc9e891d34e521227d7daad17179e94918e40e3ff57b
+  data.tar.gz: 3fd623b1194a788445eed01b72075ddb3061f1d72a9d50ae1585f767ec81716d
 SHA512:
-  metadata.gz: 7481f324212879e913399614beab51affce2c8dc05040ac0d506d9b583fcf48c897bd1a1f3b7f332212497db2000e538a1cf1fd19c60d5ddf7c884e2e366d687
-  data.tar.gz: 58eb07d5abb6307bd15464b6f33d8c0d0cc4110cf80c26915cecc00be911fba8e6240687cb46698c81fda29651718b4039f8ca1530661e5ccd4a7d1632bd6ef3
+  metadata.gz: bfa12c6fedc6fbf3137f4e38d424e17d4020df2c05f8545f16bcb303e6d31b681f3f3d134741f2e223c16b7b589d947f3c1f0735ff5ae2b298cf23fdce656ac9
+  data.tar.gz: f887741dc95b517b0697f17f1e4212b1f1024f2d8d69fe7ec9d5b8590780c2f45049256c26aa8dc547e0ab2f499f7c0aff76ba251b2003fdd0d8b6e5c6bc6219

data/documentation/docs/api/accessibility.md

@@ -4,9 +4,6 @@ sidebar_position: 10
 
 # Accessibility
 
-**DEPRECATED** This class is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
-need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
-integration with Axe.
 
 The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by
 assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or
@@ -15,12 +12,12 @@ assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Scre
 Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might
 have wildly different output.
 
-Rendering engines of Chromium, Firefox and WebKit have a concept of "accessibility tree", which is then translated into
-different platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.
+Rendering engines of Chromium, Firefox and WebKit have a concept of "accessibility tree", which is then translated into different
+platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.
 
-Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific
-AX-Tree or by assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing
-only the "interesting" nodes of the tree.
+Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific AX-Tree or by
+assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing only the
+"interesting" nodes of the tree.
 
 ## snapshot
 
@@ -28,15 +25,14 @@ only the "interesting" nodes of the tree.
 def snapshot(interestingOnly: nil, root: nil)
 ```
 
-**DEPRECATED** This method is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
-need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
-integration with Axe.
 
 Captures the current state of the accessibility tree. The returned object represents the root accessible node of the
 page.
 
-> NOTE: The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers.
-Playwright will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
+**NOTE**: The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Playwright
+will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
+
+**Usage**
 
 An example of dumping the entire accessibility tree:
 
@@ -62,4 +58,3 @@ snapshot = page.accessibility.snapshot
 node = find_focused_node(snapshot)
 puts node['name']
 ```
-

data/documentation/docs/api/api_request_context.md

@@ -4,23 +4,25 @@ sidebar_position: 10
 
 # APIRequestContext
 
+
 This API is used for the Web API testing. You can use it to trigger API endpoints, configure micro-services, prepare
 environment or the service to your e2e test.
 
-Each Playwright browser context has associated with it [APIRequestContext](./api_request_context) instance which shares cookie storage with the
-browser context and can be accessed via [BrowserContext#request](./browser_context#request) or [Page#request](./page#request). It is also
-possible to create a new APIRequestContext instance manually by calling [APIRequest#new_context](./api_request#new_context).
+Each Playwright browser context has associated with it [APIRequestContext](./api_request_context) instance which shares cookie storage with
+the browser context and can be accessed via [BrowserContext#request](./browser_context#request) or [Page#request](./page#request).
+It is also possible to create a new APIRequestContext instance manually by calling [APIRequest#new_context](./api_request#new_context).
 
 **Cookie management**
 
 [APIRequestContext](./api_request_context) returned by [BrowserContext#request](./browser_context#request) and [Page#request](./page#request) shares cookie
-storage with the corresponding [BrowserContext](./browser_context). Each API request will have `Cookie` header populated with the values
-from the browser context. If the API response contains `Set-Cookie` header it will automatically update [BrowserContext](./browser_context)
-cookies and requests made from the page will pick them up. This means that if you log in using this API, your e2e test
-will be logged in and vice versa.
+storage with the corresponding [BrowserContext](./browser_context). Each API request will have `Cookie` header populated with the
+values from the browser context. If the API response contains `Set-Cookie` header it will automatically update
+[BrowserContext](./browser_context) cookies and requests made from the page will pick them up. This means that if you log in using
+this API, your e2e test will be logged in and vice versa.
 
 If you want API requests to not interfere with the browser cookies you should create a new [APIRequestContext](./api_request_context) by
-calling [APIRequest#new_context](./api_request#new_context). Such [APIRequestContext](./api_request_context) object will have its own isolated cookie storage.
+calling [APIRequest#new_context](./api_request#new_context). Such [APIRequestContext](./api_request_context) object will have its own isolated cookie
+storage.
 
 ```ruby
 playwright.chromium.launch do |browser|
@@ -55,7 +57,6 @@ playwright.chromium.launch do |browser|
 end
 ```
 
-
 ## delete
 
 ```
@@ -72,9 +73,10 @@ def delete(
       timeout: nil)
 ```
 
-Sends HTTP(S) [DELETE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE) request and returns its
-response. The method will populate request cookies from the context and update context cookies from the response. The
-method will automatically follow redirects.
+
+Sends HTTP(S) [DELETE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE) request and returns its response.
+The method will populate request cookies from the context and update
+context cookies from the response. The method will automatically follow redirects.
 
 ## dispose
 
@@ -82,9 +84,9 @@ method will automatically follow redirects.
 def dispose
 ```
 
-All responses returned by [APIRequestContext#get](./api_request_context#get) and similar methods are stored in the memory, so that you
-can later call [APIResponse#body](./api_response#body). This method discards all stored responses, and makes
-[APIResponse#body](./api_response#body) throw "Response disposed" error.
+
+All responses returned by [APIRequestContext#get](./api_request_context#get) and similar methods are stored in the memory, so that you can later call [APIResponse#body](./api_response#body). This method
+discards all stored responses, and makes [APIResponse#body](./api_response#body) throw "Response disposed" error.
 
 ## fetch
 
@@ -103,10 +105,11 @@ def fetch(
       timeout: nil)
 ```
 
+
 Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update
-context cookies from the response. The method will automatically follow redirects.
+context cookies from the response. The method will automatically follow redirects. JSON objects can be passed directly to the request.
 
-JSON objects can be passed directly to the request:
+**Usage**
 
 ```ruby
 data = {
@@ -116,8 +119,7 @@ data = {
 api_request_context.fetch("https://example.com/api/create_book", method: 'post', data: data)
 ```
 
-The common way to send file(s) in the body of a request is to encode it as form fields with `multipart/form-data`
-encoding. You can achieve that with Playwright API like this:
+The common way to send file(s) in the body of a request is to encode it as form fields with `multipart/form-data` encoding. You can achieve that with Playwright API like this:
 
 ```ruby
 api_request_context.fetch(
@@ -133,8 +135,6 @@ api_request_context.fetch(
 )
 ```
 
-
-
 ## get
 
 ```
@@ -151,9 +151,12 @@ def get(
       timeout: nil)
 ```
 
-Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its response. The
-method will populate request cookies from the context and update context cookies from the response. The method will
-automatically follow redirects.
+
+Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its response.
+The method will populate request cookies from the context and update
+context cookies from the response. The method will automatically follow redirects.
+
+**Usage**
 
 Request parameters can be configured with `params` option, they will be serialized into the URL search parameters:
 
@@ -165,8 +168,6 @@ query_params = {
 api_request_context.get("https://example.com/api/get_text", params: query_params)
 ```
 
-
-
 ## head
 
 ```
@@ -183,9 +184,10 @@ def head(
       timeout: nil)
 ```
 
+
 Sends HTTP(S) [HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) request and returns its response.
-The method will populate request cookies from the context and update context cookies from the response. The method will
-automatically follow redirects.
+The method will populate request cookies from the context and update
+context cookies from the response. The method will automatically follow redirects.
 
 ## patch
 
@@ -203,9 +205,10 @@ def patch(
       timeout: nil)
 ```
 
+
 Sends HTTP(S) [PATCH](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH) request and returns its response.
-The method will populate request cookies from the context and update context cookies from the response. The method will
-automatically follow redirects.
+The method will populate request cookies from the context and update
+context cookies from the response. The method will automatically follow redirects.
 
 ## post
 
@@ -223,9 +226,12 @@ def post(
       timeout: nil)
 ```
 
+
 Sends HTTP(S) [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) request and returns its response.
-The method will populate request cookies from the context and update context cookies from the response. The method will
-automatically follow redirects.
+The method will populate request cookies from the context and update
+context cookies from the response. The method will automatically follow redirects.
+
+**Usage**
 
 JSON objects can be passed directly to the request:
 
@@ -237,8 +243,7 @@ data = {
 api_request_context.post("https://example.com/api/create_book", data: data)
 ```
 
-To send form data to the server use `form` option. Its value will be encoded into the request body with
-`application/x-www-form-urlencoded` encoding (see below how to use `multipart/form-data` form encoding to send files):
+To send form data to the server use `form` option. Its value will be encoded into the request body with `application/x-www-form-urlencoded` encoding (see below how to use `multipart/form-data` form encoding to send files):
 
 ```ruby
 form_data = {
@@ -248,8 +253,7 @@ form_data = {
 api_request_context.post("https://example.com/api/find_book", form: form_data)
 ```
 
-The common way to send file(s) in the body of a request is to upload them as form fields with `multipart/form-data`
-encoding. You can achieve that with Playwright API like this:
+The common way to send file(s) in the body of a request is to upload them as form fields with `multipart/form-data` encoding. You can achieve that with Playwright API like this:
 
 ```ruby
 api_request_context.post(
@@ -264,8 +268,6 @@ api_request_context.post(
 )
 ```
 
-
-
 ## put
 
 ```
@@ -282,6 +284,7 @@ def put(
       timeout: nil)
 ```
 
-Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its response. The
-method will populate request cookies from the context and update context cookies from the response. The method will
-automatically follow redirects.
+
+Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its response.
+The method will populate request cookies from the context and update
+context cookies from the response. The method will automatically follow redirects.

data/documentation/docs/api/api_response.md

@@ -4,6 +4,7 @@ sidebar_position: 10
 
 # APIResponse
 
+
 [APIResponse](./api_response) class represents responses returned by [APIRequestContext#get](./api_request_context#get) and similar methods.
 
 ```ruby
@@ -19,13 +20,13 @@ playwright.chromium.launch do |browser|
 end
 ```
 
-
 ## body
 
 ```
 def body
 ```
 
+
 Returns the buffer with response body.
 
 ## dispose
@@ -34,6 +35,7 @@ Returns the buffer with response body.
 def dispose
 ```
 
+
 Disposes the body of this response. If not called then the body will stay in memory until the context closes.
 
 ## headers
@@ -42,6 +44,7 @@ Disposes the body of this response. If not called then the body will stay in mem
 def headers
 ```
 
+
 An object with all the response HTTP headers associated with this response.
 
 ## headers_array
@@ -50,8 +53,9 @@ An object with all the response HTTP headers associated with this response.
 def headers_array
 ```
 
-An array with all the request HTTP headers associated with this response. 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. Header names are not lower-cased.
+Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
 
 ## json
 
@@ -59,6 +63,7 @@ multiple entries, such as `Set-Cookie`, appear in the array multiple times.
 def json
 ```
 
+
 Returns the JSON representation of response body.
 
 This method will throw if the response body is not parsable via `JSON.parse`.
@@ -69,6 +74,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.
 
 ## status
@@ -77,6 +83,7 @@ Contains a boolean stating whether the response was successful (status in the ra
 def status
 ```
 
+
 Contains the status code of the response (e.g., 200 for a success).
 
 ## status_text
@@ -85,6 +92,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
@@ -93,6 +101,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
@@ -101,4 +110,5 @@ Returns the text representation of response body.
 def url
 ```
 
+
 Contains the URL of the response.

data/documentation/docs/api/browser.md

@@ -19,14 +19,13 @@ ensure
 end
 ```
 
-
-
 ## browser_type
 
 ```
 def browser_type
 ```
 
+
 Get the browser type (chromium, firefox or webkit) that the browser belongs to.
 
 ## close
@@ -35,15 +34,14 @@ Get the browser type (chromium, firefox or webkit) that the browser belongs to.
 def close
 ```
 
+
 In case this browser is obtained using [BrowserType#launch](./browser_type#launch), closes the browser and all of its pages (if any
 were opened).
 
 In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from the
 browser server.
 
-> NOTE: This is similar to force quitting the browser. Therefore, you should call [BrowserContext#close](./browser_context#close) on
-any [BrowserContext](./browser_context)'s you explicitly created earlier with [Browser#new_context](./browser#new_context) **before** calling
-[Browser#close](./browser#close).
+**NOTE**: This is similar to force quitting the browser. Therefore, you should call [BrowserContext#close](./browser_context#close) on any [BrowserContext](./browser_context)'s you explicitly created earlier with [Browser#new_context](./browser#new_context) **before** calling [Browser#close](./browser#close).
 
 The [Browser](./browser) object itself is considered to be disposed and cannot be used anymore.
 
@@ -53,8 +51,11 @@ The [Browser](./browser) object itself is considered to be disposed and cannot b
 def contexts
 ```
 
+
 Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts.
 
+**Usage**
+
 ```ruby
 playwright.webkit.launch do |browser|
   puts browser.contexts.count # => 0
@@ -63,14 +64,13 @@ playwright.webkit.launch do |browser|
 end
 ```
 
-
-
 ## connected?
 
 ```
 def connected?
 ```
 
+
 Indicates that the browser is connected.
 
 ## new_browser_cdp_session
@@ -79,7 +79,8 @@ Indicates that the browser is connected.
 def new_browser_cdp_session
 ```
 
-> NOTE: CDP Sessions are only supported on Chromium-based browsers.
+
+**NOTE**: CDP Sessions are only supported on Chromium-based browsers.
 
 Returns the newly created browser session.
 
@@ -123,12 +124,13 @@ def new_context(
       &block)
 ```
 
+
 Creates a new browser context. It won't share cookies/cache with other browser contexts.
 
-> NOTE: If directly using this method to create [BrowserContext](./browser_context)s, it is best practice to explicitly close the returned
-context via [BrowserContext#close](./browser_context#close) when your code is done with the [BrowserContext](./browser_context), and before calling
-[Browser#close](./browser#close). This will ensure the `context` is closed gracefully and any artifacts—like HARs and
-videos—are fully flushed and saved.
+**NOTE**: If directly using this method to create [BrowserContext](./browser_context)s, it is best practice to explicitly close the returned context via [BrowserContext#close](./browser_context#close) when your code is done with the [BrowserContext](./browser_context),
+and before calling [Browser#close](./browser#close). This will ensure the `context` is closed gracefully and any artifacts—like HARs and videos—are fully flushed and saved.
+
+**Usage**
 
 ```ruby
 playwright.firefox.launch do |browser| # or "chromium.launch" or "webkit.launch".
@@ -141,8 +143,6 @@ playwright.firefox.launch do |browser| # or "chromium.launch" or "webkit.launch"
 end
 ```
 
-
-
 ## new_page
 
 ```
@@ -183,6 +183,7 @@ def new_page(
       &block)
 ```
 
+
 Creates a new page in a new browser context. Closing this page will close the context as well.
 
 This is a convenience API that should only be used for the single-page scenarios and short snippets. Production code and
@@ -195,12 +196,13 @@ testing frameworks should explicitly create [Browser#new_context](./browser#new_
 def start_tracing(page: nil, categories: nil, path: nil, screenshots: nil)
 ```
 
-> NOTE: This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool)
-which is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](https://playwright.dev/python/docs/trace-viewer) could be
-found [here](./tracing).
 
-You can use [Browser#start_tracing](./browser#start_tracing) and [Browser#stop_tracing](./browser#stop_tracing) to create a trace file that can be
-opened in Chrome DevTools performance panel.
+**NOTE**: This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) which is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](https://playwright.dev/python/docs/trace-viewer) could be found [here](./tracing).
+
+You can use [Browser#start_tracing](./browser#start_tracing) and [Browser#stop_tracing](./browser#stop_tracing) to create a trace file that can
+be opened in Chrome DevTools performance panel.
+
+**Usage**
 
 ```ruby
 browser.start_tracing(page: page, path: "trace.json")
@@ -211,16 +213,14 @@ ensure
 end
 ```
 
-
 ## stop_tracing
 
 ```
 def stop_tracing
 ```
 
-> NOTE: This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool)
-which is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](https://playwright.dev/python/docs/trace-viewer) could be
-found [here](./tracing).
+
+**NOTE**: This API controls [Chromium Tracing](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool) which is a low-level chromium-specific debugging tool. API to control [Playwright Tracing](https://playwright.dev/python/docs/trace-viewer) could be found [here](./tracing).
 
 Returns the buffer with trace data.
 
@@ -230,4 +230,5 @@ Returns the buffer with trace data.
 def version
 ```
 
+
 Returns the browser version.