Address review feedback

Author: dbkegley

NAMESPACE

@@ -80,6 +80,7 @@ export(get_image)
 export(get_job)
 export(get_jobs)
 export(get_my_permission)
+export(get_oauth_credentials)
 export(get_procs)
 export(get_tag_data)
 export(get_tags)

NEWS.md

@@ -2,7 +2,7 @@
 
 ## Enhancements and fixes
 
-- Implement `connect$oauth_credentials` for interacting with Connect's
+- Implement `get_oauth_credentials()` for interacting with Connect's
   `/v1/oauth/integrations/credentials` endpoint. This endpoint allows
   content running on Posit Connect to obtain the content viewer's OAuth access token.
 

R/connect.R

@@ -787,36 +787,6 @@ Connect <- R6::R6Class(
       return(res[["schedules"]])
     },
 
-    # oauth integrations --------------------------------------------
-
-    #' @description Perform an OAuth credential exchange to obtain a
-    #' viewer's OAuth access token.
-    #' @param user_session_token The content viewer's session token. This token
-    #' can only be obtained when the content is running on a Connect server. The token
-    #' identifies the user who is viewing the content interactively on the Connect server.
-    #'
-    #' Read this value from the HTTP header: `Posit-Connect-User-Session-Token`
-    #'
-    #' For example, to read the token from a Shiny session:
-    #'     `user_session_token <- session$request$HTTP_POSIT_CONNECT_USER_SESSION_TOKEN`
-    #' or, to read the token from an inbound HTTP request with Plumbler:
-    #'     `user_session_token <- req$HTTP_POSIT_CONNECT_USER_SESSION_TOKEN`
-    oauth_credentials = function(user_session_token) {
-      url <- v1_url("oauth", "integrations", "credentials")
-      body <- c(
-        list(
-          grant_type = "urn:ietf:params:oauth:grant-type:token-exchange",
-          subject_token_type = "urn:posit:connect:user-session-token",
-          subject_token = user_session_token
-        )
-      )
-      self$POST(
-        url,
-        encode = "form",
-        body = body
-      )
-    },
-
     # misc utilities --------------------------------------------
 
     #' @description Get documentation.

R/get.R

@@ -652,3 +652,53 @@ get_procs <- function(src) {
 
   return(tbl_data)
 }
+
+#' Perform an OAuth credential exchange to obtain a viewer's OAuth access token.
+#'
+#' @param client A Connect R6 object.
+#' @param user_session_token The content viewer's session token. This token
+#' can only be obtained when the content is running on a Connect server. The token
+#' identifies the user who is viewing the content interactively on the Connect server.
+#'
+#' Read this value from the HTTP header: `Posit-Connect-User-Session-Token`
+#'
+#' @examples
+#' \dontrun{
+#' library(connectapi)
+#' library(plumber)
+#' client <- connect()
+#'
+#' #* @get /do
+#' function(req){
+#'   user_session_token <- req$HTTP_POSIT_CONNECT_USER_SESSION_TOKEN
+#'   credentials <- get_oauth_credentials(client, user_session_token)
+#'
+#'   # ... do something with `credentials$access_token` ...
+#'
+#'   "done"
+#' }
+#' }
+#'
+#' @return The OAuth credential exchange response.
+#'
+#' @details
+#' Please see https://docs.posit.co/connect/user/oauth-integrations/#obtaining-a-viewer-oauth-access-token
+#' for more information.
+#'
+#' @export
+get_oauth_credentials = function(connect, user_session_token) {
+  validate_R6_class(connect, "Connect")
+  url <- v1_url("oauth", "integrations", "credentials")
+  body <- c(
+    list(
+      grant_type = "urn:ietf:params:oauth:grant-type:token-exchange",
+      subject_token_type = "urn:posit:connect:user-session-token",
+      subject_token = user_session_token
+    )
+  )
+  connect$POST(
+    url,
+    encode = "form",
+    body = body
+  )
+}

man/PositConnect.Rd

@@ -2,7 +2,7 @@ with_mock_api({
   test_that("we can retrieve the oauth credentials", {
     con <- Connect$new(server = "https://connect.example", api_key = "fake")
     expect_true(validate_R6_class(con, "Connect"))
-    credentials <- con$oauth_credentials("user-session-token")
+    credentials <- get_oauth_credentials(con, user_session_token = "user-session-token")
     expect_equal(credentials, 
       list(
         access_token="access-token",