playwright-ruby-client 1.18.0 → 1.18.3

data/lib/playwright/channel_owners/api_request_context.rb

@@ -1,4 +1,236 @@
+require 'base64'
+
 module Playwright
   define_channel_owner :APIRequestContext do
+    def dispose
+      @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,
+      )
+    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,
+      )
+    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,
+      )
+    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,
+      )
+    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,
+      )
+    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,
+      )
+    end
+
+    def fetch(
+          urlOrRequest,
+          data: nil,
+          failOnStatusCode: nil,
+          form: nil,
+          headers: nil,
+          ignoreHTTPSErrors: nil,
+          method: nil,
+          multipart: nil,
+          params: nil,
+          timeout: nil)
+
+      if [ChannelOwners::Request, String].none? { |type| urlOrRequest.is_a?(type) }
+        raise ArgumentError.new("First argument must be either URL string or Request")
+      end
+      if [data, form, multipart].compact.count > 1
+        raise ArgumentError.new("Only one of 'data', 'form' or 'multipart' can be specified")
+      end
+
+      request = urlOrRequest.is_a?(ChannelOwners::Request) ? urlOrRequest : nil
+      headers_obj = headers || request&.headers
+      fetch_params = {
+        url: request&.url || urlOrRequest,
+        params: object_to_array(params),
+        method: method || request&.method || 'GET',
+        headers: headers_obj ? HttpHeaders.new(headers_obj).as_serialized : nil,
+      }
+
+      json_data = nil
+      form_data = nil
+      multipart_data = nil
+      post_data_buffer = nil
+      if data
+        case data
+        when String
+          if headers_obj&.any? { |key, value| key.downcase == 'content-type' && value == 'application/json' }
+            json_data = data
+          else
+            post_data_buffer = data
+          end
+        when Hash, Array, Numeric, true, false
+          json_data = data
+        else
+          raise ArgumentError.new("Unsupported 'data' type: #{data.class}")
+        end
+      elsif form
+        form_data = object_to_array(form)
+      elsif multipart
+        multipart_data = multipart.map do |name, value|
+          if file_payload?(value)
+            { name: name, file: file_payload_to_json(value) }
+          else
+            { name: name, value: value.to_s }
+          end
+        end
+      end
+
+      if !json_data && !form_data && !multipart_data
+        post_data_buffer ||= request&.post_data_buffer
+      end
+      if post_data_buffer
+        fetch_params[:postData] = Base64.strict_encode64(post_data_buffer)
+      end
+
+      fetch_params[:jsonData] = json_data
+      fetch_params[:formData] = form_data
+      fetch_params[:multipartData] = multipart_data
+      fetch_params[:timeout] = timeout
+      fetch_params[:failOnStatusCode] = failOnStatusCode
+      fetch_params[:ignoreHTTPSErrors] = ignoreHTTPSErrors
+      fetch_params.compact!
+      response = @channel.send_message_to_server('fetch', fetch_params)
+
+      APIResponseImpl.new(self, response)
+    end
+
+    private def file_payload?(value)
+      value.is_a?(Hash) &&
+        %w(name mimeType buffer).all? { |key| value.has_key?(key) || value.has_key?(key.to_sym) }
+    end
+
+    private def file_payload_to_json(payload)
+      {
+        name: payload[:name] || payload['name'],
+        mimeType: payload[:mimeType] || payload['mimeType'],
+        buffer: Base64.strict_encode64(payload[:buffer] || payload['buffer'])
+      }
+    end
+
+    private def object_to_array(hash)
+      hash&.map do |key, value|
+        { name: key, value: value.to_s }
+      end
+    end
   end
 end

data/lib/playwright/channel_owners/browser_context.rb

@@ -4,7 +4,7 @@ module Playwright
     include Utils::Errors::SafeCloseError
     attr_accessor :browser
     attr_writer :owner_page, :options
-    attr_reader :tracing
+    attr_reader :tracing, :request
 
     private def after_initialize
       @pages = Set.new
@@ -15,6 +15,8 @@ module Playwright
       @background_pages = Set.new
 
       @tracing = TracingImpl.new(@channel, self)
+      @request = ChannelOwners::APIRequestContext.from(@initializer['APIRequestContext'])
+
       @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']) )})

data/lib/playwright/channel_owners/page.rb

@@ -733,6 +733,10 @@ module Playwright
       @workers.to_a
     end
 
+    def request
+      @browser_context.request
+    end
+
     def pause
       @browser_context.send(:pause)
     end

data/lib/playwright/transport.rb

@@ -46,7 +46,8 @@ module Playwright
     #
     # @note This method blocks until playwright-cli exited. Consider using Thread or Future.
     def async_run
-      @stdin, @stdout, @stderr, @thread = Open3.popen3("#{@driver_executable_path} run-driver")
+      popen3_args = {}
+      @stdin, @stdout, @stderr, @thread = run_driver_with_open3
       @stdin.binmode  # Ensure Strings are written 1:1 without encoding conversion, necessary for integer values
 
       Thread.new { handle_stdout }
@@ -55,6 +56,18 @@ module Playwright
 
     private
 
+    def run_driver_with_open3
+      Open3.popen3("#{@driver_executable_path} run-driver", { pgroup: true })
+    rescue ArgumentError => err
+      # Windows doesn't accept pgroup parameter.
+      # ArgumentError: wrong exec option symbol: pgroup
+      if err.message =~ /pgroup/
+        Open3.popen3("#{@driver_executable_path} run-driver")
+      else
+        raise
+      end
+    end
+
     def handle_stdout(packet_size: 32_768)
       while chunk = @stdout.read(4)
         length = chunk.unpack1('V') # unsigned 32bit, little endian

data/lib/playwright/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.18.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.18.0'
+  VERSION = '1.18.3'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.18.1'
 end

data/lib/playwright_api/android.rb

@@ -38,20 +38,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/android_device.rb

@@ -176,20 +176,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/api_request.rb

@@ -0,0 +1,20 @@
+module Playwright
+  # Exposes API that can be used for the Web API testing. Each Playwright browser context has a APIRequestContext instance
+  # attached which shares cookies with the page context. Its also possible to create a new APIRequestContext instance
+  # manually. For more information see [here](./class-apirequestcontext).
+  class APIRequest < PlaywrightApi
+
+    # Creates new instances of `APIRequestContext`.
+    def new_context(
+          baseURL: nil,
+          extraHTTPHeaders: nil,
+          httpCredentials: nil,
+          ignoreHTTPSErrors: nil,
+          proxy: nil,
+          storageState: nil,
+          timeout: nil,
+          userAgent: nil)
+      raise NotImplementedError.new('new_context is not implemented yet.')
+    end
+  end
+end

data/lib/playwright_api/api_request_context.rb

@@ -65,14 +65,14 @@ module Playwright
           multipart: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('delete is not implemented yet.')
+      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)))
     end
 
     # All responses returned by [`method: APIRequestContext.get`] and similar methods are stored in the memory, so that you
     # can later call [`method: APIResponse.body`]. This method discards all stored responses, and makes
     # [`method: APIResponse.body`] throw "Response disposed" error.
     def dispose
-      raise NotImplementedError.new('dispose is not implemented yet.')
+      wrap_impl(@impl.dispose)
     end
 
     # Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update
@@ -88,7 +88,7 @@ module Playwright
           multipart: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('fetch is not implemented yet.')
+      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)))
     end
 
     # Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its response. The
@@ -101,7 +101,7 @@ module Playwright
           ignoreHTTPSErrors: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('get is not implemented yet.')
+      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)))
     end
 
     # Sends HTTP(S) [HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) request and returns its response.
@@ -114,7 +114,7 @@ module Playwright
           ignoreHTTPSErrors: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('head is not implemented yet.')
+      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)))
     end
 
     # Sends HTTP(S) [PATCH](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH) request and returns its response.
@@ -130,7 +130,7 @@ module Playwright
           multipart: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('patch is not implemented yet.')
+      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)))
     end
 
     # Sends HTTP(S) [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) request and returns its response.
@@ -146,7 +146,7 @@ module Playwright
           multipart: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('post is not implemented yet.')
+      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)))
     end
 
     # Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its response. The
@@ -162,7 +162,7 @@ module Playwright
           multipart: nil,
           params: nil,
           timeout: nil)
-      raise NotImplementedError.new('put is not implemented yet.')
+      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)))
     end
 
     # Returns storage state for this request context, contains current cookies and local storage snapshot if it was passed to
@@ -173,20 +173,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/api_response.rb

@@ -0,0 +1,81 @@
+module Playwright
+  # `APIResponse` class represents responses returned by [`method: APIRequestContext.get`] and similar methods.
+  #
+  # ```python sync
+  # from playwright.sync_api import sync_playwright
+  #
+  # with sync_playwright() as p:
+  #     context = playwright.request.new_context()
+  #     response = context.get("https://example.com/user/repos")
+  #     assert response.ok
+  #     assert response.status == 200
+  #     assert response.headers["content-type"] == "application/json; charset=utf-8"
+  #     assert response.json()["name"] == "foobar"
+  #     assert response.body() == '{"status": "ok"}'
+  # ```
+  class APIResponse < PlaywrightApi
+
+    # Returns the buffer with response body.
+    def body
+      wrap_impl(@impl.body)
+    end
+
+    # Disposes the body of this response. If not called then the body will stay in memory until the context closes.
+    def dispose
+      wrap_impl(@impl.dispose)
+    end
+
+    # An object with all the response HTTP headers associated with this response.
+    def headers
+      wrap_impl(@impl.headers)
+    end
+
+    # An array with all the request HTTP headers associated with this response. 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`.
+    def json
+      wrap_impl(@impl.json)
+    end
+
+    # Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
+    def ok
+      wrap_impl(@impl.ok)
+    end
+
+    # Contains the status code of the response (e.g., 200 for a success).
+    def status
+      wrap_impl(@impl.status)
+    end
+
+    # Contains the status text of the response (e.g. usually an "OK" for a success).
+    def status_text
+      wrap_impl(@impl.status_text)
+    end
+
+    # Returns the text representation of response body.
+    def text
+      wrap_impl(@impl.text)
+    end
+
+    # Contains the URL of the response.
+    def url
+      wrap_impl(@impl.url)
+    end
+
+    # @nodoc
+    def ok?
+      wrap_impl(@impl.ok?)
+    end
+
+    # @nodoc
+    def to_s
+      wrap_impl(@impl.to_s)
+    end
+  end
+end

data/lib/playwright_api/browser.rb

@@ -168,20 +168,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/browser_context.rb

@@ -22,7 +22,7 @@ module Playwright
 
     # API testing helper associated with this context. Requests made with this API will use context cookies.
     def request # property
-      raise NotImplementedError.new('request is not implemented yet.')
+      wrap_impl(@impl.request)
     end
 
     def tracing # property
@@ -376,6 +376,11 @@ module Playwright
       wrap_impl(@impl.pause)
     end
 
+    # @nodoc
+    def enable_debug_console!
+      wrap_impl(@impl.enable_debug_console!)
+    end
+
     # @nodoc
     def browser=(req)
       wrap_impl(@impl.browser=(unwrap_impl(req)))
@@ -391,9 +396,10 @@ module Playwright
       wrap_impl(@impl.options=(unwrap_impl(req)))
     end
 
+    # -- inherited from EventEmitter --
     # @nodoc
-    def enable_debug_console!
-      wrap_impl(@impl.enable_debug_console!)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
@@ -408,12 +414,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

data/lib/playwright_api/browser_type.rb

@@ -148,20 +148,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