python-tado 0.18.0__tar.gz → 0.18.2__tar.gz

{python_tado-0.18.0/python_tado.egg-info → python_tado-0.18.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-tado
-Version: 0.18.0
+Version: 0.18.2
 Summary: PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon, FilBr, nikilase, albertomontesg, Moritz-Schmidt, palazzem
 Author-email: Chris Jewell <chrism0dwk@gmail.com>, "w.malgadey" <w.malgadey@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -699,7 +699,10 @@ Requires-Dist: black>=24.3; extra == "dev"
 Requires-Dist: pytype; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
+Requires-Dist: responses; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
 
 PyTado -- Pythonize your central heating
 ========================================

{python_tado-0.18.0 → python_tado-0.18.2}/PyTado/const.py

@@ -1,5 +1,11 @@
 """Constant values for the Tado component."""
 
+# Api credentials
+CLIENT_ID = "tado-web-app"
+CLIENT_SECRET = (
+    "wZaRN7rpjn3FoNyF5IFuxg9uMzYJcvOoQ8QWiIqS3hfk6gLhVlG57j5YNoZL2Rtc"
+)
+
 # Types
 TYPE_AIR_CONDITIONING = "AIR_CONDITIONING"
 TYPE_HEATING = "HEATING"

{python_tado-0.18.0 → python_tado-0.18.2}/PyTado/exceptions.py

@@ -9,10 +9,6 @@ class TadoNotSupportedException(TadoException):
     """Exception to indicate a requested action is not supported by Tado."""
 
 
-class TadoXNotSupportedException(TadoException):
-    """Exception to indicate a requested action is not supported by the Tado X API."""
-
-
 class TadoCredentialsException(TadoException):
     """Exception to indicate something with credentials"""
 

{python_tado-0.18.0 → python_tado-0.18.2}/PyTado/http.py

@@ -11,8 +11,9 @@ from typing import Any
 
 import requests
 
-from PyTado.exceptions import TadoWrongCredentialsException
-from PyTado.logging import Logger
+from PyTado.const import CLIENT_ID, CLIENT_SECRET
+from PyTado.exceptions import TadoException, TadoWrongCredentialsException
+from PyTado.logger import Logger
 
 _LOGGER = Logger(__name__)
 
@@ -141,7 +142,8 @@ class Http:
         self._headers = {"Referer": "https://app.tado.com/"}
         self._username = username
         self._password = password
-        self._id, self._x_api, self._token_refresh = self._login()
+        self._id, self._token_refresh = self._login()
+        self._x_api = self._check_x_line_generation()
 
     def _log_response(self, response: requests.Response, *args, **kwargs):
         og_request_method = response.request.method
@@ -199,6 +201,7 @@ class Http:
 
         return response.json()
 
+    @property
     def is_x_line(self):
         return self._x_api
 
@@ -249,10 +252,8 @@ class Http:
 
         url = "https://auth.tado.com/oauth/token"
         data = {
-            "client_id": "tado-web-app",
-            "client_secret": (
-                "wZaRN7rpjn3FoNyF5IFuxg9uMzYJcvOoQ8QWiIqS3hfk6gLhVlG57j5YNoZL2Rtc"
-            ),
+            "client_id": CLIENT_ID,
+            "client_secret": CLIENT_SECRET,
             "grant_type": "refresh_token",
             "scope": "home.user",
             "refresh_token": self._token_refresh,
@@ -273,7 +274,13 @@ class Http:
             },
         )
 
-        self._set_oauth_header(response.json())
+        if response.status_code == 200:
+            self._set_oauth_header(response.json())
+            return
+
+        raise TadoException(
+            f"Unknown error while refreshing token with status code {response.status_code}"
+        )
 
     def _login(self) -> tuple[int, bool, str] | None:
 
@@ -310,9 +317,12 @@ class Http:
         if response.status_code == 200:
             refresh_token = self._set_oauth_header(response.json())
             id_ = self._get_id()
-            x_api_ = self._check_x_line_generation()
 
-            return id_, x_api_, refresh_token
+            return id_, refresh_token
+
+        raise TadoException(
+            f"Login failed for unknown reason with status code {response.status_code}"
+        )
 
     def _get_id(self) -> int:
         request = TadoRequest()

{python_tado-0.18.0 → python_tado-0.18.2}/PyTado/interface/api/hops_tado.py

@@ -8,7 +8,7 @@ from typing import Any
 
 from .my_tado import Tado, Timetable
 
-from ...logging import Logger
+from ...logger import Logger
 from ...exceptions import TadoNotSupportedException
 from ...http import (
     Action,

{python_tado-0.18.0 → python_tado-0.18.2}/PyTado/interface/api/my_tado.py

@@ -8,7 +8,7 @@ import logging
 
 from typing import Any
 
-from ...logging import Logger
+from ...logger import Logger
 from ...exceptions import TadoNotSupportedException
 from ...http import (
     Action,

{python_tado-0.18.0 → python_tado-0.18.2}/PyTado/interface/interface.py

@@ -36,4 +36,4 @@ class Tado:
 
     def __getattr__(self, name):
         """Delegiert den Aufruf von Methoden an die richtige API-Client-Implementierung."""
-        return getattr(self.client, name)
+        return getattr(self._api, name)

{python_tado-0.18.0 → python_tado-0.18.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-tado"
-version = "0.18.0"
+version = "0.18.2"
 description = "PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon, FilBr, nikilase, albertomontesg, Moritz-Schmidt, palazzem"
 authors = [
     { name = "Chris Jewell", email = "chrism0dwk@gmail.com" },
@@ -30,7 +30,7 @@ classifiers = [
 GitHub = "https://github.com/wmalgadey/PyTado"
 
 [project.optional-dependencies]
-dev = ["black>=24.3", "pytype", "pylint", "types-requests", "pytest"]
+dev = ["black>=24.3", "pytype", "pylint", "types-requests", "responses", "coverage", "pytest", "pytest-cov"]
 
 [project.scripts]
 pytado = "pytado.__main__:main"

{python_tado-0.18.0 → python_tado-0.18.2/python_tado.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-tado
-Version: 0.18.0
+Version: 0.18.2
 Summary: PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon, FilBr, nikilase, albertomontesg, Moritz-Schmidt, palazzem
 Author-email: Chris Jewell <chrism0dwk@gmail.com>, "w.malgadey" <w.malgadey@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -699,7 +699,10 @@ Requires-Dist: black>=24.3; extra == "dev"
 Requires-Dist: pytype; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
+Requires-Dist: responses; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
 
 PyTado -- Pythonize your central heating
 ========================================

{python_tado-0.18.0 → python_tado-0.18.2}/python_tado.egg-info/SOURCES.txt

@@ -7,7 +7,7 @@ PyTado/__main__.py
 PyTado/const.py
 PyTado/exceptions.py
 PyTado/http.py
-PyTado/logging.py
+PyTado/logger.py
 PyTado/interface/__init__.py
 PyTado/interface/interface.py
 PyTado/interface/api/__init__.py
@@ -23,5 +23,7 @@ python_tado.egg-info/entry_points.txt
 python_tado.egg-info/not-zip-safe
 python_tado.egg-info/requires.txt
 python_tado.egg-info/top_level.txt
+tests/test_http.py
 tests/test_my_tado.py
-tests/test_my_zone.py
+tests/test_my_zone.py
+tests/test_tado_interface.py

{python_tado-0.18.0 → python_tado-0.18.2}/python_tado.egg-info/requires.txt

@@ -5,4 +5,7 @@ black>=24.3
 pytype
 pylint
 types-requests
+responses
+coverage
 pytest
+pytest-cov

python_tado-0.18.2/tests/test_http.py

@@ -0,0 +1,180 @@
+"""Test the Http class."""
+
+from datetime import datetime, timedelta
+import json
+import responses
+import unittest
+
+from PyTado.const import CLIENT_ID, CLIENT_SECRET
+from PyTado.exceptions import TadoException, TadoWrongCredentialsException
+
+from . import common
+
+from PyTado.http import Http
+
+
+class TestHttp(unittest.TestCase):
+    """Testcases for Http class."""
+
+    def setUp(self):
+        super().setUp()
+
+        # Mock the login response
+        responses.add(
+            responses.POST,
+            "https://auth.tado.com/oauth/token",
+            json={
+                "access_token": "value",
+                "expires_in": 1234,
+                "refresh_token": "another_value",
+            },
+            status=200,
+        )
+
+        responses.add(
+            responses.GET,
+            "https://my.tado.com/api/v2/homes/1234/",
+            json={"homes": [{"id": 1234}]},
+            status=200,
+        )
+
+        # Mock the get me response
+        responses.add(
+            responses.GET,
+            "https://my.tado.com/api/v2/me",
+            json={"homes": [{"id": 1234}]},
+            status=200,
+        )
+
+    @responses.activate
+    def test_login_successful(self):
+
+        instance = Http(
+            username="test_user",
+            password="test_pass",
+            debug=True,
+        )
+
+        # Verify that the login was successful
+        self.assertEqual(instance._id, 1234)
+        self.assertEqual(instance.is_x_line, False)
+
+    @responses.activate
+    def test_login_failed(self):
+
+        responses.replace(
+            responses.POST,
+            "https://auth.tado.com/oauth/token",
+            json={"error": "invalid_grant"},
+            status=400,
+        )
+
+        with self.assertRaises(
+            expected_exception=TadoWrongCredentialsException,
+            msg="Your username or password is invalid",
+        ):
+            Http(
+                username="test_user",
+                password="test_pass",
+                debug=True,
+            )
+
+        responses.replace(
+            responses.POST,
+            "https://auth.tado.com/oauth/token",
+            json={"error": "server failed"},
+            status=503,
+        )
+
+        with self.assertRaises(
+            expected_exception=TadoException,
+            msg="Login failed for unknown reason with status code 503",
+        ):
+            Http(
+                username="test_user",
+                password="test_pass",
+                debug=True,
+            )
+
+    @responses.activate
+    def test_line_x(self):
+
+        responses.replace(
+            responses.GET,
+            "https://my.tado.com/api/v2/homes/1234/",
+            json=json.loads(common.load_fixture("tadox/homes_response.json")),
+            status=200,
+        )
+
+        instance = Http(
+            username="test_user",
+            password="test_pass",
+            debug=True,
+        )
+
+        # Verify that the login was successful
+        self.assertEqual(instance._id, 1234)
+        self.assertEqual(instance.is_x_line, True)
+
+    @responses.activate
+    def test_refresh_token_success(self):
+        instance = Http(
+            username="test_user",
+            password="test_pass",
+            debug=True,
+        )
+
+        expected_params = {
+            "client_id": CLIENT_ID,
+            "client_secret": CLIENT_SECRET,
+            "grant_type": "refresh_token",
+            "scope": "home.user",
+            "refresh_token": "another_value",
+        }
+        # Mock the refresh token response
+        refresh_token = responses.replace(
+            responses.POST,
+            "https://auth.tado.com/oauth/token",
+            match=[
+                responses.matchers.query_param_matcher(expected_params),
+            ],
+            json={
+                "access_token": "new_value",
+                "expires_in": 1234,
+                "refresh_token": "new_refresh_value",
+            },
+            status=200,
+        )
+
+        # Force token refresh
+        instance._refresh_at = datetime.now() - timedelta(seconds=1)
+        instance._refresh_token()
+
+        assert refresh_token.call_count == 1
+
+        # Verify that the token was refreshed
+        self.assertEqual(instance._headers["Authorization"], "Bearer new_value")
+
+    @responses.activate
+    def test_refresh_token_failure(self):
+        instance = Http(
+            username="test_user",
+            password="test_pass",
+            debug=True,
+        )
+
+        # Mock the refresh token response with failure
+        refresh_token = responses.replace(
+            responses.POST,
+            "https://auth.tado.com/oauth/token",
+            json={"error": "invalid_grant"},
+            status=400,
+        )
+
+        # Force token refresh
+        instance._refresh_at = datetime.now() - timedelta(seconds=1)
+
+        with self.assertRaises(TadoException):
+            instance._refresh_token()
+
+        assert refresh_token.call_count == 1

{python_tado-0.18.0 → python_tado-0.18.2}/tests/test_my_tado.py

@@ -16,7 +16,7 @@ class TadoTestCase(unittest.TestCase):
     def setUp(self) -> None:
         super().setUp()
         login_patch = mock.patch(
-            "PyTado.http.Http._login", return_value=(1, False, "foo")
+            "PyTado.http.Http._login", return_value=(1, "foo")
         )
         get_me_patch = mock.patch("PyTado.interface.api.Tado.get_me")
         login_patch.start()

{python_tado-0.18.0 → python_tado-0.18.2}/tests/test_my_zone.py

@@ -10,13 +10,13 @@ from PyTado.http import Http
 from PyTado.interface.api import Tado
 
 
-class TadoTestCase(unittest.TestCase):
+class TadoZoneTestCase(unittest.TestCase):
     """Test cases for zone class"""
 
     def setUp(self) -> None:
         super().setUp()
         login_patch = mock.patch(
-            "PyTado.http.Http._login", return_value=(1, False, "foo")
+            "PyTado.http.Http._login", return_value=(1, "foo")
         )
         get_me_patch = mock.patch("PyTado.interface.api.Tado.get_me")
         login_patch.start()

python_tado-0.18.2/tests/test_tado_interface.py

@@ -0,0 +1,84 @@
+import json
+import unittest
+from unittest import mock
+
+from . import common
+
+from PyTado.http import Http
+from PyTado.interface import Tado
+import PyTado.interface.api as API
+
+
+class TestTadoInterface(unittest.TestCase):
+    """Test cases for main tado interface class"""
+
+    def test_interface_with_tado_api(self):
+        login_patch = mock.patch(
+            "PyTado.http.Http._login", return_value=(1, "foo")
+        )
+        login_mock = login_patch.start()
+        check_x_patch = mock.patch(
+            "PyTado.http.Http._check_x_line_generation", return_value=False
+        )
+        check_x_patch.start()
+        self.addCleanup(check_x_patch.stop)
+
+        with mock.patch("PyTado.interface.api.my_tado.Tado.get_me") as mock_it:
+            tado_interface = Tado("my@username.com", "mypassword")
+            tado_interface.get_me()
+
+            assert not tado_interface._http.is_x_line
+            mock_it.assert_called_once()
+
+        with mock.patch(
+            "PyTado.interface.api.hops_tado.TadoX.get_me"
+        ) as mock_it:
+            tado_interface = Tado("my@username.com", "mypassword")
+            tado_interface.get_me()
+
+            mock_it.assert_not_called()
+
+        assert login_mock.call_count == 2
+
+    def test_interface_with_tadox_api(self):
+        login_patch = mock.patch(
+            "PyTado.http.Http._login", return_value=(1, "foo")
+        )
+        login_mock = login_patch.start()
+        check_x_patch = mock.patch(
+            "PyTado.http.Http._check_x_line_generation", return_value=True
+        )
+        check_x_patch.start()
+        self.addCleanup(check_x_patch.stop)
+
+        with mock.patch(
+            "PyTado.interface.api.hops_tado.TadoX.get_me"
+        ) as mock_it:
+            tado_interface = Tado("my@username.com", "mypassword")
+            tado_interface.get_me()
+
+            mock_it.assert_called_once()
+            assert tado_interface._http.is_x_line
+
+        login_mock.assert_called_once()
+
+    def test_error_handling_on_api_calls(self):
+        login_patch = mock.patch(
+            "PyTado.http.Http._login", return_value=(1, "foo")
+        )
+        login_mock = login_patch.start()
+        check_x_patch = mock.patch(
+            "PyTado.http.Http._check_x_line_generation", return_value=False
+        )
+        check_x_patch.start()
+        self.addCleanup(check_x_patch.stop)
+
+        with mock.patch("PyTado.interface.api.my_tado.Tado.get_me") as mock_it:
+            mock_it.side_effect = Exception("API Error")
+
+            tado_interface = Tado("my@username.com", "mypassword")
+
+            with self.assertRaises(Exception) as context:
+                tado_interface.get_me()
+
+                self.assertIn("API Error", str(context.exception))