v1.1.0 (#752)

.github/workflows/R-CMD-check.yaml

@@ -42,6 +42,7 @@ jobs:
 
     env:
       R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
+      _R_CHECK_FORCE_SUGGESTS_: false
       RSPM: ${{ matrix.config.rspm }}
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
 
@@ -69,8 +70,8 @@ jobs:
         uses: actions/cache@v2
         with:
           path: ${{ env.R_LIBS_USER }}
-          key: ${{ matrix.config.os }}-${{ steps.install-r.outputs.installed-r-version }}-1-${{ hashFiles('.github/r-depends.rds') }}
-          restore-keys: ${{ matrix.config.os }}-${{ steps.install-r.outputs.installed-r-version }}-1-
+          key: ${{ matrix.config.os }}-${{ steps.install-r.outputs.installed-r-version }}-2-${{ hashFiles('.github/r-depends.rds') }}
+          restore-keys: ${{ matrix.config.os }}-${{ steps.install-r.outputs.installed-r-version }}-2-
 
       - name: Install system dependencies
         if: runner.os == 'Linux'
@@ -91,6 +92,16 @@ jobs:
         shell: Rscript {0}
         run: |
           install.packages("Rcpp", type = "source")
+      - name: Ubuntu 16 xml2
+        if: matrix.config.os == 'ubuntu-16.04'
+        shell: Rscript {0}
+        run: |
+          pak::pkg_system_requirements("withr", execute = TRUE)
+          pak::pkg_install("withr")
+          pak::pkg_system_requirements("xml2", execute = TRUE)
+          # https://github.com/r-lib/xml2/issues/294
+          # always install for now
+          withr::with_makevars(c(CXX = "g++ -std=c++11"), install.packages("xml2", verbose = TRUE))
 
       - name: Install dependencies
         shell: Rscript {0}

.github/workflows/pkgdown.yaml

@@ -1,6 +1,8 @@
 on:
   push:
-    branches: master
+    branches:
+      - master
+      - rc-**
   pull_request:
     branches: master
 

DESCRIPTION

@@ -2,7 +2,7 @@ Encoding: UTF-8
 Package: plumber
 Type: Package
 Title: An API Generator for R
-Version: 1.0.0.90002
+Version: 1.1.0
 Roxygen: list(markdown = TRUE)
 Authors@R: c(
   person("Barret", "Schloerke", role = c("cre", "aut"), email = "barret@rstudio.com"),
@@ -48,6 +48,7 @@ Suggests:
     feather,
     future,
     rstudioapi,
+    spelling,
     mockery (>= 0.4.2)
 RoxygenNote: 7.1.1
 Collate:
@@ -89,3 +90,4 @@ Collate:
     'validate_api_spec.R'
     'zzz.R'
 RdMacros: lifecycle
+Language: en-US

NEWS.md

@@ -1,4 +1,4 @@
-plumber 1.0.0.9999 Development version
+plumber 1.1.0
 --------------------------------------------------------------------------------
 
 ### Breaking changes
@@ -13,17 +13,15 @@ plumber 1.0.0.9999 Development version
 
 * Added option `plumber.trailingSlash`. This option (which is **disabled** by default) allows routes to be redirected to route definitions with a trailing slash. For example, if a `GET` request is submitted to `/test?a=1` with no `/test` route is defined, but a `GET` `/test/` route definition does exist, then the original request will respond with a `307` to reattempt against `GET` `/test/?a=1`. This option will be _enabled_ by default in a future release. This logic executed for before calling the `404` handler. (#746)
 
-* Added option `plumber.methodNotFound`. This option (which is enabled by default) allows for a status of `405` to be returned if an invalid method is used when requesting a valid route. This logic executed for before calling the default `404` handler. (#746)
-
-* Guess OpenApi response content type from serializer. (@meztez #684)
+* Added an experimental option `plumber.methodNotAllowed`. This option (which is enabled by default) allows for a status of `405` to be returned if an invalid method is used when requesting a valid route. This logic executed for before calling the default `404` handler. (#746)
 
 * Passing `edit = TRUE` to `plumb_api()` will open the API source file. (#699)
 
-* Allow for spaces in `@apiTag` and `@tag` when tag is surrended by single or double quotes. (#685)
-
 * OpenAPI Specification can be set using a file path. (@meztez #696)
 
-* Un-deprecated `Plumber$run(debug=, swaggerCallback=)` and added the parameters for `Plumber$run(docs=, quiet=)` and `pr_run(debug=, docs=, swaggerCallback=, quiet=)`. Now, all four parameters will not produce lingering effects on the `Plumber` router. (@jcheng5 #765)
+* Guess OpenAPI response content type from serializer. (@meztez #684)
+
+* Undeprecated `Plumber$run(debug=, swaggerCallback=)` and added the parameters for `Plumber$run(docs=, quiet=)` and `pr_run(debug=, docs=, swaggerCallback=, quiet=)`. Now, all four parameters will not produce lingering effects on the `Plumber` router. (@jcheng5 #765)
   * Setting `quiet = TRUE` will suppress routine startup messages.
   * Setting `debug = TRUE`, will display information when an error occurs. See `pr_set_debug()`.
   * Setting `docs` will update the visual documentation. See `pr_set_docs()`.
@@ -33,19 +31,21 @@ plumber 1.0.0.9999 Development version
 
 * `PlumberStep` (and `PlumberEndpoint` and `PlumberFilter`) received a new field `$srcref` and method `$getFunc()`. `$srcref` will contain the corresponding `srcref` information from original source file. `$getFunc()` will return the evaluated function. (#782)
 
+* Allow for spaces in `@apiTag` and `@tag` when tag is surrounded by single or double quotes. (#685)
+
 ### Bug fixes
 
-* Fixed bug where `httpuv` would return a status of `500` with body `An exception occurred` if no headers were set on the response object. (#745)
+* Ignore regular comments in block parsing. (@meztez #718)
 
-* Fixed bug where all `pr_*()` returned invisibly. Now all `pr_*()` methods will print the router if displayed in the console. (#740)
+* Block parsing comments, tags and responses ordering match plumber api ordering. (#722)
 
-* Ignore regular comments in block parsing (@meztez #718)
+* Fixed bug where `httpuv` would return a status of `500` with body `An exception occurred` if no headers were set on the response object. (#745)
 
-* Block parsing comments, tags and responses ordering match plumber api ordering. (#722)
+* Fixed bug where all `pr_*()` returned invisibly. Now all `pr_*()` methods will print the router if displayed in the console. (#740)
 
 * When calling `Plumber$handle()` and defining a new `PlumberEndpoint`, `...` will be checked for invalid names. (@meztez, #677)
 
-* `/__swagger__/` now always redirect to `/__docs__/`, even when Swagger isn't the selected interface. Use `options(plumber.legacyRedirects = FALSE)` to disable this behavior. (@blairj09 #694)
+* `/__swagger__/` now always redirects to `/__docs__/`, even when Swagger isn't the selected interface. Use `options(plumber.legacyRedirects = FALSE)` to disable this behavior. (@blairj09 #694)
 
 * Fixed `available_apis()` bug where all packages printed all available APIs. (@meztez #708)
 
@@ -428,7 +428,7 @@ plumber 0.2.2
 
 plumber 0.2.1
 --------------------------------------------------------------------------------
-* Add more Roxygen documentation for exported functions
+* Add more `roxygen2` documentation for exported functions
 * Remove the warning in the README as the API seems to be stabilizing.
 
 

R/openapi-spec.R

@@ -291,7 +291,7 @@ getArgsMetadata <- function(endpoint_func) {
         error = function(cond) {NA})
     }
     # Check that it is possible to transform arg value into
-    # an example for the openAPI spec. Valid transform are
+    # an example for the OpenAPI spec. Valid transform are
     # either a logical, a numeric, a character or a list that
     # is json serializable. Otherwise set to NA.
     if (!is.logical(arg) && !is.numeric(arg) && !is.character(arg)

R/options_plumber.R

@@ -15,7 +15,8 @@
 #' that has a matching route with a trailing slash. For example, if set to `TRUE` and the
 #' GET route `/test/` existed, then a GET request of `/test?a=1` would redirect to
 #' `/test/?a=1`. Defaults to `FALSE`. This option will default to `TRUE` in a future release.}
-#' \item{`plumber.methodNotAllowed`}{Logical value which allows the router to notify that an
+#' \item{`plumber.methodNotAllowed`}{`r lifecycle::badge("experimental")`
+#' Logical value which allows the router to notify that an
 #' unavailable method was requested, but a different request method is allowed. For example,
 #' if set to `TRUE` and the GET route `/test` existed, then a POST request of `/test` would
 #' receive a 405 status and the allowed methods. Defaults to `TRUE`.}

R/plumber-step.R

@@ -166,7 +166,7 @@ getRelevantArgs <- function(args, func) {
 
 #' Plumber Endpoint
 #'
-#' Defines a terminal handler in a PLumber router.
+#' Defines a terminal handler in a Plumber router.
 #'
 #' @export
 PlumberEndpoint <- R6Class(

R/plumber.R

@@ -1017,7 +1017,7 @@ Plumber <- R6Class(
         }
       private$api_spec_handler <- api_fun
     },
-    #' @description Retrieve openAPI file
+    #' @description Retrieve OpenAPI file
     getApiSpec = function() { #FIXME: test
 
       routerSpec <- private$routerSpecificationInternal(self)
@@ -1093,12 +1093,12 @@ Plumber <- R6Class(
       warning("addGlobalProcessor has been deprecated in v0.4.0 and will be removed in a coming release. Please use `registerHook`(s) instead.")
       self$registerHooks(proc)
     },
-    #' @description Deprecated. Retrieve openAPI file
+    #' @description Deprecated. Retrieve OpenAPI file
     openAPIFile = function() {
       warning("`$openAPIFile()` has been deprecated in v1.0.0 and will be removed in a coming release. Please use `$getApiSpec()`.")
       self$getApiSpec()
     },
-    #' @description Deprecated. Retrieve openAPI file
+    #' @description Deprecated. Retrieve OpenAPI file
     swaggerFile = function() {
       warning("`$swaggerFile()` has been deprecated in v1.0.0 and will be removed in a coming release. Please use `$getApiSpec()`.")
       self$getApiSpec()

R/ui.R

@@ -21,7 +21,7 @@ mount_docs <- function(pr, host, port, docs_info, callback, quiet = FALSE) {
     )
   )
 
-  # Mount openAPI spec paths openapi.json
+  # Mount OpenAPI spec paths openapi.json
   mount_openapi(pr, api_url)
 
   # Mount Docs
@@ -71,7 +71,7 @@ unmount_docs <- function(pr, docs_info) {
     return()
   }
 
-  # Unount openAPI spec paths openapi.json
+  # Unount OpenAPI spec paths openapi.json
   unmount_openapi(pr)
 
   # Mount Docs

README.md

@@ -5,11 +5,11 @@
 [![](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/master/graph/badge.svg)](https://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/tags/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 -->
 
 Plumber allows you to create a web API by merely decorating your existing R
-source code with special comments. Take a look at an example.
+source code with `roxygen2`-like comments. Take a look at an example.
 
 ```r
 # plumber.R
@@ -40,7 +40,7 @@ function(a, b) {
 
 These comments allow `plumber` to make your R functions available as API
 endpoints. You can use either `#*` as the prefix or `#'`, but we recommend the
-former since `#'` will collide with Roxygen.
+former since `#'` will collide with `roxygen2`.
 
 ```r
 library(plumber)
@@ -95,9 +95,9 @@ remotes::install_github("rstudio/plumber")
 library(plumber)
 ```
 
-## Cheatsheet
+## Cheat Sheet
 
-<a href="https://github.com/rstudio/cheatsheets/blob/master/plumber.pdf"><img src="https://github.com/rstudio/cheatsheets/blob/master/pngs/thumbnails/plumber-cheatsheet-thumbs.png" width="630" height="252"/></a>
+<a href="https://github.com/rstudio/cheatsheets/blob/master/plumber.pdf"><img src="https://raw.githubusercontent.com/rstudio/cheatsheets/master/pngs/thumbnails/plumber-cheatsheet-thumbs.png" width="630" height="252"/></a>
 
 ## Hosting
 

cran-comments.md

@@ -1,87 +1,63 @@
 ## Comments
 
-#### 2020-9-14
+#### 2020-3-23
 
-I've fixed the urls and resubmitting.
+Bug fixes and new features.
 
-Best,
-Barret
+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
 
-#### 2020-9-14
+Please let me know if there is anything else I can provide.
 
-Flavor: r-devel-linux-x86_64-debian-gcc
-Check: CRAN incoming feasibility, Result: NOTE
-  Maintainer: 'Barret Schloerke <barret@rstudio.com>'
+Thank you,
+Barret
 
-  New maintainer:
-    Barret Schloerke <barret@rstudio.com>
-  Old maintainer(s):
-    Jeff Allen <cran@trestletech.com>
 
-  Found the following (possibly) invalid URLs:
-    URL: https://rstudio.github.io/plumber (moved to https://www.rplumber.io/)
-      From: README.md
-      Status: 200
-      Message: OK
-    URL: https://www.rstudio.com/products/connect/ (moved to https://rstudio.com/products/connect/)
-      From: README.md
-      Status: 200
-      Message: OK
+#### 2020-1-5
 
-#### 2020-9-14
+These checks have naturally resolved.
 
-This is a major version update.
+- Barret
 
-Please let me know if there is anything else I can provide.
 
-Thank you,
-Barret
+#### 2020-12-13
 
-#### 2020-9-14
+Dear maintainer,
 
-Confirmed! You may change the maintainer.
+Please see the problems shown on
+<https://cran.r-project.org/web/checks/check_results_plumber.html>.
 
-- Jeff
+Please correct before 2021-01-08 to safely retain your package on CRAN.
 
-#### 2020-9-14
-
-Hi Jeff,
+Best,
+-k
 
-I'm emailing to have a formal request to change the maintainer in `plumber` to Barret Schloerke...
-My I change `plumber`'s maintainer to Barret Schloerke?
-
-Thank you,
-Barret
 
 
 ## Test environments
 
-* local macOS, R 4.0.0
+* local macOS, R 4.0.2
 * GitHub Actions
   * macOS
     * oldrel, release, devel
   * windows
-    * oldrel, release, devel
+    * release, devel
   * ubuntu18
     * 3.4, 3.5, oldrel, release, devel
   * ubuntu16
     * 3.4, 3.5, oldrel, release, devel
+* devtools::
+  * check_win_devel()
+  * check_win_release()
+  * check_win_oldrelease()
 
 0 errors ✔ | 0 warnings ✔ | 0 notes ✔
 
-* devtools::build_win()
-  * checking CRAN incoming feasibility ... NOTE
-  Maintainer: 'Barret Schloerke <barret@rstudio.com>'
-
-  New maintainer:
-    Barret Schloerke <barret@rstudio.com>
-  Old maintainer(s):
-    Jeff Allen <cran@trestletech.com>
-Status: 1 NOTE
 
 ## revdepcheck results
 
-We checked 8 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
+We checked 13 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