gsub_response: Find and replace within a 'response' or 'request'

In httptest: A Test Environment for HTTP Requests

Find and replace within a 'response' or 'request'

Description

These functions pass their arguments to base::gsub() in order to find and replace string patterns (regular expressions) within request or response objects. gsub_request() replaces in the request URL and any request body fields; gsub_response() replaces in the response URL, the response body, and it calls gsub_request() on the request object found within the response.

Usage

gsub_response(response, pattern, replacement, ...)

gsub_request(request, pattern, replacement, ...)

Arguments

response	An 'httr' response object to sanitize.
pattern	From base::gsub(): "character string containing a regular expression (or character string for fixed = TRUE) to be matched in the given character vector." Passed to gsub(). See the docs for gsub() for further details.
replacement	A replacement for the matched pattern, possibly including regular expression backreferences. Passed to gsub(). See the docs for gsub() for further details.
...	Additional logical arguments passed to gsub(): ignore.case, perl, fixed, and useBytes are the possible options.
request	An 'httr' request object to sanitize.

Details

Note that, unlike gsub(), the first argument of the function is request or response, not pattern, while the equivalent argument in gsub(), "x", is placed third. This difference is to maintain consistency with the other redactor functions in httptest, which all take response as the first argument.

Value

A request or response object, same as was passed in, with the pattern replaced in the URLs and bodies.

httptest documentation built on July 9, 2023, 7:45 p.m.