playwright-ruby-client 0.3.0 → 0.5.6

data/lib/playwright_api/android_device.rb

@@ -59,11 +59,12 @@ module Playwright
           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), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport), &wrap_block_call(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`.
@@ -159,20 +160,14 @@ module Playwright
       raise NotImplementedError.new('web_views is not implemented yet.')
     end
 
-    # @nodoc
-    def tree
-      wrap_impl(@impl.tree)
-    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)))
     end
 
-    # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def tree
+      wrap_impl(@impl.tree)
     end
 
     # -- inherited from EventEmitter --
@@ -187,6 +182,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

@@ -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.
@@ -143,12 +182,13 @@ module Playwright
           record_har_path: nil,
           record_video_dir: nil,
           record_video_size: nil,
+          screen: nil,
           storageState: nil,
           timezoneId: nil,
           userAgent: 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), 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), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), 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.
@@ -177,11 +217,46 @@ module Playwright
           record_har_path: nil,
           record_video_dir: nil,
           record_video_size: nil,
+          screen: nil,
           storageState: nil,
           timezoneId: nil,
           userAgent: 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), 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), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), 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.
@@ -189,12 +264,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)
@@ -207,6 +276,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

@@ -20,6 +20,16 @@ module Playwright
   # await context.close();
   # ```
   # 
+  # ```java
+  # // Create a new incognito browser context
+  # BrowserContext context = browser.newContext();
+  # // Create a new page inside context.
+  # Page page = context.newPage();
+  # page.navigate("https://example.com");
+  # // Dispose context once it"s no longer needed.
+  # context.close();
+  # ```
+  # 
   # ```python async
   # # create a new incognito browser context
   # context = await browser.new_context()
@@ -49,6 +59,10 @@ module Playwright
     # await browserContext.addCookies([cookieObject1, cookieObject2]);
     # ```
     # 
+    # ```java
+    # browserContext.addCookies(Arrays.asList(cookieObject1, cookieObject2));
+    # ```
+    # 
     # ```python async
     # await browser_context.add_cookies([cookie_object1, cookie_object2])
     # ```
@@ -84,6 +98,11 @@ module Playwright
     # });
     # ```
     # 
+    # ```java
+    # // In your playwright script, assuming the preload.js file is in same directory.
+    # browserContext.addInitScript(Paths.get("preload.js"));
+    # ```
+    # 
     # ```python async
     # # in your playwright script, assuming the preload.js file is in same directory.
     # await browser_context.add_init_script(path="preload.js")
@@ -100,6 +119,13 @@ module Playwright
       wrap_impl(@impl.add_init_script(path: unwrap_impl(path), script: unwrap_impl(script)))
     end
 
+    # > NOTE: Background pages are only supported on Chromium-based browsers.
+    # 
+    # All existing background pages in the context.
+    def background_pages
+      raise NotImplementedError.new('background_pages is not implemented yet.')
+    end
+
     # Returns the browser instance of the context. If it was launched as a persistent context null gets returned.
     def browser
       wrap_impl(@impl.browser)
@@ -120,6 +146,13 @@ module Playwright
     # context.clearPermissions();
     # ```
     # 
+    # ```java
+    # BrowserContext context = browser.newContext();
+    # context.grantPermissions(Arrays.asList("clipboard-read"));
+    # // do stuff ..
+    # context.clearPermissions();
+    # ```
+    # 
     # ```python async
     # context = await browser.new_context()
     # await context.grant_permissions(["clipboard-read"])
@@ -183,6 +216,30 @@ module Playwright
     # })();
     # ```
     # 
+    # ```java
+    # import com.microsoft.playwright.*;
+    # 
+    # public class Example {
+    #   public static void main(String[] args) {
+    #     try (Playwright playwright = Playwright.create()) {
+    #       BrowserType webkit = playwright.webkit()
+    #       Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));
+    #       BrowserContext context = browser.newContext();
+    #       context.exposeBinding("pageURL", (source, args) -> source.page().url());
+    #       Page page = context.newPage();
+    #       page.setContent("<script>\n" +
+    #         "  async function onClick() {\n" +
+    #         "    document.querySelector('div').textContent = await window.pageURL();\n" +
+    #         "  }\n" +
+    #         "</script>\n" +
+    #         "<button onclick=\"onClick()\">Click me</button>\n" +
+    #         "<div></div>");
+    #       page.click("button");
+    #     }
+    #   }
+    # }
+    # ```
+    # 
     # ```python async
     # import asyncio
     # from playwright.async_api import async_playwright
@@ -250,6 +307,20 @@ module Playwright
     # `);
     # ```
     # 
+    # ```java
+    # context.exposeBinding("clicked", (source, args) -> {
+    #   ElementHandle element = (ElementHandle) args[0];
+    #   System.out.println(element.textContent());
+    #   return null;
+    # }, new BrowserContext.ExposeBindingOptions().setHandle(true));
+    # page.setContent("" +
+    #   "<script>\n" +
+    #   "  document.addEventListener('click', event => window.clicked(event.target));\n" +
+    #   "</script>\n" +
+    #   "<div>Click me</div>\n" +
+    #   "<div>Or click me</div>\n");
+    # ```
+    # 
     # ```python async
     # async def print(source, element):
     #     print(await element.text_content())
@@ -313,6 +384,44 @@ module Playwright
     # })();
     # ```
     # 
+    # ```java
+    # import com.microsoft.playwright.*;
+    # 
+    # import java.nio.charset.StandardCharsets;
+    # import java.security.MessageDigest;
+    # import java.security.NoSuchAlgorithmException;
+    # import java.util.Base64;
+    # 
+    # public class Example {
+    #   public static void main(String[] args) {
+    #     try (Playwright playwright = Playwright.create()) {
+    #       BrowserType webkit = playwright.webkit()
+    #       Browser browser = webkit.launch(new BrowserType.LaunchOptions().setHeadless(false));
+    #       context.exposeFunction("sha1", args -> {
+    #         String text = (String) args[0];
+    #         MessageDigest crypto;
+    #         try {
+    #           crypto = MessageDigest.getInstance("SHA-1");
+    #         } catch (NoSuchAlgorithmException e) {
+    #           return null;
+    #         }
+    #         byte[] token = crypto.digest(text.getBytes(StandardCharsets.UTF_8));
+    #         return Base64.getEncoder().encodeToString(token);
+    #       });
+    #       Page page = context.newPage();
+    #       page.setContent("<script>\n" +
+    #         "  async function onClick() {\n" +
+    #         "    document.querySelector('div').textContent = await window.sha1('PLAYWRIGHT');\n" +
+    #         "  }\n" +
+    #         "</script>\n" +
+    #         "<button onclick=\"onClick()\">Click me</button>\n" +
+    #         "<div></div>\n");
+    #       page.click("button");
+    #     }
+    #   }
+    # }
+    # ```
+    # 
     # ```python async
     # import asyncio
     # import hashlib
@@ -388,13 +497,19 @@ module Playwright
       wrap_impl(@impl.grant_permissions(unwrap_impl(permissions), origin: unwrap_impl(origin)))
     end
 
+    # > NOTE: CDP sessions are only supported on Chromium-based browsers.
+    # 
+    # Returns the newly created session.
+    def new_cdp_session(page)
+      raise NotImplementedError.new('new_cdp_session is not implemented yet.')
+    end
+
     # Creates a new page in the browser context.
     def new_page
       wrap_impl(@impl.new_page)
     end
 
-    # Returns all open pages in the context. Non visible pages, such as `"background_page"`, will not be listed here. You can
-    # find them using [`method: ChromiumBrowserContext.backgroundPages`].
+    # Returns all open pages in the context.
     def pages
       wrap_impl(@impl.pages)
     end
@@ -402,7 +517,7 @@ module Playwright
     # Routing provides the capability to modify network requests that are made by any page in the browser context. Once route
     # is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
     # 
-    # An example of a naïve handler that aborts all image requests:
+    # An example of a naive handler that aborts all image requests:
     # 
     #
     # ```js
@@ -413,6 +528,14 @@ module Playwright
     # await browser.close();
     # ```
     # 
+    # ```java
+    # BrowserContext context = browser.newContext();
+    # context.route("**/*.{png,jpg,jpeg}", route -> route.abort());
+    # Page page = context.newPage();
+    # page.navigate("https://example.com");
+    # browser.close();
+    # ```
+    # 
     # ```python async
     # context = await browser.new_context()
     # page = await context.new_page()
@@ -440,6 +563,14 @@ module Playwright
     # await browser.close();
     # ```
     # 
+    # ```java
+    # BrowserContext context = browser.newContext();
+    # context.route(Pattern.compile("(\\.png$)|(\\.jpg$)"), route -> route.abort());
+    # Page page = context.newPage();
+    # page.navigate("https://example.com");
+    # browser.close();
+    # ```
+    # 
     # ```python async
     # context = await browser.new_context()
     # page = await context.new_page()
@@ -462,11 +593,20 @@ module Playwright
     # Page routes (set up with [`method: Page.route`]) take precedence over browser context routes when request matches both
     # handlers.
     # 
+    # To remove a route with its handler you can use [`method: BrowserContext.unroute`].
+    # 
     # > NOTE: Enabling routing disables http cache.
     def route(url, handler)
       wrap_impl(@impl.route(unwrap_impl(url), unwrap_impl(handler)))
     end
 
+    # > NOTE: Service workers are only supported on Chromium-based browsers.
+    # 
+    # All existing service workers in the context.
+    def service_workers
+      raise NotImplementedError.new('service_workers is not implemented yet.')
+    end
+
     # This setting will change the default maximum navigation time for the following methods and related shortcuts:
     # - [`method: Page.goBack`]
     # - [`method: Page.goForward`]
@@ -508,6 +648,10 @@ module Playwright
     # await browserContext.setGeolocation({latitude: 59.95, longitude: 30.31667});
     # ```
     # 
+    # ```java
+    # browserContext.setGeolocation(new Geolocation(59.95, 30.31667));
+    # ```
+    # 
     # ```python async
     # await browser_context.set_geolocation({"latitude": 59.95, "longitude": 30.31667})
     # ```
@@ -550,6 +694,10 @@ module Playwright
     # ]);
     # ```
     # 
+    # ```java
+    # Page newPage = context.waitForPage(() -> page.click("button"));
+    # ```
+    # 
     # ```python async
     # async with context.expect_event("page") as event_info:
     #     await page.click("button")
@@ -601,12 +749,6 @@ module Playwright
       wrap_impl(@impl.pause)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -619,6 +761,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