Merge pull request #82 from getwilds/egs-groups

added egs for groups fxns; also reexporting magrittr pipe so its avai…

.github/workflows/R-CMD-check.yaml

@@ -64,6 +64,7 @@ jobs:
 
       - uses: r-lib/actions/check-r-package@v2
         with:
+          args: 'c("--no-examples", "--no-manual", "--as-cran")'
           upload-snapshots: true
         env:
           AWS_REGION: us-west-2

NAMESPACE

@@ -1,6 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
 S3method(print,sixtyfour_client)
+export("%>%")
 export(as_policy_arn)
 export(aws_billing)
 export(aws_billing_raw)

R/groups.R

@@ -20,10 +20,9 @@ group_list_tidy <- function(x) {
 #' if username is non-NULL, otherwise passed on to `list_users`
 #' @return A tibble with information about groups
 #' @family groups
-#' @examples \dontrun{
+#' @examplesIf aws_has_creds()
 #' aws_groups()
 #' aws_groups(username = aws_user_current())
-#' }
 aws_groups <- function(username = NULL, ...) {
   if (is.null(username)) {
     paginate_aws_marker("list_groups", "Groups", ...) %>%
@@ -48,9 +47,13 @@ aws_groups <- function(username = NULL, ...) {
 #' @details see docs <https://www.paws-r-sdk.com/docs/iam_get_group/>
 #' @autoglobal
 #' @family groups
-#' @examples \dontrun{
-#' aws_group(name = "users")
-#' }
+#' @examplesIf aws_has_creds()
+#' # create a group
+#' aws_group_create("testing")
+#' # get the group
+#' aws_group(name = "testing")
+#' # cleanup
+#' aws_group_delete(name = "testing")
 aws_group <- function(name) {
   x <- con_iam()$get_group(name)
   list(
@@ -63,18 +66,21 @@ aws_group <- function(name) {
 
 #' Check if a group exists
 #'
+#' @importFrom purrr safely
 #' @export
 #' @param name (character) the group name
 #' @return a single boolean
 #' @details uses `aws_group` internally. see docs
 #' <https://www.paws-r-sdk.com/docs/iam_get_group/>
 #' @family groups
-#' @examples \dontrun{
-#' aws_group_exists(name = "users")
-#' aws_group_exists(name = "apples")
-#' }
+#' @examplesIf aws_has_creds()
+#' aws_group_create("apples")
+#' aws_group_exists("apples")
+#' aws_group_exists("doesnotexist")
+#' # cleanup
+#' aws_group_delete("apples")
 aws_group_exists <- function(name) {
-  check_aws_group <- purrr::safely(aws_group, otherwise = FALSE)
+  check_aws_group <- safely(aws_group, otherwise = FALSE)
   is.null(check_aws_group(name)$error)
 }
 
@@ -88,9 +94,11 @@ aws_group_exists <- function(name) {
 #' @details See <https://www.paws-r-sdk.com/docs/iam_create_group/>
 #' docs for details on the parameters
 #' @family groups
-#' @examples \dontrun{
-#' aws_group_create("testgroup")
-#' }
+#' @examplesIf aws_has_creds()
+#' aws_group_create("testingagroup")
+#' aws_group("testingagroup")
+#' # cleanup
+#' aws_group_delete("testingagroup")
 aws_group_create <- function(name, path = NULL) {
   con_iam()$create_group(Path = path, GroupName = name) %>%
     group_list_tidy()
@@ -104,9 +112,9 @@ aws_group_create <- function(name, path = NULL) {
 #' @details See <https://www.paws-r-sdk.com/docs/iam_delete_group/>
 #' docs for more details
 #' @family groups
-#' @examples \dontrun{
-#' aws_group_delete(name = "testgroup")
-#' }
+#' @examplesIf aws_has_creds()
+#' aws_group_create("somegroup")
+#' aws_group_delete("somegroup")
 aws_group_delete <- function(name) {
   con_iam()$delete_group(name)
 }

R/reexport-magrittr.R

@@ -0,0 +1,3 @@
+#' @importFrom magrittr %>%
+#' @export
+magrittr::`%>%`