Merge pull request #517 from biocore/csymons_metadata_updates

Adjustments to Metadata Push

Author: cassidysymons

.github/workflows/python-package-conda.yml

@@ -56,6 +56,7 @@ jobs:
         VS_PASSWORD: "${{ secrets.VS_PASSWORD }}"
         VS_CRYPTOKEY: "${{ secrets.VS_CRYPTOKEY }}"
         VS_REGCODE: "${{ secrets.VS_REGCODE }}"
+        GOOGLE_GEOCODING_KEY: "${{ secrets.GOOGLE_GEOCODING_KEY }}"
       run: |
         # pull out the port so we can modify the configuration file easily
         pgport=${{ job.services.postgres.ports[5432] }}

microsetta_private_api/admin/tests/test_admin_api.py

@@ -60,6 +60,9 @@ def setup_test_data():
                           12345,
                           "US"
                       ),
+                      32.8798916,
+                      -117.2363115,
+                      False,
                       "fakekit",
                       "en_US")
         acct_repo.create_account(acc)

microsetta_private_api/admin/tests/test_admin_repo.py

@@ -85,6 +85,9 @@ def setup_test_data():
                               12345,
                               "US"
                           ),
+                          32.8798916,
+                          -117.2363115,
+                          False,
                           "fakekit",
                           "en_US")
             acct_repo.create_account(acc)
@@ -103,6 +106,9 @@ def setup_test_data():
                               12345,
                               "US"
                           ),
+                          32.8798916,
+                          -117.2363115,
+                          False,
                           "fakekit",
                           "en_US")
             acct_repo.create_account(acc)

microsetta_private_api/api/_account.py

@@ -16,6 +16,7 @@
 from microsetta_private_api.repo.kit_repo import KitRepo
 from microsetta_private_api.repo.transaction import Transaction
 from microsetta_private_api.config_manager import SERVER_CONFIG
+from microsetta_private_api.util.google_geocoding import geocode_address
 
 
 def find_accounts_for_login(token_info):
@@ -66,6 +67,12 @@ def register_account(body, token_info):
     code = body.get("code", "")
     body["code"] = code
 
+    # We need these keys to exist to create the account object, but we'll
+    # update them momentarily
+    body["latitude"] = None
+    body["longitude"] = None
+    body["cannot_geocode"] = False
+
     account_obj = Account.from_dict(body, token_info[JWT_ISS_CLAIM_KEY],
                                     token_info[JWT_SUB_CLAIM_KEY])
 
@@ -96,6 +103,16 @@ def register_account(body, token_info):
         acct_repo = AccountRepo(t)
         acct_repo.create_account(account_obj)
         new_acct = acct_repo.get_account(new_acct_id)
+
+        # Now that we've successfully created an account, geocode it
+        latitude, longitude, _, _, cannot_geocode = geocode_address(
+            new_acct.address
+        )
+        new_acct.latitude = latitude
+        new_acct.longitude = longitude
+        new_acct.cannot_geocode = cannot_geocode
+        acct_repo.update_account(new_acct)
+
         t.commit()
 
     response = jsonify(new_acct.to_api())
@@ -143,6 +160,17 @@ def update_account(account_id, body, token_info):
         )
         acc.language = body['language']
 
+        # Whenever someone updates their address, we need to update geocoding
+        # info. We don't need to check if they're actually changing their
+        # address, as the geocoding code prevents duplicate requests from
+        # reaching Google's API
+        latitude, longitude, _, _, cannot_geocode = geocode_address(
+            acc.address
+        )
+        acc.latitude = latitude
+        acc.longitude = longitude
+        acc.cannot_geocode = cannot_geocode
+
         # 422 handling is done inside acct_repo
         acct_repo.update_account(acc)
         t.commit()

microsetta_private_api/api/tests/test_api.py

@@ -77,7 +77,10 @@
     "first_name": "Jane",
     "last_name": "Doe",
     "language": "en_US",
-    KIT_NAME_KEY: EXISTING_KIT_NAME
+    KIT_NAME_KEY: EXISTING_KIT_NAME,
+    "latitude": 32.8798916,
+    "longitude": -117.2363115,
+    "cannot_geocode": False
 }
 DUMMY_ACCT_INFO_2 = {
     "address": {
@@ -91,7 +94,10 @@
     "first_name": "Obie",
     "last_name": "Dobie",
     "language": "en_US",
-    KIT_NAME_KEY: EXISTING_KIT_NAME_2
+    KIT_NAME_KEY: EXISTING_KIT_NAME_2,
+    "latitude": 32.8798916,
+    "longitude": -117.2363115,
+    "cannot_geocode": False
 }
 DUMMY_ACCT_ADMIN = {
     "address": {
@@ -104,7 +110,10 @@
     "email": TEST_EMAIL_3,
     "first_name": "Obie",
     "last_name": "Dobie",
-    KIT_NAME_KEY: EXISTING_KIT_NAME_2
+    KIT_NAME_KEY: EXISTING_KIT_NAME_2,
+    "latitude": 32.8798916,
+    "longitude": -117.2363115,
+    "cannot_geocode": False
 }
 
 SOURCE_ID_1 = "9fba75a5-6fbf-42be-9624-731b6a9a161a"
@@ -467,6 +476,9 @@ def _create_dummy_acct_from_t(t, create_dummy_1=True,
                 input_obj['address']['post_code'],
                 input_obj['address']['country_code']
             ),
+            input_obj['latitude'],
+            input_obj['longitude'],
+            input_obj['cannot_geocode'],
             input_obj['kit_name'],
             input_obj['language']
         )
@@ -697,6 +709,16 @@ def validate_dummy_acct_response_body(self, response_obj,
         expected_dict[ACCT_TYPE_KEY] = ACCT_TYPE_VAL
         expected_dict[CREATION_TIME_KEY] = real_creation_time
         expected_dict[UPDATE_TIME_KEY] = real_update_time
+
+        # the lat, long, and cannot_geocode need to be ignored for the sake of
+        # comparisons
+        expected_dict.pop("latitude", None)
+        expected_dict.pop("longitude", None)
+        expected_dict.pop("cannot_geocode", None)
+        response_obj.pop("latitude", None)
+        response_obj.pop("longitude", None)
+        response_obj.pop("cannot_geocode", None)
+
         self.assertEqual(expected_dict, response_obj)
 
         return real_acct_id_from_body
@@ -740,11 +762,15 @@ def test_accounts_create_success(self):
 
     def test_accounts_create_fail_400_without_required_fields(self):
         """Return 400 validation fail if don't provide a required field """
+        input_obj = copy.deepcopy(DUMMY_ACCT_INFO)
+        input_obj.pop('latitude', None)
+        input_obj.pop('longitude', None)
+        input_obj.pop('cannot_geocode', None)
 
         self.run_query_and_content_required_field_test(
             "/api/accounts", "post",
             self.default_querystring_dict,
-            DUMMY_ACCT_INFO,
+            input_obj,
             skip_fields=["kit_name"])
 
     def test_accounts_create_fail_404(self):
@@ -926,7 +952,8 @@ def test_account_scrub_success(self):
         response_obj = json.loads(response.data)
 
         for k in DUMMY_ACCT_INFO:
-            if k in (KIT_NAME_KEY, 'language'):
+            if k in (KIT_NAME_KEY, 'language', 'cannot_geocode', 'latitude',
+                     'longitude'):
                 continue
             self.assertNotEqual(DUMMY_ACCT_INFO[k],
                                 response_obj[k])
@@ -1251,6 +1278,9 @@ def test_account_update_fail_400_without_required_fields(self):
 
         dummy_acct_id = create_dummy_acct()
         changed_acct_dict = self.make_updated_acct_dict()
+        changed_acct_dict.pop('latitude', None)
+        changed_acct_dict.pop('longitude', None)
+        changed_acct_dict.pop('cannot_geocode', None)
 
         input_url = "/api/accounts/{0}".format(dummy_acct_id)
         self.run_query_and_content_required_field_test(

microsetta_private_api/api/tests/test_integration.py

@@ -173,6 +173,9 @@ def setup_test_data():
                               12345,
                               "US"
                           ),
+                          32.8798916,
+                          -117.2363115,
+                          False,
                           "fakekit",
                           "en_US")
             acct_repo.create_account(acc)
@@ -779,6 +782,9 @@ def test_edit_account_info(self):
         # Hard to guess these two, so let's pop em out
         acc.pop("creation_time")
         acc.pop("update_time")
+        acc.pop("latitude")
+        acc.pop("longitude")
+        acc.pop("cannot_geocode")
         self.assertDictEqual(acc, regular_data, "Check Initial Account Match")
 
         regular_data.pop("account_id")
@@ -822,6 +828,9 @@ def test_edit_account_info(self):
         fuzzy_data["account_id"] = "aaaaaaaa-bbbb-cccc-dddd-eeeeffffffff"
         acc.pop('creation_time')
         acc.pop('update_time')
+        acc.pop("latitude")
+        acc.pop("longitude")
+        acc.pop("cannot_geocode")
         self.assertDictEqual(fuzzy_data, acc, "Check Fuzz Account Match")
 
         # Attempt to restore back to old data.
@@ -838,6 +847,9 @@ def test_edit_account_info(self):
 
         acc.pop('creation_time')
         acc.pop('update_time')
+        acc.pop("latitude")
+        acc.pop("longitude")
+        acc.pop("cannot_geocode")
         regular_data['account_type'] = 'standard'
         regular_data["account_id"] = "aaaaaaaa-bbbb-cccc-dddd-eeeeffffffff"
 

microsetta_private_api/celery_utils.py

@@ -44,10 +44,6 @@ def __call__(self, *args, **kwargs):
         # "fetch_ffqs": {
         #     "task": "microsetta_private_api.util.vioscreen.fetch_ffqs",
         #     "schedule":  60 * 60 * 24  # every 24 hours
-        # },
-        # "geocode_accounts": {
-        #     "task": "microsetta_private_api.tasks.geocode_accounts",
-        #     "schedule": 60
         # }
     }