Hydro-Quebec-API-Wrapper 4.3.0__tar.gz → 4.3.1__tar.gz

{hydro_quebec_api_wrapper-4.3.0 → hydro_quebec_api_wrapper-4.3.1/Hydro_Quebec_API_Wrapper.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Hydro-Quebec-API-Wrapper
-Version: 4.3.0
+Version: 4.3.1
 Summary: A wrapper library to access hydro quebec API and more
 Home-page: https://hydroqc.ca
 Author-email: Hydroqc Team <info@hydroqc.ca>

{hydro_quebec_api_wrapper-4.3.0/Hydro_Quebec_API_Wrapper.egg-info → hydro_quebec_api_wrapper-4.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: Hydro-Quebec-API-Wrapper
-Version: 4.3.0
+Version: 4.3.1
 Summary: A wrapper library to access hydro quebec API and more
 Home-page: https://hydroqc.ca
 Author-email: Hydroqc Team <info@hydroqc.ca>

{hydro_quebec_api_wrapper-4.3.0 → hydro_quebec_api_wrapper-4.3.1}/hydroqc/hydro_api/client.py

@@ -167,6 +167,7 @@ class HydroClient:
         # Azure AD B2C login state
         self._code_verifier: str = ""
         self._mfa_challenge: MFAChallenge | None = None
+        self._send_mfa_code: bool = True
         self._pending_cookies: list[dict[str, Any]] = []
 
         # OAuth handling variables
@@ -413,15 +414,18 @@ class HydroClient:
             return False
         return True
 
-    async def login(self) -> LoginStatus:
+    async def login(self, *, send_mfa_code: bool = True) -> LoginStatus:
         """Log in HydroQuebec website.
 
         Hydroquebec is using B2C solution for authentication. The policy may now
         stop after the password round trip and ask for a one-time code sent by
         e-mail: :attr:`LoginStatus.MFA_REQUIRED` is then returned and the code
-        has to be submitted with :meth:`submit_mfa_code`.
+        has to be submitted with :meth:`submit_mfa_code`. Set ``send_mfa_code``
+        to ``False`` to stop at that step without asking the portal to send a
+        code: only an interactive caller should let the user request one.
         """
         self._logger.info("Login using %s", self.username)
+        self._send_mfa_code = send_mfa_code
 
         # Reset cache
         self.reset()
@@ -658,7 +662,8 @@ class HydroClient:
             self.username,
             challenge.description,
         )
-        await self.request_mfa_code()
+        if self._send_mfa_code:
+            await self.request_mfa_code()
         return LoginStatus.MFA_REQUIRED
 
     async def request_mfa_code(self) -> bool:

{hydro_quebec_api_wrapper-4.3.0 → hydro_quebec_api_wrapper-4.3.1}/tests/unit/test_login_flow.py

@@ -70,6 +70,23 @@ async def test_login_reports_mfa_for_a_code_step() -> None:
     await client.close_session()
 
 
+@pytest.mark.asyncio(loop_scope="module")
+async def test_login_can_skip_requesting_the_code() -> None:
+    """A background caller can stop at the code step without sending an e-mail."""
+    transport = build_mfa_login()
+    client = build_client(transport)
+
+    assert await client.login(send_mfa_code=False) is LoginStatus.MFA_REQUIRED
+    assert client._mfa_challenge is not None
+    assert not transport.called(SEND_CODE_URL)
+
+    # The caller that actually asks the user for the code sends it explicitly.
+    assert await client.request_mfa_code() is True
+    assert transport.called(SEND_CODE_URL)
+
+    await client.close_session()
+
+
 @pytest.mark.asyncio(loop_scope="module")
 async def test_login_reports_mfa_from_a_redirect() -> None:
     """A redirect to the verification page is also recognised."""