playwright-ruby-client 1.14.beta2 → 1.15.beta2

data/lib/playwright_api/playwright.rb

@@ -93,20 +93,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/request.rb

@@ -14,6 +14,11 @@ module Playwright
   # request is  issued to a redirected url.
   class Request < PlaywrightApi
 
+    # An object with all the request HTTP headers associated with this request. The header names are lower-cased.
+    def all_headers
+      wrap_impl(@impl.all_headers)
+    end
+
     # The method returns `null` unless this request has failed, as reported by `requestfailed` event.
     #
     # Example of logging of all the failed requests:
@@ -30,11 +35,17 @@ module Playwright
       wrap_impl(@impl.frame)
     end
 
-    # An object with HTTP headers associated with the request. All header names are lower-case.
+    # **DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use [`method: Request.allHeaders`] instead.
     def headers
       wrap_impl(@impl.headers)
     end
 
+    # An array with all the request HTTP headers associated with this request. Unlike [`method: Request.allHeaders`], header
+    # names are not lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+    def headers_array
+      wrap_impl(@impl.headers_array)
+    end
+
     # Whether this request is driving frame's navigation.
     def navigation_request?
       wrap_impl(@impl.navigation_request?)
@@ -109,6 +120,12 @@ module Playwright
       wrap_impl(@impl.response)
     end
 
+    # Returns resource size information for given request. Requires the response to be finished via
+    # [`method: Response.finished`] to ensure the info is available.
+    def sizes
+      wrap_impl(@impl.sizes)
+    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](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
@@ -128,22 +145,27 @@ module Playwright
       wrap_impl(@impl.url)
     end
 
+    # @nodoc
+    def parse_headers_as_array(serialized_headers, downcase)
+      wrap_impl(@impl.parse_headers_as_array(unwrap_impl(serialized_headers), unwrap_impl(downcase)))
+    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/response.rb

@@ -2,6 +2,11 @@ module Playwright
   # `Response` class represents responses which are received by page.
   class Response < PlaywrightApi
 
+    # An object with all the response HTTP headers associated with this response.
+    def all_headers
+      wrap_impl(@impl.all_headers)
+    end
+
     # Returns the buffer with response body.
     def body
       wrap_impl(@impl.body)
@@ -17,11 +22,17 @@ module Playwright
       wrap_impl(@impl.frame)
     end
 
-    # Returns the object with HTTP headers associated with the response. All header names are lower-case.
+    # **DEPRECATED** Incomplete list of headers as seen by the rendering engine. Use [`method: Response.allHeaders`] instead.
     def headers
       wrap_impl(@impl.headers)
     end
 
+    # An array with all the request HTTP headers associated with this response. Unlike [`method: Response.allHeaders`], header
+    # names are not lower-cased. Headers with multiple entries, such as `Set-Cookie`, appear in the array multiple times.
+    def headers_array
+      wrap_impl(@impl.headers_array)
+    end
+
     # Returns the JSON representation of response body.
     #
     # This method will throw if the response body is not parsable via `JSON.parse`.
@@ -74,22 +85,27 @@ module Playwright
       wrap_impl(@impl.ok?)
     end
 
+    # @nodoc
+    def parse_headers_as_array(serialized_headers, downcase)
+      wrap_impl(@impl.parse_headers_as_array(unwrap_impl(serialized_headers), unwrap_impl(downcase)))
+    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/route.rb

@@ -58,20 +58,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/selectors.rb

@@ -6,7 +6,38 @@ module Playwright
     # An example of registering selector engine that queries elements based on a tag name:
     #
     # ```python sync
-    # # FIXME: add snippet
+    # from playwright.sync_api import sync_playwright
+    #
+    # def run(playwright):
+    #     tag_selector = """
+    #       {
+    #           // Returns the first element matching given selector in the root's subtree.
+    #           query(root, selector) {
+    #               return root.querySelector(selector);
+    #           },
+    #           // Returns all elements matching given selector in the root's subtree.
+    #           queryAll(root, selector) {
+    #               return Array.from(root.querySelectorAll(selector));
+    #           }
+    #       }"""
+    #
+    #     # Register the engine. Selectors will be prefixed with "tag=".
+    #     playwright.selectors.register("tag", tag_selector)
+    #     browser = playwright.chromium.launch()
+    #     page = browser.new_page()
+    #     page.set_content('<div><button>Click me</button></div>')
+    #
+    #     # Use the selector prefixed with its name.
+    #     button = page.query_selector('tag=button')
+    #     # Combine it with other selector engines.
+    #     page.click('tag=div >> text="Click me"')
+    #     # Can use it in any methods supporting selectors.
+    #     button_count = page.eval_on_selector_all('tag=button', 'buttons => buttons.length')
+    #     print(button_count)
+    #     browser.close()
+    #
+    # with sync_playwright() as playwright:
+    #     run(playwright)
     # ```
     def register(name, contentScript: nil, path: nil, script: nil)
       wrap_impl(@impl.register(unwrap_impl(name), contentScript: unwrap_impl(contentScript), path: unwrap_impl(path), script: unwrap_impl(script)))
@@ -14,20 +45,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/tracing.rb

@@ -1,13 +1,14 @@
 module Playwright
-  # API for collecting and saving Playwright traces. Playwright traces can be opened using the Playwright CLI after
-  # Playwright script runs.
+  # API for collecting and saving Playwright traces. Playwright traces can be opened in [Trace Viewer](./trace-viewer.md)
+  # after Playwright script runs.
   #
-  # Start with specifying the folder traces will be stored in:
+  # Start recording a trace before performing actions. At the end, stop tracing and save it to a file.
   #
   # ```python sync
   # browser = chromium.launch()
   # context = browser.new_context()
   # context.tracing.start(screenshots=True, snapshots=True)
+  # page = context.new_page()
   # page.goto("https://playwright.dev")
   # context.tracing.stop(path = "trace.zip")
   # ```
@@ -17,17 +18,45 @@ module Playwright
     #
     # ```python sync
     # context.tracing.start(name="trace", screenshots=True, snapshots=True)
+    # page = context.new_page()
     # page.goto("https://playwright.dev")
-    # context.tracing.stop()
     # context.tracing.stop(path = "trace.zip")
     # ```
     def start(name: nil, screenshots: nil, snapshots: nil)
       wrap_impl(@impl.start(name: unwrap_impl(name), screenshots: unwrap_impl(screenshots), snapshots: unwrap_impl(snapshots)))
     end
 
+    # Start a new trace chunk. If you'd like to record multiple traces on the same `BrowserContext`, use
+    # [`method: Tracing.start`] once, and then create multiple trace chunks with [`method: Tracing.startChunk`] and
+    # [`method: Tracing.stopChunk`].
+    #
+    # ```python sync
+    # context.tracing.start(name="trace", screenshots=True, snapshots=True)
+    # page = context.new_page()
+    # page.goto("https://playwright.dev")
+    #
+    # context.tracing.start_chunk()
+    # page.click("text=Get Started")
+    # # Everything between start_chunk and stop_chunk will be recorded in the trace.
+    # context.tracing.stop_chunk(path = "trace1.zip")
+    #
+    # context.tracing.start_chunk()
+    # page.goto("http://example.com")
+    # # Save a second trace file with different actions.
+    # context.tracing.stop_chunk(path = "trace2.zip")
+    # ```
+    def start_chunk
+      wrap_impl(@impl.start_chunk)
+    end
+
     # Stop tracing.
     def stop(path: nil)
       wrap_impl(@impl.stop(path: unwrap_impl(path)))
     end
+
+    # Stop the trace chunk. See [`method: Tracing.startChunk`] for more details about multiple trace chunks.
+    def stop_chunk(path: nil)
+      wrap_impl(@impl.stop_chunk(path: unwrap_impl(path)))
+    end
   end
 end

data/lib/playwright_api/web_socket.rb

@@ -29,20 +29,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/worker.rb

@@ -43,14 +43,20 @@ module Playwright
       wrap_impl(@impl.url)
     end
 
+    # @nodoc
+    def page=(req)
+      wrap_impl(@impl.page=(unwrap_impl(req)))
+    end
+
     # @nodoc
     def context=(req)
       wrap_impl(@impl.context=(unwrap_impl(req)))
     end
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def page=(req)
-      wrap_impl(@impl.page=(unwrap_impl(req)))
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
@@ -65,12 +71,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.14.beta2
+  version: 1.15.beta2
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-06 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -248,8 +248,10 @@ files:
 - documentation/docs/article/guides/launch_browser.md
 - documentation/docs/article/guides/playwright_on_alpine_linux.md
 - documentation/docs/article/guides/rails_integration.md
+- documentation/docs/article/guides/rails_integration_with_null_driver.md
 - documentation/docs/article/guides/recording_video.md
 - documentation/docs/article/guides/semi_automation.md
+- documentation/docs/article/guides/use_storage_state.md
 - documentation/docs/include/api_coverage.md
 - documentation/docusaurus.config.js
 - documentation/package.json
@@ -262,6 +264,7 @@ files:
 - documentation/src/pages/markdown-page.md
 - documentation/static/.nojekyll
 - documentation/static/img/playwright-logo.svg
+- documentation/static/img/playwright-ruby-client.png
 - documentation/static/img/undraw_dropdown_menu.svg
 - documentation/static/img/undraw_web_development.svg
 - documentation/static/img/undraw_windows.svg
@@ -312,7 +315,7 @@ files:
 - lib/playwright/locator_impl.rb
 - lib/playwright/mouse_impl.rb
 - lib/playwright/playwright_api.rb
-- lib/playwright/route_handler_entry.rb
+- lib/playwright/route_handler.rb
 - lib/playwright/select_option_values.rb
 - lib/playwright/timeout_settings.rb
 - lib/playwright/touchscreen_impl.rb
@@ -378,5 +381,5 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.14.0
+summary: The Ruby binding of playwright driver 1.15.0
 test_files: []