Merge pull request #11 from The-Strategy-Unit/francisbarton/issue6

Rename get token function

Author: francisbarton

DESCRIPTION

@@ -11,14 +11,18 @@ Authors@R:
 Description: Handles Azure storage authentication and basic tasks with blob
     storage.
 License: MIT + file LICENSE
-Depends: R (>= 4.1)
-Suggests: testthat (>= 3.0.0)
 Config/testthat/edition: 3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2
-Imports: 
+Depends: R (>= 4.1)
+Imports:
     AzureAuth,
     AzureRMR,
+    AzureStor,
     cli,
-    purrr
+    purrr,
+    rlang,
+    withr
+Suggests:
+    testthat (>= 3.0.0)

NAMESPACE

@@ -1,3 +1,4 @@
 # Generated by roxygen2: do not edit by hand
 
-export(get_azure_token)
+export(get_auth_token)
+export(get_container)

R/get_azure_token.R R/get_auth_token.RR/get_azure_token.R renamed to R/get_auth_token.R

@@ -39,19 +39,19 @@
 #' @examples
 #' \dontrun{
 #' # Get a token for the default resource
-#' token <- get_azure_token()
+#' token <- get_auth_token()
 #'
 #' # Get a token for a specific resource and tenant
-#' token <- get_azure_token(
+#' token <- get_auth_token(
 #'  resource = "https://graph.microsoft.com",
 #'  tenant = "my-tenant-id"
 #' )
 #'
 #' # Get a token using a specific app ID
-#' token <- get_azure_token(client_id = "my-app-id")
+#' token <- get_auth_token(client_id = "my-app-id")
 #' }
 #' @export
-get_azure_token <- function(
+get_auth_token <- function(
   resource = "https://storage.azure.com",
   managed_resource = "https://management.azure.com",
   tenant = "organizations",
@@ -117,8 +117,9 @@ get_azure_token <- function(
   }
 }
 
-#' Sub-routine for `get_azure_token()`
-#' Mainly to tidy up the code a bit
+#' Sub-routine for `get_auth_token()`
+#'
+#' Pulled out mainly to tidy up the main function code a bit
 #' @returns A string (the client ID)
 get_client_id <- function() {
   pluck_client_id <- function() {

R/get_container.R

@@ -2,11 +2,11 @@
 #'
 #' `r lifecycle::badge("experimental")`
 #' @param container_name string: name of the container
-#' @param ... arguments to be passed through to `get_azure_token()`
+#' @param ... arguments to be passed through to `get_auth_token()`
 #' @export
 get_container <- function(container_name, ...) {
   endpoint_uri <- Sys.getenv("AZ_STORAGE_EP")
-  token <- get_azure_token(...)
+  token <- get_auth_token(...)
   err_msg <- "{.fn check_val}: {.var AZ_STORAGE_EP} env var is not set"
   endpoint_uri |>
     check_val(nzchar, err_msg) |>