R Client for 'Confluence' API

Description

Provides utilities for working with various 'Confluence' API <https://docs.atlassian.com/ConfluenceServer/rest/latest/>, including a functionality to convert an R Markdown document to 'Confluence' format and upload it to 'Confluence' automatically.

Author(s)

Maintainer: Hiroaki Yutani hiroaki.yutani@linecorp.com

Other contributors:

• LINE Corporation [copyright holder]

See Also

Useful links:

• https://line.github.io/conflr/

• https://github.com/line/conflr

• Report bugs at https://github.com/line/conflr/issues

CRUD Operations for Attachments on Content

Description

CRUD Operations for Attachments on Content

Usage

confl_list_attachments(
  id,
  filename = NULL,
  mediaType = NULL,
  start = 0,
  limit = 50,
  expand = NULL
)

confl_post_attachment(id, path)

confl_update_attachment_metadata(id, attachmentId, ...)

confl_update_attachment_data(id, attachmentId, path, ...)

Arguments

Value

The API response as a list.

Examples

## Not run: 
# Create a dummy text file
tmp_txt <- tempfile(fileext = ".txt")
cat("foo", file = tmp_txt)

# Upload the file to a page whose ID is "123"
confl_post_attachment("123", tmp_txt)

# Confirm the file is attatched to the page
result <- confl_list_attachments("123", filename = basename(tmp_txt))
length(result$results) # should be 1

## End(Not run)

REST Wrapper for the ContentService

Description

REST Wrapper for the ContentService

Usage

confl_list_pages(
  type = c("page", "blogpost", "comment", "attachment"),
  limit = 10,
  start = 0,
  spaceKey = NULL,
  title = NULL,
  expand = NULL
)

confl_get_page(id, expand = "body.storage")

confl_post_page(
  type = c("page", "blogpost"),
  spaceKey,
  title,
  body,
  ancestors = NULL
)

confl_update_page(id, title, body)

confl_delete_page(id)

Arguments

Value

The API response as a list.

See Also

https://docs.atlassian.com/ConfluenceServer/rest/latest/

Examples

## Not run: 
# Create a page titled "title1" on a space named "space1"
result <- confl_post_page(
  type = "page",
  spaceKey = "space1",
  title = "title1",
  body = "<h2>example</h2><p>This is example</p>"
)

# Jump to the result page
browseURL(paste0(result$`_links`$base, result$`_links`$webui))

# List pages under space "space1" up to 10 pages
confl_list_pages(spaceKey = "space1")

## End(Not run)

Converts between content body representations

Description

Converts between content body representations

Usage

confl_contentbody_convert(
  x,
  from = c("wiki", "storage", "editor", "view", "export_view", "styled_view"),
  to = c("storage", "editor", "view", "export_view", "styled_view")
)

Arguments

Value

The API response as a list.

See Also

https://docs.atlassian.com/ConfluenceServer/rest/latest/

Examples

## Not run: 
# Convert to a Math macro
confl_contentbody_convert("\\[1+1=2\\]")

# Convert to an Expand macro
confl_contentbody_convert("{expand}detail is here {expand}")

## End(Not run)

Publish R Markdown Document to 'Confluence'

Description

Knit and post a given R Markdown file to 'Confluence'.

Usage

confl_create_post_from_Rmd(Rmd_file, interactive = NULL, params = NULL, ...)

confluence_document(
  title = NULL,
  space_key = NULL,
  parent_id = NULL,
  type = c("page", "blogpost"),
  toc = FALSE,
  toc_depth = 7,
  code_folding = c("none", "hide"),
  supported_syntax_highlighting = getOption("conflr_supported_syntax_highlighting"),
  update = NULL,
  use_original_size = FALSE,
  interactive = NULL
)

Arguments

Details

All options of confluence_document() can also be specified via the argument of confl_create_post_from_Rmd. If an option is specified on both, the one given as an argument will be used.

---
title: "title1"
output:
  confluence_document:
    space_key: "space1"
    parent_id: 1234
    toc: TRUE
    toc_depth: 4
    code_folding: hide
    supported_syntax_highlighting:
      r: r
      foo: bar
    update: true
    use_original_size: true
---

...

Value

confl_create_post_from_Rmd() returns the URL of the published page.

confluence_document() returns an rmarkdown_output_format object.

Examples

example_Rmd <- system.file("extdata/example.Rmd", package = "conflr")

## Not run: 
# Convert an R Markdown document into a 'Confluence' page interactively
confl_create_post_from_Rmd(example_Rmd)

# You can override most of the parameters of confluence_document()
confl_create_post_from_Rmd(example_Rmd, space = "space1", toc = TRUE)

## End(Not run)

## Not run: 
# A custom R markdown format that can be passed to rmarkdown::render()
format <- confluence_document(space_key = "space1")
rmarkdown::render(system.file("extdata/example.Rmd", package = "conflr"), format)

## End(Not run)

REST Wrapper for the SpaceService

Description

REST Wrapper for the SpaceService

Usage

confl_list_spaces(
  spaceKey = NULL,
  type = c("global", "personal"),
  status = c("current", "archived"),
  label = NULL,
  favourite = NULL,
  expand = NULL,
  start = NULL,
  limit = 25
)

confl_get_space(spaceKey, expand = NULL)

Arguments

Value

The API response as a list.

Examples

## Not run: 
# Get the information of a space named "space1"
confl_get_space("space1")

## End(Not run)

Non-admin User Operations

Description

Non-admin User Operations

Usage

confl_get_user(key = NULL, username = NULL, expand = NULL)

confl_get_current_user(expand = NULL)

Arguments

Value

The API response as a list.

Examples

## Not run: 
# Get the information of the current user
my_user <- confl_get_current_user()

# Show display name
my_user$displayName

# Get the information of a user whose name is "user1"
other_user <- confl_get_user(username = "user1")

## End(Not run)