method api_options conflict error

Author: Jesse Cambon

NEWS.md

@@ -3,6 +3,7 @@
 - Changed the default `min_time` (minimum seconds elapsed per query) value to 1 (60 queries per minute) for the Location IQ service ([#166](https://github.com/jessecambon/tidygeocoder/issues/166)).
 - Updated default Geocodio API URL from version 1.6 to 1.7.
 - Fixed code and documentation that incorrectly referred to `mapquest_open` as `mapbox_open`.
+- An error is now thrown if an `api_options` parameter is not compatible with the specified `method`.
 - A message is now displayed warning that `flatten=FALSE` is ignored for Geocodio and Mapquest (the output of these services requires flattening to avoid errors).
 
 # tidygeocoder 1.0.5

R/geo.R

@@ -238,7 +238,10 @@ geo <-
         api_options[["here_request_id"]] <- here_request_id
       }
     }
-
+    
+    # check for method / api_options mismatch
+    check_method_api_options_mismatch(method, api_options, FALSE)
+    
     # apply api options defaults for options not specified by the user
     api_options <- apply_api_options_defaults(api_options)
 

R/reverse_geo.R

@@ -169,6 +169,9 @@ reverse_geo <-
         here_request_id <- NULL
       }
     }
+    
+    # check for method / api_options mismatch
+    check_method_api_options_mismatch(method, api_options, TRUE)
 
     # apply api options defaults for options not specified by the user
     api_options <- apply_api_options_defaults(api_options)

R/utils.R

@@ -383,3 +383,23 @@ flatten_override_warning <- function(flatten, method, reverse, batch) {
     ))
   }
 }
+
+# throw error if method and a specified api_option is mismatched 
+# ie. method='census' and api_options(list(geocodio_hipaa=TRUE))
+check_method_api_options_mismatch <- function(method, api_options, reverse=FALSE) {
+  # cycle through the api options specified (except for init)
+  if (api_options$init == TRUE) {
+    for (api_opt in names(api_options)[!names(api_options) %in% c('init')]) {
+      # extract method name from api_option
+      api_opt_method <- strsplit(api_opt, "_")[[1]][[1]]
+      
+      if (api_opt_method != method) {
+        stop(
+          'method="', method, '" is not meant for use with api_options=list(', api_opt, ')\n',
+          'See ?', if (reverse == TRUE) "reverse_geo" else "geo",
+          call. = FALSE
+        )
+      }
+    }
+  }
+}