playwright-ruby-client 1.18.0 → 1.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd0b003cf0d53da6959d90b63c1b925e5d5545b06a96c54f40109fb943bc4d6e
-  data.tar.gz: 19db226c5ad72e480967e2476b6500607121d1b698396ff66061233eff46eeb1
+  metadata.gz: 4743c153d270bd3343d7f59b53e1ef03ebecf65495804c79ef4561e5db1263ac
+  data.tar.gz: 2f5db2b025b62ebece498cce6edc8f02f85a07377dee2945fbbcfb60e6718c48
 SHA512:
-  metadata.gz: 49ad61dde3eb71a242401225fb16c834dc6ec75f5f5b8baef959f0a162b0fac5960373b6fa2cc091f90e9dfe90bc66c72ec7858af42000c37a543daa6520974d
-  data.tar.gz: 3492a3ce647a6ee0e44ca38f10948e0b6d6a8c818595ebf4d8f57bed802ebce6065d5f8d507bbc617d2fe8d075556c8f031ede00fab902d39b77dabe1be9ec42
+  metadata.gz: 36f2d941a86f2533ad494013346f68a3840e33065bf1d3021ff071f6caec635e890378eb7a88df3d096ffa85a86b037e93dae68535c0d30baacc699cb62292a5
+  data.tar.gz: 38757489faccca207351dfc8ff1d5519ee7fe329726a0024fe80fe83eb772abed986dbfcde5ad0b1cd5987a5b79666a4675cb360bb3333b1b29e4065087b2b75

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

@@ -9,51 +9,163 @@ environment or the service to your e2e test. When used on [Page](./page) or a [B
 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.
 
-```python sync title=example_6db210740dd2dcb4551c2207b3204fde7127b24c7850226b273d15c0d6624ba5.py
-import os
-from playwright.sync_api import sync_playwright
-
-REPO = "test-repo-1"
-USER = "github-username"
-API_TOKEN = os.getenv("GITHUB_API_TOKEN")
-
-with sync_playwright() as p:
-    # This will launch a new browser, create a context and page. When making HTTP
-    # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)
-    # it will automatically set the cookies to the browser page and vise versa.
-    browser = playwright.chromium.launch()
-    context = browser.new_context(base_url="https://api.github.com")
-    api_request_context = context.request
-    page = context.new_page()
-
-    # Alternatively you can create a APIRequestContext manually without having a browser context attached:
-    # api_request_context = playwright.request.new_context(base_url="https://api.github.com")
-
-
-    # Create a repository.
-    response = api_request_context.post(
-        "/user/repos",
-        headers={
-            "Accept": "application/vnd.github.v3+json",
-            # Add GitHub personal access token.
-            "Authorization": f"token {API_TOKEN}",
-        },
-        data={"name": REPO},
-    )
-    assert response.ok
-    assert response.json()["name"] == REPO
-
-    # Delete a repository.
-    response = api_request_context.delete(
-        f"/repos/{USER}/{REPO}",
-        headers={
-            "Accept": "application/vnd.github.v3+json",
-            # Add GitHub personal access token.
-            "Authorization": f"token {API_TOKEN}",
-        },
-    )
-    assert response.ok
-    assert await response.body() == '{"status": "ok"}'
+```ruby
+playwright.chromium.launch do |browser|
+  # This will launch a new browser, create a context and page. When making HTTP
+  # requests with the internal APIRequestContext (e.g. `context.request` or `page.request`)
+  # it will automatically set the cookies to the browser page and vise versa.
+  context = browser.new_context(base_url: 'https://api.github,com')
+  api_request_context = context.request
 
+
+  # Create a repository.
+  response = api_request_context.post(
+    "/user/repos",
+    headers: {
+      "Accept": "application/vnd.github.v3+json",
+      "Authorization": "Bearer #{API_TOKEN}",
+    },
+    data: { name: 'test-repo-1' },
+  )
+  response.ok? # => true
+  response.json['name'] # => "tes≈-repo-1"
+end
+```
+
+
+## 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,104 @@
+---
+sidebar_position: 10
+---
+
+# APIResponse
+
+[APIResponse](./api_response) class represents responses returned by [APIRequestContext#get](./api_request_context#get) and similar methods.
+
+```ruby
+playwright.chromium.launch do |browser|
+  context = browser.new_context
+  response = context.request.get("https://example.com/user/repos")
+
+  response.ok? # => true
+  response.status # => 200
+  response.headers["content-type"] # => "application/json; charset=utf-8"
+  response.json # => { "name" => "Foo" }
+  response.body # => "{ \"name\" => \"Foo\" }"
+end
+```
+
+
+## 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/api/page.md

@@ -1597,4 +1597,8 @@ associated with the page.
 
 ## mouse
 
+## request
+
+API testing helper associated with this page. Requests made with this API will use page cookies.
+
 ## touchscreen

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
@@ -331,7 +319,7 @@
 * accessibility
 * keyboard
 * mouse
-* ~~request~~
+* request
 * touchscreen
 
 ## BrowserContext
@@ -362,7 +350,7 @@
 * expect_event
 * expect_page
 * ~~wait_for_event~~
-* ~~request~~
+* request
 * tracing
 
 ## CDPSession
@@ -466,6 +454,35 @@
 ## LocalUtils
 
 
+## 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.18.0'
-  COMPATIBLE_PLAYWRIGHT_VERSION = '1.18.0'
+  VERSION = '1.18.1'
+  COMPATIBLE_PLAYWRIGHT_VERSION = '1.18.1'
 end

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

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_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,11 +396,6 @@ module Playwright
       wrap_impl(@impl.options=(unwrap_impl(req)))
     end
 
-    # @nodoc
-    def enable_debug_console!
-      wrap_impl(@impl.enable_debug_console!)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)

data/lib/playwright_api/page.rb

@@ -58,7 +58,7 @@ module Playwright
 
     # API testing helper associated with this page. Requests made with this API will use page cookies.
     def request # property
-      raise NotImplementedError.new('request is not implemented yet.')
+      wrap_impl(@impl.request)
     end
 
     def touchscreen # property
@@ -1391,11 +1391,6 @@ module Playwright
       wrap_impl(@impl.start_js_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
     end
 
-    # @nodoc
-    def stop_js_coverage
-      wrap_impl(@impl.stop_js_coverage)
-    end
-
     # @nodoc
     def start_css_coverage(resetOnNavigation: nil, reportAnonymousScripts: nil)
       wrap_impl(@impl.start_css_coverage(resetOnNavigation: unwrap_impl(resetOnNavigation), reportAnonymousScripts: unwrap_impl(reportAnonymousScripts)))
@@ -1406,6 +1401,11 @@ module Playwright
       wrap_impl(@impl.stop_css_coverage)
     end
 
+    # @nodoc
+    def stop_js_coverage
+      wrap_impl(@impl.stop_js_coverage)
+    end
+
     # @nodoc
     def guid
       wrap_impl(@impl.guid)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playwright-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.18.1
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -210,7 +210,9 @@ files:
 - documentation/README.md
 - documentation/babel.config.js
 - documentation/docs/api/accessibility.md
+- documentation/docs/api/api_request.md
 - documentation/docs/api/api_request_context.md
+- documentation/docs/api/api_response.md
 - documentation/docs/api/browser.md
 - documentation/docs/api/browser_context.md
 - documentation/docs/api/browser_type.md
@@ -275,6 +277,7 @@ files:
 - lib/playwright/accessibility_impl.rb
 - lib/playwright/android_input_impl.rb
 - lib/playwright/api_implementation.rb
+- lib/playwright/api_response_impl.rb
 - lib/playwright/channel.rb
 - lib/playwright/channel_owner.rb
 - lib/playwright/channel_owners/android.rb
@@ -341,7 +344,9 @@ files:
 - lib/playwright_api/android_input.rb
 - lib/playwright_api/android_socket.rb
 - lib/playwright_api/android_web_view.rb
+- lib/playwright_api/api_request.rb
 - lib/playwright_api/api_request_context.rb
+- lib/playwright_api/api_response.rb
 - lib/playwright_api/browser.rb
 - lib/playwright_api/browser_context.rb
 - lib/playwright_api/browser_type.rb
@@ -391,5 +396,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
-summary: The Ruby binding of playwright driver 1.18.0
+summary: The Ruby binding of playwright driver 1.18.1
 test_files: []