miso-client 0.1.0__tar.gz

miso_client-0.1.0/CHANGELOG.md

@@ -0,0 +1,199 @@
+# Changelog
+
+All notable changes to the MisoClient SDK 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).
+
+## [1.1.0] - 2025-10-30
+
+### Added
+
+- **Automatic Client Token Management in HttpClient**: Client tokens are now automatically fetched, cached, and refreshed by the HttpClient
+  - Proactive token refresh when < 60 seconds until expiry (30 second buffer before actual expiration)
+  - Automatic `x-client-token` header injection for all requests
+  - Concurrent token fetch prevention using async locks
+  - Automatic token clearing on 401 responses to force refresh
+  
+- **New Data Models**:
+  - `ClientTokenResponse`: Response model for client token requests with expiration tracking
+  - `PerformanceMetrics`: Performance metrics model for logging (start time, end time, duration, memory usage)
+  - `ClientLoggingOptions`: Advanced logging options with JWT context extraction, correlation IDs, data masking, and performance metrics support
+  
+- **RedisConfig Enhancement**:
+  - Added `db` field to specify Redis database number (default: 0)
+  - Supports multi-database Redis deployments
+
+### Changed
+
+- **Module Structure**: Moved type definitions from `miso_client.types.config` to `miso_client.models.config` for better organization
+  - All imports now use `from miso_client.models.config import ...`
+  - Previous compatibility layer (`types_backup_test`) removed as no longer needed
+
+- **HttpClient Improvements**:
+  - Client token management is now fully automatic - no manual token handling required
+  - Better error handling with automatic token refresh on authentication failures
+  - All HTTP methods (GET, POST, PUT, DELETE) now automatically include client token header
+
+### Technical Improvements
+
+- Improved token expiration handling with proactive refresh mechanism
+- Reduced API calls through intelligent token caching
+- Better concurrency handling with async locks for token operations
+- Enhanced error recovery with automatic token clearing on 401 responses
+
+---
+
+## [1.0.0] - 2025-10-01
+
+### Added
+
+- **Initial Release**: Complete MisoClient SDK implementation
+- **Authentication**: JWT token validation and user management
+- **Authorization**: Role-based access control (RBAC) with Redis caching
+- **Permissions**: Fine-grained permission management with caching
+- **Logging**: Structured logging with Redis queuing and HTTP fallback
+- **Redis Integration**: Optional Redis caching for improved performance
+- **Async Support**: Full async/await support for modern Python applications
+- **Type Safety**: Complete type hints and Pydantic models
+- **Graceful Degradation**: Works with or without Redis
+- **Comprehensive Documentation**: Complete API reference and integration guides
+- **Unit Tests**: Full test coverage mirroring TypeScript implementation
+- **Package Distribution**: Ready for PyPI distribution with setup.py and pyproject.toml
+
+### Features
+
+#### Core Client
+- `MisoClient` main class with initialization and lifecycle management
+- Configuration management with `MisoClientConfig` and `RedisConfig`
+- Connection state tracking and graceful fallback
+
+#### Authentication Service
+- Token validation with controller integration
+- User information retrieval
+- Login URL generation for web applications
+- Logout functionality
+
+#### Role Service
+- Role retrieval with Redis caching (15-minute TTL)
+- Role checking methods: `has_role`, `has_any_role`, `has_all_roles`
+- Role refresh functionality to bypass cache
+- Cache key management with user/environment/application scoping
+
+#### Permission Service
+- Permission retrieval with Redis caching (15-minute TTL)
+- Permission checking methods: `has_permission`, `has_any_permission`, `has_all_permissions`
+- Permission refresh functionality to bypass cache
+- Cache clearing functionality
+- Cache key management with user/environment/application scoping
+
+#### Logger Service
+- Structured logging with multiple levels: `info`, `error`, `audit`, `debug`
+- Redis queue integration for log batching
+- HTTP fallback when Redis is unavailable
+- Context-aware logging with metadata support
+
+#### HTTP Client
+- Async HTTP client wrapper using httpx
+- Automatic header injection (X-Environment, X-Application)
+- Authenticated request support with Bearer token
+- Error handling and status code management
+
+#### Redis Service
+- Async Redis integration using redis.asyncio
+- Graceful degradation when Redis is unavailable
+- Connection state tracking
+- Key prefix support for multi-tenant environments
+
+### Data Models
+
+- `UserInfo`: User information from token validation
+- `AuthResult`: Authentication result structure
+- `LogEntry`: Structured log entry format
+- `RoleResult`: Role query result
+- `PermissionResult`: Permission query result
+- `MisoClientConfig`: Main client configuration
+- `RedisConfig`: Redis connection configuration
+
+### Integration Examples
+
+- **FastAPI**: Complete integration with dependencies and middleware
+- **Django**: Middleware, decorators, and view integration
+- **Flask**: Decorator-based authentication and authorization
+- **Custom Applications**: Dependency injection and service patterns
+
+### Documentation
+
+- **README.md**: Comprehensive SDK documentation with quick start guide
+- **API Reference**: Detailed method signatures and parameter descriptions
+- **Integration Guide**: Framework-specific integration examples
+- **Changelog**: Version history and feature tracking
+
+### Testing
+
+- **Unit Tests**: Comprehensive test coverage for all services
+- **Mock Support**: Mock implementations for testing
+- **Error Handling**: Test coverage for error scenarios and edge cases
+- **Performance Tests**: Concurrent operation testing
+
+### Package Management
+
+- **setup.py**: Traditional Python package configuration
+- **pyproject.toml**: Modern Python packaging (PEP 518)
+- **Dependencies**: httpx, redis[hiredis], pydantic, pydantic-settings, structlog
+- **Development Dependencies**: pytest, black, isort, mypy
+- **Python Support**: Python 3.8+ compatibility
+
+### Security
+
+- **Token Handling**: Secure JWT token processing
+- **Redis Security**: Password and key prefix support
+- **Logging Security**: Careful handling of sensitive information
+- **Error Handling**: Graceful error handling without information leakage
+
+### Performance
+
+- **Caching**: Redis-based caching for roles and permissions
+- **Connection Pooling**: Efficient HTTP and Redis connection management
+- **Async Operations**: Non-blocking async/await throughout
+- **Batch Operations**: Support for concurrent operations
+
+### Compatibility
+
+- **Python Versions**: 3.8, 3.9, 3.10, 3.11, 3.12
+- **Framework Support**: FastAPI, Django, Flask, and custom applications
+- **Redis Versions**: Compatible with Redis 5.0+
+- **HTTP Clients**: Uses httpx for modern async HTTP support
+
+### Migration
+
+- **From Keycloak**: Seamless migration from direct Keycloak integration
+- **Backward Compatibility**: Maintains existing API patterns
+- **Configuration**: Simple configuration migration
+- **Testing**: Comprehensive migration testing support
+
+---
+
+## Future Releases
+
+### Planned Features
+
+- **WebSocket Support**: Real-time authentication updates
+- **Metrics Integration**: Prometheus and OpenTelemetry support
+- **Advanced Caching**: Cache invalidation strategies
+- **Multi-Controller Support**: Load balancing across multiple controllers
+- **SDK Extensions**: Framework-specific SDK extensions
+
+### Roadmap
+
+- **v1.1.0**: WebSocket support and real-time updates
+- **v1.2.0**: Advanced metrics and monitoring
+- **v2.0.0**: Multi-controller support and load balancing
+- **v2.1.0**: Framework-specific SDK extensions
+
+---
+
+For more information about the MisoClient SDK, visit:
+- [Documentation](https://docs.aifabrix.ai/miso-client-python)
+- [GitHub Repository](https://github.com/aifabrix/miso-client-python)
+- [Issue Tracker](https://github.com/aifabrix/miso-client-python/issues)

miso_client-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 eSystems Nordic Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

miso_client-0.1.0/MANIFEST.in

@@ -0,0 +1,12 @@
+include README.md
+include LICENSE
+include CHANGELOG.md
+include requirements.txt
+include requirements-test.txt
+include pytest.ini
+# recursive-include docs *.md  # docs directory is empty
+recursive-include miso_client *.py
+include miso_client/py.typed
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+