playwright-ruby-client 1.16.0 → 1.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6230bd49d8e914d2ba9f4d23910e69fcc003f983cf51abb142d4361e1332fd6
-  data.tar.gz: 9cf6be0bde1f294a50604f22f8be756040a02af94c61fff376354c5b1ec8d9fe
+  metadata.gz: 9407fc7093bb4cdb7539eec09b879e4bfd665626801594c764798ae41d3c7823
+  data.tar.gz: e6047ebe532d15fa5600986ae3fc9f42a23ea670923e1ec8fac6f6ecbb7f01c4
 SHA512:
-  metadata.gz: 97bcd9185a7ac82910dcbae93c0131cf285b9c73d881705ae9b88b01fef388b999b4001e37f866f229dba2a0cb0d81af65bee34cb4301eaf16389b927aaba334
-  data.tar.gz: 047dd6e73800e629a439341d720df9e9281e9456f5f94eeeeaf475de7d439c5b0bf97332242497937684ae919e8b603f1b532a97cf6880f16c77f4f42d400ab2
+  metadata.gz: 70b935777666f43236ec9df9b8462ebebf7fb883cde2d57e167d3342a18280a86e286e99e206f47e6ee2c739f23f6afe43daa2def9ea0a322b5e09f3b36bfc81
+  data.tar.gz: 3392ad01696c2c22ba411d7e4821e0bf0a2f641526481201927ff6510d7bb077c9fb6b20fcafabd55e5067ff7b1153b950d6b3c532c0bd14d77b9a0b3ac7c4c0

data/documentation/docs/api/api_request.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 10
+---
+
+# APIRequest
+
+Not Implemented

data/documentation/docs/api/api_request_context.md

@@ -8,3 +8,140 @@ This API is used for the Web API testing. You can use it to trigger API endpoint
 environment or the service to your e2e test. When used on [Page](./page) or a [BrowserContext](./browser_context), this API will automatically use
 the cookies from the corresponding [BrowserContext](./browser_context). This means that if you log in using this API, your e2e test will be
 logged in and vice versa.
+
+## delete
+
+```
+def delete(
+      url,
+      data: nil,
+      failOnStatusCode: nil,
+      form: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      multipart: nil,
+      params: nil,
+      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.
+
+## dispose
+
+```
+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.
+
+## fetch
+
+```
+def fetch(
+      urlOrRequest,
+      data: nil,
+      failOnStatusCode: nil,
+      form: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      method: nil,
+      multipart: nil,
+      params: nil,
+      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.
+
+## get
+
+```
+def get(
+      url,
+      failOnStatusCode: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      params: nil,
+      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.
+
+## head
+
+```
+def head(
+      url,
+      failOnStatusCode: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      params: nil,
+      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.
+
+## patch
+
+```
+def patch(
+      url,
+      data: nil,
+      failOnStatusCode: nil,
+      form: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      multipart: nil,
+      params: nil,
+      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.
+
+## post
+
+```
+def post(
+      url,
+      data: nil,
+      failOnStatusCode: nil,
+      form: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      multipart: nil,
+      params: nil,
+      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.
+
+## put
+
+```
+def put(
+      url,
+      data: nil,
+      failOnStatusCode: nil,
+      form: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      multipart: nil,
+      params: nil,
+      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.

data/documentation/docs/api/api_response.md

@@ -0,0 +1,90 @@
+---
+sidebar_position: 10
+---
+
+# APIResponse
+
+[APIResponse](./api_response) class represents responses returned by [APIRequestContext#get](./api_request_context#get) and similar methods.
+
+## body
+
+```
+def body
+```
+
+Returns the buffer with response body.
+
+## dispose
+
+```
+def dispose
+```
+
+Disposes the body of this response. If not called then the body will stay in memory until the context closes.
+
+## headers
+
+```
+def headers
+```
+
+An object with all the response HTTP headers associated with this response.
+
+## headers_array
+
+```
+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.
+
+## json
+
+```
+def json
+```
+
+Returns the JSON representation of response body.
+
+This method will throw if the response body is not parsable via `JSON.parse`.
+
+## ok
+
+```
+def ok
+```
+
+Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
+
+## status
+
+```
+def status
+```
+
+Contains the status code of the response (e.g., 200 for a success).
+
+## status_text
+
+```
+def status_text
+```
+
+Contains the status text of the response (e.g. usually an "OK" for a success).
+
+## text
+
+```
+def text
+```
+
+Returns the text representation of response body.
+
+## url
+
+```
+def url
+```
+
+Contains the URL of the response.

data/documentation/docs/api/browser_context.md

@@ -436,4 +436,8 @@ def expect_page(predicate: nil, timeout: nil)
 Performs action and waits for a new [Page](./page) to be created in the context. If predicate is provided, it passes [Page](./page) value into the `predicate` and waits for `predicate.call(page)` to return a truthy value. Will throw an error if
 the context closes before new [Page](./page) is created.
 
+## request
+
+API testing helper associated with this context. Requests made with this API will use context cookies.
+
 ## tracing

data/documentation/docs/api/element_handle.md

@@ -9,6 +9,8 @@ sidebar_position: 10
 ElementHandle represents an in-page DOM element. ElementHandles can be created with the [Page#query_selector](./page#query_selector)
 method.
 
+> NOTE: The use of ElementHandle is discouraged, use [Locator](./locator) objects and web-first assertions instead.
+
 ```ruby
 href_element = page.query_selector("a")
 href_element.click
@@ -20,9 +22,6 @@ ElementHandle prevents DOM element from garbage collection unless the handle is
 ElementHandle instances can be used as an argument in [Page#eval_on_selector](./page#eval_on_selector) and [Page#evaluate](./page#evaluate)
 methods.
 
-> NOTE: In most cases, you would want to use the [Locator](./locator) object instead. You should only use [ElementHandle](./element_handle) if you
-want to retain a handle to a particular DOM Node that you intend to pass into [Page#evaluate](./page#evaluate) as an argument.
-
 The difference between the [Locator](./locator) and ElementHandle is that the ElementHandle points to a particular element, while
 [Locator](./locator) captures the logic of how to retrieve an element.
 

data/documentation/docs/api/frame.md

@@ -218,6 +218,9 @@ def eval_on_selector(selector, expression, arg: nil, strict: nil)
 
 Returns the return value of `expression`.
 
+> NOTE: This method does not wait for the element to pass actionability checks and therefore can lead to the flaky
+tests. Use [Locator#evaluate](./locator#evaluate), other [Locator](./locator) helper methods or web-first assertions instead.
+
 The method finds an element matching the specified selector within the frame and passes it as a first argument to
 `expression`. See [Working with selectors](https://playwright.dev/python/docs/selectors) for more details. If no elements match the selector, the
 method throws an error.
@@ -243,6 +246,9 @@ def eval_on_selector_all(selector, expression, arg: nil)
 
 Returns the return value of `expression`.
 
+> NOTE: In most cases, [Locator#evaluate_all](./locator#evaluate_all), other [Locator](./locator) helper methods and web-first assertions do a
+better job.
+
 The method finds all elements matching the specified selector within the frame and passes an array of matched elements
 as a first argument to `expression`. See [Working with selectors](https://playwright.dev/python/docs/selectors) for more details.
 
@@ -384,6 +390,23 @@ puts frame == content_frame # => true
 
 
 
+## frame_locator
+
+```
+def frame_locator(selector)
+```
+
+When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
+that iframe. Following snippet locates element with text "Submit" in the iframe with id `my-frame`, like `<iframe
+id="my-frame">`:
+
+```ruby
+locator = frame.frame_locator("#my-iframe").locator("text=Submit")
+locator.click
+```
+
+
+
 ## get_attribute
 
 ```
@@ -598,6 +621,8 @@ def query_selector(selector, strict: nil)
 
 Returns the ElementHandle pointing to the frame element.
 
+> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects and web-first assertions instead.
+
 The method finds an element matching the specified selector within the frame. See
 [Working with selectors](https://playwright.dev/python/docs/selectors) for more details. If no elements match the selector, returns `null`.
 
@@ -609,6 +634,8 @@ def query_selector_all(selector)
 
 Returns the ElementHandles pointing to the frame elements.
 
+> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects instead.
+
 The method finds all elements matching the specified selector within the frame. See
 [Working with selectors](https://playwright.dev/python/docs/selectors) for more details. If no elements match the selector, returns empty array.
 
@@ -878,6 +905,9 @@ def wait_for_selector(selector, state: nil, strict: nil, timeout: nil)
 Returns when element specified by selector satisfies `state` option. Returns `null` if waiting for `hidden` or
 `detached`.
 
+> NOTE: Playwright automatically waits for element to be ready before performing an action. Using [Locator](./locator) objects and
+web-first assertions make the code wait-for-selector-free.
+
 Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If at
 the moment of calling the method `selector` already satisfies the condition, the method will return immediately. If the
 selector doesn't satisfy the condition for the `timeout` milliseconds, the function will throw.

data/documentation/docs/api/frame_locator.md

@@ -0,0 +1,70 @@
+---
+sidebar_position: 10
+---
+
+# FrameLocator
+
+FrameLocator represents a view to the `iframe` on the page. It captures the logic sufficient to retrieve the `iframe`
+and locate elements in that iframe. FrameLocator can be created with either [Page#frame_locator](./page#frame_locator) or
+[Locator#frame_locator](./locator#frame_locator) method.
+
+```ruby
+locator = page.frame_locator("my-frame").locator("text=Submit")
+locator.click
+```
+
+**Strictness**
+
+Frame locators are strict. This means that all operations on frame locators will throw if more than one element matches
+given selector.
+
+```ruby
+# Throws if there are several frames in DOM:
+page.frame_locator('.result-frame').locator('button').click
+
+# Works because we explicitly tell locator to pick the first frame:
+page.frame_locator('.result-frame').first.locator('button').click
+```
+
+
+
+## first
+
+```
+def first
+```
+
+Returns locator to the first matching frame.
+
+## frame_locator
+
+```
+def frame_locator(selector)
+```
+
+When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
+that iframe.
+
+## last
+
+```
+def last
+```
+
+Returns locator to the last matching frame.
+
+## locator
+
+```
+def locator(selector)
+```
+
+The method finds an element matching the specified selector in the FrameLocator's subtree.
+
+## nth
+
+```
+def nth(index)
+```
+
+Returns locator to the n-th matching frame.

data/documentation/docs/api/locator.md

@@ -329,6 +329,22 @@ def focus(timeout: nil)
 
 Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element.
 
+## frame_locator
+
+```
+def frame_locator(selector)
+```
+
+When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
+that iframe:
+
+```ruby
+locator = page.frame_locator("text=Submit").locator("text=Submit")
+locator.click
+```
+
+
+
 ## get_attribute
 
 ```
@@ -445,8 +461,7 @@ Returns locator to the last matching element.
 def locator(selector)
 ```
 
-The method finds an element matching the specified selector in the [Locator](./locator)'s subtree. See
-[Working with selectors](https://playwright.dev/python/docs/selectors) for more details.
+The method finds an element matching the specified selector in the [Locator](./locator)'s subtree.
 
 ## nth
 

data/documentation/docs/api/page.md

@@ -315,6 +315,9 @@ page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches") # =
 def eval_on_selector(selector, expression, arg: nil, strict: nil)
 ```
 
+> NOTE: This method does not wait for the element to pass actionability checks and therefore can lead to the flaky
+tests. Use [Locator#evaluate](./locator#evaluate), other [Locator](./locator) helper methods or web-first assertions instead.
+
 The method finds an element matching the specified selector within the page and passes it as a first argument to
 `expression`. If no elements match the selector, the method throws an error. Returns the value of `expression`.
 
@@ -337,6 +340,9 @@ Shortcut for main frame's [Frame#eval_on_selector](./frame#eval_on_selector).
 def eval_on_selector_all(selector, expression, arg: nil)
 ```
 
+> NOTE: In most cases, [Locator#evaluate_all](./locator#evaluate_all), other [Locator](./locator) helper methods and web-first assertions do a
+better job.
+
 The method finds all elements matching the specified selector within the page and passes an array of matched elements as
 a first argument to `expression`. Returns the result of `expression` invocation.
 
@@ -575,6 +581,23 @@ frame = page.frame(url: /.*domain.*/)
 
 
 
+## frame_locator
+
+```
+def frame_locator(selector)
+```
+
+When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
+that iframe. Following snippet locates element with text "Submit" in the iframe with id `my-frame`, like `<iframe
+id="my-frame">`:
+
+```ruby
+locator = page.frame_locator("#my-iframe").locator("text=Submit")
+locator.click
+```
+
+
+
 ## frames
 
 ```
@@ -905,8 +928,10 @@ page.screenshot(path: "o.png")
 def query_selector(selector, strict: nil)
 ```
 
+> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects and web-first assertions instead.
+
 The method finds an element matching the specified selector within the page. If no elements match the selector, the
-return value resolves to `null`. To wait for an element on the page, use [Page#wait_for_selector](./page#wait_for_selector).
+return value resolves to `null`. To wait for an element on the page, use [Locator#wait_for](./locator#wait_for).
 
 Shortcut for main frame's [Frame#query_selector](./frame#query_selector).
 
@@ -916,6 +941,8 @@ Shortcut for main frame's [Frame#query_selector](./frame#query_selector).
 def query_selector_all(selector)
 ```
 
+> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects and web-first assertions instead.
+
 The method finds all elements matching the specified selector within the page. If no elements match the selector, the
 return value resolves to `[]`.
 
@@ -927,8 +954,8 @@ Shortcut for main frame's [Frame#query_selector_all](./frame#query_selector_all)
 def reload(timeout: nil, waitUntil: nil)
 ```
 
-Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
-last redirect.
+This method reloads the current page, in the same way as if the user had triggered a browser refresh. Returns the main
+resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
 
 ## route
 
@@ -1484,6 +1511,9 @@ def wait_for_selector(selector, state: nil, strict: nil, timeout: nil)
 Returns when element specified by selector satisfies `state` option. Returns `null` if waiting for `hidden` or
 `detached`.
 
+> NOTE: Playwright automatically waits for element to be ready before performing an action. Using [Locator](./locator) objects and
+web-first assertions make the code wait-for-selector-free.
+
 Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If at
 the moment of calling the method `selector` already satisfies the condition, the method will return immediately. If the
 selector doesn't satisfy the condition for the `timeout` milliseconds, the function will throw.

data/documentation/docs/api/request.md

@@ -127,10 +127,10 @@ 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
-`redirectedFrom()` and `redirectedTo()` methods. When multiple server redirects has happened, it is possible to
-construct the whole redirect chain by repeatedly calling `redirectedFrom()`.
+[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).
 
-For example, if the website `http://example.com` redirects to `https://example.com`:
+For example, if the website `http://github.com` redirects to `https://github.com`:
 
 ```ruby
 response = page.goto("http://github.com")

data/documentation/docs/api/selectors.md

@@ -41,7 +41,7 @@ playwright.chromium.launch do |browser|
   page.click('tag=div >> text="Click me"')
 
   # Can use it in any methods supporting selectors.
-  button_count = page.eval_on_selector_all('tag=button', 'buttons => buttons.length')
+  button_count = page.locator('tag=button').count
   button_count # => 1
 end
 ```

data/documentation/docs/api/tracing.md

@@ -23,7 +23,7 @@ end
 ## start
 
 ```
-def start(name: nil, screenshots: nil, snapshots: nil)
+def start(name: nil, screenshots: nil, snapshots: nil, title: nil)
 ```
 
 Start tracing.
@@ -40,7 +40,7 @@ context.tracing.stop(path: 'trace.zip')
 ## start_chunk
 
 ```
-def 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

data/documentation/docs/include/api_coverage.md

@@ -1,17 +1,5 @@
 # API coverages
 
-## APIRequestContext
-
-* ~~delete~~
-* ~~dispose~~
-* ~~fetch~~
-* ~~get~~
-* ~~head~~
-* ~~patch~~
-* ~~post~~
-* ~~put~~
-* ~~storage_state~~
-
 ## Request
 
 * all_headers
@@ -167,6 +155,7 @@
 * fill
 * focus
 * frame_element
+* frame_locator
 * get_attribute
 * goto
 * hover
@@ -264,6 +253,7 @@
 * fill
 * focus
 * frame
+* frame_locator
 * frames
 * get_attribute
 * go_back
@@ -359,6 +349,7 @@
 * expect_event
 * expect_page
 * ~~wait_for_event~~
+* request
 * tracing
 
 ## CDPSession
@@ -393,6 +384,7 @@
 * chromium
 * devices
 * firefox
+* ~~request~~
 * selectors
 * webkit
 
@@ -421,6 +413,7 @@
 * fill
 * first
 * focus
+* frame_locator
 * get_attribute
 * hover
 * inner_html
@@ -448,6 +441,43 @@
 * uncheck
 * wait_for
 
+## FrameLocator
+
+* first
+* frame_locator
+* last
+* locator
+* nth
+
+## APIResponse
+
+* body
+* dispose
+* headers
+* headers_array
+* json
+* ok
+* status
+* status_text
+* text
+* url
+
+## APIRequestContext
+
+* delete
+* dispose
+* fetch
+* get
+* head
+* patch
+* post
+* put
+* ~~storage_state~~
+
+## ~~APIRequest~~
+
+* ~~new_context~~
+
 ## Android
 
 * devices