Added breached_sites

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: HIBPwned
 Title: Bindings for the HaveIBeenPwned.com data breach API
-Version: 0.0.0.9001
+Version: 0.0.0.9002
 Authors@R: c(person("Steph", "Locke"
              , email = "stephanie.g.locke@gmail.com"
              , role = c("aut", "cre"))

NAMESPACE

@@ -2,6 +2,7 @@
 
 export(HIBP_headers)
 export(account_breaches)
+export(breached_sites)
 importFrom(httr,add_headers)
 importFrom(httr,content)
 importFrom(jsonlite,fromJSON)

R/breached_sites.R

@@ -0,0 +1,24 @@
+#' Get all (nonsensitive) breached sites in HIBP
+#'
+#' @param domain Search a specific domain
+#' @param ... Optional passthrough to HIBP_headers()
+#'
+#' @return Data.frame containing breach details
+#' @export
+#'
+#' @examples
+#' breached_sites()
+breached_sites<-function(domain=NULL,...){
+  if(!is.null(domain)&(
+    length(domain)!=1  |!inherits(domain,"character"))  ) stop("Problematic domain")
+  URLS<-"https://haveibeenpwned.com/api/breaches"
+  if(!is.null(domain)) URLS<- urltools::param_set(URLS,"domain",urltools::url_encode(domain))
+
+  res<- GETcontent(URLS, HIBP_headers(...))
+  if(identical(res,list())) res<-data.frame(Title=NA,Name=NA,Domain=domain,
+                                            BreachDate=NA,AddedDate=NA,PwnCount=NA,
+                                            Description=NA,DataClasses=NA,IsVerified=NA,
+                                            IsSensitive=NA,LogoType=NA )
+  return(res)
+
+}

tests/testthat/test-account_breaches.R

@@ -88,6 +88,7 @@ test_that("account_breaches works for multiple accounts",{
     expect_gte(ncol(res[[a]]),1) # key test
     expect_gte(nrow(res[[a]]),1)
   }
+
   # With domain (no breach)
   res<-account_breaches(acct, domain = "xyz.com")
 
@@ -101,6 +102,8 @@ test_that("account_breaches works for multiple accounts",{
     expect_gte(nrow(res[[a]]),1)
   }
 
+  # With header passthrough
+  expect_error(account_breaches(acct,agent="blah"),NA)
 })
 
 test_that("handles incorrect values",{

tests/testthat/test-breached_sites.R

@@ -0,0 +1,39 @@
+context("breached-sites")
+
+test_that("breached_sites works",{
+
+  # Simplest usage scenario
+  res<-breached_sites()
+
+  expect_is(res, "data.frame")
+  expect_gt(ncol(res),1)
+  expect_gt(nrow(res),1)
+
+  # With domain (known breach)
+  res<-breached_sites(domain = "adobe.com")
+
+  expect_is(res, "data.frame")
+  expect_gt(ncol(res),1)
+  expect_equal(nrow(res),1)
+
+  # With domain (no breach)
+  res<-breached_sites(domain = "xyz.com")
+
+  expect_is(res, "data.frame")
+  expect_gt(ncol(res),1)
+  expect_equal(nrow(res),1)
+
+  # With header passthrough
+  expect_error(breached_sites(agent="blah"),NA)
+
+})
+
+
+test_that("handles incorrect values",{
+  errors<-"Problematic domain"
+
+  expect_error(breached_sites(TRUE),errors)
+  expect_error(breached_sites(as.character(c())),errors)
+  expect_error(breached_sites(rep(errors,2)),errors)
+
+})