Dev/apikey

NAMESPACE

@@ -21,6 +21,7 @@ export(ping)
 export(resource_search)
 export(resource_show)
 export(revision_list)
+export(set_api_key)
 export(set_ckanr_url)
 export(tag_list)
 export(tag_search)

R/api_key.R

@@ -0,0 +1,34 @@
+#' Set API KEY of CKAN
+#'
+#' Some CKAN API functions require authentication.
+#' The \code{set_api_key} is a helper function to set the api key and
+#' enable authentication.
+#'
+#' @details
+#'
+#' The \code{ckanr} will check the value of global options \code{X-CKAN-API-Key}
+#' before communicating with CKAN server. If the value is not \code{NULL}, the
+#' \code{ckanr} will use the value as api key to authenticate with CKAN service.
+#'
+#' @param api_key (character). The api key of the user.
+#' @examples
+#' \dontrun{
+#' set_api_key("xxx")
+#' # list the private resources authorized to the above api key
+#' organization_show("some_name", include_datasets = TRUE)[["packages"]]
+#' }
+#' @export
+set_api_key <- function(api_key) {
+  options("X-CKAN-API-Key" = api_key)
+}
+
+#' Enable Authentication with API-KEY
+#'
+#' Some CKAN API functions require authentication.
+#' The \code{set_api_key} is a helper function to set the API-KEY and
+#' the \code{api_key} is a helper function to enable authentication.
+#' @importFrom httr add_headers
+api_key <- function() {
+  value <- getOption("X-CKAN-API-Key", NULL)
+  if (is.null(value)) NULL else add_headers("X-CKAN-API-Key" = value)
+}

R/zzz.R

@@ -17,10 +17,21 @@ jsd <- function(x){
 }
 
 ckan_POST <- function(url, method, body=NULL, ...){
-  if (is.null(body) || length(body) == 0) {
-    res <- POST(file.path(url, ck(), method), ctj(), ...)
+  api_key_header <- api_key()
+  if (is.null(api_key_header)) {
+    # no authentication
+    if (is.null(body) || length(body) == 0) {
+      res <- POST(file.path(url, ck(), method), ctj(), ...)
+    } else {
+      res <- POST(file.path(url, ck(), method), body = body, ...)
+    }
   } else {
-    res <- POST(file.path(url, ck(), method), body = body, ...)
+    # authentication
+    if (is.null(body) || length(body) == 0) {
+      res <- POST(file.path(url, ck(), method), ctj(), api_key_header, ...)
+    } else {
+      res <- POST(file.path(url, ck(), method), body = body, api_key_header, ...)
+    }
   }
   err_handler(res)
   content(res, "text")

man/api_key.Rd

@@ -0,0 +1,14 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/api_key.R
+\name{api_key}
+\alias{api_key}
+\title{Enable Authentication with API-KEY}
+\usage{
+api_key()
+}
+\description{
+Some CKAN API functions require authentication.
+The \code{set_api_key} is a helper function to set the API-KEY and
+the \code{api_key} is a helper function to enable authentication.
+}
+

man/set_api_key.Rd

@@ -0,0 +1,29 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/api_key.R
+\name{set_api_key}
+\alias{set_api_key}
+\title{Set API KEY of CKAN}
+\usage{
+set_api_key(api_key)
+}
+\arguments{
+\item{api_key}{(character). The api key of the user.}
+}
+\description{
+Some CKAN API functions require authentication.
+The \code{set_api_key} is a helper function to set the api key and
+enable authentication.
+}
+\details{
+The \code{ckanr} will check the value of global options \code{X-CKAN-API-Key}
+before communicating with CKAN server. If the value is not \code{NULL}, the
+\code{ckanr} will use the value as api key to authenticate with CKAN service.
+}
+\examples{
+\dontrun{
+set_api_key("xxx")
+# list the private resources authorized to the above api key
+organization_show("some_name", include_datasets = TRUE)[["packages"]]
+}
+}
+

tests/testthat/test-user_list.R

@@ -0,0 +1,13 @@
+context("user_list")
+
+test_that("user_list gives back expected class types", {
+  a <- user_list()
+  expect_is(a, "list")
+})
+
+test_that("user_list works giving back json output", {
+  b <- user_list(as = "json")
+  expect_is(b, "character")
+  b_df <- jsonlite::fromJSON(b)
+  expect_is(b_df, "list")
+})