playwright-ruby-client 1.20.2 → 1.23.0

data/documentation/docs/api/route.md

@@ -7,6 +7,8 @@ sidebar_position: 10
 Whenever a network route is set up with [Page#route](./page#route) or [BrowserContext#route](./browser_context#route), the [Route](./route) object
 allows to handle the route.
 
+Learn more about [networking](https://playwright.dev/python/docs/network).
+
 ## abort
 
 ```
@@ -29,6 +31,7 @@ def handle(route, request)
   headers = request.headers
   headers['foo'] = 'bar' # set "foo" header
   headers['user-agent'] = 'Unknown Browser' # modify user-agent
+  headers.delete('bar') # remove "bar" header
 
   route.continue(headers: headers)
 end
@@ -37,6 +40,70 @@ page.route("**/*", method(:handle))
 
 
 
+## fallback
+
+```
+def fallback(headers: nil, method: nil, postData: nil, url: nil)
+```
+
+When several routes match the given pattern, they run in the order opposite to their registration. That way the last
+registered route can always override all the previos ones. In the example below, request will be handled by the
+bottom-most handler first, then it'll fall back to the previous one and in the end will be aborted by the first
+registered route.
+
+```ruby
+page.route("**/*", -> (route,_) { route.abort })  # Runs last.
+page.route("**/*", -> (route,_) { route.fallback })  # Runs second.
+page.route("**/*", -> (route,_) { route.fallback })  # Runs first.
+```
+
+Registering multiple routes is useful when you want separate handlers to handle different kinds of requests, for example
+API calls vs page resources or GET requests vs POST requests as in the example below.
+
+```ruby
+# Handle GET requests.
+def handle_post(route, request)
+  if request.method != "GET"
+    route.fallback
+    return
+  end
+
+  # Handling GET only.
+  # ...
+end
+
+# Handle POST requests.
+def handle_post(route)
+  if request.method != "POST"
+    route.fallback
+    return
+  end
+
+  # Handling POST only.
+  # ...
+end
+
+page.route("**/*", handle_get)
+page.route("**/*", handle_post)
+```
+
+One can also modify request while falling back to the subsequent handler, that way intermediate route handler can modify
+url, method, headers and postData of the request.
+
+```ruby
+def handle(route, request)
+  # override headers
+  headers = request.headers
+  headers['foo'] = 'bar' # set "foo" header
+  headers['user-agent'] = 'Unknown Browser' # modify user-agent
+  headers.delete('bar') # remove "bar" header
+
+  route.fallback(headers: headers)
+end
+```
+
+
+
 ## fulfill
 
 ```

data/documentation/docs/include/api_coverage.md

@@ -27,6 +27,7 @@
 * body
 * finished
 * frame
+* from_service_worker
 * headers
 * headers_array
 * header_value
@@ -45,6 +46,7 @@
 
 * abort
 * continue
+* fallback
 * fulfill
 * request
 
@@ -280,6 +282,7 @@
 * query_selector_all
 * reload
 * route
+* route_from_har
 * screenshot
 * select_option
 * set_checked
@@ -339,6 +342,7 @@
 * new_page
 * pages
 * route
+* route_from_har
 * service_workers
 * set_default_navigation_timeout
 * set_default_timeout
@@ -360,6 +364,7 @@
 
 ## Browser
 
+* browser_type
 * close
 * contexts
 * connected?
@@ -413,6 +418,7 @@
 * evaluate_all
 * evaluate_handle
 * fill
+* filter
 * first
 * focus
 * frame_locator
@@ -453,9 +459,6 @@
 * locator
 * nth
 
-## LocalUtils
-
-
 ## APIResponse
 
 * body

data/documentation/package.json

@@ -14,14 +14,14 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.0-beta.6",
-    "@docusaurus/preset-classic": "^2.0.0-beta.6",
-    "@mdx-js/react": "^1.6.21",
-    "@svgr/webpack": "^5.5.0",
+    "@docusaurus/core": "^2.0.0-beta.18",
+    "@docusaurus/preset-classic": "^2.0.0-beta.18",
+    "@mdx-js/react": "^1.6.22",
+    "@svgr/webpack": "^6.2.1",
     "clsx": "^1.1.1",
     "file-loader": "^6.2.0",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
     "url-loader": "^4.1.1"
   },
   "browserslist": {