feat: create, update, and delete integrations (stacked version) #440

toph-allen · 2025-08-07T21:38:20Z

Intent

Add functions to create, update, and delete integrations.

N.B. This supersedes #439, which was based on main, and did not include changes from #437.

Fixes #434

Approach

Three pretty simple functions to create, update, and delete integrations.
create_integration() takes a client.
update_integration() and delete_integration() take a connect_integration object as their first argument.
- To support this, the connect_integration class now gets a client as an attribute when it is created.
Some other simplifications where appropriate, e.g. as_integration() no longer uses method dispatch.

Checklist

Does this change update NEWS.md (referencing the connected issue if necessary)?
Does this change need documentation? Have you run devtools::document()?

…integrations

This reverts commit 1582d27.

We’re only going to be converting lists that we get from the server to integrations; we don’t need to use method dispatch here.

toph-allen · 2025-08-07T21:38:54Z

Looks like CI will not run until the parent PR is closed and this targets main.

…ypick # Conflicts: # NAMESPACE # NEWS.md # R/integrations.R # man/as_integration.Rd # man/get_associations.Rd # man/get_integration.Rd # man/get_integrations.Rd # man/set_integrations.Rd # tests/testthat/test-integrations.R

nealrichardson · 2025-08-08T12:36:05Z

R/integrations.R

+#' @param name A descriptive name to identify the integration.
+#' @param description Optional, default `NULL.` A brief description of the integration.
+#' @param template The template to use to configure this integration (e.g.,
+#'   "custom", "github", "google", "connect").


Link to API docs for where you can get a complete list of supported values?

The API docs say "See List OAuth templates for more information" — I think our idea is that people call that endpoint. I think linking to the OAuth integration docs overview here might be better right now? 🤔

Adding a get_templates() function is tracked here: #435

Sure, whatever is best. Just flagging that we should provide users with a way of knowing what the valid values here are.

nealrichardson · 2025-08-08T12:36:15Z

R/integrations.R

+#' @param template The template to use to configure this integration (e.g.,
+#'   "custom", "github", "google", "connect").
+#' @param config A list containing the configuration for the integration. The
+#'   required fields vary depending on the template selected.


Link to API docs?

tests/testthat/2025.07.0/__api__/v1/oauth/integrations/60586f1c-b90ada-PATCH.R

Co-authored-by: Neal Richardson <[email protected]>

mconflitti-pbc · 2025-08-08T13:34:32Z

tests/testthat/test-integrations.R


 with_mock_dir("2024.12.0", {
-  test_that("integration creates a single integration", {
+  test_that("get_integration() creates a single integration", {


"creates"? or just "gets"

Oh yeah lol you're exactly right, I was thinking in a different frame when I originally wrote it

joshyam-k · 2025-08-08T15:12:19Z

R/integrations.R

+      config = config
+    )
+  )
+  as_integration(result, client)


Is there a reason we're returning an actual object on a PATCH method? I wouldn't expect a function updating an integration to return the new integration object but maybe that's a reasonable side effect in the context of this package.

Yeah, the reasons are two-fold. One is that it matches the way that if you're working with local R objects, the way you update an object is to call a function on it and assign that result to something -- like:

animals <- c("cat", "dog") # update animals animals <- c(animals, "bat")

In the context of integrations and Connect, it matches the way the PATCH API works (it returns the updated object, and we're just passing it on.)

So if you imagine that in the context of a script, if I'm say, updating an integration, like giving a GitHub integration a new key, it makes sense for my local representation of that object to be updated to the new version.

client <- connect() github_integration <- get_integrations(client) |> purrr::keep(~ .x$template == "github")[[1]] github_integration <- update_integration(github_integration, config = list(key = NEW_KEY)) # Now this object will reflect the updated info. github_integration$config$key

ah, makes perfect sense. thanks!!

toph-allen · 2025-08-11T15:46:41Z

I'm going to merge this despite CI failing, since it's broken for an unrelated reason. I'll fix CI in a separate PR and won't hold this up for it.

toph-allen added 23 commits August 5, 2025 15:13

add content_get_integrations, rename content_set_integrations to set_…

4188aa9

…integrations

add tests, update function names

cc4cb98

Remove association function, update docs

940ad5a

fix accidentally committed typo in Rd

57e4bcc

Fix CI hopefully

9a2e43f

fix lint

69534b0

fix _pkgdown.yml

95bd94e

restore function to get oauth associations

97f11a2

Use method dispatch for get_integrations()

ead8571

fix tests

562c7e7

update pkgdown

9eee7cb

update documentation

5c3d170

Attempt to fix CI

1582d27

Revert "Attempt to fix CI"

d7a4095

This reverts commit 1582d27.

tidy up spillover from a future PR

5543147

add functions to create, update, and delete integrations

cccc83a

update NEWS

c4c570e

fix cherrypick issues

bb6824f

resolve expectations about clients at integration creation time

ba81b63

simplify as_integration

a3a94e5

We’re only going to be converting lists that we get from the server to integrations; we don’t need to use method dispatch here.

update docs and namespace

1487a78

remove cherrypick duplication

5fb342c

consistency and cleanup

f92670e

toph-allen requested review from joshyam-k and mconflitti-pbc August 7, 2025 21:39

toph-allen mentioned this pull request Aug 7, 2025

feat: create, update, and delete integrations #439

Closed

2 tasks

toph-allen requested review from jonkeane and nealrichardson August 7, 2025 21:42

Base automatically changed from toph/get-integrations-for-content to main August 7, 2025 21:48

nealrichardson reviewed Aug 8, 2025

View reviewed changes

Update 60586f1c-b90ada-PATCH.R

20f0c35

Co-authored-by: Neal Richardson <[email protected]>

mconflitti-pbc reviewed Aug 8, 2025

View reviewed changes

mconflitti-pbc approved these changes Aug 8, 2025

View reviewed changes

toph-allen linked an issue Aug 8, 2025 that may be closed by this pull request

Add functions to create, delete, and update integrations #434

Closed

joshyam-k reviewed Aug 8, 2025

View reviewed changes

update documentation and tests

86617bb

toph-allen force-pushed the toph/create-delete-update-integrations-cherrypick branch from 33c7499 to 86617bb Compare August 8, 2025 15:25

toph-allen added 2 commits August 8, 2025 11:31

update test name

5e68c7d

update pkgdown yaml

b6052a6

toph-allen mentioned this pull request Aug 8, 2025

Add function to get an integration template #435

Open

attempt to make CI less flaky

a2c6741

toph-allen force-pushed the toph/create-delete-update-integrations-cherrypick branch from 6ca5987 to a2c6741 Compare August 8, 2025 16:29

toph-allen added 2 commits August 8, 2025 14:51

fix CI wait function

18c8e64

update timeout time

354204e

toph-allen merged commit b3ebf76 into main Aug 11, 2025
13 of 41 checks passed

toph-allen deleted the toph/create-delete-update-integrations-cherrypick branch August 11, 2025 15:46

toph-allen mentioned this pull request Oct 16, 2025

feat: add functions to convert content lists to data frames #470

Merged

2 tasks

feat: create, update, and delete integrations (stacked version) #440

feat: create, update, and delete integrations (stacked version) #440

Uh oh!

Conversation

toph-allen commented Aug 7, 2025

Intent

Approach

Checklist

Uh oh!

toph-allen commented Aug 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

toph-allen Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

toph-allen commented Aug 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

toph-allen commented Aug 7, 2025 •

edited

Loading

toph-allen Aug 8, 2025 •

edited

Loading