smartbox 2.1.3__tar.gz → 2.2.1__tar.gz

smartbox-2.2.1/.github/ISSUE_TEMPLATE/new-reseller.md

@@ -0,0 +1,18 @@
+---
+name: New reseller
+about: Add a new available reseller.
+title: "[RESELLER] New available reseller"
+labels: reseller
+assignees: Delmael
+
+---
+
+> [!NOTE]
+> If you do not see your current reseller in the available list, you can ask to add it. We cannot ensure your device go through this platform
+
+* [ ] I have check with the `smartbox resellers` command that my reseller is not already present
+* **Website url (mandatory)** :
+* Name of the resellers:
+* API url :
+* Basic auth headers :
+* Serial id:

{smartbox-2.1.3 → smartbox-2.2.1}/.github/workflows/publish-to-pypi.yml

@@ -22,7 +22,7 @@ jobs:
         with:
             python-version: ${{ env.PYTHON_VERSION }}
       - name: Set up Python ${{ env.PYTHON_VERSION }}
-        uses: actions/setup-python@v5.4.0
+        uses: actions/setup-python@v5.6.0
         with:
             python-version: ${{ env.PYTHON_VERSION }}
       - name: Build a binary wheel and a source tarball

{smartbox-2.1.3 → smartbox-2.2.1}/.github/workflows/python-package.yml

@@ -25,7 +25,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5.4.0
+        uses: actions/setup-python@v5.6.0
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install the project
@@ -47,7 +47,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5.4.0
+        uses: actions/setup-python@v5.6.0
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install the project
@@ -70,13 +70,13 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5.4.0
+        uses: actions/setup-python@v5.6.0
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install the project
         run: |
           uv sync --all-extras --dev
-          tox -e py
+          uv run tox -e py
       - name: "Upload coverage to Codecov"
         uses: codecov/codecov-action@v5
         with:
@@ -86,4 +86,4 @@ jobs:
         if: ${{ !cancelled() }}
         uses: codecov/test-results-action@v1
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+          token: ${{ secrets.CODECOV_TOKEN }}

{smartbox-2.1.3 → smartbox-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smartbox
-Version: 2.1.3
+Version: 2.2.1
 Summary: Python API to control heating 'smart boxes'
 Project-URL: Homepage, https://github.com/ajtudela/smartbox
 Project-URL: Issues, https://github.com/ajtudela/smartbox/issues
@@ -15,7 +15,7 @@ Requires-Dist: aiohttp>=3.11.11
 Requires-Dist: asyncclick>=8.1.8
 Requires-Dist: jq>=1.8.0
 Requires-Dist: pydantic>=2.10.4
-Requires-Dist: python-socketio==5.12.1
+Requires-Dist: python-socketio==5.13.0
 Requires-Dist: requests>=2.32.3
 Requires-Dist: websocket-client>=1.8.0
 Description-Content-Type: text/markdown
@@ -53,7 +53,7 @@ A few common options are required for all commands:
 Verbose logging can be enabled with the `-v`/`--verbose` flag.
 
 ### Optional options
-These options are useful if your resailer is not configured.
+These options are useful if your reseller is not configured.
 
 * `-b`/`--base-auth-creds`: An HTTP Basic Auth credential used to do initial
   authentication with the server. Use the base64 encoded string directly. See
@@ -61,7 +61,7 @@ These options are useful if your resailer is not configured.
 * `-a`/`--api-name`: The API name for your heater vendor. This is visible in
   the 'API Host' entry in the 'Version' menu item in the mobile app/web app. If
   the host name is of the form `api-foo.xxxx` or `api.xxxx` use the values
-  `api-foo` or `api` respectively. The resailer has to be declared in the package.
+  `api-foo` or `api` respectively. The reseller has to be declared in the package.
 * `-r`/`--x-referer`: The referer of your request.
 * `-i`/`--x-serial-id`: The serial-id of your request.
 
@@ -132,11 +132,11 @@ The `health-check` command can be used to know if the API is alived
 
     smartbox <auth options...> health-check
 
-### List available resailers
-The `resailers` command can be used to know which resailershas an automatic configuration.
-If your resailer is not present you can raise an issue in github, or use the optional options.
+### List available resellers
+The `resellers` command can be used to know which resellers has an automatic configuration.
+If your reseller is not present you can raise an issue in github, or use the optional options.
 
-    smartbox <auth options...> resailers
+    smartbox <auth options...> resellers
 
 
 See [api-notes.md](./api-notes.md) for notes on REST and socket.io endpoints.

{smartbox-2.1.3 → smartbox-2.2.1}/README.md

@@ -31,7 +31,7 @@ A few common options are required for all commands:
 Verbose logging can be enabled with the `-v`/`--verbose` flag.
 
 ### Optional options
-These options are useful if your resailer is not configured.
+These options are useful if your reseller is not configured.
 
 * `-b`/`--base-auth-creds`: An HTTP Basic Auth credential used to do initial
   authentication with the server. Use the base64 encoded string directly. See
@@ -39,7 +39,7 @@ These options are useful if your resailer is not configured.
 * `-a`/`--api-name`: The API name for your heater vendor. This is visible in
   the 'API Host' entry in the 'Version' menu item in the mobile app/web app. If
   the host name is of the form `api-foo.xxxx` or `api.xxxx` use the values
-  `api-foo` or `api` respectively. The resailer has to be declared in the package.
+  `api-foo` or `api` respectively. The reseller has to be declared in the package.
 * `-r`/`--x-referer`: The referer of your request.
 * `-i`/`--x-serial-id`: The serial-id of your request.
 
@@ -110,11 +110,11 @@ The `health-check` command can be used to know if the API is alived
 
     smartbox <auth options...> health-check
 
-### List available resailers
-The `resailers` command can be used to know which resailershas an automatic configuration.
-If your resailer is not present you can raise an issue in github, or use the optional options.
+### List available resellers
+The `resellers` command can be used to know which resellers has an automatic configuration.
+If your reseller is not present you can raise an issue in github, or use the optional options.
 
-    smartbox <auth options...> resailers
+    smartbox <auth options...> resellers
 
 
 See [api-notes.md](./api-notes.md) for notes on REST and socket.io endpoints.

{smartbox-2.1.3 → smartbox-2.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "smartbox"
-version = "2.1.3"
+version = "2.2.1"
 requires-python = ">=3.13"
 authors = [
   { name="Alberto Tudela", email="ajtudela@gmail.com" },
@@ -22,7 +22,7 @@ dependencies = [
     "asyncclick>=8.1.8",
     "jq>=1.8.0",
     "pydantic>=2.10.4",
-    "python-socketio==5.12.1",
+    "python-socketio==5.13.0",
     "requests>=2.32.3",
     "websocket-client>=1.8.0",
 ]

{smartbox-2.1.3 → smartbox-2.2.1}/src/smartbox/__init__.py

@@ -5,7 +5,7 @@ import importlib.metadata
 from .error import (
     APIUnavailableError,
     InvalidAuthError,
-    ResailerNotExistError,
+    ResellerNotExistError,
     SmartboxError,
 )
 from .models import (
@@ -21,7 +21,7 @@ from .models import (
     NodeStatus,
     SmartboxNodeType,
 )
-from .resailer import AvailableResailers, SmartboxResailer
+from .reseller import AvailableResellers, SmartboxReseller
 from .session import AsyncSmartboxSession, Session
 from .socket import SocketSession
 from .update_manager import UpdateManager
@@ -33,7 +33,7 @@ __all__ = [
     "APIUnavailableError",
     "AcmNodeStatus",
     "AsyncSmartboxSession",
-    "AvailableResailers",
+    "AvailableResellers",
     "DefaultNodeStatus",
     "GuestUser",
     "Guests",
@@ -44,11 +44,11 @@ __all__ = [
     "NodeFactoryOptions",
     "NodeSetup",
     "NodeStatus",
-    "ResailerNotExistError",
+    "ResellerNotExistError",
     "Session",
     "SmartboxError",
     "SmartboxNodeType",
-    "SmartboxResailer",
+    "SmartboxReseller",
     "SocketSession",
     "UpdateManager",
 ]

{smartbox-2.1.3 → smartbox-2.2.1}/src/smartbox/cmd.py

@@ -7,7 +7,7 @@ from typing import Any
 from aiohttp import ClientSession
 import asyncclick as click
 
-from smartbox.resailer import AvailableResailers
+from smartbox.reseller import AvailableResellers
 from smartbox.session import AsyncSmartboxSession
 from smartbox.socket import SocketSession
 
@@ -403,10 +403,10 @@ async def api_version(ctx) -> None:
     _pretty_print(version)
 
 
-@smartbox.command(help="Get the availables resailers.")
-def resailers() -> None:
-    """Get the availables resailers."""
-    for item in AvailableResailers.resailers.items():
+@smartbox.command(help="Get the availables resellers.")
+def resellers() -> None:
+    """Get the availables resellers."""
+    for item in AvailableResellers.resellers.items():
         print(item)
 
 

{smartbox-2.1.3 → smartbox-2.2.1}/src/smartbox/error.py

@@ -15,5 +15,5 @@ class APIUnavailableError(aiohttp.ClientConnectionError):
     """API is unavailable."""
 
 
-class ResailerNotExistError(Exception):
-    """Resailer is not known."""
+class ResellerNotExistError(Exception):
+    """Reseller is not known."""

smartbox-2.1.3/src/smartbox/resailer.py → smartbox-2.2.1/src/smartbox/reseller.py

@@ -1,18 +1,18 @@
-"""Resailer of Smartbox."""
+"""Reseller of Smartbox."""
 
 import logging
 from typing import ClassVar
 
 from pydantic import BaseModel, ValidationError
 
-from smartbox.error import ResailerNotExistError
+from smartbox.error import ResellerNotExistError
 
 SMARTBOX_GENERIC_BASIC_AUTH = "NTRiY2NiZmI0MWE5YTUxMTNmMDQ4OGQwOnZkaXZkaQ=="
 _LOGGER = logging.getLogger(__name__)
 
 
-class SmartboxResailer(BaseModel):
-    """Model of Smartbox Resailer config."""
+class SmartboxReseller(BaseModel):
+    """Model of Smartbox Reseller config."""
 
     name: str = "Smartbox"
     web_url: str = ""
@@ -21,53 +21,65 @@ class SmartboxResailer(BaseModel):
     serial_id: int = 0
 
 
-class AvailableResailers:
-    """Resailers that have been verified."""
+class AvailableResellers:
+    """Resellers that have been verified."""
 
-    resailers: ClassVar[dict[str, SmartboxResailer]] = {
-        "api": SmartboxResailer(
+    resellers: ClassVar[dict[str, SmartboxReseller]] = {
+        "api": SmartboxReseller(
             name="Helki",
             web_url="https://app.helki.com/",
             api_url="api",
             serial_id=1,
         ),
-        "api-ehc": SmartboxResailer(
+        "api-ehc": SmartboxReseller(
             name="Electric Heating Company",
             web_url="https://control.electric-heatingcompany.co.uk/",
             api_url="api-ehc",
             serial_id=3,
         ),
-        "api-climastar": SmartboxResailer(
+        "api-climastar": SmartboxReseller(
             name="Climastar",
             web_url="https://avantwifi.climastar.es/",
             api_url="api-climastar",
             serial_id=5,
         ),
-        "api-elnur": SmartboxResailer(
+        "api-elnur": SmartboxReseller(
             name="Elnur",
             web_url="https://remotecontrol.elnur.es/",
             api_url="api-elnur",
             serial_id=7,
         ),
-        "api-hjm": SmartboxResailer(
+        "api-hjm": SmartboxReseller(
             name="HJM",
             web_url="https://api.calorhjm.com/",
             api_url="api-hjm",
             serial_id=10,
         ),
-        "api-haverland": SmartboxResailer(
+        "api-evconfort": SmartboxReseller(
+            name="Electrorad",
+            web_url="https://app.controls-electrorad.co.uk/",
+            api_url="api-evconfort",
+            serial_id=12,
+        ),
+        "api-haverland": SmartboxReseller(
             name="Haverland",
             web_url="https://i2control.haverland.com/",
             api_url="api-haverland",
             basic_auth="NTU2ZDc0MWI3OGUzYmU5YjU2NjA3NTQ4OnZkaXZkaQ==",
             serial_id=14,
         ),
-        "api-lhz": SmartboxResailer(
+        "api-technoterm": SmartboxReseller(
             name="Technotherm",
             web_url="https://ttiapp.technotherm.com/",
             api_url="api-lhz",
             serial_id=16,
         ),
+        "api-smartcontrol": SmartboxReseller(
+            name="SmartControl",
+            web_url="https://app.smart-control.eu/",
+            api_url="api-lhz",
+            serial_id=17,
+        ),
     }
 
     def __init__(
@@ -78,7 +90,7 @@ class AvailableResailers:
         serial_id: int | None = None,
         name: str = "Smartbox",
     ) -> None:
-        """Check if resailer is already available or try to create one."""
+        """Check if reseller is already available or try to create one."""
         self._api_url = api_url
         self._basic_auth = basic_auth
         self._web_url = web_url
@@ -86,27 +98,30 @@ class AvailableResailers:
         self._name = name
 
     @property
-    def resailer(self) -> SmartboxResailer:
-        """Get the resailer."""
-        resailer = self.resailers.get(self._api_url, None)
-        if resailer is None:
+    def reseller(self) -> SmartboxReseller:
+        """Get the reseller."""
+        reseller = next(
+            (r for r in self.resellers.values() if r.api_url == self._api_url),
+            None,
+        )
+        if reseller is None:
             if (
                 self._basic_auth is None
                 or self._web_url is None
                 or self._serial_id is None
             ):
-                msg = "This Resailer is not yet available or some arguments are missing."
-                raise ResailerNotExistError(msg)
+                msg = f"This reseller {self._api_url} is not yet available or some arguments are missing."
+                raise ResellerNotExistError(msg)
             try:
                 _LOGGER.debug(
-                    "Creating a new resailer api_url (%s), name=%s,  web_url %s, basic_auth=%s, serial_id=%s",
+                    "Creating a new reseller api_url (%s), name=%s,  web_url %s, basic_auth=%s, serial_id=%s",
                     self._api_url,
                     self._name,
                     self._web_url,
                     self._basic_auth,
                     self._serial_id,
                 )
-                resailer = SmartboxResailer(
+                reseller = SmartboxReseller(
                     api_url=self._api_url,
                     basic_auth=self._basic_auth,
                     web_url=self._web_url,
@@ -114,26 +129,26 @@ class AvailableResailers:
                     name=self._name,
                 )
             except ValidationError as e:
-                raise ResailerNotExistError from e
+                raise ResellerNotExistError from e
         _LOGGER.debug(
-            "Resailer api_url (%s), name=%s,  web_url %s",
-            resailer.api_url,
-            resailer.name,
-            resailer.web_url,
+            "Reseller api_url (%s), name=%s,  web_url %s",
+            reseller.api_url,
+            reseller.name,
+            reseller.web_url,
         )
-        return resailer
+        return reseller
 
     @property
     def api_url(self) -> str:
         """Get the api sub domain url."""
-        return self.resailer.api_url
+        return self.reseller.api_url
 
     @property
     def name(self) -> str:
-        """Get the name of resailer."""
-        return self.resailer.name
+        """Get the name of reseller."""
+        return self.reseller.name
 
     @property
     def web_url(self) -> str:
-        """Get the public websit of the resailer."""
-        return self.resailer.web_url
+        """Get the public websit of the reseller."""
+        return self.reseller.web_url

{smartbox-2.1.3 → smartbox-2.2.1}/src/smartbox/session.py

@@ -31,7 +31,7 @@ from smartbox.models import (
     SmartboxNodeType,
     Token,
 )
-from smartbox.resailer import AvailableResailers, SmartboxResailer
+from smartbox.reseller import AvailableResellers, SmartboxReseller
 
 _DEFAULT_RETRY_ATTEMPTS = 5
 _DEFAULT_BACKOFF_FACTOR = 0.1
@@ -59,13 +59,13 @@ class AsyncSession:
         x_referer: str | None = None,
     ) -> None:
         """Init the session."""
-        self._resailer = AvailableResailers(
+        self._reseller = AvailableResellers(
             api_url=api_name,
             basic_auth=basic_auth_credentials,
             serial_id=x_serial_id,
             web_url=x_referer,
-        ).resailer
-        self._api_host: str = f"https://{self.resailer.api_url}.helki.com"
+        ).reseller
+        self._api_host: str = f"https://{self.reseller.api_url}.helki.com"
         self._basic_auth_credentials: str | None = basic_auth_credentials
         self._retry_attempts: int = retry_attempts
         self._backoff_factor: float = backoff_factor
@@ -78,20 +78,20 @@ class AsyncSession:
             "Authorization": f"Bearer {self._access_token}",
             "Content-Type": "application/json",
         }
-        if self.resailer.serial_id:
-            self._headers.update({"x-serialid": str(self.resailer.serial_id)})
-        if self.resailer.web_url:
-            self._headers.update({"x-referer": self.resailer.web_url})
+        if self.reseller.serial_id:
+            self._headers.update({"x-serialid": str(self.reseller.serial_id)})
+        if self.reseller.web_url:
+            self._headers.update({"x-referer": self.reseller.web_url})
 
     @property
-    def resailer(self) -> SmartboxResailer:
-        """Get the resailer."""
-        return self._resailer
+    def reseller(self) -> SmartboxReseller:
+        """Get the reseller."""
+        return self._reseller
 
     @property
     def api_name(self) -> str:
         """Get the api sub domain url."""
-        return self.resailer.api_url
+        return self.reseller.api_url
 
     @property
     def api_host(self) -> str:
@@ -150,7 +150,7 @@ class AsyncSession:
         del token_headers["Authorization"]
         token_headers.update(
             {
-                "authorization": f"Basic {self.resailer.basic_auth}",
+                "authorization": f"Basic {self.reseller.basic_auth}",
                 "Content-Type": "application/x-www-form-urlencoded",
             },
         )

{smartbox-2.1.3 → smartbox-2.2.1}/tests/conftest.py

@@ -3,7 +3,7 @@ from unittest.mock import patch
 from asyncclick.testing import CliRunner
 import pytest
 
-from smartbox.resailer import SmartboxResailer
+from smartbox.reseller import SmartboxReseller
 from smartbox.session import AsyncSession, AsyncSmartboxSession, Session
 from smartbox.update_manager import UpdateManager
 from tests.common import fake_get_request
@@ -25,7 +25,7 @@ def update_manager(mock_session):
 
 
 @pytest.fixture
-def async_smartbox_session(mocker, resailer):
+def async_smartbox_session(mocker, reseller):
     async_smartbox_session = AsyncSmartboxSession(
         api_name="test_api",
         username="test_user",
@@ -47,7 +47,7 @@ def async_smartbox_session(mocker, resailer):
 
 
 @pytest.fixture
-def session(resailer):
+def session(reseller):
     return Session(
         api_name="test_api",
         username="test_user",
@@ -56,7 +56,7 @@ def session(resailer):
 
 
 @pytest.fixture
-def async_session(resailer):
+def async_session(reseller):
     api_name = "test_api"
     username = "test_user"
     password = "test_password"
@@ -76,7 +76,7 @@ def async_session(resailer):
 
 @pytest.fixture
 def person():
-    return SmartboxResailer(
+    return SmartboxReseller(
         name="test",
         api_url="test_api",
         basic_auth="test_credentials",
@@ -86,12 +86,12 @@ def person():
 
 
 @pytest.fixture
-def resailer(mocker):
+def reseller(mocker):
     return mocker.patch(
-        "smartbox.resailer.AvailableResailers.resailers",
+        "smartbox.reseller.AvailableResellers.resellers",
         new_callable=mocker.PropertyMock,
         return_value={
-            "test_api": SmartboxResailer(
+            "test_api": SmartboxReseller(
                 name="test",
                 api_url="test_api",
                 basic_auth="test_credentials",

{smartbox-2.1.3 → smartbox-2.2.1}/tests/test_cmd.py

@@ -263,22 +263,14 @@ async def test_node_samples(runner, mock_session):
 
 
 @pytest.mark.anyio
-async def test_resailers(runner, mocker):
-    mock_resailers = mocker.patch("smartbox.cmd.AvailableResailers.resailers")
-    mock_resailers.items.return_value = [
-        ("resailer1", "details1"),
-        ("resailer2", "details2"),
-    ]
-
+async def test_reseller(runner, mocker, reseller):
     result = await runner.invoke(
         smartbox,
-        [*DEFAULT_ARGS, "resailers"],
+        [*DEFAULT_ARGS, "resellers"],
     )
     assert result.exit_code == 0
-    assert "resailer1" in result.output
-    assert "details1" in result.output
-    assert "resailer2" in result.output
-    assert "details2" in result.output
+    assert "test_api" in result.output
+    assert "http" in result.output
 
 
 @pytest.mark.anyio

smartbox-2.2.1/tests/test_reseller.py

@@ -0,0 +1,58 @@
+import pytest
+
+from smartbox import AsyncSmartboxSession, ResellerNotExistError
+from smartbox.reseller import AvailableResellers
+
+
+def test_available_resellers_existing_reseller():
+    reseller = AvailableResellers(api_url="api").reseller
+    assert reseller.name == "Helki"
+    assert reseller.api_url == "api"
+
+
+def test_available_resellers_non_existing_reseller():
+    with pytest.raises(ResellerNotExistError):
+        AvailableResellers(api_url="non-existing-api").reseller
+
+
+def test_available_resellers_custom_reseller():
+    serial_id = 99
+    _reseller = AvailableResellers(
+        api_url="custom-api",
+        basic_auth="custom-auth",
+        web_url="https://custom-url.com",
+        serial_id=serial_id,
+        name="Custom",
+    )
+    reseller = _reseller.reseller
+    assert reseller.name == "Custom"
+    assert reseller.api_url == "custom-api"
+    assert reseller.basic_auth == "custom-auth"
+    assert reseller.web_url == "https://custom-url.com"
+    assert reseller.serial_id == serial_id
+
+    assert _reseller.name == "Custom"
+    assert _reseller.api_url == "custom-api"
+    assert _reseller.web_url == "https://custom-url.com"
+
+
+def test_reseller_invalid_data():
+    with pytest.raises(ResellerNotExistError):
+        AvailableResellers(
+            api_url="invalid-api",
+            basic_auth="invalid-auth",
+            web_url="invalid-url",
+            serial_id="invalid-serial-id",
+        ).reseller
+
+
+@pytest.mark.asyncio
+async def test_all_resellers():
+    for reseller in AvailableResellers.resellers.values():
+        _session = AsyncSmartboxSession(
+            username="", password="", api_name=reseller.api_url
+        )
+        check = await _session.health_check()
+        assert check is not None
+        version = await _session.api_version()
+        assert "major" in version