v1.2.0 (#865)

rstudio · Jul 10, 2022 · c395bf4 · c395bf4
1 parent ca42a30
commit c395bf4
Show file tree

Hide file tree

Showing 21 changed files with 257 additions and 88 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -26,3 +26,4 @@ rsconnect
 ^CRAN-RELEASE$
 ^legacy_support.txt$
 ^codecov\.yml$
+^CRAN-SUBMISSION$
diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml
@@ -23,9 +23,18 @@ jobs:
           - "latest"
 
         config:
-        - name: CRAN
+        # - name: "v1.2.0"
+        #   # always overwrite the latest version with the CRAN version
+        #   tags: "v1.2.0,latest"
+        #   ref: "v1.2.0"
+
+        - name: "v1.1.0"
           # always overwrite the latest version with the CRAN version
-          tags: "v1.0.0,latest"
+          tags: "v1.1.0,latest"
+          ref: "v1.1.0"
+
+        - name: "v1.0.0"
+          tags: "v1.0.0"
           ref: "v1.0.0"
 
         # always rebuild legacy to pick up newer R library builds

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -2,7 +2,7 @@ Encoding: UTF-8
 Package: plumber
 Type: Package
 Title: An API Generator for R
-Version: 1.1.0.9000
+Version: 1.2.0
 Roxygen: list(markdown = TRUE)
 Authors@R: c(
   person("Barret", "Schloerke", role = c("cre", "aut"), email = "barret@rstudio.com", comment = c(ORCID = "0000-0001-9986-114X")),
@@ -51,6 +51,8 @@ Suggests:
     spelling,
     mockery (>= 0.4.2),
     geojsonsf,
+    redoc,
+    rapidoc,
     sf
 RoxygenNote: 7.2.0
 Collate:

diff --git a/NAMESPACE b/NAMESPACE
@@ -115,4 +115,5 @@ importFrom(stats,runif)
 importFrom(stats,setNames)
 importFrom(utils,file.edit)
 importFrom(utils,installed.packages)
+importFrom(utils,tail)
 importFrom(webutils,parse_multipart)
diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,4 @@
-# plumber (development version)
+# plumber 1.2.0
 
 ## Breaking changes
 

diff --git a/R/plumb-block.R b/R/plumb-block.R
@@ -12,6 +12,7 @@ stopOnLine <- function(lineNum, line, msg){
 #' @param lineNum The line number just above the function we're documenting
 #' @param file A character vector representing all the lines in the file
 #' @param envir An environment where to evaluate parsed expressions
+#' @importFrom utils tail
 #' @noRd
 plumbBlock <- function(lineNum, file, envir = parent.frame()){
   paths <- NULL

diff --git a/R/pr.R b/R/pr.R
@@ -346,7 +346,7 @@ pr_hooks <- function(pr,
 #'   \code{\link{random_cookie_key}}. Please see the "Storing secure keys" section for more details
 #'   complex character string to bolster security.
 #' @param name The name of the cookie in the user's browser.
-#' @param path The uri path that the cookie will be available in future requests.
+#' @param path The URI path that the cookie will be available in future requests.
 #'    Defaults to the request URI. Set to \code{"/"} to make cookie available to
 #'    all requests at the host.
 #' @param expiration A number representing the number of seconds into the future
@@ -363,7 +363,7 @@ pr_hooks <- function(pr,
 #'   accept the cookie. An error will be returned if \code{same_site = "None"} and \code{secure = FALSE}.
 #'   If not specified or a non-character is given, no SameSite policy is attached to the cookie.
 #' @seealso \itemize{
-#' \item \href{https://github.com/jeroen/sodium}{'sodium'}: R bindings to 'libsodium'
+#' \item \href{https://github.com/r-lib/sodium}{'sodium'}: R bindings to 'libsodium'
 #' \item \href{https://doc.libsodium.org/}{'libsodium'}: A Modern and Easy-to-Use Crypto Library
 #' \item \href{https://github.com/r-lib/keyring}{'keyring'}: Access the system credential store from R
 #' \item \href{https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#Directives}{Set-Cookie flags}: Descriptions of different flags for \code{Set-Cookie}

diff --git a/R/pr_set.R b/R/pr_set.R
@@ -153,7 +153,6 @@ pr_set_debug <- function(pr, debug = interactive()) {
 #'
 #' ## View API using Redoc
 #' # Official Website: https://github.com/Redocly/redoc
-#' # remotes::install_github("https://github.com/meztez/redoc/")
 #' if (require(redoc)) {
 #'   pr() %>%
 #'     pr_set_docs("redoc") %>%
@@ -163,7 +162,6 @@ pr_set_debug <- function(pr, debug = interactive()) {
 #'
 #' ## View API using RapiDoc
 #' # Official Website: https://github.com/mrin9/RapiDoc
-#' # remotes::install_github("https://github.com/meztez/rapidoc/")
 #' if (require(rapidoc)) {
 #'   pr() %>%
 #'     pr_set_docs("rapidoc") %>%

diff --git a/R/session-cookie.R b/R/session-cookie.R
@@ -32,7 +32,7 @@
 #'   \code{\link{random_cookie_key}}. Please see the "Storing secure keys" section for more details
 #'   complex character string to bolster security.
 #' @param name The name of the cookie in the user's browser.
-#' @param path The uri path that the cookie will be available in future requests.
+#' @param path The URI path that the cookie will be available in future requests.
 #'    Defaults to the request URI. Set to \code{"/"} to make cookie available to
 #'    all requests at the host.
 #' @param expiration A number representing the number of seconds into the future
@@ -50,7 +50,7 @@
 #'   If not specified or a non-character is given, no SameSite policy is attached to the cookie.
 #' @export
 #' @seealso \itemize{
-#' \item \href{https://github.com/jeroen/sodium}{'sodium'}: R bindings to 'libsodium'
+#' \item \href{https://github.com/r-lib/sodium}{'sodium'}: R bindings to 'libsodium'
 #' \item \href{https://doc.libsodium.org/}{'libsodium'}: A Modern and Easy-to-Use Crypto Library
 #' \item \href{https://github.com/r-lib/keyring}{'keyring'}: Access the system credential store from R
 #' \item \href{https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#Directives}{Set-Cookie flags}: Descriptions of different flags for \code{Set-Cookie}
@@ -175,7 +175,7 @@ session_cookie <- function(
 
 #' Random cookie key generator
 #'
-#' Uses a cryptographically secure pseudorandom number generator from [sodium::helpers()] to generate a 64 digit hexadecimal string.  \href{https://github.com/jeroen/sodium}{'sodium'} wraps around \href{https://doc.libsodium.org/}{'libsodium'}.
+#' Uses a cryptographically secure pseudorandom number generator from [sodium::helpers()] to generate a 64 digit hexadecimal string.  \href{https://github.com/r-lib/sodium}{'sodium'} wraps around \href{https://doc.libsodium.org/}{'libsodium'}.
 #'
 #' Please see \code{\link{session_cookie}} for more information on how to save the generated key.
 #'

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![R build status](https://github.com/rstudio/plumber/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rstudio/plumber/actions)
 [![](https://www.r-pkg.org/badges/version/plumber)](https://www.r-pkg.org/pkg/plumber)
 [![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/plumber?color=brightgreen)](https://www.r-pkg.org/pkg/plumber)
-[![codecov](https://codecov.io/gh/rstudio/plumber/branch/main/graph/badge.svg)](https://codecov.io/gh/rstudio/plumber)
+[![codecov](https://app.codecov.io/gh/rstudio/plumber/branch/main/graph/badge.svg)](https://app.codecov.io/gh/rstudio/plumber)
 [![RStudio community](https://img.shields.io/badge/community-plumber-blue?style=social&logo=rstudio&logoColor=75AADB)](https://community.rstudio.com/tag/plumber)
 <!-- badges: end -->
 
@@ -107,7 +107,7 @@ will be the best way to get started. You'll be able to get a server hosting your
 custom API in just two R commands. To deploy to DigitalOcean, check out the
 `plumber` companion package [`plumberDeploy`](https://github.com/meztez/plumberDeploy).
 
-[RStudio Connect](https://rstudio.com/products/connect/) is a commercial
+[RStudio Connect](https://www.rstudio.com/products/connect/) is a commercial
 publishing platform that enables R developers to easily publish a variety of R
 content types, including Plumber APIs. Additional documentation is available at
 https://www.rplumber.io/articles/hosting.html#rstudio-connect-1.

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,52 +1,30 @@
 ## Comments
 
-#### 2020-3-23
+#### 2022-7-9
 
 Bug fixes and new features.
 
 CRAN checks:
-* I have disabled the brittle test that is currently failing on https://www.r-project.org/nosvn/R.check/r-devel-windows-x86_64-gcc10-UCRT/plumber-00check.html . Checking this test on windows GHA only.
-* I can not see why this installation is failing: https://www.r-project.org/nosvn/R.check/r-release-windows-ix86+x86_64/plumber-00check.html
+* I have disabled the brittle test that is currently failing on r-oldrel-windows-ix86+x86_64 for windows platforms only
+* `LazyData` field in DESCRIPTION has been removed
+* I have disabled a test on windows involving `{future}` as I am running into https://stat.ethz.ch/pipermail/r-devel/2021-June/080830.html
 
 Please let me know if there is anything else I can provide.
 
 Thank you,
 Barret
 
 
-#### 2020-1-5
-
-These checks have naturally resolved.
-
-- Barret
-
-
-#### 2020-12-13
-
-Dear maintainer,
-
-Please see the problems shown on
-<https://cran.r-project.org/web/checks/check_results_plumber.html>.
-
-Please correct before 2021-01-08 to safely retain your package on CRAN.
-
-Best,
--k
-
-
-
 ## Test environments
 
-* local macOS, R 4.0.2
+* local macOS, R 4.1.3
 * GitHub Actions
   * macOS
-    * oldrel, release, devel
+    * 4.2
   * windows
-    * release, devel
+    * 4.2
   * ubuntu18
-    * 3.4, 3.5, oldrel, release, devel
-  * ubuntu16
-    * 3.4, 3.5, oldrel, release, devel
+    * devel, 4.2, 4.1, 4.0, 3.6, 3.5
 * devtools::
   * check_win_devel()
   * check_win_release()
@@ -57,7 +35,7 @@ Best,
 
 ## revdepcheck results
 
-We checked 13 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
+We checked 18 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
 
  * We saw 0 new problems
  * We failed to check 0 packages
diff --git a/man/pr_cookie.Rd b/man/pr_cookie.Rd
diff --git a/man/pr_set_docs.Rd b/man/pr_set_docs.Rd
diff --git a/man/random_cookie_key.Rd b/man/random_cookie_key.Rd
diff --git a/man/session_cookie.Rd b/man/session_cookie.Rd
diff --git a/revdep/README.md b/revdep/README.md
@@ -1,40 +1,46 @@
 # Platform
 
-|field    |value                        |
-|:--------|:----------------------------|
-|version  |R version 4.0.2 (2020-06-22) |
-|os       |macOS  10.16                 |
-|system   |x86_64, darwin17.0           |
-|ui       |X11                          |
-|language |(EN)                         |
-|collate  |en_US.UTF-8                  |
-|ctype    |en_US.UTF-8                  |
-|tz       |America/New_York             |
-|date     |2021-03-23                   |
+|field    |value                           |
+|:--------|:-------------------------------|
+|version  |R version 4.1.3 (2022-03-10)    |
+|os       |macOS Big Sur/Monterey 10.16    |
+|system   |x86_64, darwin17.0              |
+|ui       |X11                             |
+|language |(EN)                            |
+|collate  |en_US.UTF-8                     |
+|ctype    |en_US.UTF-8                     |
+|tz       |America/New_York                |
+|date     |2022-06-06                      |
+|pandoc   |2.9.1.1 @ /usr/local/bin/pandoc |
 
 # Dependencies
 
 |package |old   |new   |Δ  |
 |:-------|:-----|:-----|:--|
-|plumber |1.0.0 |1.1.0 |*  |
+|plumber |1.1.0 |1.2.0 |*  |
 
 # Revdeps
 
-## All (13)
+## All (18)
 
 |package                                        |version  |error |warning |note |
 |:----------------------------------------------|:--------|:-----|:-------|:----|
-|arenar                                         |0.2.0    |      |        |     |
-|[AzureContainers](problems.md#azurecontainers) |1.3.1    |      |        |1    |
-|bayesAB                                        |1.1.2    |      |        |     |
-|googleCloudRunner                              |0.4.1    |      |        |     |
-|gqlr                                           |0.0.2    |      |        |     |
-|[log](problems.md#log)                         |1.1.0    |      |        |1    |
-|[microservices](problems.md#microservices)     |0.1.0    |      |        |1    |
-|[openmetrics](problems.md#openmetrics)         |0.3.0    |      |        |1    |
-|[rapidoc](problems.md#rapidoc)                 |8.4.3    |      |        |1    |
-|redoc                                          |2.0.0.49 |      |        |     |
+|[arenar](problems.md#arenar)                   |0.2.0    |      |        |1    |
+|[AzureContainers](problems.md#azurecontainers) |1.3.2    |      |        |1    |
+|bayesAB                                        |1.1.3    |      |        |     |
+|googleCloudRunner                              |0.5.0    |      |        |     |
+|[gqlr](problems.md#gqlr)                       |0.0.2    |      |        |1    |
+|[log](problems.md#log)                         |1.1.1    |      |        |1    |
+|MicroMoB                                       |0.0.12   |-1    |        |     |
+|[microservices](problems.md#microservices)     |0.1.2    |1     |        |1    |
+|[openmetrics](problems.md#openmetrics)         |0.3.0    |      |        |2    |
+|[plumbertableau](problems.md#plumbertableau)   |0.1.0    |      |        |1    |
+|[rapidoc](problems.md#rapidoc)                 |8.4.3    |      |        |2    |
+|[redoc](problems.md#redoc)                     |2.0.0.49 |      |        |1    |
 |[rjsonapi](problems.md#rjsonapi)               |0.1.0    |      |        |1    |
-|rsconnect                                      |0.8.16   |      |        |     |
-|swagger                                        |3.33.1   |      |        |     |
+|[rsconnect](problems.md#rsconnect)             |0.8.26   |      |        |1    |
+|starsTileServer                                |0.1      |      |        |     |
+|[swagger](problems.md#swagger)                 |3.33.1   |      |        |1    |
+|tgver                                          |0.2.0    |      |        |     |
+|vetiver                                        |0.1.5    |      |        |     |
 
diff --git a/revdep/cran.md b/revdep/cran.md
@@ -1,6 +1,6 @@
 ## revdepcheck results
 
-We checked 13 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
+We checked 18 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
 
  * We saw 0 new problems
  * We failed to check 0 packages