playwright-ruby-client 0.0.6 → 0.2.0

data/lib/playwright/select_option_values.rb

@@ -0,0 +1,42 @@
+module Playwright
+  class SelectOptionValues
+    def initialize(element: nil, index: nil, value: nil, label: nil)
+      @params =
+        if element
+          convert(elmeent)
+        elsif index
+          convert(index)
+        elsif value
+          convert(value)
+        elsif label
+          convert(label)
+        else
+          {}
+        end
+    end
+
+    # @return [Hash]
+    def as_params
+      @params
+    end
+
+    private def convert(values)
+      return convert([values]) unless values.is_a?(Enumerable)
+      return {} if values.empty?
+      values.each_with_index do |value, index|
+        unless values
+          raise ArgumentError.new("options[#{index}]: expected object, got null")
+        end
+      end
+
+      case values.first
+      when ElementHandle
+        { elements: values.map(&:channel) }
+      when String
+        { options: values.map { |value| { value: value } } }
+      else
+        { options: values }
+      end
+    end
+  end
+end

data/lib/playwright/timeout_settings.rb

@@ -13,7 +13,7 @@ module Playwright
     end
 
     def timeout
-      @default_timeout || @parent&.navigation_timeout || DEFAULT_TIMEOUT
+      @default_timeout || @parent&.timeout || DEFAULT_TIMEOUT
     end
   end
 end

data/lib/playwright/touchscreen_impl.rb

@@ -0,0 +1,7 @@
+module Playwright
+  define_api_implementation :TouchscreenImpl do
+    def initialize(channel)
+      @channel = channel
+    end
+  end
+end

data/lib/playwright/utils.rb

@@ -1,5 +1,23 @@
 module Playwright
   module Utils
+    module PrepareBrowserContextOptions
+      # @see https://github.com/microsoft/playwright/blob/5a2cfdbd47ed3c3deff77bb73e5fac34241f649d/src/client/browserContext.ts#L265
+      private def prepare_browser_context_options(params)
+        if params[:noViewport] == 0
+          params.delete(:noViewport)
+          params[:noDefaultViewport] = true
+        end
+        if params[:extraHTTPHeaders]
+          params[:extraHTTPHeaders] = ::Playwright::HttpHeaders.new(params[:extraHTTPHeaders]).as_serialized
+        end
+        if params[:storageState].is_a?(String)
+          params[:storageState] = JSON.parse(File.read(params[:storageState]))
+        end
+
+        params
+      end
+    end
+
     module Errors
       module SafeCloseError
         # @param err [Exception]

data/lib/playwright/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '0.0.6'
+  VERSION = '0.2.0'
 end

data/lib/playwright/wait_helper.rb

@@ -23,7 +23,7 @@ module Playwright
       return if timeout_ms <= 0
 
       Concurrent::Promises.schedule(timeout_ms / 1000.0) {
-        reject(TimeoutError.new(message))
+        reject(TimeoutError.new(message: message))
       }
 
       self

data/lib/playwright_api/android.rb

@@ -0,0 +1,32 @@
+module Playwright
+  # @nodoc
+  class Android < PlaywrightApi
+
+    # @nodoc
+    def devices
+      wrap_impl(@impl.devices)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      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
+  end
+end

data/lib/playwright_api/android_device.rb

@@ -0,0 +1,77 @@
+module Playwright
+  # @nodoc
+  class AndroidDevice < PlaywrightApi
+
+    # @nodoc
+    def tree
+      wrap_impl(@impl.tree)
+    end
+
+    # @nodoc
+    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)))
+    end
+
+    # @nodoc
+    def screenshot(path: nil)
+      wrap_impl(@impl.screenshot(path: unwrap_impl(path)))
+    end
+
+    # @nodoc
+    def shell(command)
+      wrap_impl(@impl.shell(unwrap_impl(command)))
+    end
+
+    # @nodoc
+    def input
+      wrap_impl(@impl.input)
+    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)))
+    end
+
+    # @nodoc
+    def info(selector)
+      wrap_impl(@impl.info(unwrap_impl(selector)))
+    end
+
+    # @nodoc
+    def serial
+      wrap_impl(@impl.serial)
+    end
+
+    # @nodoc
+    def model
+      wrap_impl(@impl.model)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
+    end
+
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def on(event, callback)
+      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
+  end
+end

data/lib/playwright_api/android_input.rb

@@ -0,0 +1,25 @@
+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
+    def drag(from, to, steps)
+      wrap_impl(@impl.drag(unwrap_impl(from), unwrap_impl(to), unwrap_impl(steps)))
+    end
+
+    # @nodoc
+    def press(key)
+      wrap_impl(@impl.press(unwrap_impl(key)))
+    end
+  end
+end

data/lib/playwright_api/binding_call.rb

@@ -4,20 +4,24 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      wrap_impl(@impl.on(event, callback))
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      wrap_impl(@impl.off(event, callback))
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      wrap_impl(@impl.once(event, callback))
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
+    private def event_emitter_proxy
+      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end
   end
 end

data/lib/playwright_api/browser.rb

@@ -1,7 +1,7 @@
 module Playwright
   # - extends: [EventEmitter]
   # 
-  # A Browser is created via [`method: BrowserType.launch`]. An example of using a `Browser` to create a [Page]:
+  # A Browser is created via [`method: BrowserType.launch`]. An example of using a `Browser` to create a `Page`:
   # 
   #
   # ```js
@@ -135,19 +135,20 @@ 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,
           storageState: nil,
           timezoneId: nil,
           userAgent: nil,
-          videoSize: nil,
-          videosPath: nil,
-          viewport: nil)
-      wrap_impl(@impl.new_context(acceptDownloads: acceptDownloads, bypassCSP: bypassCSP, colorScheme: colorScheme, deviceScaleFactor: deviceScaleFactor, extraHTTPHeaders: extraHTTPHeaders, geolocation: geolocation, hasTouch: hasTouch, httpCredentials: httpCredentials, ignoreHTTPSErrors: ignoreHTTPSErrors, isMobile: isMobile, javaScriptEnabled: javaScriptEnabled, locale: locale, logger: logger, offline: offline, permissions: permissions, proxy: proxy, recordHar: recordHar, recordVideo: recordVideo, storageState: storageState, timezoneId: timezoneId, userAgent: userAgent, videoSize: videoSize, videosPath: videosPath, viewport: viewport))
+          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)))
     end
 
     # Creates a new page in a new browser context. Closing this page will close the context as well.
@@ -168,19 +169,19 @@ 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,
           storageState: nil,
           timezoneId: nil,
           userAgent: nil,
-          videoSize: nil,
-          videosPath: nil,
           viewport: nil)
-      wrap_impl(@impl.new_page(acceptDownloads: acceptDownloads, bypassCSP: bypassCSP, colorScheme: colorScheme, deviceScaleFactor: deviceScaleFactor, extraHTTPHeaders: extraHTTPHeaders, geolocation: geolocation, hasTouch: hasTouch, httpCredentials: httpCredentials, ignoreHTTPSErrors: ignoreHTTPSErrors, isMobile: isMobile, javaScriptEnabled: javaScriptEnabled, locale: locale, logger: logger, offline: offline, permissions: permissions, proxy: proxy, recordHar: recordHar, recordVideo: recordVideo, storageState: storageState, timezoneId: timezoneId, userAgent: userAgent, videoSize: videoSize, videosPath: videosPath, viewport: 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), storageState: unwrap_impl(storageState), timezoneId: unwrap_impl(timezoneId), userAgent: unwrap_impl(userAgent), viewport: unwrap_impl(viewport)))
     end
 
     # Returns the browser version.
@@ -188,27 +189,26 @@ module Playwright
       wrap_impl(@impl.version)
     end
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def after_initialize
-      wrap_impl(@impl.after_initialize)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
     def on(event, callback)
-      wrap_impl(@impl.on(event, callback))
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
     def off(event, callback)
-      wrap_impl(@impl.off(event, callback))
+      event_emitter_proxy.off(event, callback)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def once(event, callback)
-      wrap_impl(@impl.once(event, callback))
+    private def event_emitter_proxy
+      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end
   end
 end

data/lib/playwright_api/browser_context.rb

@@ -96,7 +96,7 @@ 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(script, arg: nil)
+    def add_init_script(path: nil, script: nil)
       raise NotImplementedError.new('add_init_script is not implemented yet.')
     end
 
@@ -523,12 +523,6 @@ module Playwright
     end
     alias_method :geolocation=, :set_geolocation
 
-    # **DEPRECATED** Browsers may cache credentials after successful authentication. Create a new browser context instead.
-    def set_http_credentials(httpCredentials)
-      raise NotImplementedError.new('set_http_credentials is not implemented yet.')
-    end
-    alias_method :http_credentials=, :set_http_credentials
-
     def set_offline(offline)
       raise NotImplementedError.new('set_offline is not implemented yet.')
     end
@@ -567,46 +561,61 @@ module Playwright
     #     page.click("button")
     # page = event_info.value
     # ```
-    def expect_event(event, optionsOrPredicate: nil)
+    def expect_event(event, predicate: nil, timeout: nil)
       raise NotImplementedError.new('expect_event is not implemented yet.')
     end
 
-    # @nodoc
-    def owner_page=(req)
-      wrap_impl(@impl.owner_page=(req))
+    # 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.
+    def expect_page(predicate: nil, timeout: nil)
+      raise NotImplementedError.new('expect_page is not implemented yet.')
     end
 
-    # @nodoc
-    def after_initialize
-      wrap_impl(@impl.after_initialize)
+    # > NOTE: In most cases, you should use [`method: BrowserContext.waitForEvent`].
+    # 
+    # Waits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function and
+    # waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the `event` is
+    # fired.
+    def wait_for_event(event, predicate: nil, timeout: nil)
+      raise NotImplementedError.new('wait_for_event is not implemented yet.')
     end
 
     # @nodoc
     def browser=(req)
-      wrap_impl(@impl.browser=(req))
+      wrap_impl(@impl.browser=(unwrap_impl(req)))
+    end
+
+    # @nodoc
+    def owner_page=(req)
+      wrap_impl(@impl.owner_page=(unwrap_impl(req)))
     end
 
     # @nodoc
     def options=(req)
-      wrap_impl(@impl.options=(req))
+      wrap_impl(@impl.options=(unwrap_impl(req)))
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      wrap_impl(@impl.on(event, callback))
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      wrap_impl(@impl.off(event, callback))
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      wrap_impl(@impl.once(event, callback))
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
+    private def event_emitter_proxy
+      @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end
   end
 end