playwright-ruby-client 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04f50e523a846e243058cbb53a44e0f4a6ecce32aa843a02ace9b855b2264862
-  data.tar.gz: a8c99b7550206d0ff90ad033e0391a9224f780ae1e009a8cab48441070adabaa
+  metadata.gz: eccb7fbb7a1fba3116ceaa61893b164850dc7f21eb45cac637da161bc137120a
+  data.tar.gz: ceeab7bc64c7a743ef3b682dda05271ff49eb3727ad7b47ed722f527aedacba0
 SHA512:
-  metadata.gz: d5e089555dc0d1ee2a86980d14d8310e338fa1d23b529a3d711895532dba64101300a198ed55b80f90342116b86baae8937c7526f992bc7ea9816297e385c436
-  data.tar.gz: d1da5e4e141043a37f3eccdd300865437264c795e343fa5652534d2fa04168d6f1326f7311c1f8c0212c98fd0d365b5b8f684b18b4b615b8825d5d65fa185562
+  metadata.gz: 1414afc026223b47750708cd2f30dab6453aebb5b3ce06f97a7f4a51c793f6b2b57ef307ffc0b31df2f91158d7d7e40623f443846b1653ca8778b7a67bfe7a47
+  data.tar.gz: 33cf15f92e23a118264627067f534d4379876090b6a3bf74fb8c67253e2905b575495c548247144f82ed282b8b86a1c891e89ffdf8e51423202bd38ce03a5bb2

data/docs/api_coverage.md

@@ -9,7 +9,6 @@
 * method
 * post_data
 * post_data_buffer
-* post_data_json
 * redirected_from
 * redirected_to
 * resource_type
@@ -23,7 +22,6 @@
 * ~~finished~~
 * ~~frame~~
 * ~~headers~~
-* ~~json~~
 * ~~ok~~
 * ~~request~~
 * ~~status~~
@@ -42,7 +40,6 @@
 
 * ~~closed?~~
 * ~~url~~
-* ~~expect_event~~
 
 ## Keyboard
 
@@ -76,16 +73,14 @@
 
 ## ElementHandle
 
-* query_selector
-* query_selector_all
-* eval_on_selector
-* eval_on_selector_all
 * bounding_box
 * check
 * click
 * content_frame
 * dblclick
 * dispatch_event
+* eval_on_selector
+* eval_on_selector_all
 * fill
 * focus
 * get_attribute
@@ -100,6 +95,8 @@
 * visible?
 * owner_frame
 * press
+* query_selector
+* query_selector_all
 * screenshot
 * scroll_into_view_if_needed
 * select_option
@@ -125,10 +122,6 @@
 
 ## Frame
 
-* query_selector
-* query_selector_all
-* eval_on_selector
-* eval_on_selector_all
 * add_script_tag
 * add_style_tag
 * check
@@ -137,6 +130,8 @@
 * content
 * dblclick
 * dispatch_event
+* eval_on_selector
+* eval_on_selector_all
 * evaluate
 * evaluate_handle
 * fill
@@ -158,6 +153,8 @@
 * page
 * parent_frame
 * press
+* query_selector
+* query_selector_all
 * select_option
 * set_content
 * set_input_files
@@ -170,7 +167,7 @@
 * wait_for_function
 * wait_for_load_state
 * expect_navigation
-* ~~wait_for_selector~~
+* wait_for_selector
 * ~~wait_for_timeout~~
 
 ## ~~Worker~~
@@ -214,74 +211,74 @@
 
 ## Page
 
-* query_selector
-* query_selector_all
-* eval_on_selector
-* eval_on_selector_all
-* ~~add_init_script~~
+* add_init_script
 * add_script_tag
 * add_style_tag
-* ~~bring_to_front~~
-* ~~check~~
+* bring_to_front
+* check
 * click
 * close
 * content
 * context
 * dblclick
-* ~~dispatch_event~~
-* ~~emulate_media~~
+* dispatch_event
+* emulate_media
+* eval_on_selector
+* eval_on_selector_all
 * evaluate
 * evaluate_handle
-* ~~expose_binding~~
-* ~~expose_function~~
+* expose_binding
+* expose_function
 * fill
 * focus
 * frame
 * frames
-* ~~get_attribute~~
-* ~~go_back~~
-* ~~go_forward~~
+* get_attribute
+* go_back
+* go_forward
 * goto
-* ~~hover~~
-* ~~inner_html~~
-* ~~inner_text~~
-* ~~checked?~~
+* hover
+* inner_html
+* inner_text
+* checked?
 * closed?
-* ~~disabled?~~
-* ~~editable?~~
-* ~~enabled?~~
-* ~~hidden?~~
-* ~~visible?~~
+* disabled?
+* editable?
+* enabled?
+* hidden?
+* visible?
 * main_frame
 * opener
-* ~~pdf~~
+* ~~pause~~
+* pdf
 * press
+* query_selector
+* query_selector_all
 * reload
 * ~~route~~
 * screenshot
-* ~~select_option~~
+* select_option
 * set_content
 * set_default_navigation_timeout
 * set_default_timeout
-* ~~set_extra_http_headers~~
-* ~~set_input_files~~
+* set_extra_http_headers
+* set_input_files
 * set_viewport_size
-* ~~tap_point~~
-* ~~text_content~~
+* tap_point
+* text_content
 * title
 * type
-* ~~uncheck~~
+* uncheck
 * ~~unroute~~
 * url
 * ~~video~~
 * viewport_size
-* expect_event
 * wait_for_function
 * wait_for_load_state
 * expect_navigation
 * expect_request
 * expect_response
-* ~~wait_for_selector~~
+* wait_for_selector
 * ~~wait_for_timeout~~
 * ~~workers~~
 * accessibility
@@ -313,7 +310,6 @@
 * ~~set_offline~~
 * ~~storage_state~~
 * ~~unroute~~
-* ~~expect_event~~
 
 ## ~~CDPSession~~
 
@@ -346,6 +342,7 @@
 
 ## Playwright
 
+* ~~close~~
 * chromium
 * devices
 * ~~errors~~

data/lib/playwright.rb

@@ -15,6 +15,7 @@ require 'playwright/utils'
 
 require 'playwright/channel'
 require 'playwright/channel_owner'
+require 'playwright/http_headers'
 require 'playwright/input_files'
 require 'playwright/input_type'
 require 'playwright/connection'

data/lib/playwright/channel_owners/browser_context.rb

@@ -8,7 +8,10 @@ module Playwright
       @pages = Set.new
 
       @channel.once('close', ->(_) { on_close })
-      @channel.on('page', ->(hash) { on_page(ChannelOwners::Page.from(hash['page']) )})
+      @channel.on('page', ->(params) { on_page(ChannelOwners::Page.from(params['page']) )})
+      @channel.on('route', ->(params) {
+        on_route(ChannelOwners::Route.from(params['route']), ChannelOwners::Request.from(params['request']))
+      })
     end
 
     private def on_page(page)
@@ -17,6 +20,11 @@ module Playwright
       emit(Events::BrowserContext::Page, page)
     end
 
+    private def on_route(route, request)
+      # @routes.each ...
+      route.continue_
+    end
+
     def pages
       @pages.to_a
     end

data/lib/playwright/channel_owners/frame.rb

@@ -144,6 +144,13 @@ module Playwright
       end
     end
 
+    def wait_for_selector(selector, state: nil, timeout: nil)
+      params = { selector: selector, state: state, timeout: timeout }.compact
+      resp = @channel.send_message_to_server('waitForSelector', params)
+
+      ChannelOwners::ElementHandle.from_nullable(resp)
+    end
+
     def checked?(selector, timeout: nil)
       params = { selector: selector, timeout: timeout }.compact
       @channel.send_message_to_server('isChecked', params)

data/lib/playwright/channel_owners/page.rb

@@ -26,7 +26,12 @@ module Playwright
         console_message = ChannelOwners::ConsoleMessage.from(params['message'])
         emit(Events::Page::Console, console_message)
       })
+      @channel.on('crash', ->(_) { emit(Events::Page::Crash) })
+      @channel.on('dialog', method(:on_dialog))
       @channel.on('domcontentloaded', ->(_) { emit(Events::Page::DOMContentLoaded) })
+      @channel.on('download', ->(params) {
+        emit(Events::Page::Download, ChannelOwners::Download.from(params['download']))
+      })
       @channel.on('frameAttached', ->(params) {
         on_frame_attached(ChannelOwners::Frame.from(params['frame']))
       })
@@ -34,9 +39,43 @@ module Playwright
         on_frame_detached(ChannelOwners::Frame.from(params['frame']))
       })
       @channel.on('load', ->(_) { emit(Events::Page::Load) })
+      @channel.on('pageError', ->(params) {
+        emit(Events::Page::PageError, Error.parse(params['error']['error']))
+      })
       @channel.on('popup', ->(params) {
         emit(Events::Page::Popup, ChannelOwners::Page.from(params['page']))
       })
+      @channel.on('request', ->(params) {
+        emit(Events::Page::Request, ChannelOwners::Request.from(params['request']))
+      })
+      @channel.on('requestFailed', ->(params) {
+        on_request_failed(
+          ChannelOwners::Request.from(params['request']),
+          params['responseEndTiming'],
+          params['failureText'],
+        )
+      })
+      @channel.on('requestFinished', ->(params) {
+        on_request_finished(
+          ChannelOwners::Request.from(params['request']),
+          params['responseEndTiming'],
+        )
+      })
+      @channel.on('response', ->(params) {
+        emit(Events::Page::Response, ChannelOwners::Response.from(params['response']))
+      })
+      @channel.on('route', ->(params) {
+        on_route(ChannelOwners::Route.from(params['route']), ChannelOwners::Request.from(params['request']))
+      })
+      @channel.on('video', ->(params) {
+        video.send(:update_relative_path, params['relativePath'])
+      })
+      @channel.on('webSocket', ->(params) {
+        emit(Events::Page::WebSocket, ChannelOwners::WebSocket.from(params['webSocket']))
+      })
+      @channel.on('worker', ->(params) {
+        on_worker(ChannelOwners::Worker.from(params['worker']))
+      })
     end
 
     attr_reader \
@@ -47,6 +86,17 @@ module Playwright
       :viewport_size,
       :main_frame
 
+    private def on_request_failed(request, response_end_timing, failure_text)
+      request.send(:update_failure_text, failure_text)
+      request.send(:update_response_end_timing, response_end_timing)
+      emit(Events::Page::RequestFailed)
+    end
+
+    private def on_request_finished(request, response_end_timing)
+      request.send(:update_response_end_timing, response_end_timing)
+      emit(Events::Page::RequestFinished)
+    end
+
     private def on_frame_attached(frame)
       frame.send(:update_page_from_page, self)
       @frames << frame
@@ -59,12 +109,25 @@ module Playwright
       emit(Events::Page::FrameDetached, frame)
     end
 
+    private def on_route(route, request)
+      # @routes.each ...
+      @browser_context.send(:on_route, route, request)
+    end
+
     private def on_close
       @closed = true
       @browser_context.send(:remove_page, self)
       emit(Events::Page::Close)
     end
 
+    private def on_dialog(params)
+      dialog = ChannelOwners::Dialog.from(params['dialog'])
+      unless emit(Events::Page::Dialog, dialog)
+        dialog.dismiss # FIXME: this should be asynchronous
+      end
+    end
+
+
     def context
       @browser_context
     end
@@ -121,6 +184,38 @@ module Playwright
       @main_frame.query_selector_all(selector)
     end
 
+    def wait_for_selector(selector, state: nil, timeout: nil)
+      @main_frame.wait_for_selector(selector, state: state, timeout: timeout)
+    end
+
+    def checked?(selector, timeout: nil)
+      @main_frame.checked?(selector, timeout: timeout)
+    end
+
+    def disabled?(selector, timeout: nil)
+      @main_frame.disabled?(selector, timeout: timeout)
+    end
+
+    def editable?(selector, timeout: nil)
+      @main_frame.editable?(selector, timeout: timeout)
+    end
+
+    def enabled?(selector, timeout: nil)
+      @main_frame.enabled?(selector, timeout: timeout)
+    end
+
+    def hidden?(selector, timeout: nil)
+      @main_frame.hidden?(selector, timeout: timeout)
+    end
+
+    def visible?(selector, timeout: nil)
+      @main_frame.visible?(selector, timeout: timeout)
+    end
+
+    def dispatch_event(selector, type, eventInit: nil, timeout: nil)
+      @main_frame.dispatch_event(selector, type, eventInit: eventInit, timeout: timeout)
+    end
+
     def evaluate(pageFunction, arg: nil)
       @main_frame.evaluate(pageFunction, arg: arg)
     end
@@ -145,6 +240,25 @@ module Playwright
       @main_frame.add_style_tag(content: content, path: path, url: url)
     end
 
+    def expose_function(name, callback)
+      @channel.send_message_to_server('exposeBinding', name: name)
+      @bindings[name] = ->(_source, *args) { callback.call(*args) }
+    end
+
+    def expose_binding(name, callback, handle: nil)
+      params = {
+        name: name,
+        needsHandle: handle,
+      }.compact
+      @channel.send_message_to_server('exposeBinding', params)
+      @bindings[name] = callback
+    end
+
+    def set_extra_http_headers(headers)
+      serialized_headers = HttpHeaders.new(headers).as_serialized
+      @channel.send_message_to_server('setExtraHTTPHeaders', headers: serialized_headers)
+    end
+
     def url
       @main_frame.url
     end
@@ -174,12 +288,45 @@ module Playwright
       @main_frame.wait_for_load_state(state: state, timeout: timeout)
     end
 
+    def go_back(timeout: nil, waitUntil: nil)
+      params = { timeout: timeout, waitUntil: waitUntil }.compact
+      resp = @channel.send_message_to_server('goBack', params)
+      ChannelOwners::Response.from_nullable(resp)
+    end
+
+    def go_forward(timeout: nil, waitUntil: nil)
+      params = { timeout: timeout, waitUntil: waitUntil }.compact
+      resp = @channel.send_message_to_server('goForward', params)
+      ChannelOwners::Response.from_nullable(resp)
+    end
+
+    def emulate_media(colorScheme: nil, media: nil)
+      params = {
+        colorScheme: colorScheme,
+        media: media,
+      }.compact
+      @channel.send_message_to_server('emulateMedia', params)
+
+      nil
+    end
+
     def set_viewport_size(viewportSize)
       @viewport_size = viewportSize
       @channel.send_message_to_server('setViewportSize', { viewportSize: viewportSize })
       nil
     end
 
+    def bring_to_front
+      @channel.send_message_to_server('bringToFront')
+      nil
+    end
+
+    def add_init_script(script, arg: nil)
+      @channel.send_message_to_server('addInitScript', source: script)
+      # FIXME: handling `arg` for function `script`
+      nil
+    end
+
     def screenshot(
       path: nil,
       type: nil,
@@ -269,6 +416,23 @@ module Playwright
       )
     end
 
+    def tap_point(
+          selector,
+          force: nil,
+          modifiers: nil,
+          noWaitAfter: nil,
+          position: nil,
+          timeout: nil)
+      @main_frame.tap_point(
+        selector,
+        force: force,
+        modifiers: modifiers,
+        noWaitAfter: noWaitAfter,
+        position: position,
+        timeout: timeout,
+      )
+    end
+
     def fill(selector, value, noWaitAfter: nil, timeout: nil)
       @main_frame.fill(selector, value, noWaitAfter: noWaitAfter, timeout: timeout)
     end
@@ -277,6 +441,45 @@ module Playwright
       @main_frame.focus(selector, timeout: timeout)
     end
 
+    def text_content(selector, timeout: nil)
+      @main_frame.text_content(selector, timeout: timeout)
+    end
+
+    def inner_text(selector, timeout: nil)
+      @main_frame.inner_text(selector, timeout: timeout)
+    end
+
+    def inner_html(selector, timeout: nil)
+      @main_frame.inner_html(selector, timeout: timeout)
+    end
+
+    def get_attribute(selector, name, timeout: nil)
+      @main_frame.get_attribute(selector, name, timeout: timeout)
+    end
+
+    def hover(
+          selector,
+          force: nil,
+          modifiers: nil,
+          position: nil,
+          timeout: nil)
+      @main_frame.hover(
+        selector,
+        force: force,
+        modifiers: modifiers,
+        position: position,
+        timeout: timeout,
+      )
+    end
+
+    def select_option(selector, values, noWaitAfter: nil, timeout: nil)
+      @main_frame.select_option(selector, values, noWaitAfter: noWaitAfter, timeout: timeout)
+    end
+
+    def set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
+      @main_frame.set_input_files(selector, files, noWaitAfter: noWaitAfter, timeout: timeout)
+    end
+
     def type(
       selector,
       text,
@@ -297,10 +500,57 @@ module Playwright
       @main_frame.press(selector, key, delay: delay, noWaitAfter: noWaitAfter, timeout: timeout)
     end
 
+    def check(selector, force: nil, noWaitAfter: nil, timeout: nil)
+      @main_frame.check(selector, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
+    end
+
+    def uncheck(selector, force: nil, noWaitAfter: nil, timeout: nil)
+      @main_frame.uncheck(selector, force: force, noWaitAfter: noWaitAfter, timeout: timeout)
+    end
+
     def wait_for_function(pageFunction, arg: nil, polling: nil, timeout: nil)
       @main_frame.wait_for_function(pageFunction, arg: arg, polling: polling, timeout: timeout)
     end
 
+    def pdf(
+          displayHeaderFooter: nil,
+          footerTemplate: nil,
+          format: nil,
+          headerTemplate: nil,
+          height: nil,
+          landscape: nil,
+          margin: nil,
+          pageRanges: nil,
+          path: nil,
+          preferCSSPageSize: nil,
+          printBackground: nil,
+          scale: nil,
+          width: nil)
+
+      params = {
+        displayHeaderFooter: displayHeaderFooter,
+        footerTemplate: footerTemplate,
+        format: format,
+        headerTemplate: headerTemplate,
+        height: height,
+        landscape: landscape,
+        margin: margin,
+        pageRanges: pageRanges,
+        preferCSSPageSize: preferCSSPageSize,
+        printBackground: printBackground,
+        scale: scale,
+        width: width,
+      }.compact
+      encoded_binary = @channel.send_message_to_server('pdf', params)
+      decoded_binary = Base64.strict_decode64(encoded_binary)
+      if path
+        File.open(path, 'wb') do |f|
+          f.write(decoded_binary)
+        end
+      end
+      decoded_binary
+    end
+
     class CrashedError < StandardError
       def initialize
         super('Page crashed')