playwright-ruby-client 1.17.0 → 1.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35d4a4e4ac3aa460997a5a9cd44b5272142ba89b480908f0e429fb97d7968337
-  data.tar.gz: 2a577b8683a2eba60ed97b88b183bd351477cbde0874b8d06d287be0ec4664e8
+  metadata.gz: 9407fc7093bb4cdb7539eec09b879e4bfd665626801594c764798ae41d3c7823
+  data.tar.gz: e6047ebe532d15fa5600986ae3fc9f42a23ea670923e1ec8fac6f6ecbb7f01c4
 SHA512:
-  metadata.gz: 283b87141e9ab9090488684973741983506da16d9ea991945589a1177cd99a5cf2c3b65b35770cc95a6ed3645514c35c9925e75aaffb949d58cbe6a47380c334
-  data.tar.gz: 7a6071b83e537784b58e6b350c1654a7dfa90bc99576f8ae1780c2104b30242ddd2e9651f6eb9f880a3a777e9345a5706373fbd66b64cc32739ce10cb389b5fb
+  metadata.gz: 70b935777666f43236ec9df9b8462ebebf7fb883cde2d57e167d3342a18280a86e286e99e206f47e6ee2c739f23f6afe43daa2def9ea0a322b5e09f3b36bfc81
+  data.tar.gz: 3392ad01696c2c22ba411d7e4821e0bf0a2f641526481201927ff6510d7bb077c9fb6b20fcafabd55e5067ff7b1153b950d6b3c532c0bd14d77b9a0b3ac7c4c0

data/documentation/docs/api/api_request.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 10
+---
+
+# APIRequest
+
+Not Implemented

data/documentation/docs/api/api_request_context.md

@@ -8,3 +8,140 @@ This API is used for the Web API testing. You can use it to trigger API endpoint
 environment or the service to your e2e test. When used on [Page](./page) or a [BrowserContext](./browser_context), this API will automatically use
 the cookies from the corresponding [BrowserContext](./browser_context). This means that if you log in using this API, your e2e test will be
 logged in and vice versa.
+
+## delete
+
+```
+def delete(
+      url,
+      data: nil,
+      failOnStatusCode: nil,
+      form: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      multipart: nil,
+      params: nil,
+      timeout: nil)
+```
+
+Sends HTTP(S) [DELETE](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE) request and returns its
+response. The method will populate request cookies from the context and update context cookies from the response. The
+method will automatically follow redirects.
+
+## dispose
+
+```
+def dispose
+```
+
+All responses returned by [APIRequestContext#get](./api_request_context#get) and similar methods are stored in the memory, so that you
+can later call [APIResponse#body](./api_response#body). This method discards all stored responses, and makes
+[APIResponse#body](./api_response#body) throw "Response disposed" error.
+
+## fetch
+
+```
+def fetch(
+      urlOrRequest,
+      data: nil,
+      failOnStatusCode: nil,
+      form: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      method: nil,
+      multipart: nil,
+      params: nil,
+      timeout: nil)
+```
+
+Sends HTTP(S) request and returns its response. The method will populate request cookies from the context and update
+context cookies from the response. The method will automatically follow redirects.
+
+## get
+
+```
+def get(
+      url,
+      failOnStatusCode: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      params: nil,
+      timeout: nil)
+```
+
+Sends HTTP(S) [GET](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET) request and returns its response. The
+method will populate request cookies from the context and update context cookies from the response. The method will
+automatically follow redirects.
+
+## head
+
+```
+def head(
+      url,
+      failOnStatusCode: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      params: nil,
+      timeout: nil)
+```
+
+Sends HTTP(S) [HEAD](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD) request and returns its response.
+The method will populate request cookies from the context and update context cookies from the response. The method will
+automatically follow redirects.
+
+## patch
+
+```
+def patch(
+      url,
+      data: nil,
+      failOnStatusCode: nil,
+      form: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      multipart: nil,
+      params: nil,
+      timeout: nil)
+```
+
+Sends HTTP(S) [PATCH](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH) request and returns its response.
+The method will populate request cookies from the context and update context cookies from the response. The method will
+automatically follow redirects.
+
+## post
+
+```
+def post(
+      url,
+      data: nil,
+      failOnStatusCode: nil,
+      form: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      multipart: nil,
+      params: nil,
+      timeout: nil)
+```
+
+Sends HTTP(S) [POST](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) request and returns its response.
+The method will populate request cookies from the context and update context cookies from the response. The method will
+automatically follow redirects.
+
+## put
+
+```
+def put(
+      url,
+      data: nil,
+      failOnStatusCode: nil,
+      form: nil,
+      headers: nil,
+      ignoreHTTPSErrors: nil,
+      multipart: nil,
+      params: nil,
+      timeout: nil)
+```
+
+Sends HTTP(S) [PUT](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT) request and returns its response. The
+method will populate request cookies from the context and update context cookies from the response. The method will
+automatically follow redirects.

data/documentation/docs/api/api_response.md

@@ -0,0 +1,90 @@
+---
+sidebar_position: 10
+---
+
+# APIResponse
+
+[APIResponse](./api_response) class represents responses returned by [APIRequestContext#get](./api_request_context#get) and similar methods.
+
+## body
+
+```
+def body
+```
+
+Returns the buffer with response body.
+
+## dispose
+
+```
+def dispose
+```
+
+Disposes the body of this response. If not called then the body will stay in memory until the context closes.
+
+## headers
+
+```
+def headers
+```
+
+An object with all the response HTTP headers associated with this response.
+
+## headers_array
+
+```
+def headers_array
+```
+
+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.
+
+## json
+
+```
+def json
+```
+
+Returns the JSON representation of response body.
+
+This method will throw if the response body is not parsable via `JSON.parse`.
+
+## ok
+
+```
+def ok
+```
+
+Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
+
+## status
+
+```
+def status
+```
+
+Contains the status code of the response (e.g., 200 for a success).
+
+## status_text
+
+```
+def status_text
+```
+
+Contains the status text of the response (e.g. usually an "OK" for a success).
+
+## text
+
+```
+def text
+```
+
+Returns the text representation of response body.
+
+## url
+
+```
+def url
+```
+
+Contains the URL of the response.

data/documentation/docs/api/browser_context.md

@@ -436,4 +436,8 @@ def expect_page(predicate: nil, timeout: nil)
 Performs action and waits for a new [Page](./page) to be created in the context. If predicate is provided, it passes [Page](./page) value into the `predicate` and waits for `predicate.call(page)` to return a truthy value. Will throw an error if
 the context closes before new [Page](./page) is created.
 
+## request
+
+API testing helper associated with this context. Requests made with this API will use context cookies.
+
 ## tracing

data/documentation/docs/include/api_coverage.md

@@ -1,17 +1,5 @@
 # API coverages
 
-## APIRequestContext
-
-* ~~delete~~
-* ~~dispose~~
-* ~~fetch~~
-* ~~get~~
-* ~~head~~
-* ~~patch~~
-* ~~post~~
-* ~~put~~
-* ~~storage_state~~
-
 ## Request
 
 * all_headers
@@ -361,7 +349,7 @@
 * expect_event
 * expect_page
 * ~~wait_for_event~~
-* ~~request~~
+* request
 * tracing
 
 ## CDPSession
@@ -461,6 +449,35 @@
 * locator
 * nth
 
+## APIResponse
+
+* body
+* dispose
+* headers
+* headers_array
+* json
+* ok
+* status
+* status_text
+* text
+* url
+
+## APIRequestContext
+
+* delete
+* dispose
+* fetch
+* get
+* head
+* patch
+* post
+* put
+* ~~storage_state~~
+
+## ~~APIRequest~~
+
+* ~~new_context~~
+
 ## Android
 
 * devices

data/lib/playwright/api_response_impl.rb

@@ -0,0 +1,73 @@
+module Playwright
+  define_api_implementation :APIResponseImpl do
+    include Utils::Errors::SafeCloseError
+
+    # @params context [APIRequestContext]
+    # @params initializer [Hash]
+  	def initialize(context, initializer)
+      @request = context
+      @initializer = initializer
+      @headers = RawHeaders.new(initializer['headers'])
+    end
+
+    def to_s
+      "#<APIResponse url=#{url} status=#{status} status_text=#{status_text}>"
+    end
+
+    def url
+      @initializer['url']
+    end
+
+    def ok
+      (200...300).include?(status)
+    end
+    alias_method :ok?, :ok
+
+    def status
+      @initializer['status']
+    end
+
+    def status_text
+      @initializer['statusText']
+    end
+
+    def headers
+      @headers.headers
+    end
+
+    def headers_array
+      @headers.headers_array
+    end
+
+    class AlreadyDisposedError < StandardError
+      def initialize
+        super('Response has been disposed')
+      end
+    end
+
+    def body
+      binary = @request.channel.send_message_to_server("fetchResponseBody", fetchUid: fetch_uid)
+      raise AlreadyDisposedError.new unless binary
+      Base64.strict_decode64(binary)
+    rescue => err
+      if safe_close_error?(err)
+        raise AlreadyDisposedError.new
+      else
+        raise
+      end
+    end
+    alias_method :text, :body
+
+    def json
+      JSON.parse(text)
+    end
+
+    def dispose
+      @request.channel.send_message_to_server("disposeAPIResponse", fetchUid: fetch_uid)
+    end
+
+    private def fetch_uid
+      @initializer['fetchUid']
+    end
+  end
+end

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/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playwright
-  VERSION = '1.17.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.17.0'
+  VERSION = '1.17.1'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.17.2'
 end

data/lib/playwright_api/android.rb

@@ -36,12 +36,6 @@ module Playwright
     end
     alias_method :default_timeout=, :set_default_timeout
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -54,6 +48,12 @@ 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