Merge pull request #210 from sgratzl/sgratzl/csv

csv and raw json

Author: krivard

integrations/server/test_covidcast.py

@@ -79,6 +79,76 @@ def test_round_trip(self):
       'message': 'success',
     })
 
+
+  def test_csv_format(self):
+    """Test generate csv data."""
+
+    # insert dummy data
+    self.cur.execute('''
+      insert into covidcast values
+        (0, 'src', 'sig', 'day', 'county', 20200414, '01234',
+          123, 1.5, 2.5, 3.5, 456, 4, 20200414, 0, 1, False)
+    ''')
+    self.cnx.commit()
+
+    # make the request
+    response = requests.get(BASE_URL, params={
+      'source': 'covidcast',
+      'data_source': 'src',
+      'signal': 'sig',
+      'time_type': 'day',
+      'geo_type': 'county',
+      'time_values': 20200414,
+      'geo_value': '01234',
+      'format': 'csv'
+    })
+    response.raise_for_status()
+    response = response.text
+
+    # assert that the right data came back
+    self.assertEqual(response,
+"""geo_value,signal,time_value,direction,issue,lag,value,stderr,sample_size
+01234,sig,20200414,4,20200414,0,1.5,2.5,3.5
+""")
+
+  def test_raw_json_format(self):
+    """Test generate raw json data."""
+
+    # insert dummy data
+    self.cur.execute('''
+      insert into covidcast values
+        (0, 'src', 'sig', 'day', 'county', 20200414, '01234',
+          123, 1.5, 2.5, 3.5, 456, 4, 20200414, 0, 1, False)
+    ''')
+    self.cnx.commit()
+
+    # make the request
+    response = requests.get(BASE_URL, params={
+      'source': 'covidcast',
+      'data_source': 'src',
+      'signal': 'sig',
+      'time_type': 'day',
+      'geo_type': 'county',
+      'time_values': 20200414,
+      'geo_value': '01234',
+      'format': 'json'
+    })
+    response.raise_for_status()
+    response = response.json()
+
+    # assert that the right data came back
+    self.assertEqual(response, [{
+      'time_value': 20200414,
+      'geo_value': '01234',
+      'value': 1.5,
+      'stderr': 2.5,
+      'sample_size': 3.5,
+      'direction': 4,
+      'issue': 20200414,
+      'lag': 0,
+      'signal': 'sig',
+    }])
+
   def test_fields(self):
     """Test to limit fields field"""
 

src/server/api.php

@@ -1566,7 +1566,13 @@ function meta_delphi() {
   $data['message'] = 'database error';
 }
 
-// send the response as a json object
-header('Content-Type: application/json');
-echo json_encode($data);
+if(isset($_REQUEST['format']) && $_REQUEST['format'] == "csv") {
+  send_csv($data);
+} else if(isset($_REQUEST['format']) && $_REQUEST['format'] == "json") {
+  send_json($data);
+} else {
+  // send the response as a json object
+  header('Content-Type: application/json');
+  echo json_encode($data);
+}
 ?>

src/server/api_helpers.php

@@ -367,5 +367,55 @@ function record_analytics($source, $data) {
   mysqli_query($dbh, "INSERT INTO `api_analytics` (`datetime`, `ip`, `ua`, `source`, `result`, `num_rows`) VALUES (now(), '{$ip}', '{$ua}', '{$source}', {$result}, {$num_rows})");
 }
 
+function send_status(&$data) {
+  if (intval($data["result"]) > 0 || intval($data["result"]) == -2) {
+    return FALSE;
+  }
+  if ($data["message"] == 'database error') {
+    http_response_code(500);
+  } else if ($data["message"] == 'unauthenticated') {
+    http_response_code(401);
+  } else {
+    http_response_code(400); // bad request
+  }
+  header('Content-Type: application/json');
+  echo json_encode($data);
+  return TRUE;
+}
+
+function send_csv(&$data) {
+  if (send_status($data)) {
+    return;
+  }
+  header('Content-Type: text/csv');
+  header('Content-Disposition: attachment; filename=epidata.csv');
+
+  if (intval(data["result"]) == -2) {
+    // empty
+    return;
+  }
+
+  $rows = $data["epidata"];
+  $headers = array_keys($rows[0]);
+  $out = fopen('php://output', 'w');
+  fputcsv($out, $headers);
+  foreach ($rows as $row) {
+    fputcsv($out, $row);
+  }
+  fclose($out);
+}
+
+function send_json(&$data) {
+  if (send_status($data)) {
+    return;
+  }
+  header('Content-Type: application/json');
+
+  if (intval($data["result"]) == -2) {
+    echo json_encode(array());
+  } else {
+    echo json_encode($data["epidata"]);
+  }
+}
 
 ?>