Refactor authentication handling in OverkizClient and add new credential classes by iMicknl · Pull Request #1867 · iMicknl/python-overkiz-api

iMicknl · 2025-12-29T14:22:28Z

Introduced UsernamePasswordCredentials and LocalTokenCredentials for better credential management.
Updated OverkizClient to utilize the new credential classes and refactored login logic.
Added authentication strategies for various servers, including Somfy and Rexel.
Created new modules for auth strategies and credentials to improve code organization.
Enhanced README with updated usage examples for the new authentication methods.

Breaking

OverkizServer class is renamed to ServerConfig and has additional server and type (cloud/local) property
generate_local_server is renamed to create_local_server_config
client.api_type is removed and now available via ServerConfig (e.g. client.server_config.type)
The OverkizClient constructor now requires passing a ServerConfig via server
The OverkizClient constructur now requires passing an Credentials class via credentials, e.g. UsernamePasswordCredentials(USERNAME, PASSWORD) for most server.

Features

The OverkizClient constructor now supports passing a Server enum directly, such as OverkizClient(server=Server.SOMFY_EUROPE, ...).

…ial classes - Introduced UsernamePasswordCredentials and LocalTokenCredentials for better credential management. - Updated OverkizClient to utilize the new credential classes and refactored login logic. - Added authentication strategies for various servers, including Somfy and Rexel. - Created new modules for auth strategies and credentials to improve code organization. - Enhanced README with updated usage examples for the new authentication methods.

…Config across the codebase

… utility

…ethod comments

…fig and update related references

…y and update related server handling

…_auth_strategy function

Copilot

Pull request overview

This PR introduces a comprehensive refactoring of authentication handling in the pyoverkiz library by extracting authentication logic into a dedicated module with credential classes and authentication strategies. The refactoring improves code organization and extensibility while introducing breaking changes to the OverkizClient API.

Introduced new authentication module with credential classes (UsernamePasswordCredentials, LocalTokenCredentials, RexelOAuthCodeCredentials, TokenCredentials) and strategy-based authentication
Refactored OverkizClient constructor to require ServerConfig and Credentials objects as keyword-only arguments
Added support for Rexel OAuth2 authentication flow with consent validation

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
pyoverkiz/auth/base.py	Defines AuthContext and AuthStrategy protocol for token management
pyoverkiz/auth/credentials.py	Introduces credential classes for different authentication methods
pyoverkiz/auth/strategies.py	Implements authentication strategies for various servers (Somfy, Cozytouch, Nexity, Rexel, Local)
pyoverkiz/auth/factory.py	Factory function to build appropriate auth strategy based on server and credentials
pyoverkiz/auth/init.py	Module exports for the authentication package
pyoverkiz/client.py	Refactored to use new authentication module; removed inline auth logic
pyoverkiz/models.py	Renamed OverkizServer to ServerConfig with additional server and type properties
pyoverkiz/const.py	Updated server configurations to use ServerConfig; added Rexel OAuth constants
pyoverkiz/utils.py	Renamed generate_local_server to create_local_server_config; added create_server_config helper
tests/test_client.py	Updated to use new credential classes and Server enum
tests/test_utils.py	Updated test names to match renamed utility functions
README.md	Updated examples to demonstrate new authentication approach

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pyoverkiz/auth/strategies.py

pyoverkiz/auth/base.py

pyoverkiz/utils.py

pyoverkiz/auth/strategies.py

pyoverkiz/client.py

pyoverkiz/auth/strategies.py

pyoverkiz/models.py

iMicknl · 2026-01-01T20:35:14Z

@copilot can you address the feedback in this PR?

Copilot · 2026-01-01T20:35:22Z

@iMicknl I've opened a new pull request, #1875, to work on those changes. Once the pull request is ready, I'll request review from you.

…ling, and add auth tests (#1875) - [x] Fix datetime.now() calls to use UTC timezone (pyoverkiz/auth/strategies.py lines 203, 406; pyoverkiz/auth/base.py line 24) - [x] Handle 204 No Content responses properly in strategies.py line 123 - [x] Add error handling for OAuth token exchange responses in strategies.py line 396 - [x] Remove duplicate enum conversion logic in utils.py create_server_config function - [x] Fix SSL_CONTEXT_LOCAL_API mutation issue by creating a copy per client instance - [x] Add test coverage for authentication module (strategies.py, factory.py, credentials.py) - [x] Revert SSL context creation to avoid blocking I/O at runtime - [x] Add TODO fix comment for mypy type ignore workaround  --- ✨ Let Copilot coding agent [set things up for you](https://github.com/iMicknl/python-overkiz-api/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: iMicknl <1424596+iMicknl@users.noreply.github.com>

…ategy tests

iMicknl · 2026-01-03T20:22:17Z

@tetienne I will start merging some of these, but I won't release all v2 before a final feedback round 👍🏻. And feel free to still comment on old PR's.

…ial classes (#1867) - Introduced UsernamePasswordCredentials and LocalTokenCredentials for better credential management. - Updated OverkizClient to utilize the new credential classes and refactored login logic. - Added authentication strategies for various servers, including Somfy and Rexel. - Created new modules for auth strategies and credentials to improve code organization. - Enhanced README with updated usage examples for the new authentication methods. ## Breaking - `OverkizServer` class is renamed to `ServerConfig` and has additional `server` and `type` (cloud/local) property - `generate_local_server` is renamed to `create_local_server_config` - `client.api_type` is removed and now available via `ServerConfig` (e.g. `client.server_config.type`) - The `OverkizClient` constructor now requires passing a `ServerConfig` via `server` - The `OverkizClient` constructur now requires passing an `Credentials` class via `credentials`, e.g. `UsernamePasswordCredentials(USERNAME, PASSWORD)` for most server. ## Features - The OverkizClient constructor now supports passing a Server enum directly, such as `OverkizClient(server=Server.SOMFY_EUROPE, ...)`. --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: iMicknl <1424596+iMicknl@users.noreply.github.com>

…ial classes (#1867) - Introduced UsernamePasswordCredentials and LocalTokenCredentials for better credential management. - Updated OverkizClient to utilize the new credential classes and refactored login logic. - Added authentication strategies for various servers, including Somfy and Rexel. - Created new modules for auth strategies and credentials to improve code organization. - Enhanced README with updated usage examples for the new authentication methods. - `OverkizServer` class is renamed to `ServerConfig` and has additional `server` and `type` (cloud/local) property - `generate_local_server` is renamed to `create_local_server_config` - `client.api_type` is removed and now available via `ServerConfig` (e.g. `client.server_config.type`) - The `OverkizClient` constructor now requires passing a `ServerConfig` via `server` - The `OverkizClient` constructur now requires passing an `Credentials` class via `credentials`, e.g. `UsernamePasswordCredentials(USERNAME, PASSWORD)` for most server. - The OverkizClient constructor now supports passing a Server enum directly, such as `OverkizClient(server=Server.SOMFY_EUROPE, ...)`. --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: iMicknl <1424596+iMicknl@users.noreply.github.com>

iMicknl added the v2 label Dec 29, 2025

iMicknl added this to the 2.0 milestone Dec 29, 2025

iMicknl linked an issue Dec 29, 2025 that may be closed by this pull request

Implement auth factory #321

Open

7 tasks

iMicknl force-pushed the v2/login_abstraction branch from c82af05 to 1849f13 Compare December 29, 2025 16:32

iMicknl added 15 commits January 1, 2026 18:38

Enable keyword only for OverkizClient

3250aab

Refactor authentication handling to replace OverkizServer with Server…

1e81413

…Config across the codebase

Refactor README examples to use Server enum and generate_local_server…

a3ee82b

… utility

Add docstrings to authentication strategies and improve API request m…

9f28a26

…ethod comments

Refactor server configuration handling to use create_local_server_con…

d7bdda0

…fig and update related references

Remove deprecated local token features

d00fe89

Set user agent

36d4879

Refactor authentication strategy to use server configuration diraectl…

9e8f33b

…y and update related server handling

Fix

a2c8a42

Refactor authentication strategy return type to AuthStrategy in build…

33f563c

…_auth_strategy function

Add constructor to ServerConfig for better initialization of fields

6ec3377

Add comment

d5e418a

Fix tests

f0c8e3a

Remove unused import of SUPPORTED_SERVERS from README.md

38823d2

iMicknl force-pushed the v2/login_abstraction branch from 98d9d6a to 38823d2 Compare January 1, 2026 18:39

iMicknl marked this pull request as ready for review January 1, 2026 19:07

iMicknl requested a review from tetienne as a code owner January 1, 2026 19:07

Copilot AI review requested due to automatic review settings January 1, 2026 19:07

Copilot started reviewing on behalf of iMicknl January 1, 2026 19:08 View session

Copilot AI reviewed Jan 1, 2026

View reviewed changes

tetienne reviewed Jan 1, 2026

View reviewed changes

pyoverkiz/models.py Show resolved Hide resolved

Copilot AI mentioned this pull request Jan 1, 2026

Address PR review feedback: Fix timezone handling, improve error handling, and add auth tests #1875

Merged

8 tasks

iMicknl added 2 commits January 3, 2026 19:58

Enhance SSL context handling for local API and improve Rexel auth str…

b462471

…ategy tests

Add mypy ignore

db78f52

iMicknl merged commit dbf0e92 into v2/main Jan 3, 2026
6 checks passed

iMicknl deleted the v2/login_abstraction branch January 3, 2026 20:22

iMicknl mentioned this pull request Jan 3, 2026

2.0 #1872

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor authentication handling in OverkizClient and add new credential classes#1867

Refactor authentication handling in OverkizClient and add new credential classes#1867
iMicknl merged 18 commits intov2/mainfrom
v2/login_abstraction

iMicknl commented Dec 29, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iMicknl commented Jan 1, 2026

Uh oh!

Copilot AI commented Jan 1, 2026

Uh oh!

iMicknl commented Jan 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

iMicknl commented Dec 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking

Features

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iMicknl commented Jan 1, 2026

Uh oh!

Copilot AI commented Jan 1, 2026

Uh oh!

iMicknl commented Jan 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

iMicknl commented Dec 29, 2025 •

edited

Loading