Function reference • vcr

vcr

High level overview of package

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

Configuration

Use use_vcr to get started

use_vcr(): Setup vcr for a package

vcr_configure() vcr_configure_reset() vcr_configuration() vcr_config_defaults(): Global Configuration Options

Main functions

Probably the only functions you’ll need

use_cassette(): Use a cassette to record HTTP requests

insert_cassette(): Insert a cassette to record HTTP requests

eject_cassette(): Eject a cassette

Recording and matching

Details on recording and request matching options

recording: vcr recording options

request-matching: vcr request matching

vcr in tests

Functions for more custom workflows

skip_if_vcr_off(): Skip tests if vcr is off

vcr_test_path(): Locate file in tests directory

Check current recording state

real_http_connections_allowed(): Are real http connections allowed?

Enable/Disable vcr

turned_off() turn_on() turned_on() turn_off(): Turn vcr on and off, check on/off status, and turn off for a given http call

Managing cassettes

as.cassette() as.cassettepath(): Coerce names, etc. to cassettes

cassettes() current_cassette() cassette_path(): List cassettes, get current cassette, etc.

check_cassette_names(): Check cassette names

http_interactions(): Get the http interactions of the current cassette

Internals

You shouldn’t need to use these directly

Cassette: Cassette handler

HTTPInteraction: HTTPInteraction class

HTTPInteractionList: HTTPInteractionList class

persister_fetch(): Cassette persisters

Request: The request of an HTTPInteraction

RequestHandler: RequestHandler

RequestHandlerCrul: RequestHandlerCrul

RequestHandlerHttr: RequestHandlerHttr

RequestMatcherRegistry: RequestMatcherRegistry

serializer_fetch(): Cassette serializers

vcr_last_error(): UnhandledHTTPRequestError

VcrResponse: The response of an HTTPInteraction

request_summary() response_summary(): request and response summary methods

vcr_log_file() vcr_log_info(): vcr log file setup

crul_request: An HTTP request as prepared by the crul package

str_splitter(): split string every N characters