R/getcategories.R

In yitang310/zomator: Wrapper to the Zomato API

#' @author
#' Yi Tang <tangyi2014@@gmail.com>
#'
#' @description
#' return the list of category types
#'
#' @param key your API key
#'
#' @return
#' category_id (integer) ID of the category type
#' category_name (string) Name of the category type
#'
#' @name
#' get_categories
#'
#' @title
#' category types
#'
#' @export
#' @examples
#' get_categories("testkey")


#function for getting categories
get_categories <- function(key = NULL){
  #check if given api
  apikey_check(key)

  #check if the testkey
  if (key=="testkey"){
    testword<-"This is a testkey."
    return(testword)
  }

  baseurl <- "https://developers.zomato.com"
  urlcate <- httr::modify_url(
    baseurl,
    path = "/api/v2.1/categories")
  res <- httr::GET(
    url = urlcate,
    config = httr::add_headers("user-key" = key)
  )
  #check if the api key can used to connect to zomato
  apikey_connectioncheck(res)
  #read json into dataframe
  datalist<-read_json(res)
  #only want the dataframe
  return(datalist$categories)
}

#function for checking if api key is provided
apikey_check <- function(key = NULL){
  if (is.null(key)){
    stop("Please provide a zomato API key.")
  }
}
#function for checking if api can used to connect to zomato
apikey_connectioncheck<-function(res){
  print(res)
  if (!is.null(httr::content(res)$code)){
    if(httr::content(res)$code==403){
      stop("please try another API key.")
    }
  }
}

#function for read json
read_json<-function(res){
  datalist <- jsonlite::fromJSON(
    httr::content(
      res, as = "text", type = "application/json", encoding = "UTF-8"
    ),
    flatten = TRUE
  )
  return (datalist)
}