Add v1.1.0

Author: jstabenow

.flake8

@@ -1,3 +1,3 @@
 [flake8]
-max-line-length = 110
+max-line-length = 79
 exclude = .git,__pycache__,__init__.py,.mypy_cache,.pytest_cache

.github/workflows/codeql-analysis.yml

@@ -48,11 +48,11 @@ jobs:
         # If you wish to specify custom queries, you can do so here or in a config file.
         # By default, queries listed here will override any specified in a config file.
         # Prefix the list here with "+" to use these queries and those in the config file.
-        
+
         # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
         # queries: security-extended,security-and-quality
 
-        
+
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
@@ -61,7 +61,7 @@ jobs:
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
     #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
     # - run: |

.gitignore

@@ -1,3 +1,4 @@
 *.pyc
 htmlcov
 .coverage
+coverage.xml

.pre-commit-config.yaml

@@ -17,13 +17,13 @@ repos:
         rev: 22.3.0
         hooks:
         -   id: black
-            args: ["--line-length=110"]
+            args: ["--line-length=79"]
 
     -   repo: https://github.com/pycqa/flake8
         rev: 4.0.1
         hooks:
         -   id: flake8
-            args: ["--max-line-length=110", "--ignore=E203,E501,W503", "--exclude=.git,__pycache__,__init__.py,.mypy_cache,.pytest_cache"]
+            args: ["--max-line-length=79", "--ignore=E203,E501,W503", "--exclude=.git,__pycache__,__init__.py,.mypy_cache,.pytest_cache"]
 
     -   repo: https://github.com/Lucas-C/pre-commit-hooks-bandit
         rev: v1.0.5

CHANGELOG.md

@@ -1,6 +1,19 @@
 Changelog
 ---------
 
-1.0.0
+## 1.0.0
 
-* Initial release.
+- Initial release
+
+## 1.1.0
+
+- Add `metrics_get` endpoint
+- Add definition `ConfigApiAuthAuth0Tenant`
+- Mod extends login tests
+- Mod allows v10.12.0 SRT api (sent_unique__bytes > sent_unique_bytes, recv_loss__bytes > recv_loss_bytes)
+- Mod allows `auth0_token` (login)
+- Mod `about` is now deprecated. Please use `about_get`
+- Mod `metrics` is now deprecated. Please use `metrics_post`
+- Add `memory_limit_mbytes` to config.debug
+- Fix `access_token` and `refresh_token` parameters (login)
+- Fix SRT testing (requires core v10.10+)

README.md

@@ -1,6 +1,6 @@
 # datarhei Core PyClient
-For rapid development of Python applications around the [datarhei Core](https://github.com/datarhei/core).    
-Requires Python 3.7+ and datarhei Core v16.9+.
+For rapid development of Python applications around the [datarhei Core](https://github.com/datarhei/core).
+Requires Python 3.7+ and datarhei Core v16.10+.
 
 ---
 
@@ -107,7 +107,7 @@ asyncio.run(main())
 
 ### Cluster
 
-***Do not use in production!***    
+***Do not use in production!***
 *This is an upcoming feature. More here: [Core v16.10#cluster](https://github.com/datarhei/core/tree/cluster))*
 
 
@@ -216,10 +216,16 @@ asyncio.run(main())
 
 ### Metrics
 
+-   `GET` /api/v3/metrics
+
+    ```python
+    v3_metrics_get()
+    ```
+
 -   `POST` /api/v3/metrics
 
     ```python
-    v3_metrics(config: Metrics)
+    v3_metrics_post(config: Metrics)
     ```
     *Model: [Metrics](https://github.com/datarhei/core-client-python/blob/main/core_client/base/models/v3/metrics.py)*
 
@@ -604,7 +610,7 @@ $ pre-commit run --all-files
 
 ## Contributing
 
-Found a mistake or misconduct? Create a [issue](https://github.com/datarhei/core-client-python/issues) or send a pull-request.    
+Found a mistake or misconduct? Create a [issue](https://github.com/datarhei/core-client-python/issues) or send a pull-request.
 Suggestions for improvement are welcome.
 
 ## Licence

core_client/__init__.py

@@ -6,7 +6,11 @@
 import json
 from datetime import datetime
 from httpx import InvalidURL as HttpInvalidURL, HTTPError
-from pydantic import HttpUrl, ValidationError as PydanticValidationError, validate_arguments
+from pydantic import (
+    HttpUrl,
+    ValidationError as PydanticValidationError,
+    validate_arguments,
+)
 
 from . import base
 from .models import Client as ClientModel
@@ -22,6 +26,7 @@ def __init__(
         password: str = None,
         access_token: str = None,
         refresh_token: str = None,
+        auth0_token: str = None,
         retries: int = 3,
         timeout: float = 10.0,
     ):
@@ -37,72 +42,143 @@ def __init__(
         self.password = password
         self.access_token = access_token
         self.refresh_token = refresh_token
+        self.access_token_expires_at = None
+        self.auth0_token = auth0_token
         self.retries = retries
         self.timeout = timeout
 
-    def _access_token(self, response: Token = None):
+    def _basic_login(self):
+        r_login = httpx.post(
+            url=f"{self.base_url}/api/login",
+            json={
+                "username": f"{self.username}",
+                "password": f"{self.password}",
+            },
+            # failed login delay: 5s
+            timeout=10.0,
+        )
+        if r_login.status_code == 200:
+            try:
+                response = Token(**r_login.json())
+                self._set_access_token_expires_at(response)
+                self.refresh_token = response.refresh_token
+                return response
+            except PydanticValidationError:
+                return Token()
+        else:
+            raise HTTPError("Authorization failed")
+
+    def _auth0_login(self):
+        _headers = self.headers
+        _headers["authorization"] = f"Bearer {self.auth0_token}"
+        r_login = httpx.post(
+            url=f"{self.base_url}/api/login",
+            headers=_headers,
+            # failed login delay: 5s
+            timeout=10.0,
+        )
+        if r_login.status_code == 200:
+            try:
+                response = Token(**r_login.json())
+                self._set_access_token_expires_at(response)
+                self.refresh_token = response.refresh_token
+                return response
+            except PydanticValidationError:
+                return Token()
+        else:
+            raise HTTPError("Authorization failed")
+
+    def _set_access_token_expires_at(self, response: Token = None):
         if response:
-            self.token_expire = json.loads(
-                (base64.b64decode(response.access_token.split(".")[1])).decode("utf-8")
-            )["exp"]
+            try:
+                self.access_token_expires_at = json.loads(
+                    (
+                        base64.b64decode(response.access_token.split(".")[1])
+                    ).decode("utf-8")
+                )["exp"]
+            except (AttributeError, IndexError):
+                raise HTTPError("Authorization failed")
             self.access_token = response.access_token
+            return self.access_token_expires_at
 
-    def _refresh_token(self):
+    def _access_token_is_expired(self):
+        if not self.access_token_expires_at:
+            self._set_access_token_expires_at(
+                Token(access_token=self.access_token)
+            )
+        if (
+            datetime.fromtimestamp(self.access_token_expires_at)
+            > datetime.now()
+        ):
+            return False
+        return True
+
+    def _refresh_access_token(self):
         if self.refresh_token:
             _headers = self.headers
             _headers["authorization"] = f"Bearer {self.refresh_token}"
-            r_refresh_token = httpx.get(
+            r_refresh_access_token = httpx.get(
                 url=f"{self.base_url}/api/login/refresh",
                 headers=_headers,
                 # failed login delay: 5s
                 timeout=10.0,
             )
-            if r_refresh_token.status_code == 200:
-                response = AccessToken(**r_refresh_token.json())
-                self._access_token(response)
-                return True
-        return False
-
-    def _token_expired(self):
-        if datetime.fromtimestamp(self.token_expire) > datetime.now():
-            return False
-        return True
+            if r_refresh_access_token.status_code == 200:
+                response = AccessToken(**r_refresh_access_token.json())
+                if response.access_token is not None:
+                    self._set_access_token_expires_at(response)
+            else:
+                self._basic_login()
+        else:
+            self._basic_login()
 
     def _get_headers(self):
         _headers = self.headers
-        if self.refresh_token:
-            if self._token_expired():
-                self._refresh_token()
-            _headers["authorization"] = f"Bearer {self.access_token}"
-            return _headers
+        if self.refresh_token and self._access_token_is_expired():
+            self._refresh_access_token()
+        _headers["authorization"] = f"Bearer {self.access_token}"
         return _headers
 
+    def token(self):
+        return Token(
+            access_token=self.access_token,
+            refresh_token=self.refresh_token,
+            expires_at=int(self.access_token_expires_at),
+        )
+
     def login(self):
         r_about = httpx.get(url=f"{self.base_url}/api")
         if r_about.status_code == 200:
             try:
                 about = About(**r_about.json())
             except PydanticValidationError:
                 raise HttpInvalidURL(f'"{self.base_url}/api"')
-            if about.auths and "localjwt" in about.auths and self.username and self.password:
-                r_login = httpx.post(
-                    url=f"{self.base_url}/api/login",
-                    json={
-                        "username": f"{self.username}",
-                        "password": f"{self.password}",
-                    },
-                    # failed login delay: 5s
-                    timeout=10.0,
-                )
-                if r_login.status_code == 200:
+            if about.auths and "localjwt" in about.auths:
+                if self.refresh_token:
                     try:
-                        response = Token(**r_login.json())
-                        self._access_token(response)
-                        self.refresh_token = response.refresh_token
+                        self._refresh_access_token()
+                        return self.token()
+                    except (PydanticValidationError, TypeError):
+                        raise HTTPError("Authorization failed")
+                elif self.auth0_token:
+                    self._auth0_login()
+                    return self.token()
+                elif self.username and self.password:
+                    self._basic_login()
+                    return self.token()
+                elif (
+                    self.access_token
+                    and not self.refresh_token
+                    and not (self.username and self.password)
+                ):
+                    try:
+                        response = Token(access_token=self.access_token)
+                        self._set_access_token_expires_at(response)
                         return response
-                    except PydanticValidationError:
+                    except (PydanticValidationError, TypeError):
                         return Token()
-                raise HTTPError(f'"Authorization failed", {r_login.status_code}')
+                else:
+                    raise HTTPError("Authorization failed")
             return Token()
         raise HTTPError(f'"{self.base_url}/api", {r_about.status_code}')
 
@@ -150,6 +226,8 @@ async def proxy_method(self, *args, **kwargs):
         submodule_name = f"{module_name}.{submodule_info.name}"
         submodule = importlib.import_module(submodule_name)
         if hasattr(submodule, "asyncio"):
-            AsyncClient._add_proxy_method(submodule_info.name, submodule.asyncio)
+            AsyncClient._add_proxy_method(
+                submodule_info.name, submodule.asyncio
+            )
         if hasattr(submodule, "sync"):
             Client._add_proxy_method(submodule_info.name, submodule.sync)

core_client/base/api/about.py

@@ -1,3 +1,7 @@
+"""
+Is deprecated. Please use `about_get`.
+"""
+
 import httpx
 from pydantic import parse_obj_as, validate_arguments
 

core_client/base/api/about_get.py

@@ -0,0 +1,50 @@
+import httpx
+from pydantic import parse_obj_as, validate_arguments
+
+from ...models import Client
+from ..models import Error, About
+
+
+@validate_arguments()
+def _build_request(
+    client: Client,
+    retries: int = None,
+    timeout: float = None,
+):
+    if not retries:
+        retries = client.retries
+    if not timeout:
+        timeout = client.timeout
+    return {
+        "method": "get",
+        "url": f"{client.base_url}/api",
+        "headers": client.headers,
+        "timeout": timeout,
+        "data": None,
+        "json": None,
+    }, retries
+
+
+def _build_response(response: httpx.Response):
+    if response.status_code == 200:
+        response_200 = parse_obj_as(About, response.json())
+        return response_200
+    else:
+        response_error = parse_obj_as(Error, response.json())
+        return response_error
+
+
+def sync(client: Client, **kwargs):
+    request, retries = _build_request(client, **kwargs)
+    transport = httpx.HTTPTransport(retries=retries)
+    httpx_client = httpx.Client(transport=transport, http2=True)
+    response = httpx_client.request(**request)
+    return _build_response(response=response)
+
+
+async def asyncio(client: Client, **kwargs):
+    request, retries = _build_request(client, **kwargs)
+    transport = httpx.AsyncHTTPTransport(retries=retries)
+    async with httpx.AsyncClient(transport=transport) as httpx_client:
+        response = await httpx_client.request(**request)
+    return _build_response(response=response)

core_client/base/api/v3_cluster_get_node_proxy.py

@@ -6,7 +6,9 @@
 
 
 @validate_arguments()
-def _build_request(client: Client, id: str, retries: int = None, timeout: float = None):
+def _build_request(
+    client: Client, id: str, retries: int = None, timeout: float = None
+):
     if not retries:
         retries = client.retries
     if not timeout: