playwright-ruby-client 1.17.beta1 → 1.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2fe4b12d358a45b087eee4cdfc8aecb03b9e6df7d012158e4a04a042d290d13
-  data.tar.gz: ed57849806349f58419ead4e64164cafb94de892fa5d4be7cbf9f6e67867eb5d
+  metadata.gz: 4743c153d270bd3343d7f59b53e1ef03ebecf65495804c79ef4561e5db1263ac
+  data.tar.gz: 2f5db2b025b62ebece498cce6edc8f02f85a07377dee2945fbbcfb60e6718c48
 SHA512:
-  metadata.gz: b4245e2cc937bf4dd85ab98848b4a56149d796d814407598e17258f64154d85f252a3f993e13c8a81bda0f0112ffc5c1fa93e699c7fb691e3bf7592f27cd6133
-  data.tar.gz: 5680b2040b8ff3927b952e9f5321355137c298c697b0ba5ecde686eb89545f8b3444e191da3fe8ba22315df6fc982e452bdff73d71774419ee32a08e9a0281ef
+  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

@@ -8,3 +8,164 @@ 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.
+
+```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/download.md

@@ -19,9 +19,7 @@ end
 path = download.path
 ```
 
-> NOTE: Browser context **must** be created with the `acceptDownloads` set to `true` when user needs access to the
-downloaded content. If `acceptDownloads` is not set, download events are emitted, but the actual download is not
-performed and user has no access to the downloaded files.
+
 
 ## cancel
 

data/documentation/docs/api/frame.md

@@ -549,7 +549,7 @@ considered not visible.
 ## locator
 
 ```
-def locator(selector)
+def locator(selector, hasText: nil)
 ```
 
 The method returns an element locator that can be used to perform actions in the frame. Locator is resolved to the

data/documentation/docs/api/frame_locator.md

@@ -26,6 +26,15 @@ page.frame_locator('.result-frame').locator('button').click
 page.frame_locator('.result-frame').first.locator('button').click
 ```
 
+**Converting Locator to FrameLocator**
+
+If you have a [Locator](./locator) object pointing to an `iframe` it can be converted to [FrameLocator](./frame_locator) using
+[`:scope`](https://developer.mozilla.org/en-US/docs/Web/CSS/:scope) CSS selector:
+
+```ruby
+frame_locator = locator.frame_locator(':scope')
+```
+
 
 
 ## first
@@ -56,7 +65,7 @@ Returns locator to the last matching frame.
 ## locator
 
 ```
-def locator(selector)
+def locator(selector, hasText: nil)
 ```
 
 The method finds an element matching the specified selector in the FrameLocator's subtree.

data/documentation/docs/api/locator.md

@@ -4,53 +4,10 @@ sidebar_position: 10
 
 # Locator
 
-Locator represents a view to the element(s) on the page. It captures the logic sufficient to retrieve the element at any
-given moment. Locator can be created with the [Page#locator](./page#locator) method.
-
-```ruby
-locator = page.locator("text=Submit")
-locator.click
-```
-
-The difference between the Locator and [ElementHandle](./element_handle) is that the latter points to a particular element, while Locator
-captures the logic of how to retrieve that element.
-
-In the example below, handle points to a particular DOM element on page. If that element changes text or is used by
-React to render an entirely different component, handle is still pointing to that very DOM element. This can lead to
-unexpected behaviors.
-
-```ruby
-handle = page.query_selector("text=Submit")
-handle.hover
-handle.click
-```
-
-With the locator, every time the `element` is used, up-to-date DOM element is located in the page using the selector. So
-in the snippet below, underlying DOM element is going to be located twice.
-
-```ruby
-locator = page.locator("text=Submit")
-locator.hover
-locator.click
-```
-
-**Strictness**
-
-Locators are strict. This means that all operations on locators that imply some target DOM element will throw if more
-than one element matches given selector.
-
-```ruby
-# Throws if there are several buttons in DOM:
-page.locator('button').click
-
-# Works because we explicitly tell locator to pick the first element:
-page.locator('button').first.click
-
-# Works because count knows what to do with multiple matches:
-page.locator('button').count
-```
-
+Locators are the central piece of Playwright's auto-waiting and retry-ability. In a nutshell, locators represent a way
+to find element(s) on the page at any moment. Locator can be created with the [Page#locator](./page#locator) method.
 
+[Learn more about locators](https://playwright.dev/python/docs/locators).
 
 ## all_inner_texts
 
@@ -220,6 +177,21 @@ element.dispatch_event("dragstart", eventInit: { dataTransfer: data_transfer })
 
 
 
+## drag_to
+
+```
+def drag_to(
+      target,
+      force: nil,
+      noWaitAfter: nil,
+      sourcePosition: nil,
+      targetPosition: nil,
+      timeout: nil,
+      trial: nil)
+```
+
+
+
 ## element_handle
 
 ```
@@ -458,7 +430,7 @@ Returns locator to the last matching element.
 ## locator
 
 ```
-def locator(selector)
+def locator(selector, hasText: nil)
 ```
 
 The method finds an element matching the specified selector in the [Locator](./locator)'s subtree.

data/documentation/docs/api/page.md

@@ -774,7 +774,7 @@ considered not visible.
 ## locator
 
 ```
-def locator(selector)
+def locator(selector, hasText: nil)
 ```
 
 The method returns an element locator that can be used to perform actions on the page. Locator is resolved to the
@@ -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,6 +319,7 @@
 * accessibility
 * keyboard
 * mouse
+* request
 * touchscreen
 
 ## BrowserContext
@@ -361,7 +350,7 @@
 * expect_event
 * expect_page
 * ~~wait_for_event~~
-* ~~request~~
+* request
 * tracing
 
 ## CDPSession
@@ -417,6 +406,7 @@
 * count
 * dblclick
 * dispatch_event
+* drag_to
 * element_handle
 * element_handles
 * evaluate
@@ -461,6 +451,38 @@
 * locator
 * nth
 
+## 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