playwright-ruby-client 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 140f77362280a6874d89ed73fde1e80fa47e2b83f075b6207835f02ab62cb97f
-  data.tar.gz: e715b39c620668eeea1a0dbb022865f759d02f59d2f3d23948c7c20536ca0136
+  metadata.gz: cbaaa0e61bbc515a26d0f0e6af6ca8c36bbf3db5cc6913a6895f175154ba893b
+  data.tar.gz: cdc467f161030497d4efb94689bef4901c0e15bd24e9cc8be189106f5dfe4493
 SHA512:
-  metadata.gz: 0315d44031788794eca7f506ba9a20a81dbb6bf77c15efda873a1efc3e25074d46e1629ae07551f2dd8368f8a7609568cd719fd1470fdd3bf2717373168655a2
-  data.tar.gz: a3b6a02b60059ac3ef14c0ca1222e3b88a3aaee588b8510c49ef748fab5f27c354417b1e38cc6adfe98e6b1f38805ed1c0cead8cfb465f4968e449c98dd5a9a5
+  metadata.gz: 585d3989547fd8e38e1e9503bf8aee20e732b1234bd62783c51b2e77a6061325c9a0c44de0de2b65557726dbebd6dc944ab44f72ffb8cbba69449ff3c0886a59
+  data.tar.gz: e50bd506a34d5fe1d84d6f75d0fbe8bc1128c0f93c3529dc94ba6af7dabf59e564625e6ca0b5a16cf7ad8066ffe91aeeda369599a30c0bb9e5629f54dfe54fd1

data/docs/api_coverage.md

@@ -19,24 +19,24 @@
 
 ## Response
 
-* ~~body~~
-* ~~finished~~
-* ~~frame~~
-* ~~headers~~
-* ~~json~~
-* ~~ok~~
-* ~~request~~
-* ~~status~~
-* ~~status_text~~
-* ~~text~~
-* ~~url~~
+* body
+* finished
+* frame
+* headers
+* json
+* ok
+* request
+* status
+* status_text
+* text
+* url
 
-## ~~Route~~
+## Route
 
-* ~~abort~~
-* ~~continue_~~
-* ~~fulfill~~
-* ~~request~~
+* abort
+* continue
+* fulfill
+* request
 
 ## ~~WebSocket~~
 
@@ -182,7 +182,7 @@
 
 ## Selectors
 
-* ~~register~~
+* register
 
 ## ConsoleMessage
 
@@ -191,13 +191,13 @@
 * text
 * type
 
-## ~~Dialog~~
+## Dialog
 
-* ~~accept~~
-* ~~default_value~~
-* ~~dismiss~~
-* ~~message~~
-* ~~type~~
+* accept
+* default_value
+* dismiss
+* message
+* type
 
 ## Download
 
@@ -258,7 +258,7 @@
 * query_selector
 * query_selector_all
 * reload
-* ~~route~~
+* route
 * screenshot
 * select_option
 * set_content
@@ -272,24 +272,24 @@
 * title
 * type
 * uncheck
-* ~~unroute~~
+* unroute
 * url
 * ~~video~~
 * viewport_size
+* expect_console_message
+* expect_download
 * expect_event
+* expect_file_chooser
 * wait_for_function
 * wait_for_load_state
 * expect_navigation
+* expect_popup
 * expect_request
 * expect_response
 * wait_for_selector
 * ~~wait_for_timeout~~
-* ~~workers~~
-* expect_download
-* expect_popup
 * ~~expect_worker~~
-* expect_console_message
-* expect_file_chooser
+* ~~workers~~
 * ~~wait_for_event~~
 * accessibility
 * keyboard
@@ -298,28 +298,28 @@
 
 ## BrowserContext
 
-* ~~add_cookies~~
-* ~~add_init_script~~
-* ~~browser~~
-* ~~clear_cookies~~
-* ~~clear_permissions~~
+* add_cookies
+* add_init_script
+* browser
+* clear_cookies
+* clear_permissions
 * close
-* ~~cookies~~
-* ~~expose_binding~~
-* ~~expose_function~~
-* ~~grant_permissions~~
+* cookies
+* expose_binding
+* expose_function
+* grant_permissions
 * new_page
 * pages
-* ~~route~~
-* ~~set_default_navigation_timeout~~
-* ~~set_default_timeout~~
-* ~~set_extra_http_headers~~
-* ~~set_geolocation~~
-* ~~set_offline~~
+* route
+* set_default_navigation_timeout
+* set_default_timeout
+* set_extra_http_headers
+* set_geolocation
+* set_offline
 * ~~storage_state~~
-* ~~unroute~~
-* ~~expect_event~~
-* ~~expect_page~~
+* unroute
+* expect_event
+* expect_page
 * ~~wait_for_event~~
 
 ## ~~CDPSession~~
@@ -355,5 +355,58 @@
 * chromium
 * devices
 * firefox
-* ~~selectors~~
+* selectors
 * webkit
+
+## Android
+
+* devices
+* ~~set_default_timeout~~
+
+## AndroidDevice
+
+* close
+* ~~drag~~
+* ~~fill~~
+* ~~fling~~
+* info
+* ~~install_apk~~
+* launch_browser
+* ~~long_tap~~
+* model
+* ~~open~~
+* ~~pinch_close~~
+* ~~pinch_open~~
+* ~~press~~
+* ~~push~~
+* screenshot
+* ~~scroll~~
+* serial
+* ~~set_default_timeout~~
+* shell
+* ~~swipe~~
+* ~~tap_point~~
+* ~~wait~~
+* ~~wait_for_event~~
+* ~~web_view~~
+* ~~web_views~~
+* input
+
+## AndroidInput
+
+* drag
+* press
+* ~~swipe~~
+* tap_point
+* type
+
+## ~~AndroidSocket~~
+
+* ~~close~~
+* ~~write~~
+
+## ~~AndroidWebView~~
+
+* ~~page~~
+* ~~pid~~
+* ~~pkg~~

data/lib/playwright.rb

@@ -20,6 +20,7 @@ require 'playwright/channel_owner'
 require 'playwright/http_headers'
 require 'playwright/input_files'
 require 'playwright/connection'
+require 'playwright/route_handler_entry'
 require 'playwright/select_option_values'
 require 'playwright/timeout_settings'
 require 'playwright/transport'

data/lib/playwright/channel.rb

@@ -16,20 +16,20 @@ module Playwright
     # @param method [String]
     # @param params [Hash]
     def send_message_to_server(method, params = {})
-      result = @connection.send_message_to_server(@guid, method, params)
-      if result.is_a?(Hash)
-        _type, channel_owner = result.first
-        channel_owner
-      else
-        nil
-      end
+      async_send_message_to_server(method, params).value!
     end
 
     # @param method [String]
     # @param params [Hash]
-    def send_no_reply(method, params)
-      @connection.async_send_message_to_server(@guid, method, params)
-      nil
+    def async_send_message_to_server(method, params = {})
+      @connection.async_send_message_to_server(@guid, method, params).then do |result|
+        if result.is_a?(Hash)
+          _type, channel_owner = result.first
+          channel_owner
+        else
+          nil
+        end
+      end
     end
   end
 end

data/lib/playwright/channel_owners/binding_call.rb

@@ -1,4 +1,7 @@
 module Playwright
   define_channel_owner :BindingCall do
+    def name
+      @initializer['name']
+    end
   end
 end

data/lib/playwright/channel_owners/browser_context.rb

@@ -2,11 +2,16 @@ module Playwright
   # @ref https://github.com/microsoft/playwright-python/blob/master/playwright/_impl/_browser_context.py
   define_channel_owner :BrowserContext do
     include Utils::Errors::SafeCloseError
-    attr_writer :browser, :owner_page, :options
+    attr_accessor :browser
+    attr_writer :owner_page, :options
 
     private def after_initialize
       @pages = Set.new
+      @routes = Set.new
+      @bindings = {}
+      @timeout_settings = TimeoutSettings.new
 
+      @channel.on('bindingCall', ->(params) { on_binding(ChannelOwners::BindingCall.from(params['binding'])) })
       @channel.once('close', ->(_) { on_close })
       @channel.on('page', ->(params) { on_page(ChannelOwners::Page.from(params['page']) )})
       @channel.on('route', ->(params) {
@@ -21,8 +26,32 @@ module Playwright
     end
 
     private def on_route(route, request)
-      # @routes.each ...
-      route.continue_
+      # It is not desired to use PlaywrightApi.wrap directly.
+      # However it is a little difficult to define wrapper for `handler` parameter in generate_api.
+      # Just a workaround...
+      wrapped_route = PlaywrightApi.wrap(route)
+      wrapped_request = PlaywrightApi.wrap(request)
+
+      if @routes.none? { |handler_entry| handler_entry.handle(wrapped_route, wrapped_request) }
+        route.continue
+      end
+    end
+
+    private def on_binding(binding_call)
+      func = @binding[binding_call.name]
+      if func
+        binding_call.call(func)
+      end
+    end
+
+    def set_default_navigation_timeout(timeout)
+      @timeout_settings.default_navigation_timeout = timeout
+      @channel.send_message_to_server('setDefaultNavigationTimeoutNoReply', timeout: timeout)
+    end
+
+    def set_default_timeout(timeout)
+      @timeout_settings.default_timeout = timeout
+      @channel.send_message_to_server('setDefaultTimeoutNoReply', timeout: timeout)
     end
 
     def pages
@@ -36,6 +65,111 @@ module Playwright
       ChannelOwners::Page.from(resp)
     end
 
+    def cookies(urls: nil)
+      target_urls =
+        if urls.nil?
+          []
+        elsif urls.is_a?(Enumerable)
+          urls
+        else
+          [urls]
+        end
+      @channel.send_message_to_server('cookies', urls: urls)
+    end
+
+    def add_cookies(cookies)
+      @channel.send_message_to_server('addCookies', cookies: cookies)
+    end
+
+    def clear_cookies
+      @channel.send_message_to_server('clearCookies')
+    end
+
+    def grant_permissions(permissions, origin: nil)
+      params = {
+        permissions: permissions,
+        origin: origin,
+      }.compact
+      @channel.send_message_to_server('grantPermissions', params)
+    end
+
+    def clear_permissions
+      @channel.send_message_to_server('clearPermissions')
+    end
+
+    def set_geolocation(geolocation)
+      @channel.send_message_to_server('setGeolocation', geolocation: geolocation)
+    end
+
+    def set_extra_http_headers(headers)
+      @channel.send_message_to_server('setExtraHTTPHeaders',
+        headers: HttpHeaders.new(headers).as_serialized)
+    end
+
+    def set_offline(offline)
+      @channel.send_message_to_server('setOffline', offline: offline)
+    end
+
+    def add_init_script(path: nil, script: nil)
+      source =
+        if path
+          File.read(path)
+        elsif script
+          script
+        else
+          raise ArgumentError.new('Either path or script parameter must be specified')
+        end
+
+      @channel.send_message_to_server('addInitScript', source: script)
+      nil
+    end
+
+    def expose_binding(name, callback, handle: nil)
+      if @pages.any? { |page| page.send(:has_bindings?, name) }
+        raise ArgumentError.new("Function \"#{name}\" has been already registered in one of the pages")
+      end
+      if @bindings.key?(name)
+        raise ArgumentError.new("Function \"#{name}\" has been already registered")
+      end
+      params = {
+        name: name,
+        needsHandle: handle,
+      }.compact
+      @bindings[name] = callback
+      @channel.send_message_to_server('exposeBinding', params)
+    end
+
+    def expose_function(name, callback)
+      expose_binding(name, ->(_source, *args) { callback.call(*args) }, )
+    end
+
+    def route(url, handler)
+      entry = RouteHandlerEntry.new(url, handler)
+      @routes << entry
+      if @routes.count >= 1
+        @channel.send_message_to_server('setNetworkInterceptionEnabled', enabled: true)
+      end
+    end
+
+    def unroute(url, handler: nil)
+      @routes.reject! do |handler_entry|
+        handler_entry.same_value?(url: url, handler: handler)
+      end
+      if @routes.count == 0
+        @channel.send_message_to_server('setNetworkInterceptionEnabled', enabled: false)
+      end
+    end
+
+    def expect_event(event, predicate: nil, timeout: nil, &block)
+      wait_helper = WaitHelper.new
+      wait_helper.reject_on_timeout(timeout || @timeout_settings.timeout, "Timeout while waiting for event \"#{event}\"")
+      wait_helper.wait_for_event(self, event, predicate: predicate)
+
+      block&.call
+
+      wait_helper.promise.value!
+    end
+
     private def on_close
       @closed_or_closing = true
       @browser&.send(:remove_context, self)
@@ -51,6 +185,18 @@ module Playwright
       raise unless safe_close_error?(err)
     end
 
+    def pause
+      @channel.send_message_to_server('pause')
+    end
+
+    def expect_page(predicate: nil, timeout: nil)
+      params = {
+        predicate: predicate,
+        timeout: timeout,
+      }.compact
+      expect_event(Events::BrowserContext::Page, params)
+    end
+
     # called from Page#on_close with send(:remove_page, page), so keep private
     private def remove_page(page)
       @pages.delete(page)