volkswagencarnet 4.4.70__tar.gz → 5.3.3__tar.gz

{volkswagencarnet-4.4.70 → volkswagencarnet-5.3.3}/.github/workflows/codeql-analysis.yml

@@ -22,19 +22,19 @@ 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
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       # Initializes the CodeQL tools for scanning.
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v3
+        uses: github/codeql-action/init@v4
         with:
           languages: ${{ matrix.language }}
           queries: security-and-quality
@@ -45,4 +45,4 @@ jobs:
 
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3
+        uses: github/codeql-action/analyze@v4

{volkswagencarnet-4.4.70 → volkswagencarnet-5.3.3}/.github/workflows/release.yaml

@@ -9,12 +9,15 @@ jobs:
     if: "!github.event.release.prerelease"
     name: Upload Package to PyPi Repository
     runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.x"
 
@@ -32,7 +35,6 @@ jobs:
 
       - name: Publish package to PyPI
         if: startsWith(github.ref, 'refs/tags')
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          password: ${{ secrets.PYPI_TOKEN_PROD }}
-          print_hash: true
+          print-hash: true

{volkswagencarnet-4.4.70 → volkswagencarnet-5.3.3}/.github/workflows/snyk.yaml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Run Snyk to check for vulnerabilities
         uses: snyk/actions/python@master
@@ -17,6 +17,6 @@ jobs:
           args: --sarif-file-output=snyk.sarif
 
       - name: Upload result to GitHub Code Scanning
-        uses: github/codeql-action/upload-sarif@v3
+        uses: github/codeql-action/upload-sarif@v4
         with:
           sarif_file: snyk.sarif

{volkswagencarnet-4.4.70 → volkswagencarnet-5.3.3}/.github/workflows/testrelease.yaml

@@ -9,12 +9,15 @@ jobs:
   build:
     name: Upload Package to PyPi Test Repository
     runs-on: ubuntu-latest
+    environment: testrelease
+    permissions:
+      id-token: write
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.x"
 
@@ -31,9 +34,8 @@ jobs:
           python -m setuptools_scm --strip-dev
 
       - name: Publish package to Test PyPI
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          password: ${{ secrets.PYPI_TOKEN_TEST }}
-          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-4.4.70 → volkswagencarnet-5.3.3}/.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,52 +14,34 @@ on:
       - master
 
 jobs:
-  lint:
-    name: Lint
+  ruff:
+    name: Ruff
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
-      - 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
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
         with:
           fetch-depth: 0
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
 

{volkswagencarnet-4.4.70 → volkswagencarnet-5.3.3}/.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-4.4.70 → volkswagencarnet-5.3.3}/PKG-INFO

@@ -1,7 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: volkswagencarnet
-Version: 4.4.70
-Summary: Communicate with Volkswagen WeConnect
+Version: 5.3.3
+Summary: Communicate with Volkswagen Connect
 Home-page: https://github.com/robinostlund/volkswagencarnet
 Author: Robin Ostlund
 Author-email: me@robinostlund.name
@@ -10,22 +10,25 @@ 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
 Requires-Dist: beautifulsoup4
 Requires-Dist: aiohttp
 Requires-Dist: pyjwt
+Dynamic: license-file
 
 # Volkswagen Carnet
 
 [![buy me a coffee](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/robinostlund)
 
+[![buy me a coffee](https://raw.githubusercontent.com/robinostlund/homeassistant-volkswagencarnet/master/resources/stickpin_kofi.jpeg)](https://ko-fi.com/stickpin)
+
 ![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 +40,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
 
@@ -47,6 +50,7 @@ No licence, public domain, no guarantees, feel free to use for anything. Please
 
 ## Thanks to
 
+- [stickpin](https://github.com/stickpin)
 - [Wez3](https://github.com/wez3)
 - [Reneboer](https://github.com/reneboer)
 - [Tubalainen](https://github.com/tubalainen)
@@ -124,7 +128,12 @@ RESOURCES = [
     'trip_last_average_electric_consumption',
     'trip_last_average_fuel_consumption',
     'trip_last_duration',
-    'trip_last_length'
+    'trip_last_length',
+    'trip_refuel_average_speed',
+    'trip_refuel_average_electric_consumption',
+    'trip_refuel_average_fuel_consumption',
+    'trip_refuel_duration',
+    'trip_refuel_length'
 ]
 
 def is_enabled(attr):

{volkswagencarnet-4.4.70 → volkswagencarnet-5.3.3}/README.md

@@ -2,10 +2,12 @@
 
 [![buy me a coffee](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/robinostlund)
 
+[![buy me a coffee](https://raw.githubusercontent.com/robinostlund/homeassistant-volkswagencarnet/master/resources/stickpin_kofi.jpeg)](https://ko-fi.com/stickpin)
+
 ![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 +19,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
 
@@ -27,6 +29,7 @@ No licence, public domain, no guarantees, feel free to use for anything. Please
 
 ## Thanks to
 
+- [stickpin](https://github.com/stickpin)
 - [Wez3](https://github.com/wez3)
 - [Reneboer](https://github.com/reneboer)
 - [Tubalainen](https://github.com/tubalainen)
@@ -104,7 +107,12 @@ RESOURCES = [
     'trip_last_average_electric_consumption',
     'trip_last_average_fuel_consumption',
     'trip_last_duration',
-    'trip_last_length'
+    'trip_last_length',
+    'trip_refuel_average_speed',
+    'trip_refuel_average_electric_consumption',
+    'trip_refuel_average_fuel_consumption',
+    'trip_refuel_duration',
+    'trip_refuel_length'
 ]
 
 def is_enabled(attr):

{volkswagencarnet-4.4.70 → volkswagencarnet-5.3.3}/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-4.4.70 → volkswagencarnet-5.3.3}/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-4.4.70 → volkswagencarnet-5.3.3}/requirements.txt

@@ -1,5 +1,4 @@
 aiohttp
 beautifulsoup4
-cryptography
 lxml
 pyjwt

{volkswagencarnet-4.4.70 → volkswagencarnet-5.3.3}/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.3.3/tests/conftest.py

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

{volkswagencarnet-4.4.70 → volkswagencarnet-5.3.3}/tests/credentials.py.sample

@@ -2,5 +2,5 @@
 # Oh, and replace the data in credentials.py with your own
 spin = '1234'
 username = 'john.doe@localhost.localnet'
-pasword = 'passw0rd'
+password = 'passw0rd'
 vin = 'WVWZZXXXXX1234567'

{volkswagencarnet-4.4.70 → volkswagencarnet-5.3.3}/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-4.4.70 → volkswagencarnet-5.3.3}/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,10 @@ 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,
+    )

{volkswagencarnet-4.4.70 → volkswagencarnet-5.3.3}/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 tests.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.3.3/tests/vw_connection_test.py

@@ -0,0 +1,97 @@
+"""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)
+
+    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