Skip to content

Add EcobeeAuthMfaRequiredError.challenge property (0.4.2) #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pike00 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add EcobeeAuthMfaRequiredError.challenge property (0.4.2) #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions pyecobee/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ def _generate_pkce_pair() -> tuple[str, str]:
class MfaChallenge:
"""Opaque resumption state for an in-progress MFA-gated login.

Returned (via :class:`EcobeeAuthMfaRequiredError`) when ecobee Auth0
interrupts the login flow with an MFA challenge. Pass this back into
:meth:`Ecobee.submit_mfa_code` along with the user-entered code to
Returned via :attr:`EcobeeAuthMfaRequiredError.challenge` when ecobee
Auth0 interrupts the login flow with an MFA challenge. Pass this back
into :meth:`Ecobee.submit_mfa_code` along with the user-entered code to
complete the login and obtain tokens.
"""

Expand Down
13 changes: 10 additions & 3 deletions pyecobee/errors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,18 @@ class EcobeeAuthUnknownError(EcobeeError):
class EcobeeAuthMfaRequiredError(EcobeeError):
"""Raised when ecobee Auth0 redirects to an MFA challenge during login.

Carries an :class:`~pyecobee.MfaChallenge` payload (in ``args[0]``) that
must be passed back into :meth:`Ecobee.submit_mfa_code` along with the
user-entered OTP code to resume the login flow.
Carries an :class:`~pyecobee.MfaChallenge` payload that must be passed
back into :meth:`Ecobee.submit_mfa_code` along with the user-entered OTP
code to resume the login flow.

Prefer :attr:`challenge` over indexing ``args[0]``.
"""

@property
def challenge(self):
"""Return the :class:`~pyecobee.MfaChallenge` carried by this error."""
return self.args[0]


# Sensor errors
class InvalidSensorError(EcobeeError):
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

setup(
name="python-ecobee-api",
version="0.4.1",
version="0.4.2",
description="Python API for talking to Ecobee thermostats",
url="https://github.com/nkgilley/python-ecobee-api",
author="Nolan Gilley",
Expand Down
6 changes: 4 additions & 2 deletions tests/test_auth.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,8 @@ def test_request_tokens_web_mfa_required_raises_with_challenge(
ecobee = _make_ecobee()
with pytest.raises(EcobeeAuthMfaRequiredError) as exc_info:
ecobee.request_tokens_web()
challenge = exc_info.value.args[0]
challenge = exc_info.value.challenge
assert challenge is exc_info.value.args[0]
assert isinstance(challenge, MfaChallenge)
assert challenge.mfa_type == "otp"
assert challenge.state == "MFA_STATE_9"
Expand Down Expand Up @@ -237,7 +238,8 @@ def test_request_tokens_web_sms_mfa_required_raises_with_challenge(
ecobee = _make_ecobee()
with pytest.raises(EcobeeAuthMfaRequiredError) as exc_info:
ecobee.request_tokens_web()
challenge = exc_info.value.args[0]
challenge = exc_info.value.challenge
assert challenge is exc_info.value.args[0]
assert isinstance(challenge, MfaChallenge)
assert challenge.mfa_type == "sms"
assert challenge.state == "SMS_STATE_7"
Expand Down