playwright-ruby-client 0.6.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 330a0cd5755fdbe5136276e881415f5966f159b2abc62f66a26ab5068b326efe
-  data.tar.gz: 6108f18234e97d483c17958bee26628f4068be0438d1ce5553748ff1f7489acd
+  metadata.gz: 05e5dff936dc4eda78a295d4f6935b5b92d6e82046de9a36c9f4b67aba24e89f
+  data.tar.gz: 85f30ee725facdc21d77645007cbeca689cd322dacb559146234fab1de0aab79
 SHA512:
-  metadata.gz: c82ea88ac3d7b78e1e746f95ba09f0c6903cd20f9f0410f6bba68b9fdd00cf47a5e1c3103d8884c917542a7e41959ded61ba2b2ae9f58cfa2e2bfe4e1e2edf59
-  data.tar.gz: 61867b7e5b78b8271db8d937c8e6129e84bba1eb5181179dc464c50930e88b641a25f6a3c1d3bb1e6183f0cb9546b494622a918b2942405ea9b9a3b9356f8321
+  metadata.gz: 3c0fefff97e051805fb7d48aa134456d6a45ed5ab6b6818ea506251d93a1991c47bc6fc30aa1e2eae9369b1188564c08e23d083b6f8f8a896efe52d008cf6889
+  data.tar.gz: ebaf0d10fea440818cc182496b72c5ac16d192c76825db8aa271b89f891059b496ffdaaecdcfbaf7482ceb37ea868ac13feae678eee81b76c4e856f419627209

data/README.md

@@ -159,6 +159,32 @@ end
 
 ```
 
+### Communicate with Playwright server
+
+If your environment doesn't accept installing browser or creating browser process, consider separating Ruby client and Playwright server.
+
+![structure](https://user-images.githubusercontent.com/11763113/124934448-ad4d0700-e03f-11eb-942e-b9f3282bb703.png)
+
+For launching Playwright server, just execute:
+
+```
+npx playwright install && npx playwright run-server 8080
+```
+
+and we can connect to the server with the code like this:
+
+```ruby
+Playwright.connect_to_playwright_server('ws://127.0.0.1:8080') do |playwright|
+  playwright.chromium.launch do |browser|
+    page = browser.new_page
+    page.goto('https://github.com/YusukeIwaki')
+    page.screenshot(path: './YusukeIwaki.png')
+  end
+end
+```
+
+When `Playwright.connect_to_playwright_server` is used, playwright_cli_executable_path is not required.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/documentation/docs/api/browser.md

@@ -61,6 +61,16 @@ def connected?
 
 Indicates that the browser is connected.
 
+## new_browser_cdp_session
+
+```
+def new_browser_cdp_session
+```
+
+> NOTE: CDP Sessions are only supported on Chromium-based browsers.
+
+Returns the newly created browser session.
+
 ## new_context
 
 ```

data/documentation/docs/api/browser_context.md

@@ -226,6 +226,16 @@ def grant_permissions(permissions, origin: nil)
 Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if
 specified.
 
+## new_cdp_session
+
+```
+def new_cdp_session(page)
+```
+
+> NOTE: CDP sessions are only supported on Chromium-based browsers.
+
+Returns the newly created session.
+
 ## new_page
 
 ```

data/documentation/docs/api/browser_type.md

@@ -96,6 +96,59 @@ differences between Chromium and Chrome.
 [This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md)
 describes some differences for Linux users.
 
+## launch_persistent_context
+
+```
+def launch_persistent_context(
+      userDataDir,
+      acceptDownloads: nil,
+      args: nil,
+      bypassCSP: nil,
+      channel: nil,
+      chromiumSandbox: nil,
+      colorScheme: nil,
+      deviceScaleFactor: nil,
+      devtools: nil,
+      downloadsPath: nil,
+      env: nil,
+      executablePath: nil,
+      extraHTTPHeaders: nil,
+      geolocation: nil,
+      handleSIGHUP: nil,
+      handleSIGINT: nil,
+      handleSIGTERM: nil,
+      hasTouch: nil,
+      headless: nil,
+      httpCredentials: nil,
+      ignoreDefaultArgs: nil,
+      ignoreHTTPSErrors: nil,
+      isMobile: nil,
+      javaScriptEnabled: nil,
+      locale: nil,
+      noViewport: nil,
+      offline: nil,
+      permissions: nil,
+      proxy: nil,
+      record_har_omit_content: nil,
+      record_har_path: nil,
+      record_video_dir: nil,
+      record_video_size: nil,
+      reducedMotion: nil,
+      screen: nil,
+      slowMo: nil,
+      timeout: nil,
+      timezoneId: nil,
+      tracesDir: nil,
+      userAgent: nil,
+      viewport: nil,
+      &block)
+```
+
+Returns the persistent browser context instance.
+
+Launches browser that uses persistent storage located at `userDataDir` and returns the only context. Closing this
+context will automatically close the browser.
+
 ## name
 
 ```

data/documentation/docs/api/cdp_session.md

@@ -4,4 +4,44 @@ sidebar_position: 10
 
 # CDPSession
 
-Not Implemented
+- extends: [EventEmitter]
+
+The [CDPSession](./cdp_session) instances are used to talk raw Chrome Devtools Protocol:
+- protocol methods can be called with `session.send_message` method.
+- protocol events can be subscribed to with `session.on` method.
+
+Useful links:
+- Documentation on DevTools Protocol can be found here:
+  [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/).
+- Getting Started with DevTools Protocol:
+  https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md
+
+```ruby
+client = page.context.new_cdp_session(page)
+client.send_message('Animation.enable')
+client.on('Animation.animationCreated', -> (_) { puts 'Animation Created' })
+response = client.send_message('Animation.getPlaybackRate')
+puts "Playback rate is #{response['playbackRate']}"
+client.send_message(
+  'Animation.setPlaybackRate',
+  params: { playbackRate: response['playbackRate'] / 2.0 },
+)
+```
+
+
+## detach
+
+```
+def detach
+```
+
+Detaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be used to
+send messages.
+
+## send_message
+
+```
+def send_message(method, params: nil)
+```
+
+

data/documentation/docs/api/element_handle.md

@@ -232,7 +232,7 @@ feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.innerText)
 ## fill
 
 ```
-def fill(value, noWaitAfter: nil, timeout: nil)
+def fill(value, force: nil, noWaitAfter: nil, timeout: nil)
 ```
 
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the element, fills it and triggers an `input`
@@ -300,6 +300,14 @@ def inner_text
 
 Returns the `element.innerText`.
 
+## input_value
+
+```
+def input_value(timeout: nil)
+```
+
+Returns `input.value` for `<input>` or `<textarea>` element. Throws for non-input elements.
+
 ## checked?
 
 ```
@@ -436,6 +444,7 @@ def select_option(
       index: nil,
       value: nil,
       label: nil,
+      force: nil,
       noWaitAfter: nil,
       timeout: nil)
 ```
@@ -470,7 +479,7 @@ element_handle.select_option(value: "blue", index: 2, label: "red")
 ## select_text
 
 ```
-def select_text(timeout: nil)
+def select_text(force: nil, timeout: nil)
 ```
 
 This method waits for [actionability](https://playwright.dev/python/docs/actionability) checks, then focuses the element and selects all its text

data/documentation/docs/api/frame.md

@@ -326,7 +326,12 @@ result_handle.dispose
 ## fill
 
 ```
-def fill(selector, value, noWaitAfter: nil, timeout: nil)
+def fill(
+      selector,
+      value,
+      force: nil,
+      noWaitAfter: nil,
+      timeout: nil)
 ```
 
 This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the
@@ -443,6 +448,14 @@ def inner_text(selector, timeout: nil)
 
 Returns `element.innerText`.
 
+## input_value
+
+```
+def input_value(selector, timeout: nil)
+```
+
+Returns `input.value` for the selected `<input>` or `<textarea>` element. Throws for non-input elements.
+
 ## checked?
 
 ```
@@ -588,6 +601,7 @@ def select_option(
       index: nil,
       value: nil,
       label: nil,
+      force: nil,
       noWaitAfter: nil,
       timeout: nil)
 ```

data/documentation/docs/api/page.md

@@ -499,7 +499,12 @@ page.click("button")
 ## fill
 
 ```
-def fill(selector, value, noWaitAfter: nil, timeout: nil)
+def fill(
+      selector,
+      value,
+      force: nil,
+      noWaitAfter: nil,
+      timeout: nil)
 ```
 
 This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the
@@ -650,6 +655,14 @@ def inner_text(selector, timeout: nil)
 
 Returns `element.innerText`.
 
+## input_value
+
+```
+def input_value(selector, timeout: nil)
+```
+
+Returns `input.value` for the selected `<input>` or `<textarea>` element. Throws for non-input elements.
+
 ## checked?
 
 ```
@@ -934,6 +947,7 @@ def select_option(
       index: nil,
       value: nil,
       label: nil,
+      force: nil,
       noWaitAfter: nil,
       timeout: nil)
 ```
@@ -1328,6 +1342,16 @@ puts request.headers
 
 
 
+## expect_request_finished
+
+```
+def expect_request_finished(predicate: nil, timeout: nil, &block)
+```
+
+Performs action and waits for a [Request](./request) to finish loading. If predicate is provided, it passes [Request](./request) value into
+the `predicate` function and waits for `predicate(request)` to return a truthy value. Will throw an error if the page is
+closed before the [`event: Page.requestFinished`] event is fired.
+
 ## expect_response
 
 ```
@@ -1393,6 +1417,14 @@ page.wait_for_url("**/target.html")
 
 Shortcut for main frame's [Frame#wait_for_url](./frame#wait_for_url).
 
+## expect_websocket
+
+```
+def expect_websocket(predicate: nil, timeout: nil, &block)
+```
+
+Performs action and waits for a new [WebSocket](./web_socket). If predicate is provided, it passes [WebSocket](./web_socket) value into the `predicate` function and waits for `predicate.call(web_socket)` to return a truthy value. Will throw an error if the page is closed before the WebSocket event is fired.
+
 ## accessibility
 
 ## keyboard

data/documentation/docs/api/response.md

@@ -64,6 +64,22 @@ def request
 
 Returns the matching [Request](./request) object.
 
+## security_details
+
+```
+def security_details
+```
+
+Returns SSL and other security information.
+
+## server_addr
+
+```
+def server_addr
+```
+
+Returns the IP address and port of the server.
+
 ## status
 
 ```

data/documentation/docs/api/route.md

@@ -23,18 +23,16 @@ def continue(headers: nil, method: nil, postData: nil, url: nil)
 
 Continues route's request with optional overrides.
 
-```python sync title=example_1960aabd58c9553683368e29429d39c1209d35e6e3625bbef1280a1fa022a9ee.py
-def handle(route, request):
-    # override headers
-    headers = {
-        **request.headers,
-        "foo": "bar" # set "foo" header
-        "origin": None # remove "origin" header
-    }
-    route.continue_(headers=headers)
-}
-page.route("**/*", handle)
-
+```ruby
+def handle(route, request)
+  # override headers
+  headers = request.headers
+  headers['foo'] = 'bar' # set "foo" header
+  headers['user-agent'] = 'Unknown Browser' # modify user-agent
+
+  route.continue(headers: headers)
+end
+page.route("**/*", method(:handle))
 ```
 
 
@@ -54,19 +52,20 @@ Fulfills route's request with given response.
 
 An example of fulfilling all requests with 404 responses:
 
-```python sync title=example_6d2dfd4bb5c8360f8d80bb91c563b0bd9b99aa24595063cf85e5a6e1b105f89c.py
-page.route("**/*", lambda route: route.fulfill(
-    status=404,
-    content_type="text/plain",
-    body="not found!"))
-
+```ruby
+page.route("**/*", ->(route, request) {
+  route.fulfill(
+    status: 404,
+    contentType: 'text/plain',
+    body: 'not found!!',
+  )
+})
 ```
 
 An example of serving static file:
 
-```python sync title=example_c77fd0986d0b74c905cd9417756c76775e612cc86410f9a5aabc5b46d233d150.py
-page.route("**/xhr_endpoint", lambda route: route.fulfill(path="mock_data.json"))
-
+```ruby
+page.route("**/xhr_endpoint", ->(route, _) { route.fulfill(path: "mock_data.json") })
 ```
 
 

data/documentation/docs/api/web_socket.md

@@ -4,4 +4,41 @@ sidebar_position: 10
 
 # WebSocket
 
-Not Implemented
+The [WebSocket](./web_socket) class represents websocket connections in the page.
+
+## closed?
+
+```
+def closed?
+```
+
+Indicates that the web socket has been closed.
+
+## url
+
+```
+def url
+```
+
+Contains the URL of the WebSocket.
+
+## expect_event
+
+```
+def expect_event(event, predicate: nil, timeout: nil, &block)
+```
+
+Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy
+value. Will throw an error if the webSocket is closed before the event is fired. Returns the event data value.
+
+## wait_for_event
+
+```
+def wait_for_event(event, predicate: nil, timeout: nil, &block)
+```
+
+> NOTE: In most cases, you should use [WebSocket#wait_for_event](./web_socket#wait_for_event).
+
+Waits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function and
+waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the `event` is
+fired.