Merge pull request #142 from IDEMSInternational/update-models-for-surveys

Update models for surveys

Author: edmoss345

Diff for: src/parenttext_pipeline/configs.py

@@ -51,30 +51,42 @@ class UpdateExpirationStepConfig(StepConfig):
 
 @dataclass(kw_only=True)
 class QRTreatmentStepConfig(StepConfig):
+
     # str: how to process quick replies
     # move: Remove quick replies and add equivalents to them to the message text,
     #     and give numerical prompts to allow basic phone users to use the app.
     # move_and_mod: As above but has additional functionality allowing you
     #     to replace phrases
     # reformat: Reformat quick replies so that long ones are added to the message text,
     #     as above.
+    # reformat_whatsapp: Reformat quick replies to meet the length and message restrictions of whatsapp
+    # reformat_palestine: Reformat quick replies to the standard as needed by Palestine
     # reformat_china: Reformat quick replies to the standard as requested by China
     # wechat: All quick replies moved to links in message text as can be used in WeChat
     qr_treatment: str
-    # ???
-    qr_limit: int = 10
+
     # When qr_treatment is 'reformat',
     # set limits on the number of quick replies that are processed.
     # If the number of quick replies is below or equal to count_threshold
     # then the quick replies are left in place.
     count_threshold: str = None
+    
     # When qr_treatment is 'reformat', set limits on the number of quick replies
     # that are processed. If the character-length of the longest quick reply is
     # below or equal to length_threshold then the quick replies are left in place.
     length_threshold: str = None
+
+    # When qr_treatment is 'reformat', assuming that we are moving quick replies to
+    # message text. Normally we add numerical quick replies back in, but if the number of 
+    # quick replies is above the qr_limit then numerical quick replies are not added.
+    # Should be used where platforms have limits on the number of quick replies they can send
+    # Default is set at 10 as that is the limit on whatsapp 
+    qr_limit: int = 10
+    
     # If qr_treatment is 'move', add some basic numerical quick replies back in.
     # Valid values are 'yes' or 'no'.
     add_selectors: str = None
+    
     # Path to file with the default phrase (including translations) we want to add
     # if quick replies are being moved to message text.
     replace_phrases: str = ""

Diff for: src/parenttext_pipeline/models/parenttext_models.py

@@ -9,10 +9,12 @@ class VariableModel(DataRowModel):
 
 
 class AttachmentModel(ParserModel):
-    file_type: str = ""
-    url: str = ""
-
-
+	file_type: str = ''
+	url: str = ''
+	
+class MetadataModel(ParserModel):
+    description: str = ''
+###################################################################
 class IntroductionBlockModel(ParserModel):
     msg_list: List[str] = []
 
@@ -192,6 +194,16 @@ class RelevantModel(ParserModel):
     condition_type: str = ""
 
 
+
+class IntroModel(DataRowModel):
+	filter_list:  List[str] = ""
+	relevant: List[RelevantModel] = []
+	msg: List[str] = []
+	next_button_option: str = ''
+	attachment: AttachmentModel = AttachmentModel()
+	metadata: MetadataModel = MetadataModel()
+
+
 class OnboardingStepsModel(DataRowModel):
     flow: str = ""
     survey_id: str = ""
@@ -221,30 +233,32 @@ class OnboardingQuestionWithOptionsModel(DataRowModel):
     excluded_values: List[str] = []
     confirm_question: str = ""
     go_back_opt: str = ""
+    proceed_opt: str = ""
     stop_opt: str = ""
     stop_message: str = ""
     update_flow: str = ""
     relevant: List[RelevantModel] = []
 
 
 class OnboardingQuestionInputTestModel(ParserModel):
-    expression: str = ""
-    value: str = ""
-    condition_type: str = ""
-
+	expression: str = ''
+	value: str = ''
+	condition_type: str = ''
+	error_message: str = ''
 
 class OnboardingQuestionInputModel(DataRowModel):
-    question: str = ""
-    variable: str = ""
-    skip_option: str = ""
-    skip_value: str = ""
-    test: OnboardingQuestionInputTestModel = OnboardingQuestionInputTestModel()
-    error_message: str = ""
-    capitalise: str = ""
-    attached_single_doc: str = ""
-    relevant: List[RelevantModel] = []
-    update_flow: str = ""
-
+	filter_list:  List[str] = ""
+	question: str = ''
+	variable: str = ''
+	skip_option: str = ''
+	skip_value: str = ''
+	test: OnboardingQuestionInputTestModel = OnboardingQuestionInputTestModel()
+	tests: List[OnboardingQuestionInputTestModel] = []
+	error_message: str = ''
+	capitalise: str = ''
+	attached_single_doc: str = ''
+	relevant: List[RelevantModel] = []
+	update_flow: str = ''
 
 class OnboardingRangeModel(ParserModel):
     limit: str = ""
@@ -496,8 +510,6 @@ class CongratsDataModel(DataRowModel):
     extra_msg: str = ""
 
 
-class MetadataModel(ParserModel):
-    description: str = ""
 
 
 class SingleMessageModel(DataRowModel):

Diff for: src/parenttext_pipeline/steps.py

@@ -141,6 +141,18 @@ def apply_qr_treatment(config, step_config, step_number, step_input_file):
             special_words_file,
         )
         print("Step 8 complete, reformatted quick replies")
+    elif step_config.qr_treatment == "reformat_palestine":
+        run_node(
+            "idems_translation_chatbot/index.js",
+            "reformat_quick_replies_palestine",
+            step_input_file,
+            select_phrases_file,
+            step_output_basename,
+            config.temppath,
+            str(step_config.qr_limit),
+            special_words_file,
+        )
+        print("Step 8 complete, reformatted quick replies palestine")
     elif step_config.qr_treatment == "reformat_china":
         run_node(
             "idems_translation_chatbot/index.js",