Add study variables class

Author: “Carmel

__pycache__/app.cpython-311.pyc

@@ -1,4 +1,6 @@
 from pathlib import Path
+from dataclasses import dataclass
+from typing import Optional
 
 from flask import Flask, json, render_template, request, jsonify
 import requests
@@ -19,12 +21,49 @@
 CONFIG_PATH = Path(__file__).resolve().with_name("study_configs.yaml")
 STUDIES = yaml.safe_load(CONFIG_PATH.read_text(encoding="utf-8"))
 
-def get_study_settings(study_key: str):
-    study = STUDIES.get(study_key)
-    if not study:
-        return None, None, None
 
-    return study, study.get("ldot_variables", {}), study.get("qualtrics_variables", {})
+@dataclass
+class StudySettings:
+    study_id: str
+    name: str
+    ldot_study_id: Optional[str] = None
+    id_deelnemer_entity: Optional[str] = None
+    id_location: Optional[str] = None
+    custom_var_qualtrics_link: Optional[str] = None
+    eaid_qualtrics_survey_link_creation_to_do_date: Optional[str] = None
+    eaid_qualtrics_survey_link_creation_completed: Optional[str] = None
+    eaid_survey_invitation_completed: Optional[str] = None
+    eaid_survey_progress_completed: Optional[str] = None
+    survey_id: Optional[str] = None
+    mailing_list_id: Optional[str] = None
+    embedded_data_field: Optional[str] = None
+    directory_id: Optional[str] = None
+    distribution_id: Optional[str] = None
+
+def get_study_settings(study_key: str):
+    study_variables = STUDIES.get(study_key)
+    if not study_variables:
+        return None
+
+    ldot_vars = study_variables.get("ldot_variables", {})
+    qualtrics_vars = study_variables.get("qualtrics_variables", {})
+    return StudySettings(
+        study_id=study_key,
+        name=study_variables.get("name", study_key),
+        ldot_study_id=ldot_vars.get("ldot_study_id"),
+        id_deelnemer_entity=ldot_vars.get("id_deelnemer_entity"),
+        id_location=ldot_vars.get("id_location"),
+        custom_var_qualtrics_link=ldot_vars.get("custom_var_qualtrics_link"),
+        eaid_qualtrics_survey_link_creation_to_do_date=ldot_vars.get("eaid_qualtrics_survey_link_creation_to_do_date"),
+        eaid_qualtrics_survey_link_creation_completed=ldot_vars.get("eaid_qualtrics_survey_link_creation_completed"),
+        eaid_survey_invitation_completed=ldot_vars.get("eaid_survey_invitation_completed"),
+        eaid_survey_progress_completed=ldot_vars.get("eaid_survey_progress_completed"),
+        survey_id=qualtrics_vars.get("survey_id"),
+        mailing_list_id=qualtrics_vars.get("mailing_list_id"),
+        embedded_data_field=qualtrics_vars.get("embedded_data_field"),
+        directory_id=qualtrics_vars.get("directory_id"),
+        distribution_id=qualtrics_vars.get("distribution_id"),
+    )
 
 
 with open("new_ldot_workflows/ldot_config.json") as f:
@@ -53,16 +92,17 @@ def button1():
     data = request.json
     study_id = data.get("study_id")
 
-    study, ldot_vars, qualtrics_vars = get_study_settings(study_id)
-    if not study:
+    study_variables = get_study_settings(study_id)
+    if not study_variables:
         return jsonify({"success": False, "message": f"Unknown study_id: {study_id}"}), 400
 
-    ldot_study_id = ldot_vars.get("ldot_study_id")
-    link_creation_eaid = ldot_vars.get("eaid_qualtrics_survey_link_creation_to_do_date")
-    link_completed_eaid = ldot_vars.get("eaid_qualtrics_survey_link_creation_completed")
-
     try:
-        new_subjects_ids = get_new_subjects(ldot_client, ldot_study_id, link_creation_eaid, link_completed_eaid)
+        new_subjects_ids = get_new_subjects(
+            ldot_client,
+            study_variables.get("ldot_study_id"),
+            study_variables.get("eaid_qualtrics_survey_link_creation_to_do_date"),
+            study_variables.get("eaid_qualtrics_survey_link_creation_completed"),
+        )
     except QualtricsAPIError as e:
         return jsonify({"success": False, "message": str(e)}), 502
     except requests.RequestException as e:
@@ -94,36 +134,45 @@ def button2():
         })
 
     # Lookup study variables from STUDIES config
-    study, ldot_vars, qualtrics_vars = get_study_settings(study_id)
+    study_variables = get_study_settings(study_id)
 
-    ldot_study_id = ldot_vars.get("ldot_study_id")
-    id_deelnemer_entity = ldot_vars.get("id_deelnemer_entity")
-    id_location = ldot_vars.get("id_location")
-    custom_var_qualtrics_link = ldot_vars.get("custom_var_qualtrics_link")
-    link_completed_eaid = ldot_vars.get("eaid_qualtrics_survey_link_creation_completed")
-
-    qualtrics_survey_id = qualtrics_vars.get("survey_id")
-    mailing_list_id = qualtrics_vars.get("mailing_list_id")
-    embedded_data_field = qualtrics_vars.get("embedded_data_field")
-    directory_id = qualtrics_vars.get("directory_id")
-    distribution_id = qualtrics_vars.get("distribution_id")
+    if not study_variables:
+        return jsonify({"success": False, "message": f"Unknown study_id: {study_id}"}), 400
 
     debug_inputs = {
         "study_id": study_id,
-        "ldot_study_id": ldot_study_id,
-        "id_deelnemer_entity": id_deelnemer_entity,
-        "id_location": id_location,
+        "ldot_study_id": study_variables.get("ldot_study_id"),
+        "id_deelnemer_entity": study_variables.get("id_deelnemer_entity"),
+        "id_location": study_variables.get("id_location"),
         "new_subject_ids": new_subject_ids,
-        "qualtrics_survey_id": qualtrics_survey_id,
-        "mailing_list_id": mailing_list_id,
-        "embedded_data_field": embedded_data_field,
-        "directory_id": directory_id,
-        "distribution_id": distribution_id
+        "qualtrics_survey_id": study_variables.get("qualtrics_survey_id"),
+        "mailing_list_id": study_variables.get("mailing_list_id"),
+        "embedded_data_field": study_variables.get("embedded_data_field"),
+        "directory_id": study_variables.get("directory_id"),
+        "distribution_id": study_variables.get("distribution_id"),
     }
 
     try:
-        subject_id_to_link_dict = add_individuals_to_survey(ldot_client, new_subject_ids, ldot_study_id, id_deelnemer_entity, embedded_data_field, distribution_id, qualtrics_survey_id, mailing_list_id, directory_id)
-        send_links_to_ldot(ldot_client, ldot_study_id, id_deelnemer_entity, id_location, custom_var_qualtrics_link, link_completed_eaid, subject_id_to_link_dict)
+        subject_id_to_link_dict = add_individuals_to_survey(
+            ldot_client,
+            new_subject_ids,
+            study_variables.get("ldot_study_id"),
+            study_variables.get("id_deelnemer_entity"),
+            study_variables.get("embedded_data_field"),
+            study_variables.get("distribution_id"),
+            study_variables.get("qualtrics_survey_id"),
+            study_variables.get("mailing_list_id"),
+            study_variables.get("directory_id"),
+        )
+        send_links_to_ldot(
+            ldot_client,
+            study_variables.get("ldot_study_id"),
+            study_variables.get("id_deelnemer_entity"),
+            study_variables.get("id_location"),
+            study_variables.get("custom_var_qualtrics_link"),
+            study_variables.get("eaid_qualtrics_survey_link_creation_completed"),
+            subject_id_to_link_dict,
+        )
     except QualtricsAPIError as e:
         return jsonify({"success": False, "message": str(e), "debug_inputs": debug_inputs}), 502
     except Exception as e:
@@ -142,17 +191,18 @@ def button3():
     """Third API call - returns list of subjectIDs"""
     data = request.json
     study_id = data.get("study_id")
-    study, ldot_vars, qualtrics_vars = get_study_settings(study_id)
+    study_variables = get_study_settings(study_id)
 
-    if not study:
+    if not study_variables:
         return jsonify({"success": False, "message": f"Unknown study_id: {study_id}"}), 400
-    
-    ldot_study_id = ldot_vars.get("ldot_study_id")
-    eaid_survey_invitation_completed = ldot_vars.get("eaid_survey_invitation_completed")
-    eaid_survey_progress_completed = ldot_vars.get("eaid_survey_progress_completed")
 
     try:
-        subjects_not_completed_survey = get_incomplete_subjects(ldot_client, ldot_study_id, eaid_survey_invitation_completed, eaid_survey_progress_completed)
+        subjects_not_completed_survey = get_incomplete_subjects(
+            ldot_client,
+            study_variables.get("ldot_study_id"),
+            study_variables.get("eaid_survey_invitation_completed"),
+            study_variables.get("eaid_survey_progress_completed"),
+        )
         message = f"Found {len(subjects_not_completed_survey)} subjects who have not completed the survey"
         return jsonify({"success": True, "message": message, "subject_ids": subjects_not_completed_survey})
     except QualtricsAPIError as e:
@@ -171,16 +221,21 @@ def button4():
     if not study_id:
         return jsonify({"success": False, "message": "Missing study_id in request"}), 400
 
-    study, ldot_vars, qualtrics_vars = get_study_settings(study_id)
+    study_variables = get_study_settings(study_id)
 
-    ldot_study_id = ldot_vars.get("ldot_study_id")
-    id_deelnemer_entity = ldot_vars.get("id_deelnemer_entity")
-    id_location = ldot_vars.get("id_location")
-    qualtrics_survey_id = qualtrics_vars.get("qualtrics_survey_id")
-    embedded_data_field = qualtrics_vars.get("embedded_data_field")
+    if not study_variables:
+        return jsonify({"success": False, "message": f"Unknown study_id: {study_id}"}), 400
 
     try:
-        participant_to_progress_dict = get_individual_progress(ldot_client, ldot_study_id, id_deelnemer_entity, id_location, subject_ids, embedded_data_field, qualtrics_survey_id)
+        participant_to_progress_dict = get_individual_progress(
+            ldot_client,
+            study_variables.get("ldot_study_id"),
+            study_variables.get("id_deelnemer_entity"),
+            study_variables.get("id_location"),
+            subject_ids,
+            study_variables.get("embedded_data_field"),
+            study_variables.get("qualtrics_survey_id"),
+        )
     except QualtricsAPIError as e:
         return jsonify({"success": False, "message": str(e)}), 502
     except Exception as e:
@@ -190,8 +245,8 @@ def button4():
         "success": True,
         "message": f"Retrieved progress for {len(participant_to_progress_dict)} subjects",
         "study_id": study_id,
-        "qualtrics_survey_id": qualtrics_survey_id,
-        "embedded_data_field": embedded_data_field,
+        "qualtrics_survey_id": study_variables.get("qualtrics_survey_id"),
+        "embedded_data_field": study_variables.get("embedded_data_field"),
         "progress_results": participant_to_progress_dict,
     })