Merge pull request #100 from alice-biometrics/feature/refactor-onboar…

…ding-step Feature/refactor onboarding step
alice-biometrics · Jan 30, 2024 · ca62504 · ca62504
2 parents 8e5602e + 552bec9
commit ca62504
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 14 deletions.
diff --git a/alice/onboarding/enums/onboarding_steps.py b/alice/onboarding/enums/onboarding_steps.py
@@ -1,7 +1,10 @@
 from enum import Enum
+from typing import Any, Dict, Union
 
+from pydantic import BaseModel
 
-class OnboardingSteps(Enum):
+
+class OnboardingStepName(str, Enum):
     SELFIE = "selfie"
     SELFIE_WITH_CHALLENGE = "selfie_with_challenge"
     IDCARD = "idcard"
@@ -11,3 +14,8 @@ class OnboardingSteps(Enum):
     PASSPORT = "passport"
     OTHER_TRUSTED_DOCUMENT = "otd"
     ANY_DOCUMENT = "anydocument"
+
+
+class OnboardingStep(BaseModel):
+    step: OnboardingStepName
+    config: Union[Dict[str, Any], None] = None
diff --git a/alice/onboarding/onboarding.py b/alice/onboarding/onboarding.py
@@ -13,7 +13,7 @@
 from alice.onboarding.enums.document_source import DocumentSource
 from alice.onboarding.enums.document_type import DocumentType
 from alice.onboarding.enums.duplicates_resource_type import DuplicatesResourceType
-from alice.onboarding.enums.onboarding_steps import OnboardingSteps
+from alice.onboarding.enums.onboarding_steps import OnboardingStep
 from alice.onboarding.enums.user_state import UserState
 from alice.onboarding.enums.version import Version
 from alice.onboarding.models.bounding_box import BoundingBox
@@ -1818,7 +1818,7 @@ def retrieve_flows(
     @early_return
     def create_flow(
         self,
-        steps: List[OnboardingSteps],
+        steps: List[OnboardingStep],
         default: bool,
         name: str,
         id_: Union[str, None] = None,
@@ -1865,7 +1865,7 @@ def create_flow(
     def update_flow(
         self,
         flow_id: str,
-        steps: List[OnboardingSteps],
+        steps: List[OnboardingStep],
         default: bool,
         name: str,
         verbose: bool = False,

diff --git a/alice/onboarding/onboarding_client.py b/alice/onboarding/onboarding_client.py
@@ -15,7 +15,7 @@
 from alice.onboarding.enums.document_source import DocumentSource
 from alice.onboarding.enums.document_type import DocumentType
 from alice.onboarding.enums.duplicates_resource_type import DuplicatesResourceType
-from alice.onboarding.enums.onboarding_steps import OnboardingSteps
+from alice.onboarding.enums.onboarding_steps import OnboardingStep
 from alice.onboarding.enums.user_state import UserState
 from alice.onboarding.enums.version import Version
 from alice.onboarding.models.bounding_box import BoundingBox
@@ -2093,7 +2093,7 @@ def retrieve_flows(self, verbose: bool = False) -> Result[Response, Error]:
     @timeit
     def create_flow(
         self,
-        steps: List[OnboardingSteps],
+        steps: List[OnboardingStep],
         default: bool,
         name: str,
         id_: Union[str, None] = None,
@@ -2129,7 +2129,7 @@ def create_flow(
         data = {
             "default": default,
             "name": name,
-            "steps": [step.value for step in steps],
+            "steps": [step.model_dump() for step in steps],
         }
 
         if id_:
@@ -2153,7 +2153,7 @@ def create_flow(
     def update_flow(
         self,
         flow_id: str,
-        steps: List[OnboardingSteps],
+        steps: List[OnboardingStep],
         default: bool,
         name: str,
         verbose: bool = False,
@@ -2189,7 +2189,7 @@ def update_flow(
             "id": flow_id,
             "default": default,
             "name": name,
-            "steps": [step.value for step in steps],
+            "steps": [step.model_dump() for step in steps],
         }
 
         try:

diff --git a/tests/test_integration_flows.py b/tests/test_integration_flows.py
@@ -3,7 +3,7 @@
 
 from alice import Config, DeviceInfo, Onboarding, UserInfo
 from alice.auth.auth_errors import AuthError
-from alice.onboarding.enums.onboarding_steps import OnboardingSteps
+from alice.onboarding.enums.onboarding_steps import OnboardingStep, OnboardingStepName
 
 
 @pytest.mark.unit
@@ -12,7 +12,7 @@ def test_should_return_an_error_when_the_api_key_is_not_configured():
     onboarding = Onboarding.from_config(config)
 
     result = onboarding.create_flow(
-        steps=[OnboardingSteps.SELFIE],
+        steps=[OnboardingStep(step=OnboardingStepName.SELFIE)],
         default=True,
         name="test",
     )
@@ -26,7 +26,7 @@ def test_should_timeout_when_time_exceeded(given_valid_api_key):
     onboarding = Onboarding.from_config(config)
 
     result = onboarding.create_flow(
-        steps=[OnboardingSteps.SELFIE],
+        steps=[OnboardingStep(step=OnboardingStepName.SELFIE)],
         default=True,
         name="test",
     )
@@ -42,7 +42,7 @@ def do_complete_flow() -> Result[bool, Error]:
         onboarding = Onboarding.from_config(config)
 
         flow_id = onboarding.create_flow(
-            steps=[OnboardingSteps.SELFIE],
+            steps=[OnboardingStep(step=OnboardingStepName.SELFIE)],
             default=False,
             name="alice-flow-test-onboarding-python",
         ).unwrap_or_return()
@@ -61,7 +61,10 @@ def do_complete_flow() -> Result[bool, Error]:
 
         _ = onboarding.update_flow(
             flow_id=flow_id,
-            steps=[OnboardingSteps.SELFIE, OnboardingSteps.IDCARD],
+            steps=[
+                OnboardingStep(step=OnboardingStepName.SELFIE),
+                OnboardingStep(step=OnboardingStepName.IDCARD),
+            ],
             default=False,
             name="alice-flow-test-onboarding-python-updated",
         ).unwrap_or_return()