vcr-package: vcr: Record 'HTTP' Calls to Disk

In ropenscilabs/vcr: Record 'HTTP' Calls to Disk

vcr: Record 'HTTP' Calls to Disk

Description

Record test suite 'HTTP' requests and replays them during future runs. A port of the Ruby gem of the same name (https://github.com/vcr/vcr/). Works by hooking into the 'webmockr' R package for matching 'HTTP' requests by various rules ('HTTP' method, 'URL', query parameters, headers, body, etc.), and then caching real 'HTTP' responses on disk in 'cassettes'. Subsequent 'HTTP' requests matching any previous requests in the same 'cassette' use a cached 'HTTP' response.

Backstory

A Ruby gem of the same name (VCR, https://github.com/vcr/vcr) was created many years ago and is the original. Ports in many languages have been done. Check out that GitHub repo for all the details on how the canonical version works.

Main functions

The use_cassette function is most likely what you'll want to use. It sets the cassette you want to record to, inserts the cassette, and then ejects the cassette, recording the interactions to the cassette.

Instead, you can use insert_cassette, but then you have to make sure to use eject_cassette.

vcr configuration

vcr_configure is the function to use to set R session wide settings. See it's manual file for help.

Record modes

See recording for help on record modes.

Request matching

See request-matching for help on the many request matching options.

Author(s)

Maintainer: Scott Chamberlain [e-mail] (ORCID)

Authors:

• Aaron Wolen (ORCID)

• Maëlle Salmon (ORCID)

• Daniel Possenriede (ORCID)

Other contributors:

• rOpenSci (https://ropensci.org) [funder]

See Also

Useful links:

• https://github.com/ropensci/vcr/ (devel) https://books.ropensci.org/http-testing/ (user manual) https://docs.ropensci.org/vcr/ (website)

• Report bugs at https://github.com/ropensci/vcr/issues

ropenscilabs/vcr documentation built on Feb. 5, 2024, 5:58 p.m.