trovesuite 1.0.4__py3-none-any.whl → 1.0.5__py3-none-any.whl

trovesuite/__init__.py

@@ -1,16 +1,18 @@
 """
-TroveSuite Auth Package
+TroveSuite Package
 
-A comprehensive authentication and authorization service for ERP systems.
-Provides JWT token validation, user authorization, and permission checking.
+A comprehensive authentication, authorization, and notification service for ERP systems.
+Provides JWT token validation, user authorization, permission checking, and notification capabilities.
 """
 
 from .auth import AuthService
+from .notification import NotificationService
 
 __version__ = "1.0.8"
 __author__ = "Bright Debrah Owusu"
 __email__ = "owusu.debrah@deladetech.com"
 
 __all__ = [
-    "AuthService"
+    "AuthService",
+    "NotificationService"
 ]

trovesuite/auth/__init__.py

@@ -5,13 +5,10 @@ Authentication and authorization services for ERP systems.
 """
 
 from .auth_service import AuthService
-from .auth_base import AuthBase
-from .auth_read_dto import AuthServiceReadDto, AuthControllerReadDto
+from .auth_write_dto import AuthServiceWriteDto
 
 __all__ = [
     "AuthService",
-    "AuthBase", 
-    "AuthServiceReadDto",
-    "AuthControllerReadDto"
+    "AuthServiceWriteDto"
 ]
 

trovesuite/notification/__init__.py

@@ -0,0 +1,14 @@
+"""
+TroveSuite Notification Service
+
+Provides email and SMS notification capabilities for TroveSuite applications.
+"""
+
+from .notification_service import NotificationService
+from .notification_write_dto import NotificationEmailServiceWriteDto, NotificationSMSServiceWriteDto
+
+__all__ = [
+    "NotificationService",
+    "NotificationEmailServiceWriteDto",
+    "NotificationSMSServiceWriteDto"
+]

trovesuite/notification/notification_base.py

@@ -0,0 +1,13 @@
+from typing import List, Optional, Union
+from pydantic import BaseModel
+
+class NotificationEmailBase(BaseModel):
+    sender_email: str
+    receiver_email: Union[str, List[str]]
+    password: str
+    subject: str
+    text_message: str
+    html_message: Optional[str] = None
+
+class NotificationSMSBase(BaseModel):
+    pass

trovesuite/notification/notification_controller.py

@@ -0,0 +1,21 @@
+from src.trovesuite.notification.notification_write_dto import (
+    NotificationEmailControllerWriteDto,
+    NotificationSMSControllerWriteDto
+)
+from src.trovesuite.notification.notification_read_dto import (
+    NotificationEmailControllerReadDto,
+    NotificationSMSControllerReadDto
+)
+from src.trovesuite.notification.notification_service import NotificationService
+from src.trovesuite.entities.sh_response import Respons
+from fastapi import APIRouter
+
+notification_router = APIRouter()
+
+@notification_router.post("/send_email", response_model=Respons[NotificationEmailControllerReadDto])
+async def send_email(data: NotificationEmailControllerWriteDto):
+    return NotificationService.send_email(data=data)
+
+@notification_router.post("/send_sms", response_model=Respons[NotificationSMSControllerReadDto])
+async def send_sms(data: NotificationSMSControllerWriteDto):
+    return NotificationService.send_sms(data=data)

trovesuite/notification/notification_read_dto.py

@@ -0,0 +1,21 @@
+from src.trovesuite.notification.notification_base import (
+    NotificationEmailBase,
+    NotificationSMSBase
+)
+from pydantic import BaseModel
+
+# EMAIL Notification
+
+class NotificationEmailControllerReadDto(NotificationEmailBase):
+    pass
+
+class NotificationEmailServiceReadDto(BaseModel):
+    pass
+
+# SMS Notification
+
+class NotificationSMSControllerReadDto(NotificationSMSBase):
+    pass
+
+class NotificationSMSServiceReadDto(BaseModel):
+    pass

trovesuite/notification/notification_service.py

@@ -0,0 +1,73 @@
+import smtplib
+from email.mime.text import MIMEText
+from email.mime.multipart import MIMEMultipart
+from src.trovesuite.entities.sh_response import Respons
+from src.trovesuite.notification.notification_read_dto import (
+    NotificationEmailServiceReadDto,
+    NotificationSMSServiceReadDto
+)
+from src.trovesuite.notification.notification_write_dto import (
+    NotificationEmailServiceWriteDto,
+    NotificationSMSServiceWriteDto
+)
+
+class NotificationService:
+
+    @staticmethod
+    def send_email(data: NotificationEmailServiceWriteDto) -> Respons[NotificationEmailServiceReadDto]:
+        """
+        Send an email (single or multiple recipients) via Gmail SMTP.
+        Supports both plain text and HTML email bodies.
+        """
+
+        # Extract input data
+        receiver_email = data.receiver_email
+        text_message = data.text_message
+        html_message = getattr(data, "html_message", None)
+        sender_email = data.sender_email
+        password = data.password
+        subject = data.subject
+
+        # Allow single email or list
+        if isinstance(receiver_email, str):
+            receiver_email = [receiver_email]
+
+        # Create the email container
+        message = MIMEMultipart("alternative")
+        message["From"] = sender_email
+        message["To"] = ", ".join(receiver_email)
+        message["Subject"] = subject
+
+        # Attach plain text
+        message.attach(MIMEText(text_message, "plain"))
+
+        # Attach HTML if provided
+        if html_message:
+            message.attach(MIMEText(html_message, "html"))
+
+        try:
+            with smtplib.SMTP_SSL("smtp.gmail.com", 465) as server:
+                server.login(sender_email, password)
+                server.sendmail(sender_email, receiver_email, message.as_string())
+
+            return Respons[NotificationEmailServiceReadDto](
+                detail=f"Email successfully sent to {len(receiver_email)} recipient(s)",
+                error=None,
+                data=[],
+                status_code=200,
+                success=True,
+            )
+
+        except Exception as e:
+            print(e)
+            return Respons[NotificationEmailServiceReadDto](
+                detail="An error occurred while sending the email",
+                error=str(e),
+                data=[],
+                status_code=500,
+                success=False,
+            )
+
+    @staticmethod
+    def send_sms(data: NotificationSMSServiceWriteDto) -> Respons[NotificationSMSServiceReadDto]:
+        pass

trovesuite/notification/notification_write_dto.py

@@ -0,0 +1,21 @@
+from pydantic import BaseModel
+from src.trovesuite.notification.notification_base import (
+    NotificationEmailBase,
+    NotificationSMSBase
+)
+
+# Email Notification
+
+class NotificationEmailControllerWriteDto(NotificationEmailBase):
+    pass
+
+class NotificationEmailServiceWriteDto(NotificationEmailControllerWriteDto):
+    pass
+
+# SMS Notification
+
+class NotificationSMSControllerWriteDto(NotificationSMSBase):
+    pass
+
+class NotificationSMSServiceWriteDto(BaseModel):
+    pass

{trovesuite-1.0.4.dist-info → trovesuite-1.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: trovesuite
-Version: 1.0.4
+Version: 1.0.5
 Summary: TroveSuite services package providing authentication, authorization, notifications, and other enterprise services for TroveSuite applications
 Home-page: https://dev.azure.com/brightgclt/trovesuite/_git/packages
 Author: Bright Debrah Owusu
@@ -119,10 +119,26 @@ poetry install --with dev
 
 ## Quick Start
 
+### Import Patterns
+
+The package provides clean, simplified import patterns:
+
+```python
+# Import services and DTOs from main package
+from trovesuite import AuthService, NotificationService
+from trovesuite.auth import AuthServiceWriteDto
+from trovesuite.notification import NotificationEmailServiceWriteDto, NotificationSMSServiceWriteDto
+
+# Or import everything you need in one line
+from trovesuite import AuthService, NotificationService
+from trovesuite.auth import AuthServiceWriteDto
+from trovesuite.notification import NotificationEmailServiceWriteDto
+```
+
 ### Basic Usage
 
 ```python
-from trovesuite import AuthService
+from trovesuite import AuthService, NotificationService
 from trovesuite.configs.settings import db_settings
 
 # Configure your database settings
@@ -137,7 +153,7 @@ db_settings.SECRET_KEY = "your-secret-key"
 auth_service = AuthService()
 
 # Authorize a user
-from trovesuite.auth.auth_write_dto import AuthServiceWriteDto
+from trovesuite.auth import AuthServiceWriteDto
 auth_data = AuthServiceWriteDto(user_id="user123", tenant="tenant456")
 result = AuthService.authorize(auth_data)
 
@@ -149,6 +165,30 @@ else:
     print(f"Authorization failed: {result.detail}")
 ```
 
+### Notification Service Usage
+
+```python
+from trovesuite import NotificationService
+from trovesuite.notification import NotificationEmailServiceWriteDto
+
+# Send an email notification
+email_data = NotificationEmailServiceWriteDto(
+    sender_email="your-email@gmail.com",
+    receiver_email=["recipient1@example.com", "recipient2@example.com"],
+    password="your-app-password",  # Gmail app password
+    subject="Test Notification",
+    text_message="This is a plain text message",
+    html_message="<h1>This is an HTML message</h1><p>With rich formatting!</p>"
+)
+
+result = NotificationService.send_email(email_data)
+
+if result.success:
+    print(f"Email sent successfully: {result.detail}")
+else:
+    print(f"Email failed: {result.error}")
+```
+
 ### JWT Token Decoding
 
 ```python
@@ -166,7 +206,7 @@ async def protected_route(token: str = Depends(oauth2_scheme)):
     tenant_id = user_data["tenant_id"]
     
     # Authorize user
-    from trovesuite.auth.auth_write_dto import AuthServiceWriteDto
+    from trovesuite.auth import AuthServiceWriteDto
     auth_data = AuthServiceWriteDto(user_id=user_id, tenant=tenant_id)
     auth_result = AuthService.authorize(auth_data)
     return auth_result
@@ -395,8 +435,84 @@ Check if user has all of the required permissions.
 **Returns:**
 - `bool`: True if user has all of the required permissions
 
+### NotificationService
+
+#### `send_email(data: NotificationEmailServiceWriteDto) -> Respons[NotificationEmailServiceReadDto]`
+
+Sends an email notification via Gmail SMTP. Supports both plain text and HTML email bodies.
+
+**Parameters:**
+- `data`: Email notification data including sender, recipients, subject, and message content
+
+**Returns:**
+- `Respons[NotificationEmailServiceReadDto]`: Email sending result with success status and details
+
+**Example:**
+```python
+from trovesuite import NotificationService
+from trovesuite.notification import NotificationEmailServiceWriteDto
+
+email_data = NotificationEmailServiceWriteDto(
+    sender_email="sender@gmail.com",
+    receiver_email=["user1@example.com", "user2@example.com"],
+    password="your-gmail-app-password",
+    subject="Welcome to TroveSuite",
+    text_message="Welcome! This is a plain text message.",
+    html_message="<h1>Welcome!</h1><p>This is an <strong>HTML</strong> message.</p>"
+)
+
+result = NotificationService.send_email(email_data)
+if result.success:
+    print("Email sent successfully!")
+else:
+    print(f"Failed to send email: {result.error}")
+```
+
+#### `send_sms(data: NotificationSMSServiceWriteDto) -> Respons[NotificationSMSServiceReadDto]`
+
+Sends an SMS notification (currently not implemented).
+
+**Parameters:**
+- `data`: SMS notification data
+
+**Returns:**
+- `Respons[NotificationSMSServiceReadDto]`: SMS sending result
+
 ### Data Models
 
+#### `NotificationEmailServiceWriteDto`
+
+```python
+class NotificationEmailServiceWriteDto(BaseModel):
+    sender_email: str
+    receiver_email: Union[str, List[str]]  # Single email or list of emails
+    password: str  # Gmail app password
+    subject: str
+    text_message: str
+    html_message: Optional[str] = None  # Optional HTML content
+```
+
+#### `NotificationEmailServiceReadDto`
+
+```python
+class NotificationEmailServiceReadDto(BaseModel):
+    pass  # Empty response model for email service
+```
+
+#### `NotificationSMSServiceWriteDto`
+
+```python
+class NotificationSMSServiceWriteDto(BaseModel):
+    pass  # To be implemented for SMS functionality
+```
+
+#### `NotificationSMSServiceReadDto`
+
+```python
+class NotificationSMSServiceReadDto(BaseModel):
+    pass  # To be implemented for SMS functionality
+```
+
 #### `AuthServiceReadDto`
 
 ```python
@@ -565,7 +681,7 @@ For support, email brightgclt@gmail.com or create a work item in the [Azure DevO
 
 ### 1.0.8
 - Restructured package for direct service imports
-- Added notification services
+- Added comprehensive notification services with email support
 - Excluded controllers from package build
 - Updated import paths for better usability
 - JWT token validation
@@ -574,3 +690,6 @@ For support, email brightgclt@gmail.com or create a work item in the [Azure DevO
 - PostgreSQL database integration
 - Comprehensive logging
 - Azure integration support
+- Email notification service with Gmail SMTP support
+- Support for both plain text and HTML email content
+- Multiple recipient support for email notifications

{trovesuite-1.0.4.dist-info → trovesuite-1.0.5.dist-info}/RECORD

@@ -1,5 +1,5 @@
-trovesuite/__init__.py,sha256=a9jSrjmrhOey6yE2I83TO_rVJDogIwGDyL3HJBGiGqM,347
-trovesuite/auth/__init__.py,sha256=d8d5POjq9lGe7GVbc7Qm6hUpx1bgLqEVQFG1iYafdxI,337
+trovesuite/__init__.py,sha256=c7z8TrIWz156VyDw2qEclTdJxKqAdbhQyCjDLY4s0uM,457
+trovesuite/auth/__init__.py,sha256=OjZllVvjul1glDazJ-d5TrNjgHFigFlQQi1G99DYshk,239
 trovesuite/auth/auth_base.py,sha256=rZHQVLeJRBQ8GClgF5UwG-er4_HXVX5-nt8o6_Z29uY,75
 trovesuite/auth/auth_controller.py,sha256=mMAyTV_0rFeArpcIDu9Pr_IATvFZU6wfIo6ViQoUv0U,477
 trovesuite/auth/auth_read_dto.py,sha256=pQT1ouRVZMAiJn4wAG7NQOKQKTquTMWUe-dYcpLTmEo,533
@@ -12,10 +12,16 @@ trovesuite/configs/settings.py,sha256=yUbkiFi4QdO9JZG1RRFbP4tYurT47HmN-ohgYcs2SH
 trovesuite/entities/__init__.py,sha256=Dbl_03Bueyh2vOP2hykd40MmNMrl5nNHSRGP-kqwwNo,160
 trovesuite/entities/health.py,sha256=H8-XUywzvMfZy2dZwDyJGAUbmuULuZYvYIUWhiaVGdY,2729
 trovesuite/entities/sh_response.py,sha256=1_sw3PpVaDxWsNiBU0W9YLHZgTFxEj4JJBLBfSY63Ho,1579
+trovesuite/notification/__init__.py,sha256=mjglzmlk29SREP6LfvBYGmCSc-K1SKKAEx_OJdJ2Vrs,394
+trovesuite/notification/notification_base.py,sha256=6Xo0Gnnpg3RgN1_SRkAcH-K4l7DwNDZvn1gRm3oMWyk,320
+trovesuite/notification/notification_controller.py,sha256=w-SpRTjeInrgsUX0sAzFVjXiBo395ge6v-dn1Cc8ogU,920
+trovesuite/notification/notification_read_dto.py,sha256=pZg3KHZJA4c5MoXqTHCgUiGnd8mRrQjVOaCtWXtuT7U,450
+trovesuite/notification/notification_service.py,sha256=u3-rHnTr3dgLX_RGjkG6c9mYVPspRCSEDBtDrGN-Rj0,2500
+trovesuite/notification/notification_write_dto.py,sha256=WrdFWIa9sK5rrwgp1bUOOikwE7xL8O9z110EGnXedzw,479
 trovesuite/utils/__init__.py,sha256=3UPKTz9cluTgAM-ldNsJxsnoPTZiqacXlAmzUEHy6q8,143
 trovesuite/utils/helper.py,sha256=lvZ1mvaqY84dkIPB5Ov0uwYDOWBziAS8twobEJZh2Ik,1002
-trovesuite-1.0.4.dist-info/licenses/LICENSE,sha256=EJT35ct-Q794JYPdAQy3XNczQGKkU1HzToLeK1YVw2s,1070
-trovesuite-1.0.4.dist-info/METADATA,sha256=-HtCWfAoPzJCmZdj_YCKzy8DG17EKe4mCBZDleqG7aQ,16000
-trovesuite-1.0.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-trovesuite-1.0.4.dist-info/top_level.txt,sha256=GzKhG_-MTaxeHrIgkGkBH_nof2vroGFBrjeHKWUIwNc,11
-trovesuite-1.0.4.dist-info/RECORD,,
+trovesuite-1.0.5.dist-info/licenses/LICENSE,sha256=EJT35ct-Q794JYPdAQy3XNczQGKkU1HzToLeK1YVw2s,1070
+trovesuite-1.0.5.dist-info/METADATA,sha256=JD98gu0c53MANB7pMF73Eg6axkfk_RW3HpmSU5KFVOA,19704
+trovesuite-1.0.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+trovesuite-1.0.5.dist-info/top_level.txt,sha256=GzKhG_-MTaxeHrIgkGkBH_nof2vroGFBrjeHKWUIwNc,11
+trovesuite-1.0.5.dist-info/RECORD,,