Package: vcr 1.7.0

Scott Chamberlain

vcr: Record 'HTTP' Calls to Disk

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.

Authors:Scott Chamberlain [aut, cre], Aaron Wolen [aut], Maëlle Salmon [aut], Daniel Possenriede [aut], rOpenSci [fnd]

vcr_1.7.0.tar.gz
vcr_1.7.0.zip(r-4.5)vcr_1.7.0.zip(r-4.4)vcr_1.7.0.zip(r-4.3)
vcr_1.7.0.tgz(r-4.5-any)vcr_1.7.0.tgz(r-4.4-any)vcr_1.7.0.tgz(r-4.3-any)
vcr_1.7.0.tar.gz(r-4.5-noble)vcr_1.7.0.tar.gz(r-4.4-noble)
vcr_1.7.0.tgz(r-4.4-emscripten)vcr_1.7.0.tgz(r-4.3-emscripten)
vcr.pdf |vcr.html✨
vcr/json (API)
NEWS

# Install 'vcr' in R:
install.packages('vcr', repos = c('https://packages.ropensci.org', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/ropensci/vcr/issues

Pkgdown site:https://docs.ropensci.org

Datasets:
  • crul_request - An HTTP request as prepared by the 'crul' package

On CRAN:

Conda:

httphttpsapiweb-servicescurlmockmockinghttp-mockingtestingtesting-toolstddunit-testingvcr

10.07 score 76 stars 165 scripts 3.9k downloads 41 exports 28 dependencies

Last updated 1 months agofrom:1c3478f55c (on main). Checks:9 OK. Indexed: yes.

TargetResultLatest binary
Doc / VignettesOKApr 03 2025
R-4.5-winOKApr 03 2025
R-4.5-macOKApr 03 2025
R-4.5-linuxOKApr 03 2025
R-4.4-winOKApr 03 2025
R-4.4-macOKApr 03 2025
R-4.4-linuxOKApr 03 2025
R-4.3-winOKApr 03 2025
R-4.3-macOKApr 03 2025

Exports:as.cassetteas.cassettepathCassettecassette_pathcassettescheck_cassette_namescurrent_cassetteeject_cassettehttp_interactionsHTTPInteractionHTTPInteractionListinsert_cassettePersistersreal_http_connections_allowedRequestrequest_summaryRequestHandlerRequestHandlerCrulRequestHandlerHttrRequestHandlerHttr2RequestMatcherRegistryresponse_summaryserializer_fetchSerializersskip_if_vcr_offturn_offturn_onturned_offturned_onUnhandledHTTPRequestErroruse_cassetteuse_vcrvcr_config_defaultsvcr_configurationvcr_configurevcr_configure_resetvcr_last_errorvcr_log_filevcr_log_infovcr_test_pathVcrResponse

Dependencies:askpassbase64encclicrulcurlfauxpasgluehttpcodehttrhttr2jsonlitelifecyclemagrittrmimeopensslR6rappdirsRcpprlangrprojrootsystriebeardurltoolsvctrswebmockrwhiskerwithryaml

Introduction to vcr

Scott Chamberlain

Rendered fromvcr.Rmdusingknitr::rmarkdownon Apr 03 2025.

Last update: 2024-07-19
Started: 2019-06-13

Configure vcr

Scott Chamberlain

Rendered fromconfiguration.Rmdusingknitr::rmarkdownon Apr 03 2025.

Last update: 2020-12-04
Started: 2016-04-12

Configure vcr request matching

Scott Chamberlain

Rendered fromrequest_matching.Rmdusingknitr::rmarkdownon Apr 03 2025.

Last update: 2020-12-04
Started: 2018-04-04

Debugging your tests that use vcr

Rendered fromdebugging.Rmdusingknitr::rmarkdownon Apr 03 2025.

Last update: 2020-12-04
Started: 2020-11-25

Why and how to edit your vcr cassettes?

Rendered fromcassette-manual-editing.Rmdusingknitr::rmarkdownon Apr 03 2025.

Last update: 2020-12-04
Started: 2020-11-25

Design of vcr

Rendered fromdesign.Rmdusingknitr::rmarkdownon Apr 03 2025.

Last update: 2021-05-04
Started: 2021-05-04

How vcr works, in a lot of details

Rendered frominternals.Rmdusingknitr::rmarkdownon Apr 03 2025.

Last update: 2020-12-04
Started: 2020-11-24

Turning vcr on and off

Rendered fromlightswitch.Rmdusingknitr::rmarkdownon Apr 03 2025.

Last update: 2020-12-15
Started: 2020-12-15

Record modes

Scott Chamberlain

Rendered fromrecord-modes.Rmdusingknitr::rmarkdownon Apr 03 2025.

Last update: 2020-12-15
Started: 2020-12-15

Mocking writing to disk

Scott Chamberlain

Rendered fromwrite-to-disk.Rmdusingknitr::rmarkdownon Apr 03 2025.

Last update: 2020-12-15
Started: 2020-12-15

Readme and manuals

Help Manual

Help pageTopics
Coerce names, etc. to cassettesas.cassette as.cassettepath
List cassettes, get current cassette, etc.cassettes cassette_path current_cassette
Check cassette namescheck_cassette_names
An HTTP request as prepared by the 'crul' packagecrul_request
Eject a cassetteeject_cassette
Get the http interactions of the current cassettehttp_interactions
HTTPInteraction classHTTPInteraction
HTTPInteractionList classHTTPInteractionList
Insert a cassette to record HTTP requestsinsert_cassette
Turn vcr on and off, check on/off status, and turn off for a given http calllightswitch turned_off turned_on turn_off turn_on
Are real http connections allowed?real_http_connections_allowed
vcr recording optionsrecording
vcr request matchingrequest-matching
RequestHandlerRequestHandler
RequestHandlerCrulRequestHandlerCrul
RequestHandlerHttrRequestHandlerHttr
RequestHandlerHttr2RequestHandlerHttr2
RequestMatcherRegistryRequestMatcherRegistry
Skip tests if vcr is offskip_if_vcr_off
split string every N charactersstr_splitter
UnhandledHTTPRequestErrorUnhandledHTTPRequestError vcr_last_error
Use a cassette to record HTTP requestsuse_cassette
Setup vcr for a packageuse_vcr
Global Configuration Optionsvcr_configuration vcr_configure vcr_configure_reset vcr_config_defaults
Locate file in tests directoryvcr_test_path