ddl and integration test for fluview

- explicitly define the table
- move (well, copy) data dictionary to the ddl
- introduce an integration test, which is just a simple round-trip

Author: dfarrow0

integrations/test_fluview.py

@@ -0,0 +1,82 @@
+"""Integration tests for the `fluview` endpoint."""
+
+# standard library
+import unittest
+
+# third party
+import mysql.connector
+
+# first party
+from delphi.epidata.client.delphi_epidata import Epidata
+
+
+class FluviewTests(unittest.TestCase):
+  """Tests the `fluview` endpoint."""
+
+  @classmethod
+  def setUpClass(cls):
+    """Perform one-time setup."""
+
+    # use the local instance of the Epidata API
+    Epidata.BASE_URL = 'http://delphi_web_epidata/epidata/api.php'
+
+  def setUp(self):
+    """Perform per-test setup."""
+
+    # connect to the `epidata` database and clear the `fluview` table
+    cnx = mysql.connector.connect(
+        user='user',
+        password='pass',
+        host='delphi_database_epidata',
+        database='epidata')
+    cur = cnx.cursor()
+    cur.execute('truncate table fluview')
+    cnx.commit()
+    cur.close()
+
+    # make connection and cursor available to test cases
+    self.cnx = cnx
+    self.cur = cnx.cursor()
+
+  def tearDown(self):
+    """Perform per-test teardown."""
+    self.cur.close()
+    self.cnx.close()
+
+  def test_round_trip(self):
+    """Make a simple round-trip with some sample data."""
+
+    # insert dummy data
+    self.cur.execute('''
+      insert into fluview values
+        (0, "2020-04-07", 202021, 202020, "nat", 1, 2, 3, 4, 3.14159, 1.41421,
+        10, 11, 12, 13, 14, 15)
+    ''')
+    self.cnx.commit()
+
+    # make the request
+    response = Epidata.fluview('nat', 202020)
+
+    # assert that the right data came back
+    self.assertEqual(response, {
+      "result": 1,
+      "epidata": [{
+         "release_date": "2020-04-07",
+         "region": "nat",
+         "issue": 202021,
+         "epiweek": 202020,
+         "lag": 1,
+         "num_ili": 2,
+         "num_patients": 3,
+         "num_providers": 4,
+         "num_age_0": 10,
+         "num_age_1": 11,
+         "num_age_2": 12,
+         "num_age_3": 13,
+         "num_age_4": 14,
+         "num_age_5": 15,
+         "wili": 3.14159,
+         "ili": 1.41421,
+       }],
+      "message": "success",
+    })

src/ddl/fluview.sql

@@ -0,0 +1,88 @@
+/*
+Stores ILI data from the CDC.
+
++---------------+-------------+------+-----+---------+----------------+
+| Field         | Type        | Null | Key | Default | Extra          |
++---------------+-------------+------+-----+---------+----------------+
+| id            | int(11)     | NO   | PRI | NULL    | auto_increment |
+| release_date  | date        | NO   | MUL | NULL    |                |
+| issue         | int(11)     | NO   | MUL | NULL    |                |
+| epiweek       | int(11)     | NO   | MUL | NULL    |                |
+| region        | varchar(12) | NO   | MUL | NULL    |                |
+| lag           | int(11)     | NO   | MUL | NULL    |                |
+| num_ili       | int(11)     | NO   |     | NULL    |                |
+| num_patients  | int(11)     | NO   |     | NULL    |                |
+| num_providers | int(11)     | NO   |     | NULL    |                |
+| wili          | double      | NO   |     | NULL    |                |
+| ili           | double      | NO   |     | NULL    |                |
+| num_age_0     | int(11)     | YES  |     | NULL    |                |
+| num_age_1     | int(11)     | YES  |     | NULL    |                |
+| num_age_2     | int(11)     | YES  |     | NULL    |                |
+| num_age_3     | int(11)     | YES  |     | NULL    |                |
+| num_age_4     | int(11)     | YES  |     | NULL    |                |
+| num_age_5     | int(11)     | YES  |     | NULL    |                |
++---------------+-------------+------+-----+---------+----------------+
+
+id:
+  unique identifier for each record
+release_date:
+  the date when this record was first published by the CDC
+issue:
+  the epiweek of publication (e.g. issue 201453 includes epiweeks up to and
+  including 2014w53, but not 2015w01 or following)
+epiweek:
+  the epiweek during which the data was collected
+region:
+  the name of the location (e.g. 'nat', 'hhs1', 'cen9', 'pa', 'jfk')
+lag:
+  number of weeks between `epiweek` and `issue`
+num_ili:
+  the number of ILI cases (numerator)
+num_patients:
+  the total number of patients (denominator)
+num_providers:
+  the number of reporting healthcare providers
+wili:
+  weighted percent ILI
+ili:
+  unweighted percent ILI
+num_age_0:
+  number of cases in ages 0-4
+num_age_1:
+  number of cases in ages 5-24
+num_age_2:
+  number of cases in ages 25-64
+num_age_3:
+  number of cases in ages 25-49
+num_age_4:
+  number of cases in ages 50-64
+num_age_5:
+  number of cases in ages 65+
+*/
+
+CREATE TABLE `fluview` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `release_date` date NOT NULL,
+  `issue` int(11) NOT NULL,
+  `epiweek` int(11) NOT NULL,
+  `region` varchar(12) NOT NULL,
+  `lag` int(11) NOT NULL,
+  `num_ili` int(11) NOT NULL,
+  `num_patients` int(11) NOT NULL,
+  `num_providers` int(11) NOT NULL,
+  `wili` double NOT NULL,
+  `ili` double NOT NULL,
+  `num_age_0` int(11) DEFAULT NULL,
+  `num_age_1` int(11) DEFAULT NULL,
+  `num_age_2` int(11) DEFAULT NULL,
+  `num_age_3` int(11) DEFAULT NULL,
+  `num_age_4` int(11) DEFAULT NULL,
+  `num_age_5` int(11) DEFAULT NULL,
+  PRIMARY KEY (`id`),
+  UNIQUE KEY `issue` (`issue`,`epiweek`,`region`),
+  KEY `release_date` (`release_date`),
+  KEY `issue_2` (`issue`),
+  KEY `epiweek` (`epiweek`),
+  KEY `region` (`region`),
+  KEY `lag` (`lag`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1;