playwright-ruby-client 1.25.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d7e01f93c5fa8ffd804062e0414e9de40204674ef1b070f296c0108259ca015
-  data.tar.gz: 75bdb822a5c3cc8ffe7e8dc011d8697c2cb00aa95895e7486068c09839a9c667
+  metadata.gz: beca54a9f8e488cefb33f9266bd227bdb002ea5e379f6525733375f30a26aad2
+  data.tar.gz: a8cb017751e740755cb92a7525a59afde927b9393ed13d71e0af2797c857496e
 SHA512:
-  metadata.gz: 9499d48e15c5201718f8e4569f1e28b5f66d2bd14c11b4c3a1c98c4e4ca2c39ababc74b3af1db1e2bcabbc4234fd6034eaa0c71b09b925654c468fdf65dd0547
-  data.tar.gz: 622a2e2bd96af9e65255b1abdb52f5768091af4cc8d5a6368b60237e363a8cd3bdbc1673ef1d745d017583206b6d8011f92300228b27a14e69bdc6558392de30
+  metadata.gz: f7ede551835e7916acf830ef26664cd6421910c966d96f9e85c599383c48fc7707467f2d095a848c6f23071310e6072cde47b7412b4d83d1f381373dc42b6011
+  data.tar.gz: c4aa082a27871b37b64236c0fc40c17083884696fb2ceef8a3bd9e6c72d5089081a81ac616fd1a8116cf7052575888fa63abc47866d2cff413b21aee9a695f10

data/documentation/docs/api/api_request_context.md

@@ -66,6 +66,7 @@ def delete(
       form: nil,
       headers: nil,
       ignoreHTTPSErrors: nil,
+      maxRedirects: nil,
       multipart: nil,
       params: nil,
       timeout: nil)
@@ -95,6 +96,7 @@ def fetch(
       form: nil,
       headers: nil,
       ignoreHTTPSErrors: nil,
+      maxRedirects: nil,
       method: nil,
       multipart: nil,
       params: nil,
@@ -112,6 +114,7 @@ def get(
       failOnStatusCode: nil,
       headers: nil,
       ignoreHTTPSErrors: nil,
+      maxRedirects: nil,
       params: nil,
       timeout: nil)
 ```
@@ -128,6 +131,7 @@ def head(
       failOnStatusCode: nil,
       headers: nil,
       ignoreHTTPSErrors: nil,
+      maxRedirects: nil,
       params: nil,
       timeout: nil)
 ```
@@ -146,6 +150,7 @@ def patch(
       form: nil,
       headers: nil,
       ignoreHTTPSErrors: nil,
+      maxRedirects: nil,
       multipart: nil,
       params: nil,
       timeout: nil)
@@ -165,6 +170,7 @@ def post(
       form: nil,
       headers: nil,
       ignoreHTTPSErrors: nil,
+      maxRedirects: nil,
       multipart: nil,
       params: nil,
       timeout: nil)
@@ -184,6 +190,7 @@ def put(
       form: nil,
       headers: nil,
       ignoreHTTPSErrors: nil,
+      maxRedirects: nil,
       multipart: nil,
       params: nil,
       timeout: nil)

data/documentation/docs/api/browser_type.md

@@ -37,6 +37,14 @@ The default browser context is accessible via [Browser#contexts](./browser#conte
 
 > NOTE: Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
 
+```ruby
+browser = playwright.chromium.connect_over_cdp("http://localhost:9222")
+default_context = browser.contexts.first
+page = default_context.pages.first
+```
+
+
+
 ## executable_path
 
 ```

data/documentation/docs/api/frame_locator.md

@@ -16,7 +16,7 @@ locator.click
 **Strictness**
 
 Frame locators are strict. This means that all operations on frame locators will throw if more than one element matches
-given selector.
+a given selector.
 
 ```ruby
 # Throws if there are several frames in DOM:

data/documentation/docs/api/page.md

@@ -1541,7 +1541,7 @@ Returns when element specified by selector satisfies `state` option. Returns `nu
 `detached`.
 
 > NOTE: Playwright automatically waits for element to be ready before performing an action. Using [Locator](./locator) objects and
-web-first assertions make the code wait-for-selector-free.
+web-first assertions makes the code wait-for-selector-free.
 
 Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If at
 the moment of calling the method `selector` already satisfies the condition, the method will return immediately. If the

data/documentation/src/components/HomepageFeatures.js

@@ -13,7 +13,7 @@ const FeatureList = [
     ),
   },
   {
-    title: 'Make more relyable tests',
+    title: 'Make more reliable tests',
     Svg: require('../../static/img/undraw_dropdown_menu.svg').default,
     description: (
       <>

data/lib/playwright/channel_owners/api_request_context.rb

@@ -10,136 +10,34 @@ module Playwright
       @channel.send_message_to_server('dispose')
     end
 
-    def delete(
-          url,
-          data: nil,
-          failOnStatusCode: nil,
-          form: nil,
-          headers: nil,
-          ignoreHTTPSErrors: nil,
-          multipart: nil,
-          params: nil,
-          timeout: nil)
-      fetch(
-        url,
-        method: 'DELETE',
-        data: data,
-        failOnStatusCode: failOnStatusCode,
-        form: form,
-        headers: headers,
-        ignoreHTTPSErrors: ignoreHTTPSErrors,
-        multipart: multipart,
-        params: params,
-        timeout: timeout,
-      )
+    def delete(url, **options)
+      fetch_options = options.merge(method: 'DELETE')
+      fetch(url, **fetch_options)
     end
 
-    def head(
-          url,
-          failOnStatusCode: nil,
-          headers: nil,
-          ignoreHTTPSErrors: nil,
-          params: nil,
-          timeout: nil)
-      fetch(
-        url,
-        method: 'HEAD',
-        failOnStatusCode: failOnStatusCode,
-        headers: headers,
-        ignoreHTTPSErrors: ignoreHTTPSErrors,
-        params: params,
-        timeout: timeout,
-      )
+    def head(url, **options)
+      fetch_options = options.merge(method: 'HEAD')
+      fetch(url, **fetch_options)
     end
 
-    def get(
-          url,
-          failOnStatusCode: nil,
-          headers: nil,
-          ignoreHTTPSErrors: nil,
-          params: nil,
-          timeout: nil)
-      fetch(
-        url,
-        method: 'GET',
-        failOnStatusCode: failOnStatusCode,
-        headers: headers,
-        ignoreHTTPSErrors: ignoreHTTPSErrors,
-        params: params,
-        timeout: timeout,
-      )
+    def get(url, **options)
+      fetch_options = options.merge(method: 'GET')
+      fetch(url, **fetch_options)
     end
 
-    def patch(
-          url,
-          data: nil,
-          failOnStatusCode: nil,
-          form: nil,
-          headers: nil,
-          ignoreHTTPSErrors: nil,
-          multipart: nil,
-          params: nil,
-          timeout: nil)
-      fetch(
-        url,
-        method: 'PATCH',
-        data: data,
-        failOnStatusCode: failOnStatusCode,
-        form: form,
-        headers: headers,
-        ignoreHTTPSErrors: ignoreHTTPSErrors,
-        multipart: multipart,
-        params: params,
-        timeout: timeout,
-      )
+    def patch(url, **options)
+      fetch_options = options.merge(method: 'PATCH')
+      fetch(url, **fetch_options)
     end
 
-    def put(
-          url,
-          data: nil,
-          failOnStatusCode: nil,
-          form: nil,
-          headers: nil,
-          ignoreHTTPSErrors: nil,
-          multipart: nil,
-          params: nil,
-          timeout: nil)
-      fetch(
-        url,
-        method: 'PUT',
-        data: data,
-        failOnStatusCode: failOnStatusCode,
-        form: form,
-        headers: headers,
-        ignoreHTTPSErrors: ignoreHTTPSErrors,
-        multipart: multipart,
-        params: params,
-        timeout: timeout,
-      )
+    def put(url, **options)
+      fetch_options = options.merge(method: 'PUT')
+      fetch(url, **fetch_options)
     end
 
-    def post(
-          url,
-          data: nil,
-          failOnStatusCode: nil,
-          form: nil,
-          headers: nil,
-          ignoreHTTPSErrors: nil,
-          multipart: nil,
-          params: nil,
-          timeout: nil)
-      fetch(
-        url,
-        method: 'POST',
-        data: data,
-        failOnStatusCode: failOnStatusCode,
-        form: form,
-        headers: headers,
-        ignoreHTTPSErrors: ignoreHTTPSErrors,
-        multipart: multipart,
-        params: params,
-        timeout: timeout,
-      )
+    def post(url, **options)
+      fetch_options = options.merge(method: 'POST')
+      fetch(url, **fetch_options)
     end
 
     def fetch(
@@ -149,6 +47,7 @@ module Playwright
           form: nil,
           headers: nil,
           ignoreHTTPSErrors: nil,
+          maxRedirects: nil,
           method: nil,
           multipart: nil,
           params: nil,
@@ -160,6 +59,9 @@ module Playwright
       if [data, form, multipart].compact.count > 1
         raise ArgumentError.new("Only one of 'data', 'form' or 'multipart' can be specified")
       end
+      if maxRedirects && maxRedirects < 0
+        raise ArgumentError.new("'maxRedirects' should be greater than or equal to '0'")
+      end
 
       request = urlOrRequest.is_a?(ChannelOwners::Request) ? urlOrRequest : nil
       headers_obj = headers || request&.headers
@@ -212,6 +114,7 @@ module Playwright
       fetch_params[:timeout] = timeout
       fetch_params[:failOnStatusCode] = failOnStatusCode
       fetch_params[:ignoreHTTPSErrors] = ignoreHTTPSErrors
+      fetch_params[:maxRedirects] = maxRedirects
       fetch_params.compact!
       response = @channel.send_message_to_server('fetch', fetch_params)
 

data/lib/playwright/channel_owners/browser_context.rb

@@ -26,7 +26,7 @@ module Playwright
       @channel.on('page', ->(params) { on_page(ChannelOwners::Page.from(params['page']) )})
       @channel.on('route', ->(params) {
         Concurrent::Promises.future {
-          on_route(ChannelOwners::Route.from(params['route']), ChannelOwners::Request.from(params['request']))
+          on_route(ChannelOwners::Route.from(params['route']))
         }.rescue do |err|
           puts err, err.backtrace
         end
@@ -83,22 +83,21 @@ module Playwright
       emit(Events::BrowserContext::BackgroundPage, page)
     end
 
-    private def on_route(route, request)
+    private def on_route(route)
       # 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)
 
       handled = @routes.any? do |handler_entry|
-        next false unless handler_entry.match?(request.url)
+        next false unless handler_entry.match?(route.request.url)
 
         promise = Concurrent::Promises.resolvable_future
         route.send(:set_handling_future, promise)
 
         promise_handled = Concurrent::Promises.zip(
           promise,
-          handler_entry.async_handle(wrapped_route, wrapped_request)
+          handler_entry.async_handle(wrapped_route)
         ).value!.first
 
         promise_handled

data/lib/playwright/channel_owners/dialog.rb

@@ -13,7 +13,7 @@ module Playwright
     end
 
     def accept(promptText: nil)
-      accept_async(prompt_text: promptText).value!
+      accept_async(promptText: promptText).value!
     end
 
     def accept_async(promptText: nil)

data/lib/playwright/channel_owners/page.rb

@@ -58,7 +58,7 @@ module Playwright
       })
       @channel.on('route', ->(params) {
         Concurrent::Promises.future {
-          on_route(ChannelOwners::Route.from(params['route']), ChannelOwners::Request.from(params['request']))
+          on_route(ChannelOwners::Route.from(params['route']))
         }.rescue do |err|
           puts err, err.backtrace
         end
@@ -93,22 +93,21 @@ module Playwright
       emit(Events::Page::FrameDetached, frame)
     end
 
-    private def on_route(route, request)
+    private def on_route(route)
       # 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)
 
       handled = @routes.any? do |handler_entry|
-        next false unless handler_entry.match?(request.url)
+        next false unless handler_entry.match?(route.request.url)
 
         promise = Concurrent::Promises.resolvable_future
         route.send(:set_handling_future, promise)
 
         promise_handled = Concurrent::Promises.zip(
           promise,
-          handler_entry.async_handle(wrapped_route, wrapped_request)
+          handler_entry.async_handle(wrapped_route)
         ).value!.first
 
         promise_handled
@@ -120,7 +119,7 @@ module Playwright
       end
 
       unless handled
-        @browser_context.send(:on_route, route, request)
+        @browser_context.send(:on_route, route)
       end
     end
 

data/lib/playwright/route_handler.rb

@@ -47,10 +47,10 @@ module Playwright
       @url_matcher.match?(url)
     end
 
-    def async_handle(route, request)
+    def async_handle(route)
       @counter.increment
 
-      Concurrent::Promises.future { @handler.call(route, request) }.rescue do |err|
+      Concurrent::Promises.future { @handler.call(route, route.request) }.rescue do |err|
         puts err, err.backtrace
       end
     end

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.25.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.25.0'
+  VERSION = '1.26.0'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.26.0'
 end

data/lib/playwright_api/api_request_context.rb

@@ -75,10 +75,11 @@ module Playwright
           form: nil,
           headers: nil,
           ignoreHTTPSErrors: nil,
+          maxRedirects: nil,
           multipart: nil,
           params: nil,
           timeout: nil)
-      wrap_impl(@impl.delete(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
+      wrap_impl(@impl.delete(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # All responses returned by [`method: APIRequestContext.get`] and similar methods are stored in the memory, so that you
@@ -97,11 +98,12 @@ module Playwright
           form: nil,
           headers: nil,
           ignoreHTTPSErrors: nil,
+          maxRedirects: nil,
           method: nil,
           multipart: nil,
           params: nil,
           timeout: nil)
-      wrap_impl(@impl.fetch(unwrap_impl(urlOrRequest), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), method: unwrap_impl(method), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
+      wrap_impl(@impl.fetch(unwrap_impl(urlOrRequest), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), method: unwrap_impl(method), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its response. The
@@ -112,9 +114,10 @@ module Playwright
           failOnStatusCode: nil,
           headers: nil,
           ignoreHTTPSErrors: nil,
+          maxRedirects: nil,
           params: nil,
           timeout: nil)
-      wrap_impl(@impl.get(unwrap_impl(url), failOnStatusCode: unwrap_impl(failOnStatusCode), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
+      wrap_impl(@impl.get(unwrap_impl(url), failOnStatusCode: unwrap_impl(failOnStatusCode), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # Sends HTTP(S) [HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) request and returns its response.
@@ -125,9 +128,10 @@ module Playwright
           failOnStatusCode: nil,
           headers: nil,
           ignoreHTTPSErrors: nil,
+          maxRedirects: nil,
           params: nil,
           timeout: nil)
-      wrap_impl(@impl.head(unwrap_impl(url), failOnStatusCode: unwrap_impl(failOnStatusCode), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
+      wrap_impl(@impl.head(unwrap_impl(url), failOnStatusCode: unwrap_impl(failOnStatusCode), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # Sends HTTP(S) [PATCH](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH) request and returns its response.
@@ -140,10 +144,11 @@ module Playwright
           form: nil,
           headers: nil,
           ignoreHTTPSErrors: nil,
+          maxRedirects: nil,
           multipart: nil,
           params: nil,
           timeout: nil)
-      wrap_impl(@impl.patch(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
+      wrap_impl(@impl.patch(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # Sends HTTP(S) [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) request and returns its response.
@@ -156,10 +161,11 @@ module Playwright
           form: nil,
           headers: nil,
           ignoreHTTPSErrors: nil,
+          maxRedirects: nil,
           multipart: nil,
           params: nil,
           timeout: nil)
-      wrap_impl(@impl.post(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
+      wrap_impl(@impl.post(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its response. The
@@ -172,10 +178,11 @@ module Playwright
           form: nil,
           headers: nil,
           ignoreHTTPSErrors: nil,
+          maxRedirects: nil,
           multipart: nil,
           params: nil,
           timeout: nil)
-      wrap_impl(@impl.put(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
+      wrap_impl(@impl.put(unwrap_impl(url), data: unwrap_impl(data), failOnStatusCode: unwrap_impl(failOnStatusCode), form: unwrap_impl(form), headers: unwrap_impl(headers), ignoreHTTPSErrors: unwrap_impl(ignoreHTTPSErrors), maxRedirects: unwrap_impl(maxRedirects), multipart: unwrap_impl(multipart), params: unwrap_impl(params), timeout: unwrap_impl(timeout)))
     end
 
     # Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to

data/lib/playwright_api/browser_type.rb

@@ -30,6 +30,12 @@ module Playwright
     # The default browser context is accessible via [`method: Browser.contexts`].
     #
     # > NOTE: Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
+    #
+    # ```python sync
+    # browser = playwright.chromium.connect_over_cdp("http://localhost:9222")
+    # default_context = browser.contexts[0]
+    # page = default_context.pages[0]
+    # ```
     def connect_over_cdp(
           endpointURL,
           headers: nil,

data/lib/playwright_api/frame_locator.rb

@@ -11,7 +11,7 @@ module Playwright
   # **Strictness**
   #
   # Frame locators are strict. This means that all operations on frame locators will throw if more than one element matches
-  # given selector.
+  # a given selector.
   #
   # ```python sync
   # # Throws if there are several frames in DOM:

data/lib/playwright_api/page.rb

@@ -1321,7 +1321,7 @@ module Playwright
     # `detached`.
     #
     # > NOTE: Playwright automatically waits for element to be ready before performing an action. Using `Locator` objects and
-    # web-first assertions make the code wait-for-selector-free.
+    # web-first assertions makes the code wait-for-selector-free.
     #
     # Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If at
     # the moment of calling the method `selector` already satisfies the condition, the method will return immediately. If the

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.26.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-14 00:00:00.000000000 Z
+date: 2022-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -399,5 +399,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.25.0
+summary: The Ruby binding of playwright driver 1.26.0
 test_files: []