From f193421b94139dda246f987ad6edfc86d5f88deb Mon Sep 17 00:00:00 2001 From: Hong Ooi Date: Thu, 31 Jul 2025 23:04:17 +1000 Subject: [PATCH 1/2] doc fix --- DESCRIPTION | 4 ++-- NEWS.md | 4 ++++ R/batch.R | 2 +- R/call_graph.R | 2 +- R/graph_login.R | 2 +- R/ms_graph.R | 2 +- man/call_batch_endpoint.Rd | 2 +- man/call_graph.Rd | 2 +- man/find_class_generator.Rd | 3 ++- man/graph_login.Rd | 2 +- man/ms_graph.Rd | 2 +- 11 files changed, 16 insertions(+), 11 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 04a517b..2c59147 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: AzureGraph Title: Simple Interface to 'Microsoft Graph' -Version: 1.3.4 +Version: 1.3.5 Authors@R: c( person("Hong", "Ooi", , "hongooi73@gmail.com", role = c("aut", "cre")), person("Microsoft", role="cph") @@ -27,4 +27,4 @@ Suggests: rmarkdown, testthat Roxygen: list(markdown=TRUE, r6=FALSE, old_usage=TRUE) -RoxygenNote: 7.1.1 +RoxygenNote: 7.3.1 diff --git a/NEWS.md b/NEWS.md index 87fc9b4..ab0c459 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# AzureGraph 1.3.5 + +- Update documentation links for CRAN + # AzureGraph 1.3.4 - Fix handling of OneDrive/SharePoint paths and other URLs that contain "#". Thanks to Jonathan Carroll (@jonocarroll). diff --git a/R/batch.R b/R/batch.R index d02c4d3..2830a49 100644 --- a/R/batch.R +++ b/R/batch.R @@ -101,7 +101,7 @@ public=list( #' Call the Graph API batch endpoint #' -#' @param token An Azure OAuth token, of class [AzureToken]. +#' @param token An Azure OAuth token, of class [AzureAuth::AzureToken]. #' @param requests A list of [graph_request] objects, representing individual requests to the Graph API. #' @param depends_on An optional named vector, or TRUE. See below. #' @param api_version The API version to use, which will form part of the URL sent to the host. diff --git a/R/call_graph.R b/R/call_graph.R index 1ca2f38..6621f82 100644 --- a/R/call_graph.R +++ b/R/call_graph.R @@ -1,6 +1,6 @@ #' Call the Microsoft Graph REST API #' -#' @param token An Azure OAuth token, of class [AzureToken]. +#' @param token An Azure OAuth token, of class [AzureAuth::AzureToken]. #' @param operation The operation to perform, which will form part of the URL path. #' @param options A named list giving the URL query parameters. #' @param api_version The API version to use, which will form part of the URL sent to the host. diff --git a/R/graph_login.R b/R/graph_login.R index f19fa41..0ec396d 100644 --- a/R/graph_login.R +++ b/R/graph_login.R @@ -18,7 +18,7 @@ #' @param ... Other arguments passed to `ms_graph$new()`. #' #' @details -#' `create_graph_login` creates a login client to authenticate with Microsoft Graph, using the supplied arguments. The authentication token is obtained using [get_azure_token], which automatically caches and reuses tokens for subsequent sessions. +#' `create_graph_login` creates a login client to authenticate with Microsoft Graph, using the supplied arguments. The authentication token is obtained using [AzureAuth::get_azure_token], which automatically caches and reuses tokens for subsequent sessions. #' #' For interactive use, you would normally _not_ supply the `username` and `password` arguments. Omitting them will prompt `create_graph_login` to authenticate you with AAD using your browser, which is the recommended method. If you don't have a browser available to your R session, for example if you're using RStudio Server or Azure Databricks, you can specify `auth_type="device_code`". #' diff --git a/R/ms_graph.R b/R/ms_graph.R index 3185a93..85b3ba2 100644 --- a/R/ms_graph.R +++ b/R/ms_graph.R @@ -34,7 +34,7 @@ #' - `password`: if `auth_type == "client_credentials"`, the app secret; if `auth_type == "resource_owner"`, your account password. #' - `username`: if `auth_type == "resource_owner"`, your username. #' - `certificate`: If `auth_type == "client_credentials", a certificate to authenticate with. This is a more secure alternative to using an app secret. -#' - `auth_type`: The OAuth authentication method to use, one of "client_credentials", "authorization_code", "device_code" or "resource_owner". See [get_azure_token] for how the default method is chosen, along with some caveats. +#' - `auth_type`: The OAuth authentication method to use, one of "client_credentials", "authorization_code", "device_code" or "resource_owner". See [AzureAuth::get_azure_token] for how the default method is chosen, along with some caveats. #' - `version`: The Azure Active Directory (AAD) version to use for authenticating. #' - `host`: your Microsoft Graph host. Defaults to `https://graph.microsoft.com/`. #' - `aad_host`: Azure Active Directory host for authentication. Defaults to `https://login.microsoftonline.com/`. Change this if you are using a government or private cloud. diff --git a/man/call_batch_endpoint.Rd b/man/call_batch_endpoint.Rd index 92d58c1..2e982ed 100644 --- a/man/call_batch_endpoint.Rd +++ b/man/call_batch_endpoint.Rd @@ -8,7 +8,7 @@ call_batch_endpoint(token, requests = list(), depends_on = NULL, api_version = getOption("azure_graph_api_version")) } \arguments{ -\item{token}{An Azure OAuth token, of class \link{AzureToken}.} +\item{token}{An Azure OAuth token, of class \link[AzureAuth:AzureToken]{AzureAuth::AzureToken}.} \item{requests}{A list of \link{graph_request} objects, representing individual requests to the Graph API.} diff --git a/man/call_graph.Rd b/man/call_graph.Rd index edcbf8b..88ef49d 100644 --- a/man/call_graph.Rd +++ b/man/call_graph.Rd @@ -14,7 +14,7 @@ call_graph_url(token, url, ..., body = NULL, encode = "json", simplify = FALSE, auto_refresh = TRUE) } \arguments{ -\item{token}{An Azure OAuth token, of class \link{AzureToken}.} +\item{token}{An Azure OAuth token, of class \link[AzureAuth:AzureToken]{AzureAuth::AzureToken}.} \item{operation}{The operation to perform, which will form part of the URL path.} diff --git a/man/find_class_generator.Rd b/man/find_class_generator.Rd index d9a3780..918b075 100644 --- a/man/find_class_generator.Rd +++ b/man/find_class_generator.Rd @@ -4,7 +4,8 @@ \alias{find_class_generator} \title{Find the R6 class for a Graph object} \usage{ -find_class_generator(props, type_filter = NULL, default_generator = ms_object) +find_class_generator(props, type_filter = NULL, + default_generator = ms_object) } \arguments{ \item{props}{A list of object properties, generally the result of a Graph API call.} diff --git a/man/graph_login.Rd b/man/graph_login.Rd index 5b0a65e..e215259 100644 --- a/man/graph_login.Rd +++ b/man/graph_login.Rd @@ -62,7 +62,7 @@ If the AzureR data directory for saving credentials does not exist, \code{get_gr Login to Azure Active Directory Graph } \details{ -\code{create_graph_login} creates a login client to authenticate with Microsoft Graph, using the supplied arguments. The authentication token is obtained using \link{get_azure_token}, which automatically caches and reuses tokens for subsequent sessions. +\code{create_graph_login} creates a login client to authenticate with Microsoft Graph, using the supplied arguments. The authentication token is obtained using \link[AzureAuth:get_azure_token]{AzureAuth::get_azure_token}, which automatically caches and reuses tokens for subsequent sessions. For interactive use, you would normally \emph{not} supply the \code{username} and \code{password} arguments. Omitting them will prompt \code{create_graph_login} to authenticate you with AAD using your browser, which is the recommended method. If you don't have a browser available to your R session, for example if you're using RStudio Server or Azure Databricks, you can specify \verb{auth_type="device_code}". diff --git a/man/ms_graph.Rd b/man/ms_graph.Rd index 068f94c..8fe41d8 100644 --- a/man/ms_graph.Rd +++ b/man/ms_graph.Rd @@ -47,7 +47,7 @@ To authenticate with the \code{ms_graph} class directly, provide the following a \item \code{password}: if \code{auth_type == "client_credentials"}, the app secret; if \code{auth_type == "resource_owner"}, your account password. \item \code{username}: if \code{auth_type == "resource_owner"}, your username. \item \code{certificate}: If `auth_type == "client_credentials", a certificate to authenticate with. This is a more secure alternative to using an app secret. -\item \code{auth_type}: The OAuth authentication method to use, one of "client_credentials", "authorization_code", "device_code" or "resource_owner". See \link{get_azure_token} for how the default method is chosen, along with some caveats. +\item \code{auth_type}: The OAuth authentication method to use, one of "client_credentials", "authorization_code", "device_code" or "resource_owner". See \link[AzureAuth:get_azure_token]{AzureAuth::get_azure_token} for how the default method is chosen, along with some caveats. \item \code{version}: The Azure Active Directory (AAD) version to use for authenticating. \item \code{host}: your Microsoft Graph host. Defaults to \verb{https://graph.microsoft.com/}. \item \code{aad_host}: Azure Active Directory host for authentication. Defaults to \verb{https://login.microsoftonline.com/}. Change this if you are using a government or private cloud. From b8fcc617f5e94c0140755d2d8a0da279c05b509a Mon Sep 17 00:00:00 2001 From: Hong Ooi Date: Thu, 31 Jul 2025 23:54:25 +1000 Subject: [PATCH 2/2] update actions --- .github/workflows/check-standard.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/check-standard.yaml b/.github/workflows/check-standard.yaml index e8626b6..3f5b2ce 100644 --- a/.github/workflows/check-standard.yaml +++ b/.github/workflows/check-standard.yaml @@ -17,14 +17,14 @@ jobs: config: - {os: windows-latest, r: 'release'} - {os: macOS-latest, r: 'release'} - - {os: ubuntu-20.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"} + - {os: ubuntu-24.04, r: 'release', rspm: "https://packagemanager.rstudio.com/cran/__linux__/focal/latest"} env: R_REMOTES_NO_ERRORS_FROM_WARNINGS: true RSPM: ${{ matrix.config.rspm }} steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 with: fetch-depth: 0 # required for mirroring, see https://stackoverflow.com/a/64272409/474349 @@ -54,11 +54,11 @@ jobs: - name: Cache R packages if: runner.os != 'Windows' - uses: actions/cache@v2 + uses: actions/cache@v3 with: path: ${{ env.R_LIBS_USER }} key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }} - restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1- + # restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-5- - name: Install system dependencies if: runner.os == 'Linux' @@ -85,7 +85,7 @@ jobs: - name: Upload check results if: failure() - uses: actions/upload-artifact@main + uses: actions/upload-artifact@v4 with: name: ${{ runner.os }}-r${{ matrix.config.r }}-results path: check