volkswagencarnet 5.0.0b4__tar.gz → 5.0.0b5__tar.gz

{volkswagencarnet-5.0.0b4 → volkswagencarnet-5.0.0b5}/.github/workflows/codeql-analysis.yml

@@ -22,7 +22,7 @@ jobs:
       fail-fast: false
       matrix:
         language: ["python"]
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.11", "3.12"]
 
     steps:
       - name: Checkout repository

{volkswagencarnet-5.0.0b4 → volkswagencarnet-5.0.0b5}/.github/workflows/release.yaml

@@ -37,4 +37,4 @@ jobs:
         if: startsWith(github.ref, 'refs/tags')
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          print_hash: true
+          print-hash: true

{volkswagencarnet-5.0.0b4 → volkswagencarnet-5.0.0b5}/.github/workflows/testrelease.yaml

@@ -36,6 +36,6 @@ jobs:
       - name: Publish package to Test PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          repository_url: https://test.pypi.org/legacy/
-          print_hash: true
-          skip_existing: true
+          repository-url: https://test.pypi.org/legacy/
+          print-hash: true
+          skip-existing: true

{volkswagencarnet-5.0.0b4 → volkswagencarnet-5.0.0b5}/.github/workflows/validate.yml

@@ -1,4 +1,4 @@
-# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# This workflow will install Python dependencies, run tests and ruff with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
 name: Validate
@@ -14,43 +14,25 @@ on:
       - master
 
 jobs:
-  lint:
-    name: Lint
+  ruff:
+    name: Ruff
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Set up Python 3.11
-        uses: actions/setup-python@v5
+      - name: Check ruff
+        uses: chartboost/ruff-action@v1
         with:
-          python-version: "3.11"
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install flake8 black
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-
-      - name: Lint with flake8
-        run: |
-          # stop the build if there are Python syntax errors or undefined names
-          flake8 . --select=E9,F63,F7,F82,F841,E266
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 . --exit-zero --max-complexity=10 --max-line-length=127
-
-      - name: Lint with black
-        #uses: psf/black@stable
-        run: |
-          black --check --diff --color .
+          args: 'format --diff'
 
   test-n-build:
     name: Test and Build
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.11", "3.12"]
 
     steps:
       - name: Checkout code

{volkswagencarnet-5.0.0b4 → volkswagencarnet-5.0.0b5}/.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 default_language_version:
-  python: python3.9
+  python: python3.11
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -18,17 +18,6 @@ repos:
       - id: requirements-txt-fixer
       - id: trailing-whitespace
 
-  -   repo: https://github.com/psf/black
-      rev: '22.10.0'
-      hooks:
-        - id: black
-
-  - repo: https://github.com/pycqa/flake8
-    rev: '4.0.1'
-    hooks:
-      - id: flake8
-        additional_dependencies: [ flake8-docstrings ]
-
   - repo: https://github.com/asottile/pyupgrade
     rev: v2.31.0
     hooks:

{volkswagencarnet-5.0.0b4 → volkswagencarnet-5.0.0b5}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: volkswagencarnet
-Version: 5.0.0b4
-Summary: Communicate with Volkswagen WeConnect
+Version: 5.0.0b5
+Summary: Communicate with Volkswagen Connect
 Home-page: https://github.com/robinostlund/volkswagencarnet
 Author: Robin Ostlund
 Author-email: me@robinostlund.name
@@ -10,7 +10,7 @@ Project-URL: Bug Tracker, https://github.com/robinostlund/volkswagencarnet/issue
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.7
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: lxml
@@ -25,7 +25,7 @@ Requires-Dist: pyjwt
 ![Release](https://img.shields.io/github/workflow/status/robinostlund/volkswagencarnet/Release)
 ![PyPi](https://img.shields.io/pypi/v/volkswagencarnet)
 ![Version](https://img.shields.io/github/v/release/robinostlund/volkswagencarnet)
-![CodeStyle](https://img.shields.io/badge/code%20style-black-black)
+![CodeStyle](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)
 ![Known Vulnerabilities](https://snyk.io/test/github/robinostlund/volkswagencarnet/badge.svg)
 [![CodeQL](https://github.com/robinostlund/volkswagencarnet/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/robinostlund/volkswagencarnet/actions/workflows/codeql-analysis.yml)
 [![codecov](https://codecov.io/gh/robinostlund/volkswagencarnet/branch/master/graph/badge.svg?token=NH1Q1GH4I3)](https://codecov.io/gh/robinostlund/volkswagencarnet)
@@ -37,7 +37,7 @@ Requires-Dist: pyjwt
 
 ## Help Wanted
 
-As i don't have a car with we connect anymore i would appreciate if it would be possible to get help to keep this repository maintained. So if you feel that you have some time over and is interested in helping out with this. Please feel to contact me! Thanks
+As i don't have a car with Volkswagen Connect anymore i would appreciate if it would be possible to get help to keep this repository maintained. So if you feel that you have some time over and is interested in helping out with this. Please feel to contact me! Thanks
 
 ## Information
 

{volkswagencarnet-5.0.0b4 → volkswagencarnet-5.0.0b5}/README.md

@@ -5,7 +5,7 @@
 ![Release](https://img.shields.io/github/workflow/status/robinostlund/volkswagencarnet/Release)
 ![PyPi](https://img.shields.io/pypi/v/volkswagencarnet)
 ![Version](https://img.shields.io/github/v/release/robinostlund/volkswagencarnet)
-![CodeStyle](https://img.shields.io/badge/code%20style-black-black)
+![CodeStyle](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)
 ![Known Vulnerabilities](https://snyk.io/test/github/robinostlund/volkswagencarnet/badge.svg)
 [![CodeQL](https://github.com/robinostlund/volkswagencarnet/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/robinostlund/volkswagencarnet/actions/workflows/codeql-analysis.yml)
 [![codecov](https://codecov.io/gh/robinostlund/volkswagencarnet/branch/master/graph/badge.svg?token=NH1Q1GH4I3)](https://codecov.io/gh/robinostlund/volkswagencarnet)
@@ -17,7 +17,7 @@
 
 ## Help Wanted
 
-As i don't have a car with we connect anymore i would appreciate if it would be possible to get help to keep this repository maintained. So if you feel that you have some time over and is interested in helping out with this. Please feel to contact me! Thanks
+As i don't have a car with Volkswagen Connect anymore i would appreciate if it would be possible to get help to keep this repository maintained. So if you feel that you have some time over and is interested in helping out with this. Please feel to contact me! Thanks
 
 ## Information
 

{volkswagencarnet-5.0.0b4 → volkswagencarnet-5.0.0b5}/pyproject.toml

@@ -10,19 +10,6 @@ build-backend = "setuptools.build_meta"
 fallback_version = "0.0.0"
 write_to = "volkswagencarnet/version.py"
 
-[tool.black]
-line-length = 120
-target-version = ['py37', 'py38', 'py39', 'py310']
-include = '\.pyi?$'
-extend-exclude = '''
-/(
-  # The following are specific to Black, you probably don't want those.
-  | blib2to3
-  | tests/data
-  | profiling
-)/
-'''
-
 [tool.pytest.ini_options]
 minversion = "6.0"
 addopts = "-ra"

{volkswagencarnet-5.0.0b4 → volkswagencarnet-5.0.0b5}/requirements-test.txt

@@ -1,7 +1,4 @@
 -r requirements.txt
-black
-flake8
-flake8-docstrings
 freezegun>=1.0.0
 pre-commit
 pytest>=7.0.0

{volkswagencarnet-5.0.0b4 → volkswagencarnet-5.0.0b5}/setup.cfg

@@ -2,7 +2,7 @@
 name = volkswagencarnet
 author = Robin Ostlund
 author_email = me@robinostlund.name
-description = Communicate with Volkswagen WeConnect
+description = Communicate with Volkswagen Connect
 long_description = file: README.md
 long_description_content_type = text/markdown
 url = https://github.com/robinostlund/volkswagencarnet
@@ -23,7 +23,7 @@ install_requires =
 package_dir = 
 	= .
 packages = find:
-python_requires = >= 3.7
+python_requires = >= 3.11
 
 [options.packages.find]
 where = .
@@ -31,32 +31,6 @@ exclude =
 	tests
 	tests.*
 
-[flake8]
-ignore = 
-	E722,
-	I201,
-	W503,
-	CFQ001,
-	CFQ002,
-	E501,
-	W503,
-	E203,
-	D202,
-	W504
-filename = 
-	*.py
-exclude = 
-	.git,
-	__pycache__,
-	*.txt,
-	*.md,
-	*.cfg
-max_line_length = 120
-count = True
-inline_quotes = double
-show_source = True
-statistics = True
-
 [pycodestyle]
 max_line_length = 120
 statistics = True

volkswagencarnet-5.0.0b5/tests/conftest.py

@@ -0,0 +1,4 @@
+"""Configure tests."""
+
+pytest_plugins = ["pytest_cov"]
+pytest_plugins.append("tests.fixtures.connection")

{volkswagencarnet-5.0.0b4 → volkswagencarnet-5.0.0b5}/tests/dummy_test.py

@@ -1,8 +1,7 @@
 """Dummy tests. Might be removed once there are proper ones."""
 
-import pytest
 from aiohttp import ClientSession
-
+import pytest
 from volkswagencarnet import vw_connection
 
 
@@ -10,6 +9,8 @@ from volkswagencarnet import vw_connection
 async def test_volkswagencarnet():
     """Dummy test to ensure logged in status is false by default."""
     async with ClientSession() as session:
-        connection = vw_connection.Connection(session, "test@example.com", "test_password")
+        connection = vw_connection.Connection(
+            session, "test@example.com", "test_password"
+        )
         # if await connection._login():
         assert connection.logged_in is False

{volkswagencarnet-5.0.0b4 → volkswagencarnet-5.0.0b5}/tests/fixtures/connection.py

@@ -2,11 +2,11 @@
 
 import os
 
+from aiohttp import ClientSession, CookieJar
 import pytest
 import pytest_asyncio
-from aiohttp import CookieJar, ClientSession
-
 from volkswagencarnet.vw_connection import Connection
+
 from .constants import resource_path
 
 
@@ -23,4 +23,11 @@ async def session():
 @pytest.fixture
 def connection(session):
     """Real connection for integration tests."""
-    return Connection(session=session, username="", password="", country="DE", interval=999, fulldebug=True)
+    return Connection(
+        session=session,
+        username="",
+        password="",
+        country="DE",
+        interval=999,
+        fulldebug=True,
+    )

{volkswagencarnet-5.0.0b4 → volkswagencarnet-5.0.0b5}/tests/integration_test.py

@@ -1,5 +1,4 @@
-"""
-Integration tests.
+"""Integration tests.
 
 These tests use actual credentials, and should thus be used with care.
 Credentials have to be specified in credentials.py.
@@ -7,22 +6,22 @@ Credentials have to be specified in credentials.py.
 
 import logging
 
-import pytest
 from aiohttp import ClientSession
-
+import pytest
 from volkswagencarnet import vw_connection
 
 try:
-    from credentials import username, password, spin, vin
+    from credentials import password, spin, username, vin
 except ImportError:
     username = password = spin = vin = None
 
 
 @pytest.mark.skipif(
-    username is None or password is None, reason="Username or password is not set. Check credentials.py.sample"
+    username is None or password is None,
+    reason="Username or password is not set. Check credentials.py.sample",
 )
 @pytest.mark.asyncio
-async def test_successful_login():
+async def test_successful_login() -> None:
     """Test that login succeeds."""
     async with ClientSession() as session:
         connection = vw_connection.Connection(session, username, password)
@@ -31,14 +30,14 @@ async def test_successful_login():
 
 
 @pytest.mark.skipif(
-    username is None or password is None, reason="Username or password is not set. Check credentials.py.sample"
+    username is None or password is None,
+    reason="Username or password is not set. Check credentials.py.sample",
 )
 @pytest.mark.asyncio
 @pytest.mark.skip("Not yet implemented")
-async def test_spin_action():
-    """
-    Test something that uses s-pin.
+async def test_spin_action() -> None:
+    """Test something that uses s-pin.
 
     Not yet implemented...
     """
-    logging.getLogger().debug(f"using vin: {vin} and s-pin: {spin}")
+    logging.getLogger().debug("using vin: %s and s-pin: %s", vin, spin)

volkswagencarnet-5.0.0b5/tests/vw_connection_test.py

@@ -0,0 +1,98 @@
+"""Tests for main connection class."""
+
+import sys
+from unittest import IsolatedAsyncioTestCase
+from unittest.mock import MagicMock, patch
+
+import aiohttp
+from aiohttp import client_exceptions
+import pytest
+from volkswagencarnet import vw_connection
+from volkswagencarnet.vw_connection import Connection
+
+
+class TwoVehiclesConnection(Connection):
+    """Connection that return two vehicles."""
+
+    ALLOW_RATE_LIMIT_DELAY = False
+
+    # noinspection PyUnusedLocal
+    # noinspection PyMissingConstructor
+    def __init__(self, sess, username="", password="", **kwargs):
+        """Init."""
+        super().__init__(session=sess, username=username, password=password)
+        self._jarCookie = MagicMock()
+
+    async def doLogin(self, tries=1):
+        """No-op update."""
+        return True
+
+    async def update(self):
+        """No-op update."""
+        return True
+
+    @property
+    def vehicles(self):
+        """Return the vehicles."""
+        vehicle1 = vw_connection.Vehicle(None, "vin1")
+        vehicle2 = vw_connection.Vehicle(None, "vin2")
+        return [vehicle1, vehicle2]
+
+
+@pytest.mark.skipif(
+    condition=sys.version_info < (3, 11), reason="Test incompatible with Python < 3.11"
+)
+def test_clear_cookies(connection) -> None:
+    """Check that we can clear old cookies."""
+    assert len(connection._session._cookie_jar._cookies) > 0
+    connection._clear_cookies()
+    assert len(connection._session._cookie_jar._cookies) == 0
+
+
+class SendCommandsTest(IsolatedAsyncioTestCase):
+    """Test command sending."""
+
+    async def test_set_schedule(self):
+        """Test set schedule."""
+        pass
+
+
+class RateLimitTest(IsolatedAsyncioTestCase):
+    """Test that rate limiting towards VW works."""
+
+    invocations = 0
+
+    async def rateLimitedFunction(self, url, vin=""):
+        """Limit calls test function."""
+        ri = MagicMock(aiohttp.RequestInfo)
+        e = client_exceptions.ClientResponseError(request_info=ri, history=tuple([]))
+        e.status = 429
+        self.invocations = self.invocations + 1
+        raise e
+
+    @pytest.mark.asyncio
+    @pytest.mark.skipif(
+        condition=sys.version_info < (3, 11),
+        reason="Test incompatible with Python < 3.11",
+    )
+    @patch(
+        "volkswagencarnet.vw_connection.Connection",
+        spec_set=vw_connection.Connection,
+        new=TwoVehiclesConnection,
+    )
+    @patch("volkswagencarnet.vw_connection.MAX_RETRIES_ON_RATE_LIMIT", 1)
+    async def test_rate_limit(self):
+        """Test rate limiting functionality."""
+
+        from unittest.mock import AsyncMock
+
+        sess = AsyncMock()
+
+        # noinspection PyArgumentList
+        conn = vw_connection.Connection(sess, "", "")
+
+        self.invocations = 0
+        with patch.object(conn, "_request", self.rateLimitedFunction):
+            res = await conn.get("foo")
+            assert res == {"status_code": 429}
+        assert self.invocations == vw_connection.MAX_RETRIES_ON_RATE_LIMIT + 1

volkswagencarnet-5.0.0b5/tests/vw_utilities_test.py

@@ -0,0 +1,116 @@
+"""Utilities class tests."""
+
+from datetime import datetime, timedelta, timezone
+from json import JSONDecodeError
+from unittest import TestCase
+
+import pytest
+from volkswagencarnet.vw_utilities import (
+    camel2slug,
+    is_valid_path,
+    json_loads,
+    make_url,
+    obj_parser,
+)
+
+
+class UtilitiesTest(TestCase):
+    """Test methods in utilities."""
+
+    def test_camel_to_slug(self):
+        """Test camel_to_slug conversion."""
+        data = {
+            "foo": "foo",
+            "fooBar": "foo_bar",
+            "XYZ": "x_y_z",
+            "B4R": "b4_r",  # Should this actually be "b_4_r"? =)
+            "Foo_Bar": "foo_bar",
+            "_removeExtra_Underscores__": "remove_extra_underscores",
+            "preserve___existing": "preserve___existing",
+        }
+
+        for key, expected in data.items():
+            with self.subTest(msg=key, v=key):
+                res = camel2slug(key)
+                assert expected == res
+
+    def test_is_valid_path(self):
+        """Test that is_valid_path works as expected."""
+        data = {
+            "None": [None, None, True],
+            "a in a": [{"a": 1}, "a", True],
+            "b in a": [{"a": 1}, "b", False],
+            "a.b in a.b": [{"a": {"b": 7}}, "a.b", True],
+            "false path": [{"a": {"b": 7}}, False, True],
+            "dict path": [{1, "a", "[[ :) ]]"}, {"crash": "me"}, False],
+            "": [{"a": []}, datetime.now(), TypeError],
+        }
+
+        for test_name, test_case in data.items():
+            with self.subTest(msg=test_name):
+                source, path, expected = test_case
+
+                if isinstance(expected, bool):
+                    # If expected is a boolean, assert the result of is_valid_path
+                    assert (
+                        is_valid_path(source, path) == expected
+                    ), f"Path validation error for '{path}' in '{source}'."
+                else:
+                    # If expected is an exception, assert it is raised
+                    with pytest.raises(expected) as exc_info:
+                        is_valid_path(source, path)
+                    assert isinstance(
+                        exc_info.value, expected
+                    ), f"Expected {expected.__name__}, but got {type(exc_info.value).__name__}. Exception: {str(exc_info.value)}"
+
+    def test_is_valid_path_with_lists(self):
+        """Test that is_valid_path can process lists."""
+        assert is_valid_path({"a": [{"b": True}, {"c": True}]}, "a.0.b")
+        assert not is_valid_path({"a": [{"b": True}, {"c": True}]}, "a.2")
+
+    def test_obj_parser(self):
+        """Test that the object parser works."""
+        data = {
+            "int": [0, AttributeError],
+            "dict": [{"foo": "bar"}, {"foo": "bar"}],
+            "dict with time": [
+                {"foo": "2001-01-01T23:59:59Z"},
+                {"foo": datetime(2001, 1, 1, 23, 59, 59, tzinfo=timezone.utc)},
+            ],
+            "dict with timezone": [
+                {"foo": "2001-01-01T23:59:59+0200"},
+                {
+                    "foo": datetime(
+                        2001, 1, 1, 23, 59, 59, tzinfo=timezone(timedelta(hours=2))
+                    )
+                },
+            ],
+        }
+
+        for test_name, (input_data, expected_output) in data.items():
+            with self.subTest(test_name=test_name):
+                if isinstance(expected_output, dict):
+                    res = obj_parser(input_data)
+                    assert res == expected_output
+                else:
+                    with pytest.raises(expected_output):
+                        obj_parser(input_data)
+
+    def test_json_loads(self):
+        """Test that json_loads works."""
+        expected = {"foo": {"bar": "baz"}}
+        actual = json_loads('{"foo":  {\n"bar":\t"baz"}}')
+        assert expected == actual
+
+        assert json_loads("42") == 42
+
+        with pytest.raises(JSONDecodeError):
+            json_loads("{[}")
+
+        with pytest.raises(TypeError):
+            json_loads(42)
+
+    def test_make_url(self):
+        """Test placeholder replacements."""
+        assert make_url("foo/{bar}/baz{baz}", bar=2, baz="") == "foo/2/baz"
+        assert make_url("foo/{baz}/$bar", bar=2, baz="asd") == "foo/asd/2"