playwright-ruby-client 1.26.0 → 1.28.0

data/lib/playwright_api/api_request_context.rb

@@ -91,6 +91,32 @@ module Playwright
 
     # 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.
+    #
+    # JSON objects can be passed directly to the request:
+    #
+    # ```python
+    # data = {
+    #     "title": "Book Title",
+    #     "body": "John Doe",
+    # }
+    # api_request_context.fetch("https://example.com/api/createBook", 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:
+    #
+    # ```python
+    # api_request_context.fetch(
+    #   "https://example.com/api/uploadScrip'",
+    #   method="post",
+    #   multipart={
+    #     "fileField": {
+    #       "name": "f.js",
+    #       "mimeType": "text/javascript",
+    #       "buffer": b"console.log(2022);",
+    #     },
+    #   })
+    # ```
     def fetch(
           urlOrRequest,
           data: nil,
@@ -109,15 +135,28 @@ module Playwright
     # 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.
+    #
+    # Request parameters can be configured with `params` option, they will be serialized into the URL search parameters:
+    #
+    # ```python
+    # query_params = {
+    #   "isbn": "1234",
+    #   "page": "23"
+    # }
+    # api_request_context.get("https://example.com/api/getText", params=query_params)
+    # ```
     def get(
           url,
+          data: nil,
           failOnStatusCode: nil,
+          form: nil,
           headers: nil,
           ignoreHTTPSErrors: nil,
           maxRedirects: nil,
+          multipart: nil,
           params: nil,
           timeout: nil)
-      wrap_impl(@impl.get(unwrap_impl(url), failOnStatusCode: unwrap_impl(failOnStatusCode), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
+      wrap_impl(@impl.get(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # Sends HTTP(S) [HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) request and returns its response.
@@ -125,13 +164,16 @@ module Playwright
     # automatically follow redirects.
     def head(
           url,
+          data: nil,
           failOnStatusCode: nil,
+          form: nil,
           headers: nil,
           ignoreHTTPSErrors: nil,
           maxRedirects: nil,
+          multipart: nil,
           params: nil,
           timeout: nil)
-      wrap_impl(@impl.head(unwrap_impl(url), failOnStatusCode: unwrap_impl(failOnStatusCode), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
+      wrap_impl(@impl.head(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # Sends HTTP(S) [PATCH](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH) request and returns its response.
@@ -154,6 +196,42 @@ module Playwright
     # 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.
+    #
+    # JSON objects can be passed directly to the request:
+    #
+    # ```python
+    # data = {
+    #     "title": "Book Title",
+    #     "body": "John Doe",
+    # }
+    # api_request_context.post("https://example.com/api/createBook", 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):
+    #
+    # ```python
+    # formData = {
+    #     "title": "Book Title",
+    #     "body": "John Doe",
+    # }
+    # api_request_context.post("https://example.com/api/findBook", form=formData)
+    # ```
+    #
+    # 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:
+    #
+    # ```python
+    # api_request_context.post(
+    #   "https://example.com/api/uploadScrip'",
+    #   multipart={
+    #     "fileField": {
+    #       "name": "f.js",
+    #       "mimeType": "text/javascript",
+    #       "buffer": b"console.log(2022);",
+    #     },
+    #   })
+    # ```
     def post(
           url,
           data: nil,
@@ -191,12 +269,6 @@ module Playwright
       raise NotImplementedError.new('storage_state is not implemented yet.')
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -209,6 +281,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser.rb

@@ -192,12 +192,6 @@ module Playwright
       wrap_impl(@impl.version)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -210,6 +204,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser_context.rb

@@ -131,7 +131,7 @@ module Playwright
     #     <button onclick="onClick()">Click me</button>
     #     <div></div>
     #     """)
-    #     page.locator("button").click()
+    #     page.get_by_role("button").click()
     #
     # with sync_playwright() as playwright:
     #     run(playwright)
@@ -190,7 +190,7 @@ module Playwright
     #         <button onclick="onClick()">Click me</button>
     #         <div></div>
     #     """)
-    #     page.locator("button").click()
+    #     page.get_by_role("button").click()
     #
     # with sync_playwright() as playwright:
     #     run(playwright)
@@ -358,7 +358,7 @@ module Playwright
     #
     # ```python sync
     # with context.expect_event("page") as event_info:
-    #     page.locator("button").click()
+    #     page.get_by_role("button").click()
     # page = event_info.value
     # ```
     def expect_event(event, predicate: nil, timeout: nil, &block)
@@ -406,12 +406,6 @@ module Playwright
       wrap_impl(@impl.owner_page=(unwrap_impl(req)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -424,6 +418,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/browser_type.rb

@@ -158,12 +158,6 @@ module Playwright
       wrap_impl(@impl.name)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -176,6 +170,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/cdp_session.rb

@@ -33,12 +33,6 @@ module Playwright
       wrap_impl(@impl.send_message(unwrap_impl(method), params: unwrap_impl(params)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -51,6 +45,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/console_message.rb

@@ -42,12 +42,6 @@ module Playwright
       wrap_impl(@impl.type)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -60,6 +54,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/dialog.rb

@@ -58,12 +58,6 @@ module Playwright
       wrap_impl(@impl.accept_async(promptText: unwrap_impl(promptText)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -76,6 +70,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/download.rb

@@ -7,7 +7,7 @@ module Playwright
   #
   # ```python sync
   # with page.expect_download() as download_info:
-  #     page.locator("a").click()
+  #     page.get_by_text("Download file").click()
   # download = download_info.value
   # # wait for download to complete
   # path = download.path()

data/lib/playwright_api/element_handle.rb

@@ -36,7 +36,7 @@ module Playwright
   # in the snippet below, underlying DOM element is going to be located twice.
   #
   # ```python sync
-  # locator = page.locator("text=Submit")
+  # locator = page.get_by_text("Submit")
   # locator.hover()
   # locator.click()
   # ```
@@ -251,10 +251,11 @@ module Playwright
     def hover(
           force: nil,
           modifiers: nil,
+          noWaitAfter: nil,
           position: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.hover(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.hover(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns the `element.innerHTML`.
@@ -557,12 +558,6 @@ module Playwright
       wrap_impl(@impl.wait_for_selector(unwrap_impl(selector), state: unwrap_impl(state), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -575,6 +570,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/file_chooser.rb

@@ -3,7 +3,7 @@ module Playwright
   #
   # ```python sync
   # with page.expect_file_chooser() as fc_info:
-  #     page.locator("upload").click()
+  #     page.get_by_text("Upload").click()
   # file_chooser = fc_info.value
   # file_chooser.set_files("myfile.pdf")
   # ```

data/lib/playwright_api/frame.rb

@@ -335,7 +335,7 @@ module Playwright
     # id="my-frame">`:
     #
     # ```python sync
-    # locator = frame.frame_locator("#my-iframe").locator("text=Submit")
+    # locator = frame.frame_locator("#my-iframe").get_by_text("Submit")
     # locator.click()
     # ```
     def frame_locator(selector)
@@ -347,6 +347,111 @@ module Playwright
       wrap_impl(@impl.get_attribute(unwrap_impl(selector), unwrap_impl(name), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    # Allows locating elements by their alt text. For example, this method will find the image by alt text "Castle":
+    #
+    # ```html
+    # <img alt='Castle'>
+    # ```
+    def get_by_alt_text(text, exact: nil)
+      wrap_impl(@impl.get_by_alt_text(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # Allows locating input elements by the text of the associated label. For example, this method will find the input by
+    # label text "Password" in the following DOM:
+    #
+    # ```html
+    # <label for="password-input">Password:</label>
+    # <input id="password-input">
+    # ```
+    def get_by_label(text, exact: nil)
+      wrap_impl(@impl.get_by_label(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # Allows locating input elements by the placeholder text. For example, this method will find the input by placeholder
+    # "Country":
+    #
+    # ```html
+    # <input placeholder="Country">
+    # ```
+    def get_by_placeholder(text, exact: nil)
+      wrap_impl(@impl.get_by_placeholder(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # Allows locating elements by their [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles),
+    # [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and
+    # [accessible name](https://w3c.github.io/accname/#dfn-accessible-name). Note that role selector **does not replace**
+    # accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.
+    #
+    # Note that many html elements have an implicitly
+    # [defined role](https://w3c.github.io/html-aam/#html-element-role-mappings) that is recognized by the role selector. You
+    # can find all the [supported roles here](https://www.w3.org/TR/wai-aria-1.2/#role_definitions). ARIA guidelines **do not
+    # recommend** duplicating implicit roles and attributes by setting `role` and/or `aria-*` attributes to default values.
+    def get_by_role(
+          role,
+          checked: nil,
+          disabled: nil,
+          exact: nil,
+          expanded: nil,
+          includeHidden: nil,
+          level: nil,
+          name: nil,
+          pressed: nil,
+          selected: nil)
+      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), exact: unwrap_impl(exact), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
+    end
+
+    # Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
+    # [`method: Selectors.setTestIdAttribute`] to configure a different test id attribute if necessary.
+    def get_by_test_id(testId)
+      wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
+    end
+
+    # Allows locating elements that contain given text. Consider the following DOM structure:
+    #
+    # ```html
+    # <div>Hello <span>world</span></div>
+    # <div>Hello</div>
+    # ```
+    #
+    # You can locate by text substring, exact string, or a regular expression:
+    #
+    # ```python sync
+    # # Matches <span>
+    # page.get_by_text("world")
+    #
+    # # Matches first <div>
+    # page.get_by_text("Hello world")
+    #
+    # # Matches second <div>
+    # page.get_by_text("Hello", exact=True)
+    #
+    # # Matches both <div>s
+    # page.get_by_text(re.compile("Hello"))
+    #
+    # # Matches second <div>
+    # page.get_by_text(re.compile("^hello$", re.IGNORECASE))
+    # ```
+    #
+    # See also [`method: Locator.filter`] that allows to match by another criteria, like an accessible role, and then filter
+    # by the text content.
+    #
+    # > NOTE: Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into
+    # one, turns line breaks into spaces and ignores leading and trailing whitespace.
+    # > NOTE: Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For
+    # example, locating by text `"Log in"` matches `<input type=button value="Log in">`.
+    def get_by_text(text, exact: nil)
+      wrap_impl(@impl.get_by_text(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # Allows locating elements by their title. For example, this method will find the button by its title "Place the order":
+    #
+    # ```html
+    # <button title='Place the order'>Order Now</button>
+    # ```
+    def get_by_title(text, exact: nil)
+      wrap_impl(@impl.get_by_title(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
     # Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
     # last redirect.
     #
@@ -383,11 +488,12 @@ module Playwright
           selector,
           force: nil,
           modifiers: nil,
+          noWaitAfter: nil,
           position: nil,
           strict: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.hover(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.hover(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns `element.innerHTML`.
@@ -445,9 +551,11 @@ module Playwright
       wrap_impl(@impl.visible?(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
-    # The method returns an element locator that can be used to perform actions in the frame. Locator is resolved to the
-    # element immediately before performing an action, so a series of actions on the same locator can in fact be performed on
-    # different DOM elements. That would happen if the DOM structure between those actions has changed.
+    # The method returns an element locator that can be used to perform actions on this page / frame. Locator is resolved to
+    # the element immediately before performing an action, so a series of actions on the same locator can in fact be performed
+    # on different DOM elements. That would happen if the DOM structure between those actions has changed.
+    #
+    # [Learn more about locators](../locators.md).
     #
     # [Learn more about locators](../locators.md).
     def locator(selector, has: nil, hasText: nil)
@@ -800,12 +908,6 @@ module Playwright
       wrap_impl(@impl.highlight(unwrap_impl(selector)))
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -818,6 +920,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end