Add examples (7 of 9 must be in a \dontrun{})

R/AuthState-class.R

@@ -16,6 +16,13 @@
 #'
 #' @return An object of class [AuthState].
 #' @export
+#' @examples
+#' init_AuthState(
+#'   package = "mypkg",
+#'   app = gargle_app(),
+#'   api_key = gargle_api_key(),
+#'   auth_active = TRUE
+#' )
 ## FIXME(jennybc): Analogous functions for the Gargle2.0 class default to the
 ## gargle oauth app. Should we do same in both places? If so, which way?
 ## Default to gargle app or have no default?

R/Gargle-class.R

@@ -25,6 +25,10 @@
 #'   Not used.
 #' @return An object of class [Gargle2.0], either new or loaded from the cache.
 #' @export
+#' @examples
+#' \dontrun{
+#' gargle2.0_token()
+#' }
 gargle2.0_token <- function(email = gargle_oauth_email(),
                             app = gargle_app(),
                             package = "gargle",

R/credential-function-registry.R

@@ -25,6 +25,9 @@ gargle_env$cred_funs <- list()
 #'
 #' @param f A function to check.
 #' @keywords internal
+#' @example
+#' f <- function(scopes, ...) {}
+#' is_cred_fun(f)
 is_cred_fun <- function(f) {
   if (!is.function(f)) {
     return(FALSE)

R/credentials_app_default.R

@@ -30,6 +30,10 @@
 #'   [`httr::Token2.0`][httr::Token-class] or `NULL`.
 #' @family credential functions
 #' @export
+#' @examples
+#' \dontrun{
+#' credentials_app_default()
+#' }
 credentials_app_default <- function(scopes = NULL, ...) {
   cat_line("trying credentials_app_default()")
   # In general, application default credentials only include the cloud-platform

R/credentials_gce.R

@@ -10,6 +10,10 @@
 #' @return A [GceToken()] or `NULL`.
 #' @family credential functions
 #' @export
+#' @examples
+#' \dontrun{
+#' credentials_gce()
+#' }
 credentials_gce <- function(scopes = NULL, service_account = "default", ...) {
   cat_line("trying credentials_gce()")
   if (!detect_gce() || is.null(scopes)) {

R/gargle-api-key.R

@@ -11,6 +11,7 @@
 #' @return A Google API key
 #' @export
 #' @examples
+#' \dontrun{
 #' ## see the key
 #' gargle_api_key()
 #'
@@ -30,6 +31,7 @@
 #' resp <- request_make(req)
 #' out <- response_process(resp)
 #' vapply(out$results, function(x) x$name, character(1))
+#' }
 gargle_api_key <- function() {
   paste0(
     "AIzaSyDXic",

R/request-make.R

@@ -17,6 +17,15 @@
 #' @return Object of class `response` from [httr].
 #' @export
 #' @family requests and responses
+#' @examples
+#' \dontrun{
+#' req <- gargle::request_build(
+#'   method = "GET",
+#'   path = "path/to/the/resource",
+#'   token = "PRETEND_I_AM_TOKEN"
+#' )
+#' gargle::request_make(req)
+#' }
 request_make <- function(x, ..., user_agent = gargle_user_agent()) {
   stopifnot(is.character(x$method))
   method <- switch(

R/response_process.R

@@ -38,6 +38,31 @@
 #'   content) is a special case returning `TRUE`.
 #' @family requests and responses
 #' @export
+#' @examples
+#' \dontrun{
+#' # get an OAuth2 token with 'userinfo.email' scope
+#' token <- token_fetch(scopes = "https://www.googleapis.com/auth/userinfo.email")
+#'
+#' # see the email associated with this token
+#' req <- gargle::request_build(
+#'   method = "GET",
+#'   path = "v1/userinfo",
+#'   token = token,
+#'   base_url = "https://openidconnect.googleapis.com"
+#' )
+#' resp <- gargle::request_make(req)
+#' response_process(resp)
+#'
+#' # make a bad request (this token has incorrect scope)
+#' req <- gargle::request_build(
+#'   method = "GET",
+#'   path = "fitness/v1/users/{userId}/dataSources",
+#'   token = token,
+#'   params = list(userId = 12345)
+#' )
+#' resp <- gargle::request_make(req)
+#' response_process(resp)
+#' }
 response_process <- function(resp, error_message = gargle_error_message) {
   code <- httr::status_code(resp)
 

R/token-fetch.R

@@ -14,6 +14,10 @@
 #' @return An [`httr::Token`][httr::Token-class] or `NULL`.
 #' @family credential functions
 #' @export
+#' @examples
+#' \dontrun{
+#' token_fetch(scopes = "https://www.googleapis.com/auth/userinfo.email")
+#' }
 token_fetch <- function(scopes = NULL, ...) {
   cat_line("trying token_fetch()")
   for (f in gargle_env$cred_funs) {