playwright-ruby-client 1.17.beta1 → 1.18.1

data/lib/playwright_api/api_request_context.rb

@@ -3,6 +3,53 @@ module Playwright
   # environment or the service to your e2e test. When used on `Page` or a `BrowserContext`, this API will automatically use
   # the cookies from the corresponding `BrowserContext`. This means that if you log in using this API, your e2e test will be
   # logged in and vice versa.
+  #
+  # ```python sync
+  # import os
+  # from playwright.sync_api import sync_playwright
+  #
+  # REPO = "test-repo-1"
+  # USER = "github-username"
+  # API_TOKEN = os.getenv("GITHUB_API_TOKEN")
+  #
+  # with sync_playwright() as p:
+  #     # This will launch a new browser, create a context and page. When making HTTP
+  #     # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)
+  #     # it will automatically set the cookies to the browser page and vise versa.
+  #     browser = playwright.chromium.launch()
+  #     context = browser.new_context(base_url="https://api.github.com")
+  #     api_request_context = context.request
+  #     page = context.new_page()
+  #
+  #     # Alternatively you can create a APIRequestContext manually without having a browser context attached:
+  #     # api_request_context = playwright.request.new_context(base_url="https://api.github.com")
+  #
+  #
+  #     # Create a repository.
+  #     response = api_request_context.post(
+  #         "/user/repos",
+  #         headers={
+  #             "Accept": "application/vnd.github.v3+json",
+  #             # Add GitHub personal access token.
+  #             "Authorization": f"token {API_TOKEN}",
+  #         },
+  #         data={"name": REPO},
+  #     )
+  #     assert response.ok
+  #     assert response.json()["name"] == REPO
+  #
+  #     # Delete a repository.
+  #     response = api_request_context.delete(
+  #         f"/repos/{USER}/{REPO}",
+  #         headers={
+  #             "Accept": "application/vnd.github.v3+json",
+  #             # Add GitHub personal access token.
+  #             "Authorization": f"token {API_TOKEN}",
+  #         },
+  #     )
+  #     assert response.ok
+  #     assert await response.body() == '{"status": "ok"}'
+  # ```
   class APIRequestContext < PlaywrightApi
 
     # Sends HTTP(S) [DELETE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE) request and returns its
@@ -18,14 +65,14 @@ module Playwright
           multipart: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('delete is not implemented yet.')
+      wrap_impl(@impl.delete(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # All responses returned by [`method: APIRequestContext.get`] and similar methods are stored in the memory, so that you
     # can later call [`method: APIResponse.body`]. This method discards all stored responses, and makes
     # [`method: APIResponse.body`] throw "Response disposed" error.
     def dispose
-      raise NotImplementedError.new('dispose is not implemented yet.')
+      wrap_impl(@impl.dispose)
     end
 
     # Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update
@@ -41,7 +88,7 @@ module Playwright
           multipart: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('fetch is not implemented yet.')
+      wrap_impl(@impl.fetch(unwrap_impl(urlOrRequest), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), method: unwrap_impl(method), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its response. The
@@ -54,7 +101,7 @@ module Playwright
           ignoreHTTPSErrors: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('get is not implemented yet.')
+      wrap_impl(@impl.get(unwrap_impl(url), failOnStatusCode: unwrap_impl(failOnStatusCode), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), 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.
@@ -67,7 +114,7 @@ module Playwright
           ignoreHTTPSErrors: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('head is not implemented yet.')
+      wrap_impl(@impl.head(unwrap_impl(url), failOnStatusCode: unwrap_impl(failOnStatusCode), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), 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.
@@ -83,7 +130,7 @@ module Playwright
           multipart: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('patch is not implemented yet.')
+      wrap_impl(@impl.patch(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # Sends HTTP(S) [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) request and returns its response.
@@ -99,7 +146,7 @@ module Playwright
           multipart: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('post is not implemented yet.')
+      wrap_impl(@impl.post(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its response. The
@@ -115,7 +162,7 @@ module Playwright
           multipart: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('put is not implemented yet.')
+      wrap_impl(@impl.put(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to
@@ -124,12 +171,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)
@@ -142,6 +183,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/api_response.rb

@@ -0,0 +1,81 @@
+module Playwright
+  # `APIResponse` class represents responses returned by [`method: APIRequestContext.get`] and similar methods.
+  #
+  # ```python sync
+  # from playwright.sync_api import sync_playwright
+  #
+  # with sync_playwright() as p:
+  #     context = playwright.request.new_context()
+  #     response = context.get("https://example.com/user/repos")
+  #     assert response.ok
+  #     assert response.status == 200
+  #     assert response.headers["content-type"] == "application/json; charset=utf-8"
+  #     assert response.json()["name"] == "foobar"
+  #     assert response.body() == '{"status": "ok"}'
+  # ```
+  class APIResponse < PlaywrightApi
+
+    # Returns the buffer with response body.
+    def body
+      wrap_impl(@impl.body)
+    end
+
+    # Disposes the body of this response. If not called then the body will stay in memory until the context closes.
+    def dispose
+      wrap_impl(@impl.dispose)
+    end
+
+    # An object with all the response HTTP headers associated with this response.
+    def headers
+      wrap_impl(@impl.headers)
+    end
+
+    # 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.
+    def headers_array
+      wrap_impl(@impl.headers_array)
+    end
+
+    # Returns the JSON representation of response body.
+    #
+    # This method will throw if the response body is not parsable via `JSON.parse`.
+    def json
+      wrap_impl(@impl.json)
+    end
+
+    # Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
+    def ok
+      wrap_impl(@impl.ok)
+    end
+
+    # Contains the status code of the response (e.g., 200 for a success).
+    def status
+      wrap_impl(@impl.status)
+    end
+
+    # Contains the status text of the response (e.g. usually an "OK" for a success).
+    def status_text
+      wrap_impl(@impl.status_text)
+    end
+
+    # Returns the text representation of response body.
+    def text
+      wrap_impl(@impl.text)
+    end
+
+    # Contains the URL of the response.
+    def url
+      wrap_impl(@impl.url)
+    end
+
+    # @nodoc
+    def ok?
+      wrap_impl(@impl.ok?)
+    end
+
+    # @nodoc
+    def to_s
+      wrap_impl(@impl.to_s)
+    end
+  end
+end

data/lib/playwright_api/browser.rb

@@ -166,12 +166,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)
@@ -184,6 +178,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

@@ -22,7 +22,7 @@ module Playwright
 
     # API testing helper associated with this context. Requests made with this API will use context cookies.
     def request # property
-      raise NotImplementedError.new('request is not implemented yet.')
+      wrap_impl(@impl.request)
     end
 
     def tracing # property
@@ -371,6 +371,11 @@ module Playwright
       raise NotImplementedError.new('wait_for_event is not implemented yet.')
     end
 
+    # @nodoc
+    def pause
+      wrap_impl(@impl.pause)
+    end
+
     # @nodoc
     def enable_debug_console!
       wrap_impl(@impl.enable_debug_console!)
@@ -386,22 +391,11 @@ module Playwright
       wrap_impl(@impl.owner_page=(unwrap_impl(req)))
     end
 
-    # @nodoc
-    def pause
-      wrap_impl(@impl.pause)
-    end
-
     # @nodoc
     def options=(req)
       wrap_impl(@impl.options=(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)
@@ -414,6 +408,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

@@ -146,12 +146,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)
@@ -164,6 +158,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

@@ -23,12 +23,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)
@@ -41,6 +35,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

@@ -12,10 +12,6 @@ module Playwright
   # # wait for download to complete
   # path = download.path()
   # ```
-  #
-  # > NOTE: Browser context **must** be created with the `acceptDownloads` set to `true` when user needs access to the
-  # downloaded content. If `acceptDownloads` is not set, download events are emitted, but the actual download is not
-  # performed and user has no access to the downloaded files.
   class Download < PlaywrightApi
 
     # Cancels a download. Will not fail if the download is already finished or canceled. Upon successful cancellations,

data/lib/playwright_api/element_handle.rb

@@ -551,12 +551,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)
@@ -569,6 +563,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/frame.rb

@@ -445,8 +445,8 @@ module Playwright
     # 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.
-    def locator(selector)
-      wrap_impl(@impl.locator(unwrap_impl(selector)))
+    def locator(selector, hasText: nil)
+      wrap_impl(@impl.locator(unwrap_impl(selector), hasText: unwrap_impl(hasText)))
     end
 
     # Returns frame's name attribute as specified in the tag.
@@ -788,12 +788,6 @@ module Playwright
       wrap_impl(@impl.detached=(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)
@@ -806,6 +800,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/frame_locator.rb

@@ -20,6 +20,15 @@ module Playwright
   # # Works because we explicitly tell locator to pick the first frame:
   # page.frame_locator('.result-frame').first.locator('button').click()
   # ```
+  #
+  # **Converting Locator to FrameLocator**
+  #
+  # If you have a `Locator` object pointing to an `iframe` it can be converted to `FrameLocator` using
+  # [`:scope`](https://developer.mozilla.org/en-US/docs/Web/CSS/:scope) CSS selector:
+  #
+  # ```python sync
+  # frameLocator = locator.frame_locator(":scope");
+  # ```
   class FrameLocator < PlaywrightApi
 
     # Returns locator to the first matching frame.
@@ -39,8 +48,8 @@ module Playwright
     end
 
     # The method finds an element matching the specified selector in the FrameLocator's subtree.
-    def locator(selector)
-      wrap_impl(@impl.locator(unwrap_impl(selector)))
+    def locator(selector, hasText: nil)
+      wrap_impl(@impl.locator(unwrap_impl(selector), hasText: unwrap_impl(hasText)))
     end
 
     # Returns locator to the n-th matching frame.

data/lib/playwright_api/js_handle.rb

@@ -88,12 +88,6 @@ module Playwright
       wrap_impl(@impl.to_s)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -106,6 +100,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/local_utils.rb

@@ -0,0 +1,9 @@
+module Playwright
+  class LocalUtils < PlaywrightApi
+
+    # @nodoc
+    def zip(zip_file, name_value_array)
+      wrap_impl(@impl.zip(unwrap_impl(zip_file), unwrap_impl(name_value_array)))
+    end
+  end
+end

data/lib/playwright_api/locator.rb

@@ -1,49 +1,8 @@
 module Playwright
-  # Locator represents a view to the element(s) on the page. It captures the logic sufficient to retrieve the element at any
-  # given moment. Locator can be created with the [`method: Page.locator`] method.
+  # Locators are the central piece of Playwright's auto-waiting and retry-ability. In a nutshell, locators represent a way
+  # to find element(s) on the page at any moment. Locator can be created with the [`method: Page.locator`] method.
   #
-  # ```python sync
-  # locator = page.locator("text=Submit")
-  # locator.click()
-  # ```
-  #
-  # The difference between the Locator and `ElementHandle` is that the latter points to a particular element, while Locator
-  # captures the logic of how to retrieve that element.
-  #
-  # In the example below, handle points to a particular DOM element on page. If that element changes text or is used by
-  # React to render an entirely different component, handle is still pointing to that very DOM element. This can lead to
-  # unexpected behaviors.
-  #
-  # ```python sync
-  # handle = page.query_selector("text=Submit")
-  # handle.hover()
-  # handle.click()
-  # ```
-  #
-  # With the locator, every time the `element` is used, up-to-date DOM element is located in the page using the selector. So
-  # in the snippet below, underlying DOM element is going to be located twice.
-  #
-  # ```python sync
-  # locator = page.locator("text=Submit")
-  # locator.hover()
-  # locator.click()
-  # ```
-  #
-  # **Strictness**
-  #
-  # Locators are strict. This means that all operations on locators that imply some target DOM element will throw if more
-  # than one element matches given selector.
-  #
-  # ```python sync
-  # # Throws if there are several buttons in DOM:
-  # page.locator('button').click()
-  #
-  # # Works because we explicitly tell locator to pick the first element:
-  # page.locator('button').first.click()
-  #
-  # # Works because count knows what to do with multiple matches:
-  # page.locator('button').count()
-  # ```
+  # [Learn more about locators](./locators.md).
   class Locator < PlaywrightApi
 
     # Returns an array of `node.innerText` values for all matching nodes.
@@ -183,6 +142,17 @@ module Playwright
       wrap_impl(@impl.dispatch_event(unwrap_impl(type), eventInit: unwrap_impl(eventInit), timeout: unwrap_impl(timeout)))
     end
 
+    def drag_to(
+          target,
+          force: nil,
+          noWaitAfter: nil,
+          sourcePosition: nil,
+          targetPosition: nil,
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.drag_to(unwrap_impl(target), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), sourcePosition: unwrap_impl(sourcePosition), targetPosition: unwrap_impl(targetPosition), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+    end
+
     # Resolves given locator to the first matching DOM element. If no elements matching the query are visible, waits for them
     # up to a given timeout. If multiple elements match the selector, throws.
     def element_handle(timeout: nil)
@@ -350,8 +320,8 @@ module Playwright
     end
 
     # The method finds an element matching the specified selector in the `Locator`'s subtree.
-    def locator(selector)
-      wrap_impl(@impl.locator(unwrap_impl(selector)))
+    def locator(selector, hasText: nil)
+      wrap_impl(@impl.locator(unwrap_impl(selector), hasText: unwrap_impl(hasText)))
     end
 
     # Returns locator to the n-th matching element.