playwright-ruby-client 0.0.3 → 0.0.4

data/lib/playwright_api/playwright.rb

@@ -1,35 +1,99 @@
 module Playwright
-  # @nodoc
+  # Playwright module provides a method to launch a browser instance. The following is a typical example of using Playwright
+  # to drive automation:
+  # 
+  #
+  # ```js
+  # const { chromium, firefox, webkit } = require('playwright');
+  # 
+  # (async () => {
+  #   const browser = await chromium.launch();  // Or 'firefox' or 'webkit'.
+  #   const page = await browser.newPage();
+  #   await page.goto('http://example.com');
+  #   // other actions...
+  #   await browser.close();
+  # })();
+  # ```
+  # 
+  # By default, the `playwright` NPM package automatically downloads browser executables during installation. The
+  # `playwright-core` NPM package can be used to skip automatic downloads.
   class Playwright < PlaywrightApi
 
-    # @nodoc
-    def android
-      wrap_channel_owner(@channel_owner.android)
+    # This object can be used to launch or connect to Chromium, returning instances of `ChromiumBrowser`.
+    def chromium # property
+      wrap_channel_owner(@channel_owner.chromium)
     end
 
-    # @nodoc
-    def chromium
-      wrap_channel_owner(@channel_owner.chromium)
+    # Returns a list of devices to be used with [`method: Browser.newContext`] or [`method: Browser.newPage`]. Actual list of
+    # devices can be found in
+    # [src/server/deviceDescriptors.ts](https://github.com/Microsoft/playwright/blob/master/src/server/deviceDescriptors.ts).
+    # 
+    #
+    # ```js
+    # const { webkit, devices } = require('playwright');
+    # const iPhone = devices['iPhone 6'];
+    # 
+    # (async () => {
+    #   const browser = await webkit.launch();
+    #   const context = await browser.newContext({
+    #     ...iPhone
+    #   });
+    #   const page = await context.newPage();
+    #   await page.goto('http://example.com');
+    #   // other actions...
+    #   await browser.close();
+    # })();
+    # ```
+    def devices # property
+      wrap_channel_owner(@channel_owner.devices)
     end
 
-    # @nodoc
-    def electron
-      wrap_channel_owner(@channel_owner.electron)
+    # Playwright methods might throw errors if they are unable to fulfill a request. For example,
+    # [`method: Page.waitForSelector`] might fail if the selector doesn't match any nodes during the given timeframe.
+    # 
+    # For certain types of errors Playwright uses specific error classes. These classes are available via
+    # [`playwright.errors`](#playwrighterrors).
+    # 
+    # An example of handling a timeout error:
+    # 
+    #
+    # ```js
+    # try {
+    #   await page.waitForSelector('.foo');
+    # } catch (e) {
+    #   if (e instanceof playwright.errors.TimeoutError) {
+    #     // Do something if this is a timeout.
+    #   }
+    # }
+    # ```
+    def errors # property
+      raise NotImplementedError.new('errors is not implemented yet.')
     end
 
-    # @nodoc
-    def firefox
+    # This object can be used to launch or connect to Firefox, returning instances of `FirefoxBrowser`.
+    def firefox # property
       wrap_channel_owner(@channel_owner.firefox)
     end
 
+    # Selectors can be used to install custom selector engines. See
+    # [Working with selectors](./selectors.md#working-with-selectors) for more information.
+    def selectors # property
+      raise NotImplementedError.new('selectors is not implemented yet.')
+    end
+
+    # This object can be used to launch or connect to WebKit, returning instances of `WebKitBrowser`.
+    def webkit # property
+      wrap_channel_owner(@channel_owner.webkit)
+    end
+
     # @nodoc
-    def devices
-      wrap_channel_owner(@channel_owner.devices)
+    def android
+      wrap_channel_owner(@channel_owner.android)
     end
 
     # @nodoc
-    def webkit
-      wrap_channel_owner(@channel_owner.webkit)
+    def electron
+      wrap_channel_owner(@channel_owner.electron)
     end
   end
 end

data/lib/playwright_api/request.rb

@@ -1,19 +1,23 @@
 module Playwright
-  # Whenever the page sends a request for a network resource the following sequence of events are emitted by Page:
+  # Whenever the page sends a request for a network resource the following sequence of events are emitted by `Page`:
+  # - [`event: Page.request`] emitted when the request is issued by the page.
+  # - [`event: Page.response`] emitted when/if the response status and headers are received for the request.
+  # - [`event: Page.requestfinished`] emitted when the response body is downloaded and the request is complete.
   # 
-  # page.on('request') emitted when the request is issued by the page.
-  # page.on('response') emitted when/if the response status and headers are received for the request.
-  # page.on('requestfinished') emitted when the response body is downloaded and the request is complete.
+  # If request fails at some point, then instead of `'requestfinished'` event (and possibly instead of 'response' event),
+  # the  [`event: Page.requestfailed`] event is emitted.
   # 
-  # If request fails at some point, then instead of `'requestfinished'` event (and possibly instead of 'response' event), the  page.on('requestfailed') event is emitted.
+  # > **NOTE** HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request
+  # will complete with `'requestfinished'` event.
   # 
-  # **NOTE** HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with `'requestfinished'` event.
-  # 
-  # If request gets a 'redirect' response, the request is successfully finished with the 'requestfinished' event, and a new request is  issued to a redirected url.
+  # If request gets a 'redirect' response, the request is successfully finished with the 'requestfinished' event, and a new
+  # request is  issued to a redirected url.
   class Request < PlaywrightApi
 
     # The method returns `null` unless this request has failed, as reported by `requestfailed` event.
+    # 
     # Example of logging of all the failed requests:
+    # 
     #
     # ```js
     # page.on('requestfailed', request => {
@@ -24,7 +28,7 @@ module Playwright
       raise NotImplementedError.new('failure is not implemented yet.')
     end
 
-    # Returns the Frame that initiated this request.
+    # Returns the `Frame` that initiated this request.
     def frame
       raise NotImplementedError.new('frame is not implemented yet.')
     end
@@ -55,20 +59,29 @@ module Playwright
     end
 
     # Returns parsed request's body for `form-urlencoded` and JSON as a fallback if any.
-    # When the response is `application/x-www-form-urlencoded` then a key/value object of the values will be returned. Otherwise it will be parsed as JSON.
+    # 
+    # When the response is `application/x-www-form-urlencoded` then a key/value object of the values will be returned.
+    # Otherwise it will be parsed as JSON.
     def post_data_json
       raise NotImplementedError.new('post_data_json is not implemented yet.')
     end
 
     # Request that was redirected by the server to this one, if any.
-    # When the server responds with a redirect, Playwright creates a new Request object. The two requests are connected by `redirectedFrom()` and `redirectedTo()` methods. When multiple server redirects has happened, it is possible to construct the whole redirect chain by repeatedly calling `redirectedFrom()`.
+    # 
+    # When the server responds with a redirect, Playwright creates a new `Request` object. The two requests are connected by
+    # `redirectedFrom()` and `redirectedTo()` methods. When multiple server redirects has happened, it is possible to
+    # construct the whole redirect chain by repeatedly calling `redirectedFrom()`.
+    # 
     # For example, if the website `http://example.com` redirects to `https://example.com`:
+    # 
     #
     # ```js
     # const response = await page.goto('http://example.com');
     # console.log(response.request().redirectedFrom().url()); // 'http://example.com'
     # ```
+    # 
     # If the website `https://google.com` has no redirects:
+    # 
     #
     # ```js
     # const response = await page.goto('https://google.com');
@@ -79,7 +92,9 @@ module Playwright
     end
 
     # New request issued by the browser if the server responded with redirect.
-    # This method is the opposite of `request.redirectedFrom()`:
+    # 
+    # This method is the opposite of [`method: Request.redirectedFrom`]:
+    # 
     #
     # ```js
     # console.log(request.redirectedFrom().redirectedTo() === request); // true
@@ -88,17 +103,22 @@ module Playwright
       raise NotImplementedError.new('redirected_to is not implemented yet.')
     end
 
-    # Contains the request's resource type as it was perceived by the rendering engine. ResourceType will be one of the following: `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`, `websocket`, `manifest`, `other`.
+    # Contains the request's resource type as it was perceived by the rendering engine. ResourceType will be one of the
+    # following: `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`,
+    # `websocket`, `manifest`, `other`.
     def resource_type
       raise NotImplementedError.new('resource_type is not implemented yet.')
     end
 
-    # Returns the matching Response object, or `null` if the response was not received due to error.
+    # Returns the matching `Response` object, or `null` if the response was not received due to error.
     def response
       raise NotImplementedError.new('response is not implemented yet.')
     end
 
-    # Returns resource timing information for given request. Most of the timing values become available upon the response, `responseEnd` becomes available when request finishes. Find more information at Resource Timing API.
+    # Returns resource timing information for given request. Most of the timing values become available upon the response,
+    # `responseEnd` becomes available when request finishes. Find more information at
+    # [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
+    # 
     #
     # ```js
     # const [request] = await Promise.all([

data/lib/playwright_api/response.rb

@@ -1,5 +1,5 @@
 module Playwright
-  # Response class represents responses which are received by page.
+  # `Response` class represents responses which are received by page.
   class Response < PlaywrightApi
 
     # Returns the buffer with response body.
@@ -12,7 +12,7 @@ module Playwright
       raise NotImplementedError.new('finished is not implemented yet.')
     end
 
-    # Returns the Frame that initiated this response.
+    # Returns the `Frame` that initiated this response.
     def frame
       raise NotImplementedError.new('frame is not implemented yet.')
     end
@@ -23,6 +23,7 @@ module Playwright
     end
 
     # Returns the JSON representation of response body.
+    # 
     # This method will throw if the response body is not parsable via `JSON.parse`.
     def json
       raise NotImplementedError.new('json is not implemented yet.')
@@ -33,7 +34,7 @@ module Playwright
       raise NotImplementedError.new('ok is not implemented yet.')
     end
 
-    # Returns the matching Request object.
+    # Returns the matching `Request` object.
     def request
       raise NotImplementedError.new('request is not implemented yet.')
     end

data/lib/playwright_api/route.rb

@@ -1,5 +1,6 @@
 module Playwright
-  # Whenever a network route is set up with `page.route(url, handler)` or `browserContext.route(url, handler)`, the `Route` object allows to handle the route.
+  # Whenever a network route is set up with [`method: Page.route`] or [`method: BrowserContext.route`], the `Route` object
+  # allows to handle the route.
   class Route < PlaywrightApi
 
     # Aborts the route's request.
@@ -8,6 +9,7 @@ module Playwright
     end
 
     # Continues route's request with optional overrides.
+    # 
     #
     # ```js
     # await page.route('**/*', (route, request) => {
@@ -20,12 +22,14 @@ module Playwright
     #   route.continue({headers});
     # });
     # ```
-    def continue(overrides: nil)
-      raise NotImplementedError.new('continue is not implemented yet.')
+    def continue_(headers: nil, method: nil, postData: nil, url: nil)
+      raise NotImplementedError.new('continue_ is not implemented yet.')
     end
 
     # Fulfills route's request with given response.
+    # 
     # An example of fulfilling all requests with 404 responses:
+    # 
     #
     # ```js
     # await page.route('**/*', route => {
@@ -36,12 +40,19 @@ module Playwright
     #   });
     # });
     # ```
+    # 
     # An example of serving static file:
+    # 
     #
     # ```js
     # await page.route('**/xhr_endpoint', route => route.fulfill({ path: 'mock_data.json' }));
     # ```
-    def fulfill(response)
+    def fulfill(
+          body: nil,
+          contentType: nil,
+          headers: nil,
+          path: nil,
+          status: nil)
       raise NotImplementedError.new('fulfill is not implemented yet.')
     end
 

data/lib/playwright_api/selectors.rb

@@ -1,8 +1,10 @@
 module Playwright
-  # Selectors can be used to install custom selector engines. See Working with selectors for more information.
+  # Selectors can be used to install custom selector engines. See
+  # [Working with selectors](./selectors.md#working-with-selectors) for more information.
   class Selectors < PlaywrightApi
 
     # An example of registering selector engine that queries elements based on a tag name:
+    # 
     #
     # ```js
     # const { selectors, firefox } = require('playwright');  // Or 'chromium' or 'webkit'.
@@ -10,12 +12,6 @@ module Playwright
     # (async () => {
     #   // Must be a function that evaluates to a selector engine instance.
     #   const createTagNameEngine = () => ({
-    #     // Creates a selector that matches given target when queried at the root.
-    #     // Can return undefined if unable to create one.
-    #     create(root, target) {
-    #       return root.querySelector(target.tagName) === target ? target.tagName : undefined;
-    #     },
-    # 
     #     // Returns the first element matching given selector in the root's subtree.
     #     query(root, selector) {
     #       return root.querySelector(selector);

data/lib/playwright_api/touchscreen.rb

@@ -1,5 +1,6 @@
 module Playwright
-  # The Touchscreen class operates in main-frame CSS pixels relative to the top-left corner of the viewport. Methods on the touchscreen can only be used in browser contexts that have been intialized with `hasTouch` set to true.
+  # The Touchscreen class operates in main-frame CSS pixels relative to the top-left corner of the viewport. Methods on the
+  # touchscreen can only be used in browser contexts that have been intialized with `hasTouch` set to true.
   class Touchscreen < PlaywrightApi
 
     # Dispatches a `touchstart` and `touchend` event with a single touch at the position (`x`,`y`).

data/lib/playwright_api/video.rb

@@ -1,12 +1,14 @@
 module Playwright
   # When browser context is created with the `videosPath` option, each page has a video object associated with it.
+  # 
   #
   # ```js
   # console.log(await page.video().path());
   # ```
   class Video < PlaywrightApi
 
-    # Returns the file system path this video will be recorded to. The video is guaranteed to be written to the filesystem upon closing the browser context.
+    # Returns the file system path this video will be recorded to. The video is guaranteed to be written to the filesystem
+    # upon closing the browser context.
     def path
       raise NotImplementedError.new('path is not implemented yet.')
     end

data/lib/playwright_api/web_socket.rb

@@ -1,5 +1,5 @@
 module Playwright
-  # The WebSocket class represents websocket connections in the page.
+  # The `WebSocket` class represents websocket connections in the page.
   class WebSocket < PlaywrightApi
 
     # Indicates that the web socket has been closed.
@@ -13,7 +13,9 @@ module Playwright
     end
 
     # Returns the event data value.
-    # 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.
+    # 
+    # 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.
     def wait_for_event(event, optionsOrPredicate: nil)
       raise NotImplementedError.new('wait_for_event is not implemented yet.')
     end

data/lib/playwright_api/worker.rb

@@ -1,5 +1,8 @@
 module Playwright
-  # The Worker class represents a WebWorker. `worker` event is emitted on the page object to signal a worker creation. `close` event is emitted on the worker object when the worker is gone.
+  # The Worker class represents a [WebWorker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API). `worker`
+  # event is emitted on the page object to signal a worker creation. `close` event is emitted on the worker object when the
+  # worker is gone.
+  # 
   #
   # ```js
   # page.on('worker', worker => {
@@ -14,15 +17,24 @@ module Playwright
   class Worker < PlaywrightApi
 
     # Returns the return value of `pageFunction`
-    # If the function passed to the `worker.evaluate` returns a Promise, then `worker.evaluate` would wait for the promise to resolve and return its value.
-    # If the function passed to the `worker.evaluate` returns a non-Serializable value, then `worker.evaluate` returns `undefined`. DevTools Protocol also supports transferring some additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.
+    # 
+    # If the function passed to the `worker.evaluate` returns a [Promise], then `worker.evaluate` would wait for the promise
+    # to resolve and return its value.
+    # 
+    # If the function passed to the `worker.evaluate` returns a non-[Serializable] value, then `worker.evaluate` returns
+    # `undefined`. DevTools Protocol also supports transferring some additional values that are not serializable by `JSON`:
+    # `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.
     def evaluate(pageFunction, arg: nil)
       raise NotImplementedError.new('evaluate is not implemented yet.')
     end
 
     # Returns the return value of `pageFunction` as in-page object (JSHandle).
-    # The only difference between `worker.evaluate` and `worker.evaluateHandle` is that `worker.evaluateHandle` returns in-page object (JSHandle).
-    # If the function passed to the `worker.evaluateHandle` returns a Promise, then `worker.evaluateHandle` would wait for the promise to resolve and return its value.
+    # 
+    # The only difference between `worker.evaluate` and `worker.evaluateHandle` is that `worker.evaluateHandle` returns
+    # in-page object (JSHandle).
+    # 
+    # If the function passed to the `worker.evaluateHandle` returns a [Promise], then `worker.evaluateHandle` would wait for
+    # the promise to resolve and return its value.
     def evaluate_handle(pageFunction, arg: nil)
       raise NotImplementedError.new('evaluate_handle is not implemented yet.')
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -147,9 +147,12 @@ files:
 - lib/playwright/channel_owners/browser_type.rb
 - lib/playwright/channel_owners/chromium_browser.rb
 - lib/playwright/channel_owners/chromium_browser_context.rb
+- lib/playwright/channel_owners/console_message.rb
 - lib/playwright/channel_owners/electron.rb
+- lib/playwright/channel_owners/element_handle.rb
 - lib/playwright/channel_owners/firefox_browser.rb
 - lib/playwright/channel_owners/frame.rb
+- lib/playwright/channel_owners/js_handle.rb
 - lib/playwright/channel_owners/page.rb
 - lib/playwright/channel_owners/playwright.rb
 - lib/playwright/channel_owners/request.rb