Merge pull request #1868 from cmu-delphi/ln/validator

Validator API call header authentication

Author: minhkhul

_delphi_utils_python/delphi_utils/validator/datafetcher.py

@@ -9,14 +9,13 @@
 import requests
 import pandas as pd
 import numpy as np
-
 import covidcast
+from .. import read_params
 from .errors import APIDataFetchError, ValidationFailure
 
 FILENAME_REGEX = re.compile(
     r'^(?P<date>\d{8})_(?P<geo_type>\w+?)_(?P<signal>\w+)\.csv$')
 
-
 def make_date_filter(start_date, end_date):
     """
     Create a function to filter dates in the specified date range (inclusive).
@@ -110,8 +109,12 @@ def get_geo_signal_combos(data_source):
 
     Cross references based on combinations reported available by COVIDcast metadata.
     """
+    params = read_params()
+    assert "validation" in params
+    api_key = ("epidata", params["validation"]["common"]["api_credentials"])
     # Maps data_source name with what's in the API, lists used in case of multiple names
-    meta_response = requests.get("https://api.covidcast.cmu.edu/epidata/covidcast/meta")
+    meta_response = requests.get("https://api.covidcast.cmu.edu/epidata/covidcast/meta",
+                                 auth=api_key)
     meta_response.raise_for_status()
     source_signal_mappings = {i['source']:i['db_source'] for i in
         meta_response.json()}
@@ -139,7 +142,7 @@ def get_geo_signal_combos(data_source):
             elif geo_status == "unknown":
                 epidata_signal = requests.get(
                     "https://api.covidcast.cmu.edu/epidata/covidcast/meta",
-                    params={'signal': f"{src}:{sig}"})
+                    params={'signal': f"{src}:{sig}"}, auth=api_key)
                 epidata_signal.raise_for_status()
                 # Not an active signal
                 active_status = [val['active'] for i in epidata_signal.json()

_delphi_utils_python/tests/params.json.template

@@ -1,3 +1,8 @@
 {
-  "test": "yes"
+  "test": "yes",
+  "validation": {
+    "common": {
+      "api_credentials": "fake_key"
+    }
+  }
 }

_delphi_utils_python/tests/validator/test_datafetcher.py

@@ -40,10 +40,10 @@ def json(self):
             def raise_for_status(self):
                 if self.status_code != 200:
                     raise HTTPError()
-        if len(kwargs) == 0:
+        if len(kwargs) == 0 or list(kwargs.keys())==["auth"]:
             return MockResponse([{'source': 'chng', 'db_source': 'chng'},
                 {'source': 'covid-act-now', 'db_source': 'covid-act-now'}], 200)
-        elif kwargs["params"] == {'signal': 'chng:inactive'}:
+        elif "params" in kwargs and kwargs["params"] == {'signal': 'chng:inactive'}:
             return MockResponse([{"signals": [{"active": False}]}], 200)
         else:
             return MockResponse([{"signals": [{"active": True}]}], 200)
@@ -78,7 +78,6 @@ def test_get_geo_signal_combos(self, mock_metadata, mock_get):
                                                                 "hrr", "msa", "msa",
                                                                 "state"]
                                                   })
-
         assert set(get_geo_signal_combos("chng")) == set(
             [("state", "smoothed_outpatient_cli"),
              ("state", "smoothed_outpatient_covid"),