Pass auth_url param through to oauth_flow_device (#331)

* Pass `auth_url` through to `oauth_flow_device()`
* Add example
* Extract out repeated example GitHub client
* Fix `oauth_flow_abort()` buglet

NAMESPACE

@@ -16,6 +16,7 @@ export("%>%")
 export(curl_help)
 export(curl_translate)
 export(default_redirect_uri)
+export(example_github_client)
 export(example_url)
 export(jwt_claim)
 export(jwt_encode_hmac)

NEWS.md

@@ -1,5 +1,11 @@
 # httr2 (development version)
 
+* `req_oauth_device()` now takes a `auth_url` parameter making it usable 
+  (#331, @taerwin).
+
+* OAuth errors containing a url now correctly display that URL 
+  (instead of just uri).
+
 * New `req_paginate()` and `paginate_req_perform()` to easily request paginated
   APIs (@mgirlich, #8).
 

R/oauth-flow-auth-code.R

@@ -39,18 +39,16 @@
 #' @returns A modified HTTP [request].
 #' @inheritParams oauth_flow_auth_code
 #' @examples
-#' client <- oauth_client(
-#'   id = "28acfec0674bb3da9f38",
-#'   secret = obfuscated(paste0(
-#'      "J9iiGmyelHltyxqrHXW41ZZPZamyUNxSX1_uKnv",
-#'      "PeinhhxET_7FfUs2X0LLKotXY2bpgOMoHRCo"
-#'   )),
-#'   token_url = "https://github.com/login/oauth/access_token",
-#'   name = "hadley-oauth-test"
-#' )
+#' req_auth_github <- function(req) {
+#'   req_oauth_auth_code(
+#'     req,
+#'     client = example_github_client(),
+#'     auth_url = "https://github.com/login/oauth/authorize"
+#'   )
+#' }
 #'
 #' request("https://api.github.com/user") %>%
-#'   req_oauth_auth_code(client, auth_url = "https://github.com/login/oauth/authorize")
+#'   req_auth_github()
 req_oauth_auth_code <- function(req, client,
                                 auth_url,
                                 cache_disk = FALSE,

R/oauth-flow-device.R

@@ -13,11 +13,17 @@
 #' @inheritParams req_oauth_auth_code
 #' @returns A modified HTTP [request].
 #' @examples
-#' client <- oauth_client("example", "https://example.com/get_token")
-#' req <- request("https://example.com")
+#' req_auth_github <- function(req) {
+#'   req_oauth_device(
+#'     req,
+#'     client = example_github_client(),
+#'     auth_url = "https://github.com/login/device/code"
+#'   )
+#' }
 #'
-#' req %>% req_oauth_device(client)
-req_oauth_device <- function(req, client,
+#' request("https://api.github.com/user") %>%
+#'   req_auth_github()
+req_oauth_device <- function(req, client, auth_url,
                              cache_disk = FALSE,
                              cache_key = NULL,
                              scope = NULL,
@@ -26,6 +32,7 @@ req_oauth_device <- function(req, client,
 
   params <- list(
     client = client,
+    auth_url = auth_url,
     scope = scope,
     auth_params = auth_params,
     token_params = token_params

R/oauth-flow.R

@@ -40,7 +40,7 @@ oauth_flow_abort <- function(error,
     c(
       "OAuth failure [{error}]",
       "*" = description,
-      i = if (!is.null(uri)) "Learn more at {.url uri}."
+      i = if (!is.null(uri)) "Learn more at {.url {uri}}."
     ),
     code = error,
     class = c(glue("httr2_oauth_{error}"), "httr2_oauth"),

R/test.R

@@ -30,14 +30,18 @@ request_pagination_test <- function(parse_resp = NULL,
 }
 
 
-#' URL to a local server that's useful for tests and examples
+#' Code for examples
 #'
-#' Requires the webfakes package to be installed. It has the following endpoints:
+#' @description
+#' `example_url()` runs a simple websever using the webfakes package with the
+#' following endpoints:
 #'
 #' * all the ones from the [webfakes::httpbin_app()]
 #' * `/iris`: paginate through the iris dataset. It has the query parameters
 #'   `page` and `limit` to control the pagination.
 #'
+#' `example_github_client()` is an OAuth client for GitHub.
+#'
 #' @keywords internal
 #' @export
 example_url <- function() {
@@ -74,3 +78,18 @@ example_url <- function() {
   )
   the$test_app$url()
 }
+
+#' @export
+#' @rdname example_url
+example_github_client <- function() {
+  # <https://github.com/settings/applications/1636322>
+  oauth_client(
+    id = "28acfec0674bb3da9f38",
+    secret = obfuscated(paste0(
+       "J9iiGmyelHltyxqrHXW41ZZPZamyUNxSX1_uKnv",
+       "PeinhhxET_7FfUs2X0LLKotXY2bpgOMoHRCo"
+    )),
+    token_url = "https://github.com/login/oauth/access_token",
+    name = "hadley-oauth-test"
+  )
+}

tests/testthat/_snaps/oauth-flow-auth-code.md

@@ -46,7 +46,7 @@
       Error in `oauth_flow_auth_code_parse()`:
       ! OAuth failure [123]
       * A bad error
-      i Learn more at <uri>.
+      i Learn more at <http://example.com>.
     Code
       oauth_flow_auth_code_parse(query3, "abc")
     Condition