From dd988199dbe17d6fe6845c974481bf28e240a87c Mon Sep 17 00:00:00 2001 From: Hong Ooi Date: Mon, 6 Apr 2020 07:55:04 +1000 Subject: [PATCH] first check fixes --- .Rbuildignore | 1 + CODE_OF_CONDUCT.md | 9 ---- README.md => CONTRIBUTING.md | 28 +++++------ DESCRIPTION | 2 + R/AzureQstor.R | 1 + R/container.R | 4 +- man/queue.Rd | 94 ++++++++++++++++++++++++++++++++++++ man/storage_queue.Rd | 26 ---------- 8 files changed, 114 insertions(+), 51 deletions(-) delete mode 100644 CODE_OF_CONDUCT.md rename README.md => CONTRIBUTING.md (98%) create mode 100644 man/queue.Rd delete mode 100644 man/storage_queue.Rd diff --git a/.Rbuildignore b/.Rbuildignore index 2d43cb9..0f1083b 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -6,4 +6,5 @@ ^\.Rproj\.user$ CONTRIBUTING.md ^LICENSE\.md$ +^SECURITY\.md$ azure-pipelines.yml diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index c72a574..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,9 +0,0 @@ -# Microsoft Open Source Code of Conduct - -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). - -Resources: - -- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) -- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) -- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns diff --git a/README.md b/CONTRIBUTING.md similarity index 98% rename from README.md rename to CONTRIBUTING.md index b81a84e..8eeee9c 100644 --- a/README.md +++ b/CONTRIBUTING.md @@ -1,14 +1,14 @@ - -# Contributing - -This project welcomes contributions and suggestions. Most contributions require you to agree to a -Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us -the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. - -When you submit a pull request, a CLA bot will automatically determine whether you need to provide -a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions -provided by the bot. You will only need to do this once across all repos using our CLA. - -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). -For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or -contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + +# Contributing + +This project welcomes contributions and suggestions. Most contributions require you to agree to a +Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us +the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. + +When you submit a pull request, a CLA bot will automatically determine whether you need to provide +a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions +provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. diff --git a/DESCRIPTION b/DESCRIPTION index b26be88..251ee6d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -18,5 +18,7 @@ Imports: openssl, xml2, httr +Suggests: + testthat Roxygen: list(markdown=TRUE) RoxygenNote: 7.1.0 diff --git a/R/AzureQstor.R b/R/AzureQstor.R index a96aa3f..6f42d59 100644 --- a/R/AzureQstor.R +++ b/R/AzureQstor.R @@ -2,6 +2,7 @@ #' @import AzureRMR NULL +utils::globalVariables(c("self", "private")) .onLoad <- function(libname, pkgname) { diff --git a/R/container.R b/R/container.R index 68c4e74..9ae4ef7 100644 --- a/R/container.R +++ b/R/container.R @@ -7,8 +7,8 @@ #' @param api_version If an endpoint object is not supplied, the storage API version to use when interacting with the host. Currently defaults to `"2019-07-07"`. #' @param name The name of the queue to get, create, or delete. #' @param confirm For deleting a queue, whether to ask for confirmation. -#' @param x For the print method, a queue object. #' @param ... Further arguments passed to lower-level functions. +#' @rdname queue #' @export storage_queue <- function(endpoint, ...) { @@ -21,7 +21,7 @@ storage_queue.character <- function(endpoint, key=NULL, token=NULL, sas=NULL, api_version=getOption("azure_storage_api_version"), ...) { - do.call(storage_queue, generate_endpoint(endpoint, key, token, sas, api_version)) + do.call(storage_queue, generate_endpoint_container(endpoint, key, token, sas, api_version)) } #' @rdname queue diff --git a/man/queue.Rd b/man/queue.Rd new file mode 100644 index 0000000..3a9cc58 --- /dev/null +++ b/man/queue.Rd @@ -0,0 +1,94 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/container.R +\name{storage_queue} +\alias{storage_queue} +\alias{storage_queue.character} +\alias{storage_queue.queue_endpoint} +\alias{list_storage_queues} +\alias{list_storage_queues.character} +\alias{list_storage_queues.queue_endpoint} +\alias{list_storage_containers.queue_endpoint} +\alias{create_storage_queue} +\alias{create_storage_queue.character} +\alias{create_storage_queue.queue_endpoint} +\alias{create_storage_queue.StorageQueue} +\alias{delete_storage_queue} +\alias{delete_storage_queue.character} +\alias{delete_storage_queue.queue_endpoint} +\alias{delete_storage_queue.StorageQueue} +\title{Message queues} +\usage{ +storage_queue(endpoint, ...) + +\method{storage_queue}{character}( + endpoint, + key = NULL, + token = NULL, + sas = NULL, + api_version = getOption("azure_storage_api_version"), + ... +) + +\method{storage_queue}{queue_endpoint}(endpoint, name, ...) + +list_storage_queues(endpoint, ...) + +\method{list_storage_queues}{character}( + endpoint, + key = NULL, + token = NULL, + sas = NULL, + api_version = getOption("azure_storage_api_version"), + ... +) + +\method{list_storage_queues}{queue_endpoint}(endpoint, ...) + +\method{list_storage_containers}{queue_endpoint}(endpoint, ...) + +create_storage_queue(endpoint, ...) + +\method{create_storage_queue}{character}( + endpoint, + key = NULL, + token = NULL, + sas = NULL, + api_version = getOption("azure_storage_api_version"), + ... +) + +\method{create_storage_queue}{queue_endpoint}(endpoint, name, ...) + +\method{create_storage_queue}{StorageQueue}(endpoint, ...) + +delete_storage_queue(endpoint, ...) + +\method{delete_storage_queue}{character}( + endpoint, + key = NULL, + token = NULL, + sas = NULL, + api_version = getOption("azure_storage_api_version"), + ... +) + +\method{delete_storage_queue}{queue_endpoint}(endpoint, name, ...) + +\method{delete_storage_queue}{StorageQueue}(endpoint, confirm = TRUE, ...) +} +\arguments{ +\item{endpoint}{Either a queue endpoint object as created by \link{storage_endpoint}, or a character string giving the URL of the endpoint.} + +\item{...}{Further arguments passed to lower-level functions.} + +\item{key, token, sas}{If an endpoint object is not supplied, authentication credentials: either an access key, an Azure Active Directory (AAD) token, or a SAS, in that order of priority.} + +\item{api_version}{If an endpoint object is not supplied, the storage API version to use when interacting with the host. Currently defaults to \code{"2019-07-07"}.} + +\item{name}{The name of the queue to get, create, or delete.} + +\item{confirm}{For deleting a queue, whether to ask for confirmation.} +} +\description{ +Get, list, create, or delete queues. +} diff --git a/man/storage_queue.Rd b/man/storage_queue.Rd deleted file mode 100644 index fcbb640..0000000 --- a/man/storage_queue.Rd +++ /dev/null @@ -1,26 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/container.R -\name{storage_queue} -\alias{storage_queue} -\title{Message queues} -\usage{ -storage_queue(endpoint, ...) -} -\arguments{ -\item{endpoint}{Either a queue endpoint object as created by \link{storage_endpoint}, or a character string giving the URL of the endpoint.} - -\item{...}{Further arguments passed to lower-level functions.} - -\item{key, token, sas}{If an endpoint object is not supplied, authentication credentials: either an access key, an Azure Active Directory (AAD) token, or a SAS, in that order of priority.} - -\item{api_version}{If an endpoint object is not supplied, the storage API version to use when interacting with the host. Currently defaults to \code{"2019-07-07"}.} - -\item{name}{The name of the queue to get, create, or delete.} - -\item{confirm}{For deleting a queue, whether to ask for confirmation.} - -\item{x}{For the print method, a queue object.} -} -\description{ -Get, list, create, or delete queues. -}