Merge pull request #15 from devolo/development

Bump version

Author: Markus Bong

.github/workflows/convert_todos_to_issues.yml

@@ -63,34 +63,3 @@ jobs:
     - name: Test with pytest
       run: |
         pytest --cov=ssllabs
-    - name: Preserve coverage
-      uses: actions/upload-artifact@v2
-      with:
-        name: coverage
-        path: .coverage
-
-  # coverage:
-  #   name: Upload coverage
-  #   runs-on: ubuntu-latest
-  #   needs: test
-  #   steps:
-  #   - name: Checkout sources
-  #     uses: actions/checkout@v2
-  #   - name: Set up Python
-  #     uses: actions/setup-python@v2
-  #     with:
-  #       python-version: 3.8
-  #   - name: Download coverage
-  #     uses: actions/download-artifact@v2
-  #     with:
-  #       name: coverage
-  #   - name: Coveralls
-  #     run: |
-  #       python -m pip install --upgrade pip
-  #       pip install wheel coveralls==1.10.0
-  #       export COVERALLS_REPO_TOKEN=${{ secrets.COVERALLS_TOKEN }}
-  #       coveralls
-  #   - name: Clean up coverage
-  #     uses: geekyeggo/delete-artifact@v1
-  #     with:
-  #       name: coverage

.github/workflows/pythonpackage.yml

@@ -1,14 +1,14 @@
 repos:
 -   repo: https://github.com/pre-commit/mirrors-yapf
-    rev: ''
+    rev: 'v0.30.0'
     hooks:
     -   id: yapf
 -   repo: https://github.com/pycqa/isort
-    rev: ''
+    rev: '5.7.0'
     hooks:
         - id: isort
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: ''
+    rev: 'v3.4.0'
     hooks:
         - id: end-of-file-fixer
         - id: trailing-whitespace

.pre-commit-config.yaml

@@ -153,3 +153,7 @@ async def get_grade():
 ```
 
 Classes are called like the [API call](https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs-v3.md#protocol-calls) without the leading get. The get method will query the API. It will take the parameters like in the documentation and return a dataclass representing the object, the API describes. One exception in the naming: the getEndpointData call is implemented in the Endpoint class to be able to better distinguish it from its EndpointData result object.
+
+## Exceptions
+
+Three types of exceptions might hit you, if the connection to SSL Labs' API is affected: ```httpx.ConnectTimeout``` or ```httpx.ReadTimeout``` appear, if the servers are down, and ```httpx.HTTPStatusError``` appears, if there is a client or server [error response](https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs-v3.md#error-response-status-codes). In this cases, you are asked to wait 15 to 30 minutes before you try again.

README.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v0.3.0] - 2021/02/08
+
+### Added
+
+- Query used API version with ssllabs.api.API_VERSION
+- Low level methods now can reuse an existing AsyncClient instance
+
+### Fixed
+
+- Fix dataclasses for certain situations
+
 ## [v0.2.0] - 2021/01/28
 
 ### Added

docs/CHANGELOG.md

@@ -1,6 +1,6 @@
 from .ssllabs import Ssllabs
 
 __license__ = "MIT"
-__version__ = "0.2.0"
+__version__ = "0.3.0"
 
 __all__ = ['Ssllabs', "__license__", "__version__"]

ssllabs/__init__.py

@@ -1,7 +1,8 @@
+from ._api import API_VERSION
 from .analyze import Analyze
 from .endpoint import Endpoint
 from .info import Info
 from .root_certs_raw import RootCertsRaw
 from .status_codes import StatusCodes
 
-__all__ = ["Analyze", "Endpoint", "Info", "RootCertsRaw", "StatusCodes"]
+__all__ = ["API_VERSION", "Analyze", "Endpoint", "Info", "RootCertsRaw", "StatusCodes"]

ssllabs/api/__init__.py

@@ -1,6 +1,6 @@
-import asyncio
 import logging
 from abc import ABC
+from typing import KeysView, Optional
 
 import httpx
 
@@ -11,16 +11,24 @@
 class _Api(ABC):
     """Abstract class to communicate with Qualys SSL Labs Assessment APIs."""
 
-    def __init__(self):
-        self.logger = logging.getLogger(f"{self.__class__.__module__}.{self.__class__.__name__}")
-        self.client = httpx.AsyncClient()
-
-    def __del__(self):
-        loop = asyncio.get_event_loop()
-        loop.create_task(self.client.aclose())
+    def __init__(self, client: Optional[httpx.AsyncClient] = None):
+        self._logger = logging.getLogger(f"{self.__class__.__module__}.{self.__class__.__name__}")
+        self._client = client
 
     async def _call(self, api_endpoint: str, **kwargs) -> httpx.Response:
         """Invocate API."""
-        r = await self.client.get(f"{SSLLABS_URL}{api_endpoint}", params=kwargs)
+        if self._client:
+            r = await self._client.get(f"{SSLLABS_URL}{api_endpoint}", params=kwargs)
+        else:
+            async with httpx.AsyncClient() as client:
+                r = await client.get(f"{SSLLABS_URL}{api_endpoint}", params=kwargs)
         r.raise_for_status()
         return r
+
+    def _verify_kwargs(self, given: KeysView, known: list):
+        """Log warning, if an argument is unknown."""
+        for arg in given:
+            if arg not in known:
+                self._logger.warning(
+                    "Argument '%s' is not known by the SSL Labs API. It will be send, but the results might be unexpected.",
+                    arg)

ssllabs/api/_api.py

@@ -30,6 +30,10 @@ async def get(self, host: str, **kwargs) -> HostData:
         :key ignoreMismatch: Set to "on" to proceed with assessments even when the server certificate doesn't match the
                              assessment hostname. Set to off by default. Please note that this parameter is ignored if a
                              cached report is returned.
+        :raises httpx.ConnectTimeout: SSL Labs Servers don't respond.
+        :raises httpx.HTTPStatusError: A client or server error response occured.
+        :raises httpx.ReadTimeout: SSL Labs Servers don't respond.
         """
+        self._verify_kwargs(kwargs.keys(), ["publish", "startNew", "fromCache", "maxAge", "all", "ignoreMismatch"])
         r = await self._call("analyze", host=host, **kwargs)
         return from_dict(data_class=HostData, data=r.json())

ssllabs/api/analyze.py

@@ -18,6 +18,10 @@ async def get(self, host: str, s: str, **kwargs) -> EndpointData:
         :key fromCache: Always deliver cached assessment reports if available; optional, defaults to "off". This parameter is
                         intended for API consumers that don't want to wait for assessment results. Can't be used at the same
                         time as the startNew parameter.
+        :raises httpx.ConnectTimeout: SSL Labs Servers don't respond.
+        :raises httpx.HTTPStatusError: A client or server error response occured.
+        :raises httpx.ReadTimeout: SSL Labs Servers don't respond.
         """
+        self._verify_kwargs(kwargs.keys(), ["fromCache"])
         r = await self._call("getEndpointData", host=host, s=s, **kwargs)
         return from_dict(data_class=EndpointData, data=r.json())