playwright-ruby-client 0.1.0 → 0.5.3

data/lib/playwright_api/android_device.rb

@@ -1,60 +1,173 @@
 module Playwright
-  # @nodoc
+  # `AndroidDevice` represents a connected device, either real hardware or emulated. Devices can be obtained using
+  # [`method: Android.devices`].
   class AndroidDevice < PlaywrightApi
 
-    # @nodoc
-    def tree
-      wrap_impl(@impl.tree)
+    def input # property
+      wrap_impl(@impl.input)
     end
 
-    # @nodoc
+    # Disconnects from the device.
     def close
       wrap_impl(@impl.close)
     end
 
-    # @nodoc
-    def after_initialize
-      wrap_impl(@impl.after_initialize)
+    # Drags the widget defined by `selector` towards `dest` point.
+    def drag(selector, dest, speed: nil)
+      raise NotImplementedError.new('drag is not implemented yet.')
     end
 
-    # @nodoc
-    def tap_on(selector, duration: nil, timeout: nil)
-      wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
+    # Fills the specific `selector` input box with `text`.
+    def fill(selector, text)
+      raise NotImplementedError.new('fill is not implemented yet.')
     end
 
-    # @nodoc
+    # Flings the widget defined by `selector` in  the specified `direction`.
+    def fling(selector, direction, speed: nil)
+      raise NotImplementedError.new('fling is not implemented yet.')
+    end
+
+    # Returns information about a widget defined by `selector`.
+    def info(selector)
+      wrap_impl(@impl.info(unwrap_impl(selector)))
+    end
+
+    # Installs an apk on the device.
+    def install_apk(file, args: nil)
+      raise NotImplementedError.new('install_apk is not implemented yet.')
+    end
+
+    # Launches Chrome browser on the device, and returns its persistent context.
+    def launch_browser(
+          acceptDownloads: nil,
+          bypassCSP: nil,
+          colorScheme: nil,
+          command: nil,
+          deviceScaleFactor: nil,
+          extraHTTPHeaders: nil,
+          geolocation: nil,
+          hasTouch: nil,
+          httpCredentials: nil,
+          ignoreHTTPSErrors: nil,
+          isMobile: nil,
+          javaScriptEnabled: nil,
+          locale: nil,
+          noViewport: nil,
+          offline: nil,
+          permissions: nil,
+          record_har_omit_content: nil,
+          record_har_path: nil,
+          record_video_dir: nil,
+          record_video_size: nil,
+          screen: nil,
+          timezoneId: nil,
+          userAgent: nil,
+          viewport: nil,
+          &block)
+      wrap_impl(@impl.launch_browser(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), command: unwrap_impl(command), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), screen: unwrap_impl(screen), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+    end
+
+    # Performs a long tap on the widget defined by `selector`.
+    def long_tap(selector)
+      raise NotImplementedError.new('long_tap is not implemented yet.')
+    end
+
+    # Device model.
+    def model
+      wrap_impl(@impl.model)
+    end
+
+    # Launches a process in the shell on the device and returns a socket to communicate with the launched process.
+    def open(command)
+      raise NotImplementedError.new('open is not implemented yet.')
+    end
+
+    # Pinches the widget defined by `selector` in the closing direction.
+    def pinch_close(selector, percent, speed: nil)
+      raise NotImplementedError.new('pinch_close is not implemented yet.')
+    end
+
+    # Pinches the widget defined by `selector` in the open direction.
+    def pinch_open(selector, percent, speed: nil)
+      raise NotImplementedError.new('pinch_open is not implemented yet.')
+    end
+
+    # Presses the specific `key` in the widget defined by `selector`.
+    def press(selector, key)
+      raise NotImplementedError.new('press is not implemented yet.')
+    end
+
+    # Copies a file to the device.
+    def push(file, path, mode: nil)
+      raise NotImplementedError.new('push is not implemented yet.')
+    end
+
+    # Returns the buffer with the captured screenshot of the device.
     def screenshot(path: nil)
       wrap_impl(@impl.screenshot(path: unwrap_impl(path)))
     end
 
-    # @nodoc
+    # Scrolls the widget defined by `selector` in  the specified `direction`.
+    def scroll(selector, direction, percent, speed: nil)
+      raise NotImplementedError.new('scroll is not implemented yet.')
+    end
+
+    # Device serial number.
+    def serial
+      wrap_impl(@impl.serial)
+    end
+
+    # This setting will change the default maximum time for all the methods accepting `timeout` option.
+    def set_default_timeout(timeout)
+      raise NotImplementedError.new('set_default_timeout is not implemented yet.')
+    end
+    alias_method :default_timeout=, :set_default_timeout
+
+    # Executes a shell command on the device and returns its output.
     def shell(command)
       wrap_impl(@impl.shell(unwrap_impl(command)))
     end
 
-    # @nodoc
-    def input
-      wrap_impl(@impl.input)
+    # Swipes the widget defined by `selector` in  the specified `direction`.
+    def swipe(selector, direction, percent, speed: nil)
+      raise NotImplementedError.new('swipe is not implemented yet.')
     end
 
-    # @nodoc
-    def launch_browser(pkg: nil, acceptDownloads: nil, bypassCSP: nil, colorScheme: nil, deviceScaleFactor: nil, extraHTTPHeaders: nil, geolocation: nil, hasTouch: nil, httpCredentials: nil, ignoreHTTPSErrors: nil, isMobile: nil, javaScriptEnabled: nil, locale: nil, logger: nil, offline: nil, permissions: nil, proxy: nil, recordHar: nil, recordVideo: nil, storageState: nil, timezoneId: nil, userAgent: nil, videoSize: nil, videosPath: nil, viewport: nil, &block)
-      wrap_impl(@impl.launch_browser(pkg: unwrap_impl(pkg), acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), logger: unwrap_impl(logger), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), recordHar: unwrap_impl(recordHar), recordVideo: unwrap_impl(recordVideo), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), videoSize: unwrap_impl(videoSize), videosPath: unwrap_impl(videosPath), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+    # Taps on the widget defined by `selector`.
+    def tap_point(selector, duration: nil)
+      raise NotImplementedError.new('tap_point is not implemented yet.')
     end
 
-    # @nodoc
-    def info(selector)
-      wrap_impl(@impl.info(unwrap_impl(selector)))
+    # Waits for the specific `selector` to either appear or disappear, depending on the `state`.
+    def wait(selector, state: nil)
+      raise NotImplementedError.new('wait is not implemented yet.')
+    end
+
+    # Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy
+    # value.
+    def wait_for_event(event, optionsOrPredicate: nil)
+      raise NotImplementedError.new('wait_for_event is not implemented yet.')
+    end
+
+    # This method waits until `AndroidWebView` matching the `selector` is opened and returns it. If there is already an open
+    # `AndroidWebView` matching the `selector`, returns immediately.
+    def web_view(selector)
+      raise NotImplementedError.new('web_view is not implemented yet.')
+    end
+
+    # Currently open WebViews.
+    def web_views
+      raise NotImplementedError.new('web_views is not implemented yet.')
     end
 
     # @nodoc
-    def serial
-      wrap_impl(@impl.serial)
+    def tap_on(selector, duration: nil, timeout: nil)
+      wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
     end
 
     # @nodoc
-    def model
-      wrap_impl(@impl.model)
+    def tree
+      wrap_impl(@impl.tree)
     end
 
     # -- inherited from EventEmitter --

data/lib/playwright_api/android_input.rb

@@ -1,25 +1,29 @@
 module Playwright
-  # @nodoc
   class AndroidInput < PlaywrightApi
 
-    # @nodoc
-    def type(text)
-      wrap_impl(@impl.type(unwrap_impl(text)))
-    end
-
-    # @nodoc
-    def tap_point(point)
-      wrap_impl(@impl.tap_point(unwrap_impl(point)))
-    end
-
-    # @nodoc
+    # Performs a drag between `from` and `to` points.
     def drag(from, to, steps)
       wrap_impl(@impl.drag(unwrap_impl(from), unwrap_impl(to), unwrap_impl(steps)))
     end
 
-    # @nodoc
+    # Presses the `key`.
     def press(key)
       wrap_impl(@impl.press(unwrap_impl(key)))
     end
+
+    # Swipes following the path defined by `segments`.
+    def swipe(from, segments, steps)
+      raise NotImplementedError.new('swipe is not implemented yet.')
+    end
+
+    # Taps at the specified `point`.
+    def tap_point(point)
+      wrap_impl(@impl.tap_point(unwrap_impl(point)))
+    end
+
+    # Types `text` into currently focused widget.
+    def type(text)
+      wrap_impl(@impl.type(unwrap_impl(text)))
+    end
   end
 end

data/lib/playwright_api/android_socket.rb

@@ -0,0 +1,16 @@
+module Playwright
+  # `AndroidSocket` is a way to communicate with a process launched on the `AndroidDevice`. Use
+  # [`method: AndroidDevice.open`] to open a socket.
+  class AndroidSocket < PlaywrightApi
+
+    # Closes the socket.
+    def close
+      raise NotImplementedError.new('close is not implemented yet.')
+    end
+
+    # Writes some `data` to the socket.
+    def write(data)
+      raise NotImplementedError.new('write is not implemented yet.')
+    end
+  end
+end

data/lib/playwright_api/android_web_view.rb

@@ -0,0 +1,21 @@
+module Playwright
+  # `AndroidWebView` represents a WebView open on the `AndroidDevice`. WebView is usually obtained using
+  # [`method: AndroidDevice.webView`].
+  class AndroidWebView < PlaywrightApi
+
+    # Connects to the WebView and returns a regular Playwright `Page` to interact with.
+    def page
+      raise NotImplementedError.new('page is not implemented yet.')
+    end
+
+    # WebView process PID.
+    def pid
+      raise NotImplementedError.new('pid is not implemented yet.')
+    end
+
+    # WebView package identifier.
+    def pkg
+      raise NotImplementedError.new('pkg is not implemented yet.')
+    end
+  end
+end

data/lib/playwright_api/browser.rb

@@ -15,6 +15,22 @@ module Playwright
   # })();
   # ```
   # 
+  # ```java
+  # import com.microsoft.playwright.*;
+  # 
+  # public class Example {
+  #   public static void main(String[] args) {
+  #     try (Playwright playwright = Playwright.create()) {
+  #       BrowserType firefox = playwright.firefox()
+  #       Browser browser = firefox.launch();
+  #       Page page = browser.newPage();
+  #       page.navigate('https://example.com');
+  #       browser.close();
+  #     }
+  #   }
+  # }
+  # ```
+  # 
   # ```python async
   # import asyncio
   # from playwright.async_api import async_playwright
@@ -69,6 +85,13 @@ module Playwright
     # console.log(browser.contexts().length); // prints `1`
     # ```
     # 
+    # ```java
+    # Browser browser = pw.webkit().launch();
+    # System.out.println(browser.contexts().size()); // prints "0"
+    # BrowserContext context = browser.newContext();
+    # System.out.println(browser.contexts().size()); // prints "1"
+    # ```
+    # 
     # ```python async
     # browser = await pw.webkit.launch()
     # print(len(browser.contexts())) # prints `0`
@@ -91,6 +114,13 @@ module Playwright
       wrap_impl(@impl.connected?)
     end
 
+    # > NOTE: CDP Sessions are only supported on Chromium-based browsers.
+    # 
+    # Returns the newly created browser session.
+    def new_browser_cdp_session
+      raise NotImplementedError.new('new_browser_cdp_session is not implemented yet.')
+    end
+
     # Creates a new browser context. It won't share cookies/cache with other browser contexts.
     # 
     #
@@ -105,6 +135,15 @@ module Playwright
     # })();
     # ```
     # 
+    # ```java
+    # Browser browser = playwright.firefox().launch();  // Or 'chromium' or 'webkit'.
+    # // Create a new incognito browser context.
+    # BrowserContext context = browser.newContext();
+    # // Create a new page in a pristine context.
+    # Page page = context.newPage();
+    # page.navigate('https://example.com');
+    # ```
+    # 
     # ```python async
     # browser = await playwright.firefox.launch() # or "chromium" or "webkit".
     # # create a new incognito browser context.
@@ -135,21 +174,21 @@ module Playwright
           isMobile: nil,
           javaScriptEnabled: nil,
           locale: nil,
-          logger: nil,
+          noViewport: nil,
           offline: nil,
           permissions: nil,
           proxy: nil,
-          recordHar: nil,
-          recordVideo: nil,
+          record_har_omit_content: nil,
+          record_har_path: nil,
+          record_video_dir: nil,
+          record_video_size: nil,
+          screen: nil,
           storageState: nil,
-          storageStatePath: nil,
           timezoneId: nil,
           userAgent: nil,
-          videoSize: nil,
-          videosPath: nil,
           viewport: nil,
           &block)
-      wrap_impl(@impl.new_context(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), logger: unwrap_impl(logger), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), recordHar: unwrap_impl(recordHar), recordVideo: unwrap_impl(recordVideo), storageState: unwrap_impl(storageState), storageStatePath: unwrap_impl(storageStatePath), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), videoSize: unwrap_impl(videoSize), videosPath: unwrap_impl(videosPath), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
+      wrap_impl(@impl.new_context(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(block)))
     end
 
     # Creates a new page in a new browser context. Closing this page will close the context as well.
@@ -170,20 +209,54 @@ module Playwright
           isMobile: nil,
           javaScriptEnabled: nil,
           locale: nil,
-          logger: nil,
+          noViewport: nil,
           offline: nil,
           permissions: nil,
           proxy: nil,
-          recordHar: nil,
-          recordVideo: nil,
+          record_har_omit_content: nil,
+          record_har_path: nil,
+          record_video_dir: nil,
+          record_video_size: nil,
+          screen: nil,
           storageState: nil,
-          storageStatePath: nil,
           timezoneId: nil,
           userAgent: nil,
-          videoSize: nil,
-          videosPath: nil,
           viewport: nil)
-      wrap_impl(@impl.new_page(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), logger: unwrap_impl(logger), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), recordHar: unwrap_impl(recordHar), recordVideo: unwrap_impl(recordVideo), storageState: unwrap_impl(storageState), storageStatePath: unwrap_impl(storageStatePath), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), videoSize: unwrap_impl(videoSize), videosPath: unwrap_impl(videosPath), viewport: unwrap_impl(viewport)))
+      wrap_impl(@impl.new_page(acceptDownloads: unwrap_impl(acceptDownloads), bypassCSP: unwrap_impl(bypassCSP), colorScheme: unwrap_impl(colorScheme), deviceScaleFactor: unwrap_impl(deviceScaleFactor), extraHTTPHeaders: unwrap_impl(extraHTTPHeaders), geolocation: unwrap_impl(geolocation), hasTouch: unwrap_impl(hasTouch), httpCredentials: unwrap_impl(httpCredentials), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), isMobile: unwrap_impl(isMobile), javaScriptEnabled: unwrap_impl(javaScriptEnabled), locale: unwrap_impl(locale), noViewport: unwrap_impl(noViewport), offline: unwrap_impl(offline), permissions: unwrap_impl(permissions), proxy: unwrap_impl(proxy), record_har_omit_content: unwrap_impl(record_har_omit_content), record_har_path: unwrap_impl(record_har_path), record_video_dir: unwrap_impl(record_video_dir), record_video_size: unwrap_impl(record_video_size), screen: unwrap_impl(screen), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport)))
+    end
+
+    # > NOTE: Tracing is only supported on Chromium-based browsers.
+    # 
+    # You can use [`method: Browser.startTracing`] and [`method: Browser.stopTracing`] to create a trace file that can be
+    # opened in Chrome DevTools performance panel.
+    # 
+    #
+    # ```js
+    # await browser.startTracing(page, {path: 'trace.json'});
+    # await page.goto('https://www.google.com');
+    # await browser.stopTracing();
+    # ```
+    # 
+    # ```python async
+    # await browser.start_tracing(page, path="trace.json")
+    # await page.goto("https://www.google.com")
+    # await browser.stop_tracing()
+    # ```
+    # 
+    # ```python sync
+    # browser.start_tracing(page, path="trace.json")
+    # page.goto("https://www.google.com")
+    # browser.stop_tracing()
+    # ```
+    def start_tracing(page: nil, categories: nil, path: nil, screenshots: nil)
+      wrap_impl(@impl.start_tracing(page: unwrap_impl(page), categories: unwrap_impl(categories), path: unwrap_impl(path), screenshots: unwrap_impl(screenshots)))
+    end
+
+    # > NOTE: Tracing is only supported on Chromium-based browsers.
+    # 
+    # Returns the buffer with trace data.
+    def stop_tracing
+      wrap_impl(@impl.stop_tracing)
     end
 
     # Returns the browser version.
@@ -191,11 +264,6 @@ module Playwright
       wrap_impl(@impl.version)
     end
 
-    # @nodoc
-    def after_initialize
-      wrap_impl(@impl.after_initialize)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)