Skip to content

Commit 4e287a2

Browse files
committed
update contribs in readme
1 parent 8e49c9f commit 4e287a2

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.Rmd

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ The canonical `vcr` (in Ruby) lists ports in other languages at <https://github.
127127
* [Scott Chamberlain](https://github.com/sckott)
128128
* [Aaron Wolen](https://github.com/aaronwolen)
129129
* [Maëlle Salmon](https://github.com/maelle)
130+
* [Daniel Possenriede](https://github.com/dpprdan)
130131

131132
## Meta
132133

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ This will:
8181
* setup a config file for `vcr`
8282
* add an example test file for `vcr`
8383
* make a `.gitattributes` file with settings for `vcr`
84-
* make a `./tests/testthat/setup-vcr.R` file
84+
* make a `./tests/testthat/helper-vcr.R` file
8585

8686
What you will see in the R console:
8787

@@ -92,7 +92,7 @@ What you will see in the R console:
9292
✓ Creating directory: ./tests/testthat
9393
◉ Looking for testthat.R file or similar
9494
✓ tests/testthat.R: added
95-
✓ Adding vcr config to tests/testthat/setup-vcr.example.R
95+
✓ Adding vcr config to tests/testthat/helper-vcr.example.R
9696
✓ Adding example test file tests/testthat/test-vcr_example.R
9797
✓ .gitattributes: added
9898
◉ Learn more about `vcr`: https://books.ropensci.org/http-testing
@@ -104,7 +104,7 @@ Secrets often turn up in API work. A common example is an API key.
104104
`vcr` saves responses from APIs as YAML files, and this will include your secrets unless you indicate to `vcr` what they are and how to protect them.
105105
The `vcr_configure` function has the `filter_sensitive_data` argument function for just this situation.
106106
The `filter_sensitive_data` argument takes a named list where the _name_ of the list is the string that will be used in the recorded cassettes _instead of_ the secret, which is the list _item_.
107-
`vcr` will manage the replacement of that for you, so all you need to do is to edit your `setup-vcr.R` file like this:
107+
`vcr` will manage the replacement of that for you, so all you need to do is to edit your [`helper-vcr.R` file](https://testthat.r-lib.org/reference/test_dir.html#special-files) like this:
108108

109109
```r
110110
library("vcr") # *Required* as vcr is set up on loading
@@ -152,7 +152,7 @@ Furthermore, as by default requests matching does not include the API key, thing
152152
E.g. to have tests pass on continuous integration for external pull requests to your code repository.
153153

154154
* vcr does not need an actual API key for requests once the cassettes are created, as no real requests will be made.
155-
* you still need to fool your _package_ into believing there is an API key as it will construct requests with it. So add the following lines to a testthat setup file (e.g. `tests/testthat/setup-vcr.R`)
155+
* you still need to fool your _package_ into believing there is an API key as it will construct requests with it. So add the following lines to a testthat setup file (e.g. `tests/testthat/helper-vcr.R`)
156156

157157
```r
158158
if (!nzchar(Sys.getenv("APIKEY"))) {
@@ -470,6 +470,7 @@ We've tried to make sure the parameters that are ignored are marked as such. Kee
470470
* [Scott Chamberlain](https://github.com/sckott)
471471
* [Aaron Wolen](https://github.com/aaronwolen)
472472
* [Maëlle Salmon](https://github.com/maelle)
473+
* [Daniel Possenriede](https://github.com/dpprdan)
473474

474475
## Meta
475476

0 commit comments

Comments
 (0)