juham-visualcrossing 0.1.7__tar.gz → 0.1.9__tar.gz

juham_visualcrossing-0.1.9/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: juham-visualcrossing
+Version: 0.1.9
+Summary: A Weather forecast  plugin extending `Juham` applications
+Author-email: J Meskanen <juham.api@gmail.com>
+Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://gitlab.com/juham/juham/juham-visualcrossing
+Project-URL: Bug Reports, https://gitlab.com/juham/juham/juham-visualcrossing
+Project-URL: Funding, https://meskanen.com
+Project-URL: Say Thanks!, http://meskanen.com
+Project-URL: Source, https://gitlab.com/juham/juham/juham-visualcrossing
+Keywords: object-oriented,plugin,framework
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development
+Classifier: Programming Language :: Python :: 3.8
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE.rst
+Requires-Dist: juham-core>=0.1.5
+Requires-Dist: pytz>=2024.1
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
+Dynamic: license-file
+
+VisualCrossing forecast plugin for Juham™
+=========================================
+
+Description
+-----------
+
+Adds forecast support to Juham™ home automation.
+
+.. image:: _static/images/visualcrossing.png
+   :alt: Solar and temperature forecasts
+   :width: 640px
+   :align: center  
+
+
+Project Status
+--------------
+
+**Current State**: **Alpha (Status 3)**  
+
+Please check out the `CHANGELOG <CHANGELOG.rst>`_ file for changes in this release.
+
+
+
+Getting Started
+---------------
+
+### Installation
+
+1. Install
+
+   .. code-block:: bash
+
+      pip install juham_visualcrossing
+
+
+2. Configure
+
+   - ``VisualCrossing.json``: Add your Visual Crossing API key for weather forecasts.
+

{juham_visualcrossing-0.1.7 → juham_visualcrossing-0.1.9}/juham_visualcrossing/visualcrossing.py

@@ -2,7 +2,7 @@ from datetime import datetime, timedelta, timezone
 import json
 from typing_extensions import override
 from typing import Any, Optional, cast
-from masterpiece.mqtt import MqttMsg, Mqtt
+from masterpiece import MqttMsg, Mqtt
 from juham_core import JuhamThread, JuhamCloudThread
 
 
@@ -68,7 +68,7 @@ class VisualCrossingThread(JuhamCloudThread):
     def process_data(self, data: Any) -> None:
         self.info("VisualCrossing process_data()")
         data = data.json()
-        forecast = []
+        forecast: list[dict[str, Any]] = []
         self.info(f"VisualCrossing {data}")
         for day in data["days"]:
             for hour in day["hours"]:
@@ -113,6 +113,8 @@ class VisualCrossing(JuhamThread):
     update_interval.
     """
 
+    _VISUALCROSSING: str = "visualcrossing"
+
     workerThreadId: str = VisualCrossingThread.get_class_id()
     base_url: str = (
         "https://weather.visualcrossing.com/VisualCrossingWebServices/rest/services/timeline/"
@@ -121,7 +123,7 @@ class VisualCrossing(JuhamThread):
     api_key: str = "SE9W7EHP775N7NDNW8ANM2MZN"
     location: str = "lahti,finland"
 
-    def __init__(self, name="visualcrossing") -> None:
+    def __init__(self, name: str = "visualcrossing") -> None:
         """Constructs VisualCrossing automation object for acquiring and publishing
         forecast data.
 
@@ -148,11 +150,11 @@ class VisualCrossing(JuhamThread):
         else:
             super().on_message(client, userdata, msg)
 
-    def on_forecast(self, em: dict) -> None:
+    def on_forecast(self, em: dict[str, Any]) -> None:
         """Handle weather forecast data.
 
         Args:
-            em (dict): forecast
+            em (dict[str, Any]): forecast
         """
         # self.debug(f"VisualCrossing: got mqtt message {em}")
 
@@ -176,19 +178,20 @@ class VisualCrossing(JuhamThread):
         super().run()
 
     @override
-    def to_dict(self) -> dict:
-        data = super().to_dict()
-        data["_visualcrossing"] = {
-            "topic": self.forecast_topic,
-            "url": self.base_url,
+    def to_dict(self) -> dict[str, Any]:
+        data: dict[str, dict[str, Any]] = super().to_dict()
+        data[self._VISUALCROSSING] = {
+            "forecast_topic": self.forecast_topic,
+            "base_url": self.base_url,
             "api_key": self.api_key,
-            "interval": self.update_interval,
+            "update_interval": self.update_interval,
+            "location": self.location,
         }
         return data
 
     @override
-    def from_dict(self, data) -> None:
+    def from_dict(self, data: dict[str, Any]) -> None:
         super().from_dict(data)
-        if "_visualcrossing" in data:
-            for key, value in data["_visualcrossing"].items():
+        if self._VISUALCROSSING in data:
+            for key, value in data[self._VISUALCROSSING].items():
                 setattr(self, key, value)

{juham_visualcrossing-0.1.7 → juham_visualcrossing-0.1.9}/juham_visualcrossing/visualcrossing_plugin.py

@@ -1,4 +1,3 @@
-from ast import Str
 from typing_extensions import override
 from masterpiece import Plugin, Composite
 from .visualcrossing import VisualCrossing

juham_visualcrossing-0.1.9/juham_visualcrossing.egg-info/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: juham-visualcrossing
+Version: 0.1.9
+Summary: A Weather forecast  plugin extending `Juham` applications
+Author-email: J Meskanen <juham.api@gmail.com>
+Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://gitlab.com/juham/juham/juham-visualcrossing
+Project-URL: Bug Reports, https://gitlab.com/juham/juham/juham-visualcrossing
+Project-URL: Funding, https://meskanen.com
+Project-URL: Say Thanks!, http://meskanen.com
+Project-URL: Source, https://gitlab.com/juham/juham/juham-visualcrossing
+Keywords: object-oriented,plugin,framework
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development
+Classifier: Programming Language :: Python :: 3.8
+Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE.rst
+Requires-Dist: juham-core>=0.1.5
+Requires-Dist: pytz>=2024.1
+Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
+Dynamic: license-file
+
+VisualCrossing forecast plugin for Juham™
+=========================================
+
+Description
+-----------
+
+Adds forecast support to Juham™ home automation.
+
+.. image:: _static/images/visualcrossing.png
+   :alt: Solar and temperature forecasts
+   :width: 640px
+   :align: center  
+
+
+Project Status
+--------------
+
+**Current State**: **Alpha (Status 3)**  
+
+Please check out the `CHANGELOG <CHANGELOG.rst>`_ file for changes in this release.
+
+
+
+Getting Started
+---------------
+
+### Installation
+
+1. Install
+
+   .. code-block:: bash
+
+      pip install juham_visualcrossing
+
+
+2. Configure
+
+   - ``VisualCrossing.json``: Add your Visual Crossing API key for weather forecasts.
+

juham_visualcrossing-0.1.9/juham_visualcrossing.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE.rst
+MANIFEST.in
+README.rst
+pyproject.toml
+juham_visualcrossing/__init__.py
+juham_visualcrossing/py.typed
+juham_visualcrossing/visualcrossing.py
+juham_visualcrossing/visualcrossing_plugin.py
+juham_visualcrossing.egg-info/PKG-INFO
+juham_visualcrossing.egg-info/SOURCES.txt
+juham_visualcrossing.egg-info/dependency_links.txt
+juham_visualcrossing.egg-info/entry_points.txt
+juham_visualcrossing.egg-info/requires.txt
+juham_visualcrossing.egg-info/top_level.txt
+tests/__init__.py
+tests/test_visualcrossing.py

{juham_visualcrossing-0.1.7 → juham_visualcrossing-0.1.9}/juham_visualcrossing.egg-info/requires.txt

@@ -1,4 +1,4 @@
-juham-automation>=0.0.7
+juham-core>=0.1.5
 pytz>=2024.1
 
 [dev]

{juham_visualcrossing-0.1.7 → juham_visualcrossing-0.1.9}/pyproject.toml

@@ -1,16 +1,21 @@
 
+
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
 
 
+[tool.setuptools]
+include-package-data = true
+packages = ["juham_visualcrossing"]
+
 [project]
 name = "juham-visualcrossing"
-version = "0.1.7"
+version = "0.1.9"
 requires-python = ">=3.8"
 description = "A Weather forecast  plugin extending `Juham` applications"
-readme = {file = "docs/source/README.rst", content-type = "text/x-rst"}
-license = {file = "docs/source/LICENSE.rst", content-type = "text/x-rst"}
+readme = {file = "README.rst", content-type = "text/x-rst"}
+license = "MIT"
 keywords = ["object-oriented", "plugin", "framework"]
 authors = [
   {name = "J Meskanen", email = "juham.api@gmail.com" }
@@ -23,12 +28,11 @@ classifiers = [
   "Development Status :: 3 - Alpha",
   "Intended Audience :: Developers",
   "Topic :: Software Development",
-  "License :: OSI Approved :: MIT License",
   "Programming Language :: Python :: 3.8",
 ]
 
 dependencies = [
-  "juham-automation >= 0.0.7",
+  "juham-core >= 0.1.5",
   "pytz >= 2024.1",
 ]
 
@@ -41,14 +45,12 @@ dev = ["check-manifest"]
 visualcrossing_plugin = "juham_visualcrossing:VisualCrossingPlugin"
 
 
-
 [project.urls]
-"Homepage" = "https://meskanen.com"
-"Bug Reports" = "https://meskanen.com"
+"Homepage" = "https://gitlab.com/juham/juham/juham-visualcrossing"
+"Bug Reports" = "https://gitlab.com/juham/juham/juham-visualcrossing"
 "Funding" = "https://meskanen.com"
 "Say Thanks!" = "http://meskanen.com"
-"Source" = "https://meskanen.com"
-
+"Source" = "https://gitlab.com/juham/juham/juham-visualcrossing"
 
 
 [tool.mypy]

juham_visualcrossing-0.1.9/tests/test_visualcrossing.py

@@ -0,0 +1,217 @@
+import unittest
+
+from datetime import datetime, timedelta
+from unittest.mock import MagicMock, patch
+import json
+from typing_extensions import Any
+from juham_visualcrossing.visualcrossing import VisualCrossing, VisualCrossingThread
+
+
+class MockResponse:
+
+    def __init__(self, data: Any) -> None:
+        self._data = data
+
+    def json(self) -> Any:
+        return self._data
+
+
+# Assuming your classes are imported as follows:
+# from your_module import VisualCrossingThread, VisualCrossing, Mqtt
+
+
+class TestVisualCrossingThread(unittest.TestCase):
+
+    @patch("juham_visualcrossing.visualcrossing.Mqtt")
+    def test_visualcrossing_thread_init(self, MockMqtt: MagicMock) -> None:
+        # Mock the MQTT client
+        mock_client = MockMqtt.return_value
+        thread: VisualCrossingThread = VisualCrossingThread(mock_client)
+
+        # Assert that the MQTT client is assigned
+        self.assertEqual(thread.mqtt_client, mock_client)
+
+    @patch("juham_visualcrossing.visualcrossing.datetime")
+    def test_make_weburl(self, MockDatetime: MagicMock) -> None:
+        # Mock datetime to return a specific date
+        mock_now = datetime(2023, 10, 20)
+        mock_end = mock_now + timedelta(days=1)
+
+        # Mock the return value of now() and strftime() on the mocked datetime
+        MockDatetime.now.return_value = mock_now
+        MockDatetime.return_value.strftime.side_effect = lambda fmt: (
+            mock_now.strftime(fmt) if fmt != "%Y-%m-%d" else mock_end.strftime(fmt)
+        )
+
+        # Initialize and set class-level attributes
+        thread = VisualCrossingThread(None)
+        thread.init(
+            "forecast_topic", "https://api.example.com/", 3600, "API_KEY", "city"
+        )
+
+        # Call method
+        result = thread.make_weburl()
+
+        # Expected URL based on the mocked datetime
+        expected_url = "https://api.example.com/city/2023-10-20/2023-10-21?unitGroup=metric&contentType=json&include=hours&key=API_KEY"
+
+        # Assert the result is as expected
+        self.assertEqual(result, expected_url)
+
+    # @patch("juham_visualcrossing.visualcrossing.json.dumps")
+    # @patch("juham_visualcrossing.visualcrossing.Mqtt")
+    def test_process_data(self) -> None:
+        # Setup mock MQTT and data
+        mock_client = MagicMock()
+        thread = VisualCrossingThread(mock_client)
+
+        # Prepare mock response data
+        mock_data: dict[str, list[dict[str, list[dict[str, Any]]]]] = {
+            "days": [
+                {
+                    "hours": [
+                        {
+                            "datetimeEpoch": 1632952200,
+                            "uvindex": 5,
+                            "solarradiation": 1.5,
+                            "solarenergy": 10.5,
+                            "cloudcover": 80,
+                            "snow": 0,
+                            "snowdepth": 0,
+                            "pressure": 1015,
+                            "temp": 20,
+                            "humidity": 60,
+                            "windspeed": 5,
+                            "winddir": 180,
+                            "dew": 10,
+                        }
+                    ]
+                }
+            ]
+        }
+
+        with patch.object(thread, "publish") as mock_publish, patch.object(
+            thread, "info"
+        ) as mock_info:
+            # Act
+            thread.process_data(MockResponse(mock_data))
+
+            # Assert
+            mock_publish.assert_called_once()
+
+
+class TestVisualCrossing(unittest.TestCase):
+
+    def test_visualcrossing_init(self) -> None:
+        # Instantiate VisualCrossing and check its properties
+        vc = VisualCrossing(name="test_visualcrossing")
+
+        self.assertEqual(vc.forecast_topic, vc.make_topic_name("forecast"))
+
+    @patch("juham_visualcrossing.visualcrossing.VisualCrossingThread")
+    def test_visualcrossing_on_connect(
+        self, MockVisualCrossingThread: MagicMock
+    ) -> None:
+        # Mock the thread and MQTT client
+
+        vc = VisualCrossing(name="test_visualcrossing")
+
+        # Ensure forecast_topic is set
+        vc.forecast_topic = "/forecast"  # Make sure forecast_topic has a value
+
+        # Mock subscribe method before calling on_connect
+        with patch.object(vc, "subscribe", MagicMock()):
+
+            # Mock the MQTT connection callback
+            mock_client = MagicMock()
+            userdata = None
+            flags = 0
+            rc = 0  # Success
+
+            # Call the on_connect method
+            vc.on_connect(mock_client, userdata, flags, rc)
+
+            # Assert that it subscribed to the topic
+            vc.subscribe.assert_called_once_with(vc.forecast_topic)
+
+    @patch("juham_visualcrossing.visualcrossing.VisualCrossingThread")
+    def test_visualcrossing_run(self, MockVisualCrossingThread: MagicMock) -> None:
+        # Mock the thread's methods
+        mock_thread = MockVisualCrossingThread.return_value
+        vc = VisualCrossing(name="test_visualcrossing")
+
+        # Patch instantiate to return our mock
+        vc.instantiate = MagicMock(return_value=mock_thread)
+
+        # Initialize with required attributes
+        vc.forecast_topic = "forecast_topic"
+        vc.base_url = "https://example.com"
+        vc.update_interval = 3600
+        vc.api_key = "API_KEY"
+        vc.location = "city"
+
+        # Call the method
+        vc.run()
+
+        # Check if the thread was initialized correctly
+        mock_thread.init.assert_called_once_with(
+            "forecast_topic", "https://example.com", 3600, "API_KEY", "city"
+        )
+
+    def test_visualcrossing_to_dict(self) -> None:
+        vc = VisualCrossing(name="test_visualcrossing")
+        vc.forecast_topic = "forecast_topic"
+        vc.base_url = "https://example.com"
+        vc.api_key = "API_KEY"
+        vc.update_interval = 3600
+        vc.location = "city"
+
+        expected_dict: dict[str, Any] = {
+            "_class": "VisualCrossing",
+            "_version": 0,
+            "_object": {"name": "test_visualcrossing", "payload": None},
+            "_base": {},
+            "visualcrossing": {
+                "forecast_topic": "forecast_topic",
+                "base_url": "https://example.com",
+                "api_key": "API_KEY",
+                "update_interval": 3600,
+                "location": "city",
+            },
+        }
+
+        # Check if the to_dict method works
+        result = vc.to_dict()
+        self.assertEqual(result["visualcrossing"], expected_dict["visualcrossing"])
+
+    @patch("juham_visualcrossing.visualcrossing.VisualCrossingThread")
+    def test_visualcrossing_from_dict(
+        self, MockVisualCrossingThread: MagicMock
+    ) -> None:
+        data: dict[str, Any] = {
+            "_class": "VisualCrossing",
+            "_version": 0,
+            "_object": {"name": "visualcrossing", "payload": None},
+            "_base": {},
+            "visualcrossing": {
+                "forecast_topic": "forecast_topic",
+                "base_url": "https://example.com",
+                "api_key": "API_KEY",
+                "update_interval": 3600,
+                "location": "dusseldorf",
+            },
+        }
+
+        vc = VisualCrossing(name="test_visualcrossing")
+        vc.from_dict(data)
+
+        # Assert that the from_dict method correctly assigns values
+        self.assertEqual(vc.forecast_topic, "forecast_topic")
+        self.assertEqual(vc.base_url, "https://example.com")
+        self.assertEqual(vc.api_key, "API_KEY")
+        self.assertEqual(vc.update_interval, 3600)
+        self.assertEqual(vc.location, "dusseldorf")
+
+
+if __name__ == "__main__":
+    unittest.main()

juham_visualcrossing-0.1.7/PKG-INFO

@@ -1,24 +0,0 @@
-Metadata-Version: 2.2
-Name: juham-visualcrossing
-Version: 0.1.7
-Summary: A Weather forecast  plugin extending `Juham` applications
-Author-email: J Meskanen <juham.api@gmail.com>
-Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
-Project-URL: Homepage, https://meskanen.com
-Project-URL: Bug Reports, https://meskanen.com
-Project-URL: Funding, https://meskanen.com
-Project-URL: Say Thanks!, http://meskanen.com
-Project-URL: Source, https://meskanen.com
-Keywords: object-oriented,plugin,framework
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Software Development
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.8
-Requires-Python: >=3.8
-Description-Content-Type: text/x-rst
-License-File: LICENSE.rst
-Requires-Dist: juham-automation>=0.0.7
-Requires-Dist: pytz>=2024.1
-Provides-Extra: dev
-Requires-Dist: check-manifest; extra == "dev"

juham_visualcrossing-0.1.7/docs/build/html/.buildinfo

@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: e545442b084f19cc5bc8f5695e997a7b
-tags: 645f666f9bcd5a90fca523b33c5a78b7

juham_visualcrossing-0.1.7/docs/build/html/_sources/index.rst.txt

@@ -1,50 +0,0 @@
-VisualCrossing Weather Forecast Plugin
-======================================
-
-
-.. image:: _static/juham.png
-    :alt: VisualCrossing Forecast service for Juha's Ultimate Home Automation Masterpiece
-    :width: 400px
-    :height: 300px
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-   juham_visualcrossing/index
-
-.. include:: ../../README.rst
-
-.. include:: ../../LICENSE.rst
-
-.. include:: ../../CHANGELOG.rst
-
-
-
-
-Classes
--------
-
-.. inheritance-diagram::
-   juham_visualcrossing.VisualCrossing
-   juham_visualcrossing.VisualCrossingThread
-   juham_visualcrossing.VisualCrossingPlugin
-   juham_core.Juham
-   masterpiece.composite.Composite
-   masterpiece.application.Application
-   masterpiece.plugin.Plugin
-   masterpiece.plugmaster.PlugMaster
-   masterpiece.argmaestro.ArgMaestro
-   masterpiece.log.Log
-   :parts: 1
-
-
-
-
-
-Index
-=====
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

juham_visualcrossing-0.1.7/docs/build/html/_sources/juham_visualcrossing/index.rst.txt

@@ -1,9 +0,0 @@
-Juham Visual Crossing Plugin
-============================
-
-.. automodule:: juham_visualcrossing
-   :members:
-   :inherited-members:
-   :undoc-members:
-   :show-inheritance:
-