Merge pull request #245 from sgratzl/sgratzl/geo_values_clients

add geo_values support in raw clients

Author: krivard

integrations/client/test_delphi_epidata.py

@@ -46,7 +46,7 @@ def tearDown(self):
   def test_covidcast(self):
     """Test that the covidcast endpoint returns expected data."""
     self.maxDiff=None
-    
+
     # insert dummy data
     self.cur.execute('''
       insert into covidcast values
@@ -123,7 +123,7 @@ def test_covidcast(self):
       }],
       'message': 'success',
     })
-    
+
     # fetch data, without specifying issue or lag
     response_1 = Epidata.covidcast(
         'src', 'sig', 'day', 'county', 20200414, '01234')
@@ -221,6 +221,92 @@ def test_covidcast(self):
         'message': 'success',
     })
 
+  def test_geo_value(self):
+    """test different variants of geo types: single, *, multi."""
+
+    # insert dummy data
+    self.cur.execute('''
+      insert into covidcast values
+        (0, 'src', 'sig', 'day', 'county', 20200414, '11111',
+          123, 10, 11, 12, 456, 13, 20200414, 0, 1, False),
+        (0, 'src', 'sig', 'day', 'county', 20200414, '22222',
+          123, 20, 21, 22, 456, 23, 20200414, 0, 1, False),
+        (0, 'src', 'sig', 'day', 'county', 20200414, '33333',
+          123, 30, 31, 32, 456, 33, 20200414, 0, 1, False),
+        (0, 'src', 'sig', 'day', 'msa', 20200414, '11111',
+          123, 40, 41, 42, 456, 43, 20200414, 0, 1, False),
+        (0, 'src', 'sig', 'day', 'msa', 20200414, '22222',
+          123, 50, 51, 52, 456, 53, 20200414, 0, 1, False),
+        (0, 'src', 'sig', 'day', 'msa', 20200414, '33333',
+          123, 60, 61, 62, 456, 634, 20200414, 0, 1, False)
+    ''')
+    self.cnx.commit()
+
+    def fetch(geo_value):
+      # make the request
+      response = Epidata.covidcast(
+        'src', 'sig', 'day', 'county', 20200414, geo_value)
+      return response
+
+    counties = [{
+      'time_value': 20200414,
+      'geo_value': '11111',
+      'value': 10,
+      'stderr': 11,
+      'sample_size': 12,
+      'direction': 13,
+      'issue': 20200414,
+      'lag': 0,
+      'signal': 'sig',
+    }, {
+      'time_value': 20200414,
+      'geo_value': '22222',
+      'value': 20,
+      'stderr': 21,
+      'sample_size': 22,
+      'direction': 23,
+      'issue': 20200414,
+      'lag': 0,
+      'signal': 'sig',
+    }, {
+      'time_value': 20200414,
+      'geo_value': '33333',
+      'value': 30,
+      'stderr': 31,
+      'sample_size': 32,
+      'direction': 33,
+      'issue': 20200414,
+      'lag': 0,
+      'signal': 'sig',
+    }]
+
+    # test fetch all
+    r = fetch('*')
+    self.assertEqual(r['message'], 'success')
+    self.assertEqual(r['epidata'], counties)
+    # test fetch a specific region
+    r = fetch('11111')
+    self.assertEqual(r['message'], 'success')
+    self.assertEqual(r['epidata'], [counties[0]])
+    # test fetch a specific yet not existing region
+    r = fetch('55555')
+    self.assertEqual(r['message'], 'no results')
+    # test fetch a multiple regions
+    r = fetch(['11111', '22222'])
+    self.assertEqual(r['message'], 'success')
+    self.assertEqual(r['epidata'], [counties[0], counties[1]])
+    # test fetch a multiple regions in another variant
+    r = fetch(['11111', '33333'])
+    self.assertEqual(r['message'], 'success')
+    self.assertEqual(r['epidata'], [counties[0], counties[2]])
+    # test fetch a multiple regions but one is not existing
+    r = fetch(['11111', '55555'])
+    self.assertEqual(r['message'], 'success')
+    self.assertEqual(r['epidata'], [counties[0]])
+    # test fetch a multiple regions but specify no region
+    r = fetch([])
+    self.assertEqual(r['message'], 'no results')
+
   def test_covidcast_meta(self):
     """Test that the covidcast_meta endpoint returns expected data."""
 

src/client/delphi_epidata.R

@@ -522,9 +522,13 @@ Epidata <- (function() {
       time_type = time_type,
       geo_type = geo_type,
       time_values = .list(time_values),
-      geo_value = geo_value,
       format = format
     )
+    if(is.list(geo_value)) {
+      params$geo_values = paste(geo_value, collapse=',')
+    } else {
+      params$geo_value = geo_value
+    }
     if(!missing(as_of)) {
       params$as_of <- as_of
     }

src/client/delphi_epidata.coffee

@@ -370,7 +370,10 @@ class Epidata
       'time_type': time_type
       'geo_type': geo_type
       'time_values': _list(time_values)
-      'geo_value': geo_value
+    if Array.isArray(geo_value)
+      params.geo_values = geo_value.join(',')
+    else
+      params.geo_value = geo_value
     if as_of?
       params.as_of = as_of
     if issues?

src/client/delphi_epidata.js

@@ -573,10 +573,15 @@ function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _d
             'signals': signals,
             'time_type': time_type,
             'geo_type': geo_type,
-            'time_values': _list(time_values),
-            'geo_value': geo_value
+            'time_values': _list(time_values)
           };
 
+          if (Array.isArray(geo_value)) {
+            params.geo_values = geo_value.join(',');
+          } else {
+            params.geo_value = geo_value;
+          }
+
           if (as_of != null) {
             params.as_of = as_of;
           }

src/client/delphi_epidata.py

@@ -573,10 +573,13 @@ def covidcast(
       'signals': Epidata._list(signals),
       'time_type': time_type,
       'geo_type': geo_type,
-      'time_values': Epidata._list(time_values),
-      'geo_value': geo_value,
+      'time_values': Epidata._list(time_values)
     }
 
+    if isinstance(geo_value, (list, tuple)):
+      params['geo_values'] = ','.join(geo_value)
+    else:
+      params['geo_value'] = geo_value
     if as_of is not None:
       params['as_of'] = as_of
     if issues is not None: