add github actions

Author: IvanKirpichnikov

.github/workflows/setup.yml

@@ -0,0 +1,42 @@
+# This workflow will install Python dependencies, run tests and lint
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: CI
+
+on:
+  push:
+    branches: [ "develop" ]
+  pull_request:
+    branches: [ "develop" ]
+
+jobs:
+  cpython:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+        python-version:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up ${{ matrix.python-version }} on ${{ matrix.os }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[dev]
+
+    - name: Run ruff
+      run: |
+        ruff check .
+
+    - name: Run mypy
+      run: |
+        mypy src

.ruff.toml

@@ -0,0 +1,28 @@
+line-length = 79
+target-version = "py310"
+src = ["src"]
+
+include = ["src/**.py"]
+lint.select = ["ALL"]
+lint.ignore = [
+   "ARG",
+   "ANN",
+   "D",
+   "EM101",
+   "EM102",
+   "PT001",
+   "PT023",
+   "SIM108",
+   "SIM114",
+   "TRY003",
+   "TCH003",
+   "PLW2901",
+   "RET505",
+   "PLR0913",
+   "UP038",
+   "TCH001",
+   "SIM103",
+   "PERF401",
+   "PLR2004",
+   "PYI034",
+]

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=75.2.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = 'aiokycloak'
+name = 'aiokeycloak'
 description = ''
 requires-python = '>= 3.10.0'
 version = '0.0.1'
@@ -17,8 +17,14 @@ dependencies = [
 
 [project.optional-dependencies]
 aiohttp = ['aiohttp==3.10.0']
+integrations = [
+    'aiokeycloak[aiohttp]',
+]
 linters = [
     'mypy==1.12.1',
     'ruff==0.7.0',
 ]
-dev = ['aiokycloak[linters]']
+dev = [
+    'aiokeycloak[linters]',
+    'aiokeycloak[integrations]'
+]

src/aiokeycloak/client.py

@@ -3,7 +3,9 @@
 from typing import Any, TypeVar
 from uuid import UUID
 
-from aiokeycloak.methods.assign_realm_roles_to_user import AssignRealmRolesToUser
+from aiokeycloak.methods.assign_realm_roles_to_user import (
+    AssignRealmRolesToUser,
+)
 from aiokeycloak.methods.base import KeycloakMethod
 from aiokeycloak.methods.create_user import CreateUser
 from aiokeycloak.methods.delete_user import DeleteUser
@@ -23,7 +25,6 @@
 from aiokeycloak.types.user import User
 from aiokeycloak.types.users import Users
 
-
 T = TypeVar("T", bound=KeycloakType)
 
 
@@ -47,14 +48,14 @@ async def get_realms_roles(
         self,
         realm_name: str,
         *,
-        max: int | None = None,
+        max_: int | None = None,
         first: int | None = None,
         search: str | None = None,
         brief_representation: bool | None = None,
     ) -> RealmRoles:
         method = GetRealmRoles(
             realm_name=realm_name,
-            max=max,
+            max=max_,
             first=first,
             search=search,
             access_token=self._access_token,
@@ -119,7 +120,7 @@ async def get_users(
         first: int | None = None,
         first_name: str | None = None,
         last_name: str | None = None,
-        max: int | None = None,
+        max_: int | None = None,
         username: str | None = None,
     ) -> Users:
         method = GetUsers(
@@ -133,7 +134,7 @@ async def get_users(
             first=first,
             first_name=first_name,
             last_name=last_name,
-            max=max,
+            max=max_,
             username=username,
         )
         return await self.send_request(method)

src/aiokeycloak/methods/assign_realm_roles_to_user.py

@@ -23,7 +23,8 @@ class AssignRealmRolesToUser(KeycloakMethod[Success]):
     def build_request_context(self) -> RequestContext:
         return RequestContext(
             body=[
-                {"name": realm_role_name} for realm_role_name in self.realm_roles_names
+                {"name": realm_role_name}
+                for realm_role_name in self.realm_roles_names
             ],
             url_format={
                 "realm_name": self.realm_name,

src/aiokeycloak/methods/base.py

@@ -1,11 +1,10 @@
 from abc import abstractmethod
 from dataclasses import dataclass
-from enum import auto, StrEnum
+from enum import StrEnum, auto
 from typing import Any, Protocol, TypeVar
 
 from aiokeycloak.types.base import KeycloakType
 
-
 T = TypeVar("T", bound=KeycloakType)
 
 

src/aiokeycloak/methods/get_users.py

@@ -50,5 +50,7 @@ def build_request_context(self) -> RequestContext:
                 "Content-Type": "application/json",
                 "Authorization": f"Bearer {self.access_token}",
             },
-            query_parameters={data[0]: data[1] for data in query_parameters if data[1]},
+            query_parameters={
+                data[0]: data[1] for data in query_parameters if data[1]
+            },
         )

src/aiokeycloak/sessions/aiohttp.py

@@ -36,7 +36,8 @@ def _load_http_method(self, http_method: HTTPMethodType) -> AioHTTPMethod:
         elif http_method == HTTPMethodType.DELETE:
             return self._client_session.delete
         else:
-            raise ValueError("Unknown http method %r" % http_method)
+            msg = f"Unknown http method {http_method!r}"
+            raise ValueError(msg)
 
     async def _send_request(
         self,

src/aiokeycloak/sessions/base.py

@@ -1,7 +1,7 @@
 from abc import abstractmethod
 from asyncio import Protocol
 from dataclasses import dataclass
-from typing import Any, cast, TypeVar
+from typing import Any, TypeVar, cast
 
 from aiokeycloak.errors import (
     KeycloakError,
@@ -11,7 +11,6 @@
 from aiokeycloak.methods.base import HTTPMethodType, KeycloakMethod
 from aiokeycloak.types.base import FromResponse, KeycloakType
 
-
 T = TypeVar("T", bound=KeycloakType)
 
 
@@ -34,10 +33,10 @@ class ResponseDS:
 
 def error_handling(response: ResponseDS) -> None:
     if not isinstance(response.body, dict):
-        return None
+        return
 
     if response.http_status < 400:
-        return None
+        return
 
     error: str = (
         response.body.get("error")
@@ -52,16 +51,18 @@ def error_handling(response: ResponseDS) -> None:
         "http_status": response.http_status,
     }
     if "Unauthorized" in error:
+        msg = f"Unauthorized client. {error}"
         raise UnauthorizedError(
-            "Unauthorized client. %s" % error,
+            msg,
             **error_data,
         )
 
     if "User exists" in error:
         raise UserExistsError(error, **error_data)
 
+    msg = f"An error has occurred. Url {response.url!r}. {error!r}."
     raise KeycloakError(
-        "An error has occurred. Url %r. %r." % (response.url, error),
+        msg,
         **error_data,
     )
 

src/aiokeycloak/token_decoders/access.py

@@ -1,9 +1,8 @@
 import json
-from typing import Any, cast, Final
+from typing import Any, Final, cast
 
 from jwcrypto import jwk, jwt  # type: ignore[import-untyped]
 
-
 BEGIN_PUBLIC_KEY: Final = "-----BEGIN PUBLIC KEY-----\n"
 END_PUBLIC_KEY: Final = "\n-----END PUBLIC KEY-----"
 
@@ -13,7 +12,11 @@ def __init__(self, access_token: str) -> None:
         self._access_token = access_token
 
     def decode(
-        self, public_key: str, validate: bool = True, **kwargs: Any
+        self,
+        public_key: str,
+        *,
+        validate: bool = True,
+        **kwargs: Any,
     ) -> dict[str, Any]:
         if not validate:
             full_jwt = jwt.JWT(jwt=self._access_token, **kwargs)

src/aiokeycloak/types/access_token.py

@@ -4,7 +4,7 @@
 from enum import StrEnum
 from typing import Any
 
-from adaptix import name_mapping, Retort
+from adaptix import Retort, name_mapping
 
 from aiokeycloak.types.base import FromResponse, KeycloakType
 

src/aiokeycloak/types/realm.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 
-from adaptix import name_mapping, Retort
+from adaptix import Retort, name_mapping
 
 from aiokeycloak.types.base import FromResponse, KeycloakType
 

src/aiokeycloak/types/realm_role.py

@@ -4,7 +4,7 @@
 from typing import Any, cast
 from uuid import UUID
 
-from adaptix import name_mapping, NameStyle, Retort
+from adaptix import NameStyle, Retort, name_mapping
 
 from aiokeycloak.types.base import FromResponse, KeycloakType
 

src/aiokeycloak/types/realm_roles.py

@@ -2,8 +2,8 @@
 
 from dataclasses import dataclass
 
-from aiokeycloak.types.realm_role import RealmRole
 from aiokeycloak.types.base import FromResponse, KeycloakType
+from aiokeycloak.types.realm_role import RealmRole
 
 
 @dataclass(frozen=True, slots=True)

src/aiokeycloak/types/user.py

@@ -4,7 +4,7 @@
 from typing import Any, cast
 from uuid import UUID
 
-from adaptix import name_mapping, NameStyle, Retort
+from adaptix import NameStyle, Retort, name_mapping
 
 from aiokeycloak.types.base import FromResponse, KeycloakType
 

src/aiokeycloak/types/users.py

@@ -22,7 +22,7 @@ def from_response(
                     FromResponse(
                         body=body,
                         headers=data.headers,
-                    )
+                    ),
                 ),
             )
         return cls(users=users)