foo
") 22 | } 23 | ) 24 | 25 | args <- mockery::mock_args(m)[[1]] 26 | expect_equal(args$body, list( 27 | type = "page", 28 | title = "title", 29 | space = list( 30 | key = "space1" 31 | ), 32 | body = list( 33 | storage = list( 34 | value = "foo
", 35 | representation = "storage" 36 | ) 37 | ) 38 | )) 39 | }) 40 | 41 | test_that("confl_update_page() works", { 42 | skip_on_cran() 43 | 44 | res <- structure(list(status_code = 200), class = "response") 45 | m <- mockery::mock(res) 46 | info <- list(version = list(number = 11L), type = "page") 47 | m2 <- mockery::mock(info) 48 | 49 | with_mock( 50 | "conflr::confl_verb" = m, 51 | "conflr::confl_get_page" = m2, 52 | "httr::content" = function(res) NULL, 53 | { 54 | confl_update_page("1234", "title", "foo
") 55 | } 56 | ) 57 | args <- mockery::mock_args(m)[[1]] 58 | expect_equal(args$body, list( 59 | type = "page", 60 | title = "title", 61 | body = list( 62 | storage = list( 63 | value = "foo
", 64 | representation = "storage" 65 | ) 66 | ), 67 | version = list( 68 | number = 12L, 69 | minorEdit = FALSE 70 | ) 71 | )) 72 | }) 73 | -------------------------------------------------------------------------------- /man/confl_attachment.Rd: -------------------------------------------------------------------------------- 1 | % Generated by roxygen2: do not edit by hand 2 | % Please edit documentation in R/attachment.R 3 | \name{confl_attachment} 4 | \alias{confl_attachment} 5 | \alias{confl_list_attachments} 6 | \alias{confl_post_attachment} 7 | \alias{confl_update_attachment_metadata} 8 | \alias{confl_update_attachment_data} 9 | \title{CRUD Operations for Attachments on Content} 10 | \usage{ 11 | confl_list_attachments( 12 | id, 13 | filename = NULL, 14 | mediaType = NULL, 15 | start = 0, 16 | limit = 50, 17 | expand = NULL 18 | ) 19 | 20 | confl_post_attachment(id, path, minor_edit = FALSE) 21 | 22 | confl_update_attachment_metadata(id, attachmentId, ...) 23 | 24 | confl_update_attachment_data(id, attachmentId, path, ..., minor_edit = FALSE) 25 | } 26 | \arguments{ 27 | \item{id}{The ID of a page that attachments belong to.} 28 | 29 | \item{filename}{Filter parameter to return only the Attachment with the matching file name. Optional.} 30 | 31 | \item{mediaType}{Filter parameter to return only Attachments with a matching Media-Type. Optional.} 32 | 33 | \item{start}{The start point of the collection to return.} 34 | 35 | \item{limit}{The limit of the number of items to return, this may be restricted by fixed system limits.} 36 | 37 | \item{expand}{A comma separated list of properties to expand. To refer the nested 38 | contents, use periods. (e.g. \verb{body.storage,history}).} 39 | 40 | \item{path}{Path to a file to upload.} 41 | 42 | \item{minor_edit}{If \code{TRUE}, will mark the \code{update} as a minor edit not notifying watchers.} 43 | 44 | \item{attachmentId}{The ID of an attachment.} 45 | 46 | \item{...}{Other arguments passed to 'query'.} 47 | } 48 | \value{ 49 | The API response as a list. 50 | } 51 | \description{ 52 | CRUD Operations for Attachments on Content 53 | } 54 | \examples{ 55 | \dontrun{ 56 | # Create a dummy text file 57 | tmp_txt <- tempfile(fileext = ".txt") 58 | cat("foo", file = tmp_txt) 59 | 60 | # Upload the file to a page whose ID is "123" 61 | confl_post_attachment("123", tmp_txt) 62 | 63 | # Confirm the file is attatched to the page 64 | result <- confl_list_attachments("123", filename = basename(tmp_txt)) 65 | length(result$results) # should be 1 66 | } 67 | 68 | } 69 | -------------------------------------------------------------------------------- /tests/testthat/test-render.R: -------------------------------------------------------------------------------- 1 | # Copyright (C) 2019 LINE Corporation 2 | # 3 | # conflr is free software; you can redistribute it and/or modify it under the 4 | # terms of the GNU General Public License as published by the Free Software 5 | # Foundation, version 3. 6 | # 7 | # conflr is distributed in the hope that it will be useful, but WITHOUT ANY 8 | # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 9 | # A PARTICULAR PURPOSE. SeeThis is example
" 71 | ) 72 | 73 | # Jump to the result page 74 | browseURL(paste0(result$`_links`$base, result$`_links`$webui)) 75 | 76 | # List pages under space "space1" up to 10 pages 77 | confl_list_pages(spaceKey = "space1") 78 | } 79 | 80 | } 81 | \seealso{ 82 | \url{https://docs.atlassian.com/ConfluenceServer/rest/latest/} 83 | } 84 | -------------------------------------------------------------------------------- /NEWS.md: -------------------------------------------------------------------------------- 1 | # conflr (development version) 2 | 3 | * New `minor_edit` parameter (default to `FALSE`) in the YAML front 4 | matter to skip sending notifications on page or attachment updates 5 | to watchers (#20, #107 @daroczig, #108). 6 | 7 | * New helper functions with the `confl_macro` prefix to generate HTML 8 | tags for the following Confluence macros: Table of Contents, Jira 9 | ticket references, Expand and Excerpt blocks (#111 @daroczig). 10 | 11 | * Add an experimental support for tabset (#113). 12 | 13 | # conflr 0.1.1 14 | 15 | * A maintainance relase to fix errors on CRAN check. 16 | 17 | # conflr 0.1.0 18 | 19 | * First CRAN release. 20 | 21 | ## Major changes 22 | 23 | * conflr now works outside RStudio (e.g. Emacs/Vim) (#10). 24 | 25 | * conflr now fits batch/console uses; you can either 26 | 1. run `confl_create_post_from_Rmd()` with `interactive = FALSE` so that it 27 | doesn't show Shiny popups (#32, @ndiquattro). 28 | 2. set `output: conflr::confluence_document` in the YAML front matter of the 29 | R Markdown file, and run `rmarkdown::render()` (#44, @kazutan / #80). 30 | 31 | ``` md 32 | --- 33 | title: "I love Confluence" 34 | output: 35 | conflr::confluence_document: 36 | space_key: "space1" 37 | --- 38 | ``` 39 | 40 | * conflr provides several new options: 41 | * "Use original image sizes" option controls whether to resize the image 42 | (default) or not (#21). 43 | * "TOC" option adds a table of contents and "TOC depth" option changes the 44 | max level of headers to include (#67). 45 | * "Fold code blocks" option controls whether to fold codes (default) or not 46 | (#81). 47 | 48 | ### Minor changes 49 | 50 | * `confl_create_post_from_Rmd()` gets `params` argument for parameterized R 51 | Markdown (#37, @ellisvalentiner). 52 | 53 | * External images are now converted properly (#39). 54 | 55 | * Add an option `conflr_addin_clear_password_after_success` not to cache the 56 | password as envvars. (#41 and #48, @Curycu). 57 | 58 | * A new function `confl_contentbody_convert()` converts the Confluence-related 59 | formats by using the Confluence REST API (#58). 60 | 61 | * `confl_post_page()` and `confl_update_page()` no longer translate the 62 | Confluence macros automatically. Accordingly, they lose `image_size_default` 63 | and `supported_syntax_highlighting` arguments (#76). 64 | 65 | * `confl_create_post_from_Rmd()` now handles documents containing Confluence 66 | macro tags (i.e. `
46 |
92 |
This is example
" 42 | #' ) 43 | #' 44 | #' # Jump to the result page 45 | #' browseURL(paste0(result$`_links`$base, result$`_links`$webui)) 46 | #' 47 | #' # List pages under space "space1" up to 10 pages 48 | #' confl_list_pages(spaceKey = "space1") 49 | #' } 50 | #' 51 | #' @export 52 | confl_list_pages <- function(type = c("page", "blogpost", "comment", "attachment"), 53 | limit = 10, 54 | start = 0, 55 | spaceKey = NULL, 56 | title = NULL, 57 | expand = NULL) { 58 | type <- arg_match(type) 59 | query <- list(type = type, limit = limit, start = start, spaceKey = spaceKey, title = title, expand = expand) 60 | res <- confl_verb("GET", "/content/", query = purrr::compact(query)) 61 | httr::content(res) 62 | } 63 | 64 | 65 | #' @rdname confl_content 66 | #' 67 | #' @param id 68 | #' ID of the content. 69 | #' @export 70 | confl_get_page <- function(id, expand = "body.storage") { 71 | id <- as.character(id) 72 | res <- confl_verb("GET", glue("/content/{id}"), query = list(expand = expand)) 73 | httr::content(res) 74 | } 75 | 76 | #' @rdname confl_content 77 | #' @param body 78 | #' The HTML source of the page. 79 | #' @param ancestors 80 | #' The page ID of the parent pages. 81 | #' @export 82 | confl_post_page <- function(type = c("page", "blogpost"), 83 | spaceKey, 84 | title, 85 | body, 86 | ancestors = NULL) { 87 | type <- arg_match(type) 88 | 89 | req_body <- list( 90 | type = type, 91 | title = title, 92 | space = list(key = spaceKey), 93 | body = list(storage = list(value = body, representation = "storage")) 94 | ) 95 | 96 | if (!is.null(ancestors) && !identical(ancestors, "")) { 97 | ancestors <- stringi::stri_trim_both(ancestors) 98 | req_body$ancestors <- purrr::map(ancestors, ~ list(id = .)) 99 | } 100 | res <- confl_verb("POST", "/content/", 101 | body = req_body, encode = "json" 102 | ) 103 | httr::content(res) 104 | } 105 | 106 | #' @rdname confl_content 107 | #' @param minor_edit 108 | #' If `TRUE`, will mark the `update` as a minor edit not notifying watchers. 109 | #' @export 110 | confl_update_page <- function(id, 111 | title, 112 | body, 113 | minor_edit = FALSE) { 114 | id <- as.character(id) 115 | page_info <- confl_get_page(id, expand = "version") 116 | 117 | res <- confl_verb("PUT", glue("/content/{id}"), 118 | body = list( 119 | type = page_info$type, 120 | title = title, 121 | body = list(storage = list(value = body, representation = "storage")), 122 | version = list( 123 | number = page_info$version$number + 1L, 124 | minorEdit = minor_edit 125 | ) 126 | ), 127 | encode = "json" 128 | ) 129 | httr::content(res) 130 | } 131 | 132 | 133 | #' @rdname confl_content 134 | #' @export 135 | confl_delete_page <- function(id) { 136 | id <- as.character(id) 137 | res <- confl_verb("DELETE", glue("/content/{id}")) 138 | httr::content(res) 139 | } 140 | -------------------------------------------------------------------------------- /tests/testthat/test-tabset.R: -------------------------------------------------------------------------------- 1 | test_that("wrap_tabsets() works", { 2 | expect <- "# h1\n# h2 \n\ncontent2
47 |content3
49 |content2
87 |content4
92 |content2
135 |content4
139 |content2
174 |content3
181 |content2
222 |content3
229 |conent4
') 236 | }) 237 | -------------------------------------------------------------------------------- /R/macros.R: -------------------------------------------------------------------------------- 1 | # Copyright (C) 2019-2020 LINE Corporation 2 | # 3 | # conflr is free software; you can redistribute it and/or modify it under the 4 | # terms of the GNU General Public License as published by the Free Software 5 | # Foundation, version 3. 6 | # 7 | # conflr is distributed in the hope that it will be useful, but WITHOUT ANY 8 | # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 9 | # A PARTICULAR PURPOSE. See",
102 | '
Provides utilities for working with various 'Confluence' API 124 | <https://docs.atlassian.com/ConfluenceServer/rest/latest/>, including a 125 | functionality to convert an R Markdown document to 'Confluence' format and 126 | upload it to 'Confluence' automatically.
127 |Useful links:
Report bugs at https://github.com/line/conflr/issues
R/macros.R
116 | confl_macro_jira.RdGenerate Confluence macro referencing a Jira ticket
121 |confl_macro_jira(key)124 | 125 |
| key | 130 |Jira ticket id, eg CONFLR-XXXX |
131 |
|---|
HTML as string
137 | 138 |140 |confl_macro_jira('CONFLR-42')#> [1] "`<ac:structured-macro ac:name=\"jira\"><ac:parameter ac:name=\"key\">CONFLR-42</ac:parameter></ac:structured-macro>`{=html}"
R/macros.R
116 | confl_macro_excerpt.RdGenerate Confluence macro for an excerpt block
121 |confl_macro_excerpt(body, hidden = TRUE)124 | 125 |
| body | 130 |HTML content of the excerpt |
131 |
|---|---|
| hidden | 134 |if the |
135 |
HTML as string
141 |https://confluence.atlassian.com/doc/excerpt-macro-148062.html
144 | 145 |First of all, thank you so much for taking your time to contribute! conflr is not very different from any other open source projects you are aware of. It will be amazing if you could help us by doing any of the following:
119 |When you are sending a pull request and it’s a non-trivial change beyond fixing typos, please sign the ICLA (individual contributor license agreement). Please contact us if you need the CCLA (corporate contributor license agreement).
129 |We expect contributors to follow our code of conduct.
134 |R/macros.R
116 | confl_macro_toc.RdGenerate Confluence macro for dynamic Table of Contents
121 |confl_macro_toc(levels)124 | 125 |
| levels | 130 |max number of levels to show |
131 |
|---|
HTML as string
137 |https://confluence.atlassian.com/doc/table-of-contents-macro-182682099.html
140 | 141 |143 |confl_macro_toc(2)#> [1] "\n```{=html}\n<ac:structured-macro ac:name=\"toc\"><ac:parameter ac:name=\"levels\">2</ac:parameter></ac:structured-macro>\n```\n"
R/macros.R
116 | conf_macro_generator.RdGeneral Confluence macro builder for internal use
121 |conf_macro_generator( 124 | type = c("inline", "block"), 125 | name, 126 | parameters = NULL, 127 | body = NULL 128 | )129 | 130 |
| type | 135 |inline or block code style to be used for the HTML content |
136 |
|---|---|
| name | 139 |Confluence macro name |
140 |
| parameters | 143 |named list of optional macro parameters |
144 |
| body | 147 |optional |
148 |
HTML
154 | 155 |Non-admin User Operations
121 |confl_get_user(key = NULL, username = NULL, expand = NULL) 124 | 125 | confl_get_current_user(expand = NULL)126 | 127 |
| key | 132 |Userkey of the user to request from this resource. |
133 |
|---|---|
| username | 136 |Username of the user to request from this resource. |
137 |
| expand | 140 |A comma separated list of properties to expand. To refer the nested
141 | contents, use periods. (e.g. |
142 |
The API response as a list.
148 | 149 |160 |if (FALSE) { 151 | # Get the information of the current user 152 | my_user <- confl_get_current_user() 153 | 154 | # Show display name 155 | my_user$displayName 156 | 157 | # Get the information of a user whose name is "user1" 158 | other_user <- confl_get_user(username = "user1") 159 | }
R/contentbody.R
116 | confl_contentbody.RdConverts between content body representations
121 |confl_contentbody_convert( 124 | x, 125 | from = c("wiki", "storage", "editor", "view", "export_view", "styled_view"), 126 | to = c("storage", "editor", "view", "export_view", "styled_view") 127 | )128 | 129 |
| x | 134 |The content body to convert. |
135 |
|---|---|
| from | 138 |The format to convert from. |
139 |
| to | 142 |The format to convert to. |
143 |
The API response as a list.
149 |161 |if (FALSE) { 155 | # Convert to a Math macro 156 | confl_contentbody_convert("\\[1+1=2\\]") 157 | 158 | # Convert to an Expand macro 159 | confl_contentbody_convert("{expand}detail is here {expand}") 160 | }
R/macros.R
116 | confl_macro_expand.RdGenerate Confluence macro for an expand block
121 |confl_macro_expand(title, body)124 | 125 |
| title | 130 |defines the text that appears next to the expand/collapse icon |
131 |
|---|---|
| body | 134 |this HTML content will be visible when someone clicks the macro title |
135 |
HTML as string
141 |content needs to be HTML, so look at commonmark::markdown_html, pander::pander and eg xtable for doing the conversion before passing to confluence_expand
https://confluence.atlassian.com/doc/expand-macro-223222352.html
147 | 148 |154 |if (FALSE) { 150 | confl_macro_expand( 151 | 'Example block', 152 | commonmark::markdown_html(pander::pander_return(list(a = list(b = 4), c = 2)))) 153 | }
REST Wrapper for the SpaceService
121 |confl_list_spaces( 124 | spaceKey = NULL, 125 | type = c("global", "personal"), 126 | status = c("current", "archived"), 127 | label = NULL, 128 | favourite = NULL, 129 | expand = NULL, 130 | start = NULL, 131 | limit = 25 132 | ) 133 | 134 | confl_get_space(spaceKey, expand = NULL)135 | 136 |
| spaceKey | 141 |The space key to find content under. |
142 |
|---|---|
| type | 145 |Filter the list of spaces returned by type ( |
146 |
| status | 149 |Filter the list of spaces returned by status ( |
150 |
| label | 153 |Filter the list of spaces returned by label. |
154 |
| favourite | 157 |Filter the list of spaces returned by favourites. |
158 |
| expand | 161 |A comma separated list of properties to expand. To refer the nested
162 | contents, use periods. (e.g. |
163 |
| start | 166 |The start point of the collection to return. |
167 |
| limit | 170 |The limit of the number of items to return, this may be restricted by fixed system limits. |
171 |
The API response as a list.
177 | 178 |183 |if (FALSE) { 180 | # Get the information of a space named "space1" 181 | confl_get_space("space1") 182 | }
R/addin.R
113 | confl_create_post_from_Rmd.RdKnit and post a given R Markdown file to 'Confluence'.
118 |confl_create_post_from_Rmd( 121 | Rmd_file, 122 | interactive = NULL, 123 | params = NULL, 124 | ..., 125 | title = NULL, 126 | space_key = NULL, 127 | type = NULL, 128 | parent_id = NULL, 129 | toc = NULL, 130 | update = NULL, 131 | use_original_size = NULL 132 | )133 | 134 |
| Rmd_file | 139 |Path to an .Rmd file. |
140 |
|---|---|
| interactive | 143 |If |
144 |
| params | 147 |If provided, a list of named parameters that override custom 148 | params in the YAML front-matter. |
149 |
| ... | 152 |Ignored. |
153 |
| title | 156 |Title of the post. |
157 |
| space_key | 160 |The space key to find content under. |
161 |
| type | 164 |If provided, this overwrites the YAML front matter type |
165 |
| parent_id | 168 |The page ID of the parent pages. |
169 |
| toc | 172 |If |
173 |
| update | 176 |If |
177 |
| use_original_size | 180 |If |
181 |
title, type, space_key, parent_id, toc, update, and
187 | use_original_size can be specified as confluence_settings item in the
188 | front-matter of the Rmd file to knit. The arguments of
189 | confl_create_post_from_Rmd() overwrite these settings if provided.