playwright-ruby-client 0.0.3

data/lib/playwright_api/browser_context.rb

@@ -0,0 +1,285 @@
+module Playwright
+  # BrowserContexts provide a way to operate multiple independent browser sessions.
+  # If a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser context.
+  # Playwright allows creation of "incognito" browser contexts with `browser.newContext()` method. "Incognito" browser contexts don't write any browsing data to disk.
+  #
+  # ```js
+  # // Create a new incognito browser context
+  # const context = await browser.newContext();
+  # // Create a new page inside context.
+  # const page = await context.newPage();
+  # await page.goto('https://example.com');
+  # // Dispose context once it's no longer needed.
+  # await context.close();
+  # ```
+  class BrowserContext < PlaywrightApi
+
+    # Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be obtained via `browserContext.cookies([urls])`.
+    #
+    # ```js
+    # await browserContext.addCookies([cookieObject1, cookieObject2]);
+    # ```
+    def add_cookies(cookies)
+      raise NotImplementedError.new('add_cookies is not implemented yet.')
+    end
+
+    # Adds a script which would be evaluated in one of the following scenarios:
+    # 
+    # Whenever a page is created in the browser context or is navigated.
+    # Whenever a child frame is attached or navigated in any page in the browser context. In this case, the script is evaluated in the context of the newly attached frame.
+    # 
+    # The script is evaluated after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed `Math.random`.
+    # An example of overriding `Math.random` before the page loads:
+    #
+    # ```js
+    # // preload.js
+    # Math.random = () => 42;
+    # ```
+    #
+    # ```js
+    # // In your playwright script, assuming the preload.js file is in same directory.
+    # await browserContext.addInitScript({
+    #   path: 'preload.js'
+    # });
+    # ```
+    # 
+    # **NOTE** The order of evaluation of multiple scripts installed via `browserContext.addInitScript(script[, arg])` and `page.addInitScript(script[, arg])` is not defined.
+    def add_init_script(script, arg: nil)
+      raise NotImplementedError.new('add_init_script 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
+      raise NotImplementedError.new('browser is not implemented yet.')
+    end
+
+    # Clears context cookies.
+    def clear_cookies
+      raise NotImplementedError.new('clear_cookies is not implemented yet.')
+    end
+
+    # Clears all permission overrides for the browser context.
+    #
+    # ```js
+    # const context = await browser.newContext();
+    # await context.grantPermissions(['clipboard-read']);
+    # // do stuff ..
+    # context.clearPermissions();
+    # ```
+    def clear_permissions
+      raise NotImplementedError.new('clear_permissions is not implemented yet.')
+    end
+
+    # Closes the browser context. All the pages that belong to the browser context will be closed.
+    # 
+    # **NOTE** the default browser context cannot be closed.
+    def close
+      raise NotImplementedError.new('close is not implemented yet.')
+    end
+
+    # If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs are returned.
+    def cookies(urls: nil)
+      raise NotImplementedError.new('cookies is not implemented yet.')
+    end
+
+    # The method adds a function called `name` on the `window` object of every frame in every page in the context. When called, the function executes `playwrightBinding` and returns a Promise which resolves to the return value of `playwrightBinding`. If the `playwrightBinding` returns a Promise, it will be awaited.
+    # The first argument of the `playwrightBinding` function contains information about the caller: `{ browserContext: BrowserContext, page: Page, frame: Frame }`.
+    # See `page.exposeBinding(name, playwrightBinding[, options])` for page-only version.
+    # An example of exposing page URL to all frames in all pages in the context:
+    #
+    # ```js
+    # const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.
+    # 
+    # (async () => {
+    #   const browser = await webkit.launch({ headless: false });
+    #   const context = await browser.newContext();
+    #   await context.exposeBinding('pageURL', ({ page }) => page.url());
+    #   const page = await context.newPage();
+    #   await page.setContent(`
+    #     <script>
+    #       async function onClick() {
+    #         document.querySelector('div').textContent = await window.pageURL();
+    #       }
+    #     </script>
+    #     <button onclick="onClick()">Click me</button>
+    #     <div></div>
+    #   `);
+    #   await page.click('button');
+    # })();
+    # ```
+    # An example of passing an element handle:
+    #
+    # ```js
+    # await context.exposeBinding('clicked', async (source, element) => {
+    #   console.log(await element.textContent());
+    # }, { handle: true });
+    # await page.setContent(`
+    #   <script>
+    #     document.addEventListener('click', event => window.clicked(event.target));
+    #   </script>
+    #   <div>Click me</div>
+    #   <div>Or click me</div>
+    # `);
+    # ```
+    def expose_binding(name, playwrightBinding, handle: nil)
+      raise NotImplementedError.new('expose_binding is not implemented yet.')
+    end
+
+    # The method adds a function called `name` on the `window` object of every frame in every page in the context. When called, the function executes `playwrightFunction` and returns a Promise which resolves to the return value of `playwrightFunction`.
+    # If the `playwrightFunction` returns a Promise, it will be awaited.
+    # See `page.exposeFunction(name, playwrightFunction)` for page-only version.
+    # An example of adding an `md5` function to all pages in the context:
+    #
+    # ```js
+    # const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.
+    # const crypto = require('crypto');
+    # 
+    # (async () => {
+    #   const browser = await webkit.launch({ headless: false });
+    #   const context = await browser.newContext();
+    #   await context.exposeFunction('md5', text => crypto.createHash('md5').update(text).digest('hex'));
+    #   const page = await context.newPage();
+    #   await page.setContent(`
+    #     <script>
+    #       async function onClick() {
+    #         document.querySelector('div').textContent = await window.md5('PLAYWRIGHT');
+    #       }
+    #     </script>
+    #     <button onclick="onClick()">Click me</button>
+    #     <div></div>
+    #   `);
+    #   await page.click('button');
+    # })();
+    # ```
+    def expose_function(name, playwrightFunction)
+      raise NotImplementedError.new('expose_function is not implemented yet.')
+    end
+
+    # Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if specified.
+    def grant_permissions(permissions, origin: nil)
+      raise NotImplementedError.new('grant_permissions is not implemented yet.')
+    end
+
+    # Creates a new page in the browser context.
+    def new_page
+      wrap_channel_owner(@channel_owner.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 `chromiumBrowserContext.backgroundPages()`.
+    def pages
+      raise NotImplementedError.new('pages is not implemented yet.')
+    end
+
+    # 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:
+    #
+    # ```js
+    # const context = await browser.newContext();
+    # await context.route('**/*.{png,jpg,jpeg}', route => route.abort());
+    # const page = await context.newPage();
+    # await page.goto('https://example.com');
+    # await browser.close();
+    # ```
+    # or the same snippet using a regex pattern instead:
+    #
+    # ```js
+    # const context = await browser.newContext();
+    # await context.route(/(\.png$)|(\.jpg$)/, route => route.abort());
+    # const page = await context.newPage();
+    # await page.goto('https://example.com');
+    # await browser.close();
+    # ```
+    # Page routes (set up with `page.route(url, handler)`) take precedence over browser context routes when request matches both handlers.
+    # 
+    # **NOTE** Enabling routing disables http cache.
+    def route(url, handler)
+      raise NotImplementedError.new('route is not implemented yet.')
+    end
+
+    # This setting will change the default maximum navigation time for the following methods and related shortcuts:
+    # 
+    # `page.goBack([options])`
+    # `page.goForward([options])`
+    # `page.goto(url[, options])`
+    # `page.reload([options])`
+    # `page.setContent(html[, options])`
+    # `page.waitForNavigation([options])`
+    # 
+    # 
+    # **NOTE** `page.setDefaultNavigationTimeout(timeout)` and `page.setDefaultTimeout(timeout)` take priority over `browserContext.setDefaultNavigationTimeout(timeout)`.
+    def set_default_navigation_timeout(timeout)
+      raise NotImplementedError.new('set_default_navigation_timeout is not implemented yet.')
+    end
+
+    # This setting will change the default maximum time for all the methods accepting `timeout` option.
+    # 
+    # **NOTE** `page.setDefaultNavigationTimeout(timeout)`, `page.setDefaultTimeout(timeout)` and `browserContext.setDefaultNavigationTimeout(timeout)` take priority over `browserContext.setDefaultTimeout(timeout)`.
+    def set_default_timeout(timeout)
+      raise NotImplementedError.new('set_default_timeout is not implemented yet.')
+    end
+
+    # The extra HTTP headers will be sent with every request initiated by any page in the context. These headers are merged with page-specific extra HTTP headers set with `page.setExtraHTTPHeaders(headers)`. If page overrides a particular header, page-specific header value will be used instead of the browser context header value.
+    # 
+    # **NOTE** `browserContext.setExtraHTTPHeaders` does not guarantee the order of headers in the outgoing requests.
+    def set_extra_http_headers(headers)
+      raise NotImplementedError.new('set_extra_http_headers is not implemented yet.')
+    end
+
+    # Sets the context's geolocation. Passing `null` or `undefined` emulates position unavailable.
+    #
+    # ```js
+    # await browserContext.setGeolocation({latitude: 59.95, longitude: 30.31667});
+    # ```
+    # 
+    # **NOTE** Consider using `browserContext.grantPermissions(permissions[, options])` to grant permissions for the browser context pages to read its geolocation.
+    def set_geolocation(geolocation)
+      raise NotImplementedError.new('set_geolocation is not implemented yet.')
+    end
+
+    # Provide credentials for HTTP authentication.
+    # 
+    # **NOTE** Browsers may cache credentials after successful authentication. Passing different credentials or passing `null` to disable authentication will be unreliable. To remove or replace credentials, create a new browser context instead.
+    def set_http_credentials(httpCredentials)
+      raise NotImplementedError.new('set_http_credentials is not implemented yet.')
+    end
+
+    def set_offline(offline)
+      raise NotImplementedError.new('set_offline is not implemented yet.')
+    end
+
+    # Returns storage state for this browser context, contains current cookies and local storage snapshot.
+    def storage_state(path: nil)
+      raise NotImplementedError.new('storage_state is not implemented yet.')
+    end
+
+    # Removes a route created with `browserContext.route(url, handler)`. When `handler` is not specified, removes all routes for the `url`.
+    def unroute(url, handler: nil)
+      raise NotImplementedError.new('unroute 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. Will throw an error if the context closes before the event is fired. Returns the event data value.
+    #
+    # ```js
+    # const context = await browser.newContext();
+    # await context.grantPermissions(['geolocation']);
+    # ```
+    def wait_for_event(event, optionsOrPredicate: nil)
+      raise NotImplementedError.new('wait_for_event is not implemented yet.')
+    end
+
+    # @nodoc
+    def browser=(req)
+      wrap_channel_owner(@channel_owner.browser=(req))
+    end
+
+    # @nodoc
+    def owner_page=(req)
+      wrap_channel_owner(@channel_owner.owner_page=(req))
+    end
+
+    # @nodoc
+    def options=(req)
+      wrap_channel_owner(@channel_owner.options=(req))
+    end
+  end
+end

data/lib/playwright_api/browser_type.rb

@@ -0,0 +1,144 @@
+module Playwright
+  # BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a typical example of using Playwright to drive automation:
+  #
+  # ```js
+  # const { chromium } = require('playwright');  // Or 'firefox' or 'webkit'.
+  # 
+  # (async () => {
+  #   const browser = await chromium.launch();
+  #   const page = await browser.newPage();
+  #   await page.goto('https://example.com');
+  #   // other actions...
+  #   await browser.close();
+  # })();
+  # ```
+  class BrowserType < PlaywrightApi
+
+    # This methods attaches Playwright to an existing browser instance.
+    def connect(params)
+      raise NotImplementedError.new('connect is not implemented yet.')
+    end
+
+    # A path where Playwright expects to find a bundled browser executable.
+    def executable_path
+      wrap_channel_owner(@channel_owner.executable_path)
+    end
+
+    # Returns the browser instance.
+    # You can use `ignoreDefaultArgs` to filter out `--mute-audio` from default arguments:
+    #
+    # ```js
+    # const browser = await chromium.launch({  // Or 'firefox' or 'webkit'.
+    #   ignoreDefaultArgs: ['--mute-audio']
+    # });
+    # ```
+    # 
+    # **Chromium-only** Playwright can also be used to control the Chrome browser, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use `executablePath` option with extreme caution.
+    # If Google Chrome (rather than Chromium) is preferred, a Chrome Canary or Dev Channel build is suggested.
+    # In `browserType.launch([options])` above, any mention of Chromium also applies to Chrome.
+    # See `this article` for a description of the differences between Chromium and Chrome. `This article` describes some differences for Linux users.
+    def launch(
+          headless: nil,
+          executablePath: nil,
+          args: nil,
+          ignoreDefaultArgs: nil,
+          proxy: nil,
+          downloadsPath: nil,
+          chromiumSandbox: nil,
+          firefoxUserPrefs: nil,
+          handleSIGINT: nil,
+          handleSIGTERM: nil,
+          handleSIGHUP: nil,
+          logger: nil,
+          timeout: nil,
+          env: nil,
+          devtools: nil,
+          slowMo: nil,
+          &block)
+      wrap_channel_owner(@channel_owner.launch(headless: headless, executablePath: executablePath, args: args, ignoreDefaultArgs: ignoreDefaultArgs, proxy: proxy, downloadsPath: downloadsPath, chromiumSandbox: chromiumSandbox, firefoxUserPrefs: firefoxUserPrefs, handleSIGINT: handleSIGINT, handleSIGTERM: handleSIGTERM, handleSIGHUP: handleSIGHUP, logger: logger, timeout: timeout, env: env, devtools: devtools, slowMo: slowMo, &wrap_block_call(block)))
+    end
+
+    # 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.
+    def launch_persistent_context(
+          userDataDir,
+          headless: nil,
+          executablePath: nil,
+          args: nil,
+          ignoreDefaultArgs: nil,
+          proxy: nil,
+          downloadsPath: nil,
+          chromiumSandbox: nil,
+          handleSIGINT: nil,
+          handleSIGTERM: nil,
+          handleSIGHUP: nil,
+          timeout: nil,
+          env: nil,
+          devtools: nil,
+          slowMo: nil,
+          acceptDownloads: nil,
+          ignoreHTTPSErrors: nil,
+          bypassCSP: nil,
+          viewport: nil,
+          userAgent: nil,
+          deviceScaleFactor: nil,
+          isMobile: nil,
+          hasTouch: nil,
+          javaScriptEnabled: nil,
+          timezoneId: nil,
+          geolocation: nil,
+          locale: nil,
+          permissions: nil,
+          extraHTTPHeaders: nil,
+          offline: nil,
+          httpCredentials: nil,
+          colorScheme: nil,
+          logger: nil,
+          videosPath: nil,
+          videoSize: nil,
+          recordHar: nil,
+          recordVideo: nil)
+      raise NotImplementedError.new('launch_persistent_context is not implemented yet.')
+    end
+
+    # Returns the browser app instance.
+    # Launches browser server that client can connect to. An example of launching a browser executable and connecting to it later:
+    #
+    # ```js
+    # const { chromium } = require('playwright');  // Or 'webkit' or 'firefox'.
+    # 
+    # (async () => {
+    #   const browserServer = await chromium.launchServer();
+    #   const wsEndpoint = browserServer.wsEndpoint();
+    #   // Use web socket endpoint later to establish a connection.
+    #   const browser = await chromium.connect({ wsEndpoint });
+    #   // Close browser instance.
+    #   await browserServer.close();
+    # })();
+    # ```
+    def launch_server(
+          headless: nil,
+          port: nil,
+          executablePath: nil,
+          args: nil,
+          ignoreDefaultArgs: nil,
+          proxy: nil,
+          downloadsPath: nil,
+          chromiumSandbox: nil,
+          firefoxUserPrefs: nil,
+          handleSIGINT: nil,
+          handleSIGTERM: nil,
+          handleSIGHUP: nil,
+          logger: nil,
+          timeout: nil,
+          env: nil,
+          devtools: nil)
+      raise NotImplementedError.new('launch_server is not implemented yet.')
+    end
+
+    # Returns browser name. For example: `'chromium'`, `'webkit'` or `'firefox'`.
+    def name
+      wrap_channel_owner(@channel_owner.name)
+    end
+  end
+end

data/lib/playwright_api/cdp_session.rb

@@ -0,0 +1,34 @@
+module Playwright
+  # The `CDPSession` instances are used to talk raw Chrome Devtools Protocol:
+  # 
+  # protocol methods can be called with `session.send` method.
+  # protocol events can be subscribed to with `session.on` method.
+  # 
+  # Useful links:
+  # 
+  # Documentation on DevTools Protocol can be found here: DevTools Protocol Viewer.
+  # Getting Started with DevTools Protocol: https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md
+  # 
+  #
+  # ```js
+  # const client = await page.context().newCDPSession(page);
+  # await client.send('Animation.enable');
+  # client.on('Animation.animationCreated', () => console.log('Animation created!'));
+  # const response = await client.send('Animation.getPlaybackRate');
+  # console.log('playback rate is ' + response.playbackRate);
+  # await client.send('Animation.setPlaybackRate', {
+  #   playbackRate: response.playbackRate / 2
+  # });
+  # ```
+  class CDPSession < PlaywrightApi
+
+    # Detaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be used to send messages.
+    def detach
+      raise NotImplementedError.new('detach is not implemented yet.')
+    end
+
+    def send_message(method, params: nil)
+      raise NotImplementedError.new('send_message is not implemented yet.')
+    end
+  end
+end