Skip to content

Commit

Permalink
udpate news, cran comments, and codemeta.json for next cran push
Browse files Browse the repository at this point in the history
  • Loading branch information
sckott committed Mar 3, 2020
1 parent b99e0d3 commit 96f8242
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 17 deletions.
3 changes: 1 addition & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Description: Record test suite 'HTTP' requests and replays them during
real 'HTTP' responses on disk in 'cassettes'. Subsequent 'HTTP' requests
matching any previous requests in the same 'cassette' use a cached
'HTTP' response.
Version: 0.4.2.94
Version: 0.5.0
Authors@R: c(person("Scott", "Chamberlain", role = c("aut", "cre"),
email = "sckott@protonmail.com",
comment = c(ORCID="0000-0003-1444-9135")),
Expand Down Expand Up @@ -43,7 +43,6 @@ Suggests:
cli,
curl
RoxygenNote: 7.0.2
Remotes: ropensci/webmockr
X-schema.org-applicationCategory: Web
X-schema.org-keywords: http, https, API, web-services, curl, mock, mocking, http-mocking, testing, testing-tools, tdd
X-schema.org-isPartOf: https://ropensci.org
31 changes: 31 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
vcr 0.5.0
=========

### NEW FEATURES

* new function `check_cassette_names` to use in your `helper-pkgname.R` file in your test suite; it checks for duplicated cassette names only. Any use of `insert_cassette()` (thereby, any use of `use_cassette()`) uses a revamped version of an internal fxn that checks for an improved list of potential problems in cassette names (#116) (#159)
* `use_vcr()` adds gitignore cassette diffs via the addition of a `gitattributes` file (#109)
* `vcr_configure()` overhaul: function no longer has each setting as a parameter; rather, it has an ellipsis (`...`), and internally we check parameters passed in. The documentation (`?vcr_configure`) lists the details for each available parameter. Importantly, each call to `vcr_configure()` now only changes the vcr settings for parameters passed in to the function; to reset all vcr settings, run `vcr_configure_reset()` (#136) (#141)
* `insert_cassette()` and `use_cassette()` now inherit any vcr settings set by `vcr_configure()`; this wasn't happening consistently before. Most default parameter values in `insert_cassette/use_cassette` set to `NULL`, in which case they inherit from whatever values are set by `vcr_configure()`, but can be overriden (#151) (#153)

### MINOR IMPROVEMENTS

* define _serialize_, _cassette_, and _fixture_ in the README (#138) (#139)
* fix `filter_sensitive_data` parameter description in `vcr_configure` docs (#129)
* move higher up in README a brief description of what this package does (#140)
* import `utils::getParseData` so its in namespace (#142)
* better cleanup of some stray test files left on disk (#148)
* `use_vcr()` no longer uses `context()` in example test file (#144)
* improved documentation of functions and environment variables for turning vcr on and off and when to use each of them - documentation mostly in the HTTP Testing book at https://books.ropensci.org/http-testing/lightswitch.html (#131)
* fix a `use_cassette` test (#133)
* Add assertions to `vcr_configure()` when parameters are set by the user to fail early (#156)

### BUG FIXES

* fix for handling of http requests that request image data AND do not write that data to disk; in addition, fix usage of `preserve_exact_body_bytes` when image data is in the response body (#128) thanks @Rekyt
* vcr now should handle request bodies correctly on POST requests (#143)
* Request matching was failing for empty bodies when "body" was one of the matchers (#157) (#161)
* fix to `sensitive_remove()` internal function used when the user sets `filter_sensitive_data` in `vcr_configure()`; when an env var is missing in the `filter_sensitive_data` list, `sensitive_remove()` was causing C stack errors in some cases (#160) thanks @zachary-foster
* fix for recording JSON-encoded bodies; vcr wasn't handling HTTP requests when the user set the body to be encoded as JSON (e.g., `encode="json"` with crul or httr) (#130)


vcr 0.4.0
=========

Expand Down
55 changes: 45 additions & 10 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@
"codeRepository": "https://github.com/ropensci/vcr/",
"issueTracker": "https://github.com/ropensci/vcr/issues",
"license": "https://spdx.org/licenses/MIT",
"version": "0.3.0",
"version": "0.5.0",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
"version": "3.6.1",
"version": "3.6.3",
"url": "https://r-project.org"
},
"runtimePlatform": "R version 3.6.1 Patched (2019-07-17 r76848)",
"runtimePlatform": "R version 3.6.3 RC (2020-02-21 r77868)",
"author": [
{
"@type": "Person",
Expand All @@ -37,6 +37,19 @@
}
],
"softwareSuggestions": [
{
"@type": "SoftwareApplication",
"identifier": "roxygen2",
"name": "roxygen2",
"version": ">= 7.0.2",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=roxygen2"
},
{
"@type": "SoftwareApplication",
"identifier": "jsonlite",
Expand Down Expand Up @@ -120,14 +133,26 @@
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=cli"
},
{
"@type": "SoftwareApplication",
"identifier": "curl",
"name": "curl",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=curl"
}
],
"softwareRequirements": [
{
"@type": "SoftwareApplication",
"identifier": "crul",
"name": "crul",
"version": ">= 0.7.0",
"version": ">= 0.8.4",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
Expand All @@ -152,7 +177,7 @@
"@type": "SoftwareApplication",
"identifier": "webmockr",
"name": "webmockr",
"version": ">= 0.4.0",
"version": ">= 0.6.0",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
Expand Down Expand Up @@ -225,19 +250,29 @@
"applicationCategory": "Web",
"isPartOf": "https://ropensci.org",
"keywords": ["http", "https", "API", "web-services", "curl", "mock", "mocking", "http-mocking", "testing", "testing-tools", "tdd", "unit-testing", "rstats", "vcr", "r", "r-package"],
"contIntegration": "https://travis-ci.org/ropenscilabs/vcr",
"contIntegration": ["https://travis-ci.org/ropensci/vcr", "https://ci.appveyor.com/project/sckott/vcr", "https://codecov.io/gh/ropensci/vcr"],
"readme": "https://github.com/ropensci/vcr/blob/master/README.md",
"fileSize": "73.897KB",
"relatedLink": "https://ropenscilabs.github.io/http-testing-book/",
"fileSize": "148.962KB",
"relatedLink": [
"https://ropenscilabs.github.io/http-testing-book/",
"https://books.ropensci.org/http-testing/"
],
"releaseNotes": "https://github.com/ropensci/vcr/blob/master/NEWS.md",
"developmentStatus": "http://www.repostatus.org/#wip",
"developmentStatus": "https://www.repostatus.org/#active",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"contributor": {},
"contributor": [
{
"@type": "Person",
"givenName": "Aaron",
"familyName": "Wolen",
"@id": "https://orcid.org/0000-0003-2542-2202"
}
],
"copyrightHolder": {},
"funder": {}
}
9 changes: 4 additions & 5 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Test environments

* local OS X install, R 3.6.1 Patched
* ubuntu 14.04 (on travis-ci), R 3.6.1
* local OS X install, R 3.6.3 RC
* ubuntu 14.04 (on travis-ci), R 3.6.2
* win-builder (devel and release)

## R CMD check results
Expand All @@ -10,12 +10,11 @@

## Reverse dependencies

* I have run R CMD check on the 25 reverse dependencies.
(Summary at <https://github.com/ropensci/vcr/blob/master/revdep/README.md>).
* I have run R CMD check on the 28 reverse dependencies. Summary at https://github.com/ropensci/vcr/blob/master/revdep/README.md

--------

This version adds some major features including supporting http requests that write to disk, ignoring certain requests, and turning vcr completely off during a test suite run.
This version makes many improvements to configuration settings, improves documentation, and fixes many bugs.

Thanks very much,
Scott Chamberlain

0 comments on commit 96f8242

Please sign in to comment.