Added unit tests

Author: antaldaniel

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: wbdataset
 Title: Making Datasets Truly Interoperable and Reusable in R with Wikibase
-Version: 0.1.1042
-Date: 2024-04-07
+Version: 0.1.1043
+Date: 2024-04-10
 Authors@R: 
     c(person(given="Daniel", family="Antal", 
            email= "daniel.antal@dataobservatory.eu", 

R/check_existing_item.R

@@ -1,23 +1,30 @@
-#' @title Check if a label already has an item.
-#' @description Avoid failed writing attempts by checking if a label already
-#' matches an item.
-#' @details A wrapper around
+#' @title Check for Existing Items in Wikibase
+#'
+#' @description This function searches for existing items in a specified
+#' Wikibase instance that match a given label in a specified language. It helps
+#' prevent duplicate item creation by identifying existing matches.
+#'
+#' @details The function interfaces with the Wikibase API's `wbsearchentities`
+#' action to perform a search based on the provided label (`search_term`) and
+#' language. It returns information about matching items, facilitating the
+#' management of data consistency within the Wikibase. See:
 #' \href{https://www.wikidata.org/w/api.php?action=help&modules=wbsearchentities}{MediaWiki
 #' action=wbsearchentities}.
-#' @param action Defaults to \code{"create_item"}.
-#' @param search_term A label in the given language, for example, "Estonia".
-#' @param language A single language code that indicates the language of the
-#'   label and description, using BCP 47-compliant language tags (e.g., "en" for
-#'   English, "fr" for French). Defaults to \code{"en"} for English.
-#' @param wikibase_api_url The full URL of the Wikibase API, which is the
-#'   address that the \code{wbdataset} R client sends requests to when
-#'   interacting with the knowledge base. In this case it defaults to
-#'   \code{'https://www.wikidata.org/w/api.php'}, Wikidata itself, where no
-#'   CSRF is needed.
-#' @param csrf The CSRF token of your session, received with
-#'   \code{\link{get_csrf}}, not needed if
-#'   \code{wikibase_api_url="https://www.wikidata.org/w/api.php"}. Defaults
-#'   to \code{NULL}.
+#'
+#' @param search_term A character string representing the label to search for in
+#'   the Wikibase. For example, `"Estonian National Museum"`.
+#' @param language A character string specifying the language code of the label,
+#'   adhering to BCP 47 standards (e.g., `"en"` for English). Defaults to
+#'   `"en"`.
+#' @param action A character string indicating the action being performed.
+#'   Defaults to `"create_item"`.
+#' @param log_file_name A character string specifying the name of the log file.
+#'   Defaults to `NA_character_`.
+#' @param data_curator An object of class `person` representing the data
+#'   curator. Defaults to `person("Unknown", "Person")`.
+#' @return A `dataset_df` object containing information about the matching
+#' item(s), including action performed, item ID, label, description, language,
+#' and other metadata. Returns `NULL` if no matching items are found.
 #' @inheritParams create_item
 #' @return A data.frame or NULL.
 #' @examples
@@ -44,8 +51,17 @@ check_existing_item <- function(search_term,
   action_timestamp <- action_timestamp_create()
   action_time <- Sys.time()
 
-  if ( length(search_term)!=1) {
-    stop("check_existing_item(search_term, ...): length of search term must be 1.")
+
+  if (!is.character(search_term) || length(search_term) != 1 || nchar(search_term) == 0) {
+    stop("Invalid input in check_existing_item(): 'search_term' must be a non-empty character string.")
+  }
+
+  if (!is.character(language) || length(language) != 1 || nchar(language) == 0) {
+    stop("Invalid input in check_existing_item(): 'language' must be a non-empty character string.")
+  }
+
+  if (!is.character(wikibase_api_url) || length(wikibase_api_url) != 1 || !grepl("^https?://", wikibase_api_url)) {
+    stop("Invalid input in check_existing_item(): 'wikibase_api_url' must be a valid URL string.")
   }
 
   get_search <- httr::POST(

R/check_existing_property.R

@@ -46,10 +46,19 @@ check_existing_property <- function(
   action_timestamp <- action_timestamp_create()
   action_time <- Sys.time()
 
-  if ( length(search_term)!=1) {
-    stop("check_existing_item(search_term, ...): length of search term must be 1.")
+  if (!is.character(search_term) || length(search_term) != 1 || nchar(search_term) == 0) {
+    stop("Invalid input in check_existing_property(): 'search_term' must be a non-empty character string.")
   }
 
+  if (!is.character(language) || length(language) != 1 || nchar(language) == 0) {
+    stop("Invalid input in check_existing_property(): 'language' must be a non-empty character string.")
+  }
+
+  if (!is.character(wikibase_api_url) || length(wikibase_api_url) != 1 || !grepl("^https?://", wikibase_api_url)) {
+    stop("Invalid input in check_existing_property(): 'wikibase_api_url' must be a valid URL string.")
+  }
+
+
   get_search <- httr::POST(
     wikibase_api_url,
     body = list(

R/get_claim.R

@@ -54,6 +54,15 @@ get_claim <- function(qid = "Q528626",
                       wikibase_api_url = "https://www.wikidata.org/w/api.php",
                       csrf = NULL,
                       first = TRUE) {
+
+  if (!is_qid(qid)) {
+    stop(sprintf("Invalid QID: '%s'. QIDs must begin with 'Q' followed by digits (e.g., 'Q42').", qid))
+  }
+
+  if (!is_pid(property)) {
+    stop(sprintf("Invalid property ID: '%s'. Properties must begin with 'P' followed by digits (e.g., 'P31').", property))
+  }
+
   response <- httr::POST(
     wikibase_api_url,
     body = list(

man/check_existing_item.Rd

@@ -3,8 +3,46 @@ test_that("check_existing_item() works", {
     search_term = "Estonian National Museum",
     language = "en"
   )
+  expect_true(inherits(test, "data.frame"))
   expect_equal(
     as.character(test$rowid),
     "wbi:Q1370397"
   )
 })
+
+test_that("check_existing_item() handles invalid inputs appropriately", {
+  # Test for non-character search_term
+  expect_error(
+    check_existing_item(search_term = 123, language = "en"),
+    "Invalid input in check_existing_item(): 'search_term' must be a non-empty character string.",
+    fixed = TRUE
+  )
+
+  # Test for empty search_term
+  expect_error(
+    check_existing_item(search_term = "", language = "en"),
+    "Invalid input in check_existing_item(): 'search_term' must be a non-empty character string.",
+    fixed = TRUE
+  )
+
+  # Test for non-character language
+  expect_error(
+    check_existing_item(search_term = "Estonian National Museum", language = 123),
+    "Invalid input in check_existing_item(): 'language' must be a non-empty character string.",
+    fixed = TRUE
+  )
+
+  # Test for empty language
+  expect_error(
+    check_existing_item(search_term = "Estonian National Museum", language = ""),
+    "Invalid input in check_existing_item(): 'language' must be a non-empty character string.",
+    fixed = TRUE
+  )
+
+  # Test for invalid wikibase_api_url
+  expect_error(
+    check_existing_item(search_term = "Estonian National Museum", language = "en", wikibase_api_url = "invalid_url"),
+    "Invalid input in check_existing_item(): 'wikibase_api_url' must be a valid URL string.",
+    fixed = TRUE
+  )
+})

man/is_pid.Rd

@@ -9,3 +9,41 @@ test_that("check_existing_property() works", {
     "wikibase-item"
   )
 })
+
+
+test_that("check_existing_property() handles invalid inputs appropriately", {
+  # Test for non-character search_term
+  expect_error(
+    check_existing_property(search_term = 123, language = "en"),
+    "Invalid input in check_existing_property(): 'search_term' must be a non-empty character string.",
+    fixed = TRUE
+  )
+
+  # Test for empty search_term
+  expect_error(
+    check_existing_property(search_term = "", language = "en"),
+    "Invalid input in check_existing_property(): 'search_term' must be a non-empty character string.",
+    fixed = TRUE
+  )
+
+  # Test for non-character language
+  expect_error(
+    check_existing_property(search_term = "Estonian National Museum", language = 123),
+    "Invalid input in check_existing_property(): 'language' must be a non-empty character string.",
+    fixed = TRUE
+  )
+
+  # Test for empty language
+  expect_error(
+    check_existing_property(search_term = "Estonian National Museum", language = ""),
+    "Invalid input in check_existing_property(): 'language' must be a non-empty character string.",
+    fixed = TRUE
+  )
+
+  # Test for invalid wikibase_api_url
+  expect_error(
+    check_existing_property(search_term = "Estonian National Museum", language = "en", wikibase_api_url = "invalid_url"),
+    "Invalid input in check_existing_property(): 'wikibase_api_url' must be a valid URL string.",
+    fixed = TRUE
+  )
+})

man/is_qid.Rd

@@ -5,6 +5,23 @@ test_that("get_claim() throws error for missing property", {
   )
 })
 
+test_that("get_claim() throws an error for invalid QID", {
+  expect_error(
+    get_claim(qid = "invalidQID", property = "P31"),
+    "Invalid QID: 'invalidQID'. QIDs must begin with 'Q' followed by digits (e.g., 'Q42').",
+    fixed = TRUE
+  )
+})
+
+test_that("get_claim() throws an error for invalid property ID", {
+  expect_error(
+    get_claim(qid = "Q42", property = "invalidPID"),
+    "Invalid property ID: 'invalidPID'. Properties must begin with 'P' followed by digits (e.g., 'P31').",
+    fixed = TRUE
+  )
+})
+
+
 test_that("get_claim(): wikibase-item value correctly returned", {
   expect_equal(
     get_claim(qid = "Q28104185", property = "P1889")$P1889,
@@ -36,10 +53,10 @@ test_that("get_claim(): time value correctly returned", {
               wikibase_api_url = "https://www.wikidata.org/w/api.php")$P1889,
     "Q234138")
   expect_equal(
-  get_claim(qid = "Q28104185",
-            property = "P1889",
-            wikibase_api_url = "https://www.wikidata.org/w/api.php")$type,
-  "wikibase-item")
+    get_claim(qid = "Q28104185",
+              property = "P1889",
+              wikibase_api_url = "https://www.wikidata.org/w/api.php")$type,
+    "wikibase-item")
 })
 
 test_that("get_claim(): external-id value correctly returned", {