Merge pull request #43 from kzosabe/develop

Release 0.3.1

Author: kzosabe

.gitignore

@@ -5,5 +5,7 @@ __pycache__/
 /dist/
 /docs/_build
 /.tox
+/.coverage
+/htmlcov
 .idea
 !.keep

CHANGELOG.md

@@ -1,3 +1,9 @@
+0.3.1, 2021-11-27
+-------------------------
+
+- Bug fix
+  - Fix import issue when using physical device objects
+
 0.3.0, 2021-11-27
 -------------------------
 

docs/conf.py

@@ -5,7 +5,7 @@
 project = "switchbot-client"
 copyright = "2021, kzosabe"
 author = "kzosabe"
-release = "0.3.0"
+release = "0.3.1"
 extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"]
 templates_path = ["_templates"]
 exclude_patterns = ["_build", ".DS_Store"]

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "switchbot-client"
-version = "0.3.0"
+version = "0.3.1"
 description = "A Python client library for SwitchBot API."
 license = "Apache-2.0 or MIT"
 authors = [
@@ -30,12 +30,12 @@ black = ">=20.8b1"
 flake8 = "^4.0.1"
 isort = "^5.9.3"
 mypy = "^0.910"
-pylint = "^2.10.2"
+pylint = "^2.12.1"
 pytest = "^6.2.5"
 pytest-cov = "^3.0.0"
 pytest-mock = "^3.6.1"
 tox = "^3.24.4"
-Sphinx = "^4.3.0"
+Sphinx = "^4.3.1"
 
 [build-system]
 requires = ["poetry_core>=1.0.0"]

pyproject.toml

@@ -0,0 +1,3 @@
+#!/bin/bash -eu
+cd "$( dirname "$0" )"/..
+poetry run pytest -v --cov=switchbot_client --cov-report=html

scripts/cov.sh

@@ -128,10 +128,10 @@ def _load_config(self):
     def _check_api_response(original_response: requests.Response):
         response = original_response.json()
         if "message" not in response:
-            raise RuntimeError("format error")
+            raise RuntimeError("format error", original_response.text)
         if response["message"] == "Unauthorized":
             raise RuntimeError(
                 "Http 401 Error. User permission is denied due to invalid token.",
-                original_response.text,
+                response,
             )
         return SwitchBotAPIResponse(response["statusCode"], response["message"], response["body"])

switchbot_client/api.py

@@ -1,2 +1,2 @@
 class AppConstants:
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"

switchbot_client/constants.py

@@ -2,25 +2,25 @@
 
 from typing import TYPE_CHECKING
 
+from switchbot_client.devices.status import (
+    BotDeviceStatus,
+    ColorBulbDeviceStatus,
+    ContactSensorDeviceStatus,
+    CurtainDeviceStatus,
+    DeviceStatus,
+    HumidifierDeviceStatus,
+    MeterDeviceStatus,
+    MotionSensorDeviceStatus,
+    PlugDeviceStatus,
+    SmartFanDeviceStatus,
+)
 from switchbot_client.enums import ControlCommand, DeviceType
 from switchbot_client.types import APIPhysicalDeviceObject
 
 from .base import SwitchBotCommandResult, SwitchBotDevice
 
 if TYPE_CHECKING:
     from switchbot_client import SwitchBotClient
-    from switchbot_client.devices.status import (
-        BotDeviceStatus,
-        ColorBulbDeviceStatus,
-        ContactSensorDeviceStatus,
-        CurtainDeviceStatus,
-        DeviceStatus,
-        HumidifierDeviceStatus,
-        MeterDeviceStatus,
-        MotionSensorDeviceStatus,
-        PlugDeviceStatus,
-        SmartFanDeviceStatus,
-    )
 
 
 class SwitchBotPhysicalDevice(SwitchBotDevice):

switchbot_client/devices/physical.py

@@ -3,6 +3,7 @@
 import pytest
 import requests
 
+from switchbot_client import ControlCommand
 from switchbot_client.api import SwitchBotAPIClient
 from switchbot_client.constants import AppConstants
 from switchbot_client.devices import SwitchBotPhysicalDevice, SwitchBotRemoteDevice
@@ -33,10 +34,15 @@ def test_init_by_config_file(patch_path_exists, mocker):
 
 @patch("os.path.exists")
 def test_init_by_another_config_file(patch_path_exists, mocker):
-    m = mocker.patch("builtins.open", mocker.mock_open(read_data="token: foo"))
+    m = mocker.patch(
+        "builtins.open",
+        mocker.mock_open(read_data="token: foo\napi_host_domain: https://new-api.example.com"),
+    )
     patch_path_exists.return_value = True
     sut = SwitchBotAPIClient(config_file_path="~/.config/switch-bot-client/another-config.yml")
     m.assert_called_with("~/.config/switch-bot-client/another-config.yml", encoding="utf-8")
+    assert sut.token == "foo"
+    assert sut.api_host_domain == "https://new-api.example.com"
 
 
 @patch("os.path.exists")
@@ -155,3 +161,158 @@ def mock_get(*args, **kwargs):
     assert sut.status_code == expected.get("statusCode")
     assert sut.message == expected.get("message")
     assert sut.body == expected.get("body")
+
+
+def test_devices_status_wrong_device_error(monkeypatch):
+    expected = {
+        "statusCode": 190,
+        "message": "error message",
+        "body": {},
+    }
+
+    class MockResponse:
+        @staticmethod
+        def json():
+            return expected
+
+    def mock_get(*args, **kwargs):
+        assert kwargs["headers"]["user-agent"] == f"switchbot-client/{AppConstants.VERSION}"
+        return MockResponse()
+
+    monkeypatch.setattr(requests, "get", mock_get)
+    client = SwitchBotAPIClient("token")
+
+    with pytest.raises(RuntimeError) as e:
+        sut = client.devices_status("device_foo")
+    assert "Wrong device ID or trying to get infrared virtual device status" in str(e.value)
+
+
+def test_devices_status_broken_response(monkeypatch):
+    expected = {
+        "someInvalidResponse": "panic",
+    }
+
+    class MockResponse:
+        def __init__(self):
+            self.text = """{
+                "someInvalidResponse": "panic",
+            }"""
+
+        @staticmethod
+        def json():
+            return expected
+
+    def mock_get(*args, **kwargs):
+        assert kwargs["headers"]["user-agent"] == f"switchbot-client/{AppConstants.VERSION}"
+        return MockResponse()
+
+    monkeypatch.setattr(requests, "get", mock_get)
+    client = SwitchBotAPIClient("token")
+
+    with pytest.raises(RuntimeError) as e:
+        sut = client.devices_status("device_foo")
+    assert "format error" in str(e.value)
+
+
+def test_devices_status_unauthorized(monkeypatch):
+    expected = {
+        "message": "Unauthorized",
+    }
+
+    class MockResponse:
+        @staticmethod
+        def json():
+            return expected
+
+    def mock_get(*args, **kwargs):
+        assert kwargs["headers"]["user-agent"] == f"switchbot-client/{AppConstants.VERSION}"
+        return MockResponse()
+
+    monkeypatch.setattr(requests, "get", mock_get)
+    client = SwitchBotAPIClient("token")
+
+    with pytest.raises(RuntimeError) as e:
+        sut = client.devices_status("device_foo")
+    assert "Http 401 Error. User permission is denied due to invalid token." in str(e.value)
+
+
+def test_devices_commands(monkeypatch):
+    expected = {
+        "statusCode": 100,
+        "message": "success",
+        "body": {},
+    }
+
+    class MockResponse:
+        @staticmethod
+        def json():
+            return expected
+
+    def mock_post(*args, **kwargs):
+        assert kwargs["headers"]["user-agent"] == f"switchbot-client/{AppConstants.VERSION}"
+        return MockResponse()
+
+    monkeypatch.setattr(requests, "post", mock_post)
+    client = SwitchBotAPIClient("token")
+    sut = client.devices_commands(
+        "device_foo",
+        ControlCommand.ColorBulb.SET_BRIGHTNESS,
+        parameter="50",
+        command_type="command",
+    )
+    assert sut.status_code == expected.get("statusCode")
+    assert sut.message == expected.get("message")
+    assert sut.body == expected.get("body")
+
+
+def test_scenes(monkeypatch):
+    expected = {
+        "statusCode": 100,
+        "message": "success",
+        "body": [
+            {"sceneId": "S1", "sceneName": "Scene 1"},
+            {"sceneId": "S2", "sceneName": "Scene 2"},
+        ],
+    }
+
+    class MockResponse:
+        @staticmethod
+        def json():
+            return expected
+
+    def mock_get(*args, **kwargs):
+        assert kwargs["headers"]["user-agent"] == f"switchbot-client/{AppConstants.VERSION}"
+        return MockResponse()
+
+    monkeypatch.setattr(requests, "get", mock_get)
+    client = SwitchBotAPIClient("token")
+    sut = client.scenes()
+    assert sut.status_code == expected.get("statusCode")
+    assert sut.message == expected.get("message")
+    assert sut.body == expected.get("body")
+
+
+def test_scenes_execute(monkeypatch):
+    expected = {
+        "statusCode": 100,
+        "message": "success",
+        "body": {},
+    }
+
+    class MockResponse:
+        @staticmethod
+        def json():
+            return expected
+
+    def mock_post(*args, **kwargs):
+        assert kwargs["headers"]["user-agent"] == f"switchbot-client/{AppConstants.VERSION}"
+        return MockResponse()
+
+    monkeypatch.setattr(requests, "post", mock_post)
+    client = SwitchBotAPIClient("token")
+    sut = client.scenes_execute(
+        "scene_foo",
+    )
+    assert sut.status_code == expected.get("statusCode")
+    assert sut.message == expected.get("message")
+    assert sut.body == expected.get("body")