R/mindat_endpoint.R

In OpenMindat: Quickly Retrieve Datasets from the 'Mindat' API

########### mindat_rest_api.R ###########
#' mindat_uri_builder
#' @description generate the mindat_uri_builder
#' @usage mindat_uri_builder (api_base_url, config,querystring)
#' @param api_base_url list. The base url of mindat api.
#' @param config list. config of current environment.
#' @param querystring list. list of query fields and conditions.
#' @noRd
mindat_uri_builder<- function(api_base_url, config, querystring = ''){
  if(querystring != ''){
    uri <- paste(api_base_url, '/', sprintf(config[['endpoint_base']], querystring) ,sep = "")
  }
  else{
    config_str <- sub('%s','',config[['endpoint_base']])
    uri <- paste(api_base_url,config_str,sep = "/")
  }
  uri
}

#' mindat_set_up_endpoints
#' @description Set up the basic mindat endpoints for current mindat API.
#' @usage mindat_set_up_endpoints ()
#' @noRd
mindat_set_up_endpoints<-function(){
  # single ima mineral
  mindat_api_endpoint('minerals_ima', 'minerals-ima/%s', uri_builder = mindat_uri_builder,
                      compulsory_params = list('id'))

  # ima minerals list
  mindat_api_endpoint('minerals_ima_list', 'minerals-ima/%s', uri_builder = mindat_uri_builder)

  # single locality
  mindat_api_endpoint('localities', 'localities/%s',uri_builder = mindat_uri_builder,
                      compulsory_params = list('id'))
  # localities
  mindat_api_endpoint('localities_list', 'localities/%s',uri_builder = mindat_uri_builder)

  # locality_age
  mindat_api_endpoint('locality_age_list', 'locality-age/%s',uri_builder = mindat_uri_builder)
  mindat_api_endpoint('locality_age', 'locality-age/%s',uri_builder = mindat_uri_builder,
                      compulsory_params = list('id'))

  # locality_status
  mindat_api_endpoint('locality_status_list', 'locality-status/%s',uri_builder = mindat_uri_builder)
  mindat_api_endpoint('locality_status', 'locality-status/%s',uri_builder = mindat_uri_builder,
                      compulsory_params = list('id'))
  # locality_type
  mindat_api_endpoint('locality_type_list', 'locality-type/%s',uri_builder = mindat_uri_builder)
  mindat_api_endpoint('locality_type', 'locality-type/%s',uri_builder = mindat_uri_builder,
                      compulsory_params = list('id'))

  #locentries
  mindat_api_endpoint('locentries_list', 'locentries/%s',uri_builder = mindat_uri_builder)
  mindat_api_endpoint('locentries', 'locentries/%s',uri_builder = mindat_uri_builder,
                      compulsory_params = list('id'))
  #locentries_statistics
  mindat_api_endpoint('locentries_statistics_list', 'locentries-statistics/%s',uri_builder = mindat_uri_builder)
  mindat_api_endpoint('locentries_statistics', 'locentries-statistics/%s',uri_builder = mindat_uri_builder,
                      compulsory_params = list('id'))
  #geomaterials
  mindat_api_endpoint('geomaterials', 'geomaterials/%s',uri_builder = mindat_uri_builder,
                      compulsory_params = list('id'))
  #geomaterials_list
  mindat_api_endpoint('geomaterials_list', 'geomaterials/%s',uri_builder = mindat_uri_builder)

  #geomaterials_varieties/{id}/varieties/
  mindat_api_endpoint('geomaterials_varieties', 'geomaterials/%s/varieties',uri_builder = mindat_uri_builder)

  #geomaterials/dict/
  mindat_api_endpoint('geomaterials/dict', 'geomaterials/dict/%s',uri_builder = mindat_uri_builder)

  #geomaterials_search/
  mindat_api_endpoint('geomaterials_search', 'geomaterials-search/?%s',uri_builder = mindat_uri_builder)

  #crystalclasses/
  mindat_api_endpoint('crystalclasses', 'crystalclasses/%s',uri_builder = mindat_uri_builder,
                      compulsory_params = list('id'))
  #crystalclasses_list
  mindat_api_endpoint('crystalclasses_list', 'crystalclasses/%s',uri_builder = mindat_uri_builder)

  #spacegroups/
  mindat_api_endpoint('spacegroups', 'spacegroups/%s',uri_builder = mindat_uri_builder,
                      compulsory_params = list('id'))
  #spacegroups_list
  mindat_api_endpoint('spacegroups_list', 'spacegroups/%s',uri_builder = mindat_uri_builder)

  #spacegroupsets/
  mindat_api_endpoint('spacegroupsets', 'spacegroupsets/%s',uri_builder = mindat_uri_builder,
                      compulsory_params = list('id'))
  #spacegroupsets_list
  mindat_api_endpoint('spacegroupsets_list', 'spacegroupsets/%s',uri_builder = mindat_uri_builder)

  #dana-8
  #mindat_api_endpoint('dana-8', 'dana-8/%s',uri_builder = mindat_uri_builder,
  #                    compulsory_params = list('id'))

  #mindat_api_endpoint('dana-8', 'dana-8/%s',uri_builder = mindat_uri_builder)

  #dana-8/groups
  mindat_api_endpoint('dana-8/groups', 'dana-8/groups/%s',uri_builder = mindat_uri_builder,
                      compulsory_params = list('id'))
  #dana-8/subgroups
  mindat_api_endpoint('dana-8/subgroups', 'dana-8/subgroup/%s',uri_builder = mindat_uri_builder)

  #nickel-strunz-10/classes
  mindat_api_endpoint('nickel-strunz-10/classes', 'nickel-strunz-10/classes/%s',uri_builder = mindat_uri_builder)

  #nickel-strunz-10/subclasses
  mindat_api_endpoint('nickel-strunz-10/subclasses', 'nickel-strunz-10/subclasses/%s',uri_builder = mindat_uri_builder)

  #nickel-strunz-10/families
  mindat_api_endpoint('nickel-strunz-10/families', 'nickel-strunz-10/families/%s',uri_builder = mindat_uri_builder)


  #countries
  mindat_api_endpoint('countries', 'countries/%s',uri_builder = mindat_uri_builder)

  #countries
  mindat_api_endpoint('countries', 'countries/%s',uri_builder = mindat_uri_builder,
                      compulsory_params = list('id'))


}

#' mindat_setup
#' @description set up of the mindat basic uri, endpoints, and cache
#' @usage mindat_setup(base_uri = 'https://api.mindat.org/v1',page_size = 800)
#' @param base_uri base uri of mindat API.
#' @param page_size interger,setting the page size of responsed data from the API server.
#' @examples
#' \dontrun{
#' mindat_setup()
#' }
#' @export
mindat_setup<-function(base_uri = 'https://api.mindat.org/v1',page_size = 800){
  set_api_base(base_uri)
  set_page_size(page_size)
  mindat_set_up_endpoints()
  mindat_cache_set('api_format', 'json')
}


########### mindat_rest_api.R ###########