playwright-ruby-client 0.2.1 → 0.3.0

data/lib/playwright_api/android_device.rb

@@ -1,55 +1,178 @@
 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 tap_on(selector, duration: nil, timeout: nil)
-      wrap_impl(@impl.tap_on(unwrap_impl(selector), duration: unwrap_impl(duration), timeout: unwrap_impl(timeout)))
+    # 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
+    # Fills the specific `selector` input box with `text`.
+    def fill(selector, text)
+      raise NotImplementedError.new('fill is not implemented yet.')
+    end
+
+    # 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,
+          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)))
+    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, 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, storageState: nil, timezoneId: nil, userAgent: 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), 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)))
+    # Taps on the widget defined by `selector`.
+    def tap_point(selector, duration: nil)
+      raise NotImplementedError.new('tap_point is not implemented yet.')
+    end
+
+    # 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 info(selector)
-      wrap_impl(@impl.info(unwrap_impl(selector)))
+    def tree
+      wrap_impl(@impl.tree)
     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
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def model
-      wrap_impl(@impl.model)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
@@ -64,12 +187,6 @@ 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/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/binding_call.rb

@@ -2,22 +2,27 @@ module Playwright
   # @nodoc
   class BindingCall < PlaywrightApi
 
+    # @nodoc
+    def name
+      wrap_impl(@impl.name)
+    end
+
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/browser.rb

@@ -191,20 +191,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/browser_context.rb

@@ -57,7 +57,7 @@ module Playwright
     # browser_context.add_cookies([cookie_object1, cookie_object2])
     # ```
     def add_cookies(cookies)
-      raise NotImplementedError.new('add_cookies is not implemented yet.')
+      wrap_impl(@impl.add_cookies(unwrap_impl(cookies)))
     end
 
     # Adds a script which would be evaluated in one of the following scenarios:
@@ -97,17 +97,17 @@ module Playwright
     # > NOTE: The order of evaluation of multiple scripts installed via [`method: BrowserContext.addInitScript`] and
     # [`method: Page.addInitScript`] is not defined.
     def add_init_script(path: nil, script: nil)
-      raise NotImplementedError.new('add_init_script is not implemented yet.')
+      wrap_impl(@impl.add_init_script(path: unwrap_impl(path), script: unwrap_impl(script)))
     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.')
+      wrap_impl(@impl.browser)
     end
 
     # Clears context cookies.
     def clear_cookies
-      raise NotImplementedError.new('clear_cookies is not implemented yet.')
+      wrap_impl(@impl.clear_cookies)
     end
 
     # Clears all permission overrides for the browser context.
@@ -134,7 +134,7 @@ module Playwright
     # context.clear_permissions()
     # ```
     def clear_permissions
-      raise NotImplementedError.new('clear_permissions is not implemented yet.')
+      wrap_impl(@impl.clear_permissions)
     end
 
     # Closes the browser context. All the pages that belong to the browser context will be closed.
@@ -147,7 +147,7 @@ module Playwright
     # 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.')
+      wrap_impl(@impl.cookies(urls: unwrap_impl(urls)))
     end
 
     # The method adds a function called `name` on the `window` object of every frame in every page in the context. When
@@ -278,7 +278,7 @@ module Playwright
     # """)
     # ```
     def expose_binding(name, callback, handle: nil)
-      raise NotImplementedError.new('expose_binding is not implemented yet.')
+      wrap_impl(@impl.expose_binding(unwrap_impl(name), unwrap_impl(callback), handle: unwrap_impl(handle)))
     end
 
     # The method adds a function called `name` on the `window` object of every frame in every page in the context. When
@@ -379,13 +379,13 @@ module Playwright
     #     run(playwright)
     # ```
     def expose_function(name, callback)
-      raise NotImplementedError.new('expose_function is not implemented yet.')
+      wrap_impl(@impl.expose_function(unwrap_impl(name), unwrap_impl(callback)))
     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.')
+      wrap_impl(@impl.grant_permissions(unwrap_impl(permissions), origin: unwrap_impl(origin)))
     end
 
     # Creates a new page in the browser context.
@@ -464,7 +464,7 @@ module Playwright
     # 
     # > NOTE: Enabling routing disables http cache.
     def route(url, handler)
-      raise NotImplementedError.new('route is not implemented yet.')
+      wrap_impl(@impl.route(unwrap_impl(url), unwrap_impl(handler)))
     end
 
     # This setting will change the default maximum navigation time for the following methods and related shortcuts:
@@ -478,7 +478,7 @@ module Playwright
     # > NOTE: [`method: Page.setDefaultNavigationTimeout`] and [`method: Page.setDefaultTimeout`] take priority over
     # [`method: BrowserContext.setDefaultNavigationTimeout`].
     def set_default_navigation_timeout(timeout)
-      raise NotImplementedError.new('set_default_navigation_timeout is not implemented yet.')
+      wrap_impl(@impl.set_default_navigation_timeout(unwrap_impl(timeout)))
     end
     alias_method :default_navigation_timeout=, :set_default_navigation_timeout
 
@@ -487,7 +487,7 @@ module Playwright
     # > NOTE: [`method: Page.setDefaultNavigationTimeout`], [`method: Page.setDefaultTimeout`] and
     # [`method: BrowserContext.setDefaultNavigationTimeout`] take priority over [`method: BrowserContext.setDefaultTimeout`].
     def set_default_timeout(timeout)
-      raise NotImplementedError.new('set_default_timeout is not implemented yet.')
+      wrap_impl(@impl.set_default_timeout(unwrap_impl(timeout)))
     end
     alias_method :default_timeout=, :set_default_timeout
 
@@ -497,7 +497,7 @@ module Playwright
     # 
     # > NOTE: [`method: 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.')
+      wrap_impl(@impl.set_extra_http_headers(unwrap_impl(headers)))
     end
     alias_method :extra_http_headers=, :set_extra_http_headers
 
@@ -519,12 +519,12 @@ module Playwright
     # > NOTE: Consider using [`method: BrowserContext.grantPermissions`] 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.')
+      wrap_impl(@impl.set_geolocation(unwrap_impl(geolocation)))
     end
     alias_method :geolocation=, :set_geolocation
 
     def set_offline(offline)
-      raise NotImplementedError.new('set_offline is not implemented yet.')
+      wrap_impl(@impl.set_offline(unwrap_impl(offline)))
     end
     alias_method :offline=, :set_offline
 
@@ -536,7 +536,7 @@ module Playwright
     # Removes a route created with [`method: BrowserContext.route`]. When `handler` is not specified, removes all routes for
     # the `url`.
     def unroute(url, handler: nil)
-      raise NotImplementedError.new('unroute is not implemented yet.')
+      wrap_impl(@impl.unroute(unwrap_impl(url), handler: unwrap_impl(handler)))
     end
 
     # Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy
@@ -561,15 +561,15 @@ module Playwright
     #     page.click("button")
     # page = event_info.value
     # ```
-    def expect_event(event, predicate: nil, timeout: nil)
-      raise NotImplementedError.new('expect_event is not implemented yet.')
+    def expect_event(event, predicate: nil, timeout: nil, &block)
+      wrap_impl(@impl.expect_event(unwrap_impl(event), predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block)))
     end
 
-    # Performs action and waits for `page` event to fire. If predicate is provided, it passes `Page` value into the
-    # `predicate` function and waits for `predicate(event)` to return a truthy value. Will throw an error if the page is
-    # closed before the worker event is fired.
+    # Performs action and waits for a new `Page` to be created in the context. If predicate is provided, it passes `Page`
+    # value into the `predicate` function and waits for `predicate(event)` to return a truthy value. Will throw an error if
+    # the context closes before new `Page` is created.
     def expect_page(predicate: nil, timeout: nil)
-      raise NotImplementedError.new('expect_page is not implemented yet.')
+      wrap_impl(@impl.expect_page(predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout)))
     end
 
     # > NOTE: In most cases, you should use [`method: BrowserContext.waitForEvent`].
@@ -596,22 +596,27 @@ module Playwright
       wrap_impl(@impl.options=(unwrap_impl(req)))
     end
 
+    # @nodoc
+    def pause
+      wrap_impl(@impl.pause)
+    end
+
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy