Merge pull request #183 from rstudio/v0.1.3-rc

V0.1.3 rc

Author: colearendt

.github/CODE_OF_CONDUCT.md

@@ -59,7 +59,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at codeofconduct@rstudio.com. 
+reported to the community leaders responsible for enforcement at codeofconduct@posit.co. 
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

.github/CONTRIBUTING.md

@@ -4,6 +4,16 @@ This outlines how to propose a change to connectapi.
 For more detailed info about contributing to this, and other tidyverse packages, please see the
 [**development contributing guide**](https://rstd.io/tidy-contrib). 
 
+## Testing
+
+- Most tests can be run using `testthat`
+- If you are using an x86 Mac or another system with `docker` and `docker-compose` installed, then
+you can also use our inbuilt integration testing locally:
+```
+connectapi:::build_test_env()
+```
+- Then the integration test suite should run with `devtools::test()`
+
 ## Fixing typos
 
 You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the _source_ file. 

.github/local/run_tests.R

@@ -1,6 +1,6 @@
 options(
   "repos" = c(
-    RSPM = "https://packagemanager.rstudio.com/cran/__linux__/bionic/latest"
+    RSPM = "https://packagemanager.posit.co/cran/__linux__/bionic/latest"
     )
   )
 install.packages("devtools")

.github/workflows/pr-commands.yaml

@@ -7,6 +7,53 @@ on:
 name: Commands
 
 jobs:
+  update_snapshot:
+    if: ${{ github.event.issue.pull_request && (github.event.comment.author_association == 'MEMBER' || github.event.comment.author_association == 'OWNER') && startsWith(github.event.comment.body, '/snapshot') }}
+    name: snapshot
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+      RSC_VERSION: 2022.09.0
+      RSC_LICENSE: ${{ secrets.RSC_LICENSE }}
+      CONNECTAPI_INTEGRATED: true
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::covr, local::.
+          needs: coverage
+
+      - name: Setup test environment
+        run: |
+          connectapi:::build_test_env()
+        shell: Rscript {0}
+
+      - uses: r-lib/actions/check-r-package@v2
+
+      - name: Accept Snapshots
+        run: |
+          testthat::snapshot_accept(path = "tests/testthat")
+          testthat::snapshot_accept(path = "tests/integrated")
+
+      - name: Commit results
+        run: |
+          set -xe
+          git config --local user.name "$GITHUB_ACTOR"
+          git config --local user.email "[email protected]"
+          git commit tests/**/_snaps || echo "No changes to commit"
+
+      - uses: r-lib/actions/pr-push@v2
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+
   document:
     if: ${{ github.event.issue.pull_request && (github.event.comment.author_association == 'MEMBER' || github.event.comment.author_association == 'OWNER') && startsWith(github.event.comment.body, '/document') }}
     name: document

DESCRIPTION

@@ -1,22 +1,22 @@
 Type: Package
 Package: connectapi
-Title: Utilities for Interacting with the 'RStudio Connect' Server API
-Version: 0.1.2.9000
+Title: Utilities for Interacting with the 'Posit Connect' Server API
+Version: 0.1.3.9000
 Authors@R: 
     c(person(given = "Sean",
              family = "Lopp",
              role = c("aut")),
       person(given = "Cole",
              family = "Arendt",
              role = c("aut", "cre"),
-             email = "cole@rstudio.com"),
-      person(given = "RStudio PBC",
+             email = "cole@posit.co"),
+      person(given = "Posit, PBC",
              role = c("cph", "fnd")))
 Description: Provides a helpful 'R6' class and methods for interacting with 
-    the 'RStudio Connect' Server API along with some meaningful utility functions
-    for regular tasks. API documentation varies by 'RStudio Connect' installation
+    the 'Posit Connect' Server API along with some meaningful utility functions
+    for regular tasks. API documentation varies by 'Posit Connect' installation
     and version, but the latest documentation is also hosted publicly at 
-    <https://docs.rstudio.com/connect/api/>.
+    <https://docs.posit.co/connect/api/>.
 License: MIT + file LICENSE
 URL: https://github.com/rstudio/connectapi
 Imports: 
@@ -61,5 +61,5 @@ RdMacros:
     lifecycle
 Encoding: UTF-8
 Language: en-US
-RoxygenNote: 7.2.1
+RoxygenNote: 7.2.3
 Roxygen: list(markdown = TRUE)

LICENSE

@@ -1,2 +1,2 @@
 YEAR: 2022
-COPYRIGHT HOLDER: RStudio PBC
+COPYRIGHT HOLDER: Posit Software, PBC

LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2022 RStudio PBC
+Copyright (c) 2022 Posit Software, PBC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

NEWS.md

@@ -1,5 +1,15 @@
 # connectapi (development version)
 
+# connectapi 0.1.3.1
+
+- Fix generated documentation HTML for CRAN submission
+
+# connectapi 0.1.3
+
+- Rebrand RStudio to Posit
+  - `RStudioConnect` documentation is now at `PositConnect`
+- Fix `purrr` deprecated changes
+
 # connectapi 0.1.2
 
 - Update docs to illustrate customizing HTTP requests

R/connect.R

@@ -1,6 +1,6 @@
 #' Class representing a Connect API client
 #'
-#' @name RStudioConnect
+#' @name PositConnect
 #'
 #' @section Usage:
 #' \preformatted{
@@ -51,9 +51,9 @@ Connect <- R6::R6Class(
     # helpers ----------------------------------------------------------
 
     print = function(...) {
-      cat("RStudio Connect API Client: \n")
-      cat("  RStudio Connect Server: ", self$server, "\n", sep = "")
-      cat("  RStudio Connect API Key: ", paste0(strrep("*", 11), substr(self$api_key, nchar(self$api_key) - 3, nchar(self$api_key))), "\n", sep = "")
+      cat("Posit Connect API Client: \n")
+      cat("  Posit Connect Server: ", self$server, "\n", sep = "")
+      cat("  Posit Connect API Key: ", paste0(strrep("*", 11), substr(self$api_key, nchar(self$api_key) - 3, nchar(self$api_key))), "\n", sep = "")
       # TODO: something about API key... role... ?
       # TODO: point to docs on methods... how to see methods?
       cat("\n")
@@ -742,22 +742,22 @@ Connect <- R6::R6Class(
   )
 )
 
-#' Create a connection to RStudio Connect
+#' Create a connection to Posit Connect
 #'
-#' Creates a connection to RStudio Connect using the server URL and an api key.
+#' Creates a connection to Posit Connect using the server URL and an api key.
 #' Validates the connection and checks that the version of the server is
 #' compatible with the current version of the package.
 #'
-#' @param server The URL for accessing RStudio Connect. Defaults to environment
+#' @param server The URL for accessing Posit Connect. Defaults to environment
 #'   variable CONNECT_SERVER
-#' @param api_key The API Key to authenticate to RStudio Connect with. Defaults
+#' @param api_key The API Key to authenticate to Posit Connect with. Defaults
 #'   to environment variable CONNECT_API_KEY
 #' @param prefix The prefix used to determine environment variables
 #' @param ... Additional arguments. Not used at present
 #' @param .check_is_fatal Whether to fail if "check" requests fail. Useful in
 #'   rare cases where more http request customization is needed for requests to
 #'   succeed.
-#' @return An RStudio Connect R6 object that can be passed along to methods
+#' @return A Posit Connect R6 object that can be passed along to methods
 #'
 #' @rdname connect
 #'

R/content.R

@@ -9,7 +9,7 @@ Content <- R6::R6Class(
   public = list(
     #' @field connect An R6 Connect object
     connect = NULL,
-    #' @field content The content details from RStudio Connect
+    #' @field content The content details from Posit Connect
     content = NULL,
 
     initialize = function(connect, content) {
@@ -224,7 +224,7 @@ Content <- R6::R6Class(
       )
     },
     print = function(...) {
-      cat("RStudio Connect Content: \n")
+      cat("Posit Connect Content: \n")
       cat("  Content GUID: ", self$get_content()$guid, "\n", sep = "")
       cat("  Content URL: ", dashboard_url_chr(self$get_connect()$server, self$get_content()$guid), "\n", sep = "")
       cat("  Content Title: ", self$get_content()$title, "\n", sep = "")
@@ -491,7 +491,7 @@ content_ensure <- function(connect, name = uuid::UUIDgenerate(), title = name, g
 #' Get Jobs
 #'
 #' \lifecycle{experimental} Retrieve details about jobs associated with a `content_item`.
-#' "Jobs" in RStudio Connect are content executions
+#' "Jobs" in Posit Connect are content executions
 #'
 #' @param content A Content object, as returned by `content_item()`
 #' @param key The key for a job
@@ -533,7 +533,7 @@ get_job <- function(content, key) {
 #' - PAM is the authentication method
 #' - `Applications.RunAsCurrentUser` is enabled on the server
 #'
-#' Also worth noting that the `run_as` user must exist on the RStudio Connect
+#' Also worth noting that the `run_as` user must exist on the Posit Connect
 #' server (as a linux user) and have appropriate group memberships, or you will
 #' get a `400: Bad Request`. Set to `NULL` to use the default RunAs user / unset
 #' any current configuration.
@@ -597,7 +597,7 @@ content_delete <- function(content, force=FALSE) {
 #'
 #' Update settings for a content item. For a list of all settings, see the
 #' [latest
-#' documentation](https://docs.rstudio.com/connect/api/#patch-/v1/content/{guid})
+#' documentation](https://docs.posit.co/connect/api/#patch-/v1/content/{guid})
 #' or the documentation for your server via `connectapi::browse_api_docs()`.
 #'
 #' Popular selections are `content_update(access_type="all")`,
@@ -609,7 +609,7 @@ content_delete <- function(content, force=FALSE) {
 #' - `content_update_owner()` is a helper to make it easier to change owner
 #'
 #' @param content An R6 content item
-#' @param ... Settings up update that are passed along to RStudio Connect
+#' @param ... Settings up update that are passed along to Posit Connect
 #' @param access_type One of "all", "logged_in", or "acl"
 #' @param owner_guid The GUID of a user who is a publisher, so that they can
 #'   become the new owner of the content
@@ -646,7 +646,7 @@ content_update_owner <- function(content, owner_guid) {
 
 #' Verify Content Name
 #'
-#' Ensures that a content name fits the specifications / requirements of RStudio
+#' Ensures that a content name fits the specifications / requirements of Posit
 #' Connect. Throws an error if content name is invalid. Content names (as of the
 #' time of writing) must be between 3 and 64 alphanumeric characters, dashes,
 #' and underscores

R/deploy.R

@@ -22,7 +22,7 @@ Bundle <- R6::R6Class(
     },
 
     print = function(...) {
-      cat("RStudio Connect Bundle: \n")
+      cat("Posit Connect Bundle: \n")
       cat("  Path: ", self$path, "\n", sep = "")
       cat("  Size: ", capture.output(self$size), "\n", sep = "")
       cat("\n")
@@ -69,7 +69,7 @@ Task <- R6::R6Class(
       self$data
     },
     print = function(...) {
-      cat("RStudio Connect Task: \n")
+      cat("Posit Connect Task: \n")
       cat("  Task ID: ", self$get_task()$task_id, "\n", sep = "")
       cat("\n")
       invisible(self)
@@ -109,7 +109,7 @@ ContentTask <- R6::R6Class(
       self$data
     },
     print = function(...) {
-      cat("RStudio Connect Content Task: \n")
+      cat("Posit Connect Content Task: \n")
       cat("  Content GUID: ", self$get_content()$guid, "\n", sep = "")
       cat("  URL: ", dashboard_url_chr(self$get_connect()$server, self$get_content()$guid), "\n", sep = "")
       cat("  Task ID: ", self$get_task()$task_id, "\n", sep = "")
@@ -143,7 +143,7 @@ Vanity <- R6::R6Class(
     },
 
     print = function(...) {
-      cat("RStudio Connect Content Vanity URL: \n")
+      cat("Posit Connect Content Vanity URL: \n")
       cat("  Content GUID: ", self$get_content()$guid, "\n", sep = "")
       cat("  Vanity URL: ", self$get_vanity()$path, "\n", sep = "")
       cat("\n")
@@ -291,7 +291,7 @@ download_bundle <- function(content, filename = fs::file_temp(pattern = "bundle"
 
 #' Deploy a bundle
 #'
-#' Deploys a bundle (tarball) to an RStudio Connect server. If not provided,
+#' Deploys a bundle (tarball) to an Posit Connect server. If not provided,
 #' `name` (a unique identifier) will be an auto-generated alphabetic string. If
 #' deploying to an existing endpoint, you can set `name` or `guid` to the
 #' desired content.