v1.2.0 (#865)

Author: schloerke

.Rbuildignore

@@ -26,3 +26,4 @@ rsconnect
 ^CRAN-RELEASE$
 ^legacy_support.txt$
 ^codecov\.yml$
+^CRAN-SUBMISSION$

.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

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:

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)

NEWS.md

@@ -1,4 +1,4 @@
-# plumber (development version)
+# plumber 1.2.0
 
 ## Breaking changes
 

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

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}

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") %>%

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.
 #'

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.