Merge pull request #38 from RafaelJohn9/dev

Dev

Author: RafaelJohn9

.github/workflows/code-quality.yml

@@ -36,7 +36,7 @@ jobs:
         run: uv pip install -e '.[dev]'
 
       - name: Run Ruff
-        run: uv run ruff check mpesa_sdk
+        run: uv run ruff check mpesa_sdk && uv run ruff check tests
 
   mypy:
     runs-on: ubuntu-latest

.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish Python Package
+
+on:
+  push:
+    tags:
+      - "v*"   # publish only on version tags like v0.1.0
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Hatch
+        run: pip install hatch
+
+      - name: Build package
+        run: hatch build
+
+      - name: Publish to PyPI
+        env:
+          HATCH_INDEX_USER: __token__
+          HATCH_INDEX_AUTH: ${{ secrets.PYPI_API_TOKEN }}
+        run: hatch publish

.github/workflows/tests.yml

@@ -0,0 +1,31 @@
+name: Run Unit Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+  workflow_dispatch: # Allows manual triggering of the workflow
+
+jobs:
+  unit-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+            pip install ".[dev,test]"
+            pip install pytest
+            pip install -e .
+
+      - name: Run unit tests
+        run: |
+          pytest tests/unit

mpesa_sdk/B2C/__init__.py

@@ -5,7 +5,6 @@
     B2CResultParameter,
     B2CResultMetadata,
     B2CResultCallback,
-    B2CTimeoutCallbackResponse,
     B2CTimeoutCallback,
     B2CTimeoutCallbackResponse,
 )

mpesa_sdk/C2B/__init__.py

@@ -5,10 +5,12 @@
     C2BValidationResponse,
     C2BConfirmationResponse,
     C2BValidationResultCodeType,
+    C2BResponseType,
 )
 from .C2B import C2B
 
 __all__ = [
+    "C2BResponseType",
     "C2BRegisterUrlRequest",
     "C2BRegisterUrlResponse",
     "C2BValidationRequest",

mpesa_sdk/bill_manager/__init__.py

@@ -14,6 +14,7 @@
     BillManagerPaymentNotificationResponse,
     BillManagerPaymentAcknowledgmentRequest,
     BillManagerPaymentAcknowledgmentResponse,
+    InvoiceItem,
 )
 
 from .bill_manager import BillManager
@@ -35,4 +36,5 @@
     "BillManagerPaymentAcknowledgmentRequest",
     "BillManagerPaymentAcknowledgmentResponse",
     "BillManager",
+    "InvoiceItem",
 ]

mpesa_sdk/bill_manager/schemas.py

@@ -56,6 +56,10 @@ class BillManagerOptInResponse(BaseModel):
         }
     )
 
+    def is_successful(self) -> bool:
+        """Checks if the response indicates success."""
+        return self.rescode == "200"
+
 
 # Update Opt-in Details API
 class BillManagerUpdateOptInRequest(BaseModel):
@@ -98,6 +102,10 @@ class BillManagerUpdateOptInResponse(BaseModel):
         json_schema_extra={"example": {"resmsg": "Success", "rescode": "200"}}
     )
 
+    def is_successful(self) -> bool:
+        """Checks if the response indicates success."""
+        return self.rescode == "200"
+
 
 # Invoice Item
 class InvoiceItem(BaseModel):
@@ -324,6 +332,10 @@ class BillManagerBulkInvoiceResponse(BaseModel):
         }
     )
 
+    def is_successful(self) -> bool:
+        """Checks if the response indicates success."""
+        return self.rescode == "200"
+
 
 # Cancel Single Invoice API
 class BillManagerCancelSingleInvoiceRequest(BaseModel):

mpesa_sdk/dynamic_qr_code/schemas.py

@@ -5,7 +5,6 @@
 """
 
 from enum import Enum
-from typing import Optional
 from pydantic import BaseModel, Field, ConfigDict
 from pydantic import model_validator
 from mpesa_sdk.utils.phone import normalize_phone_number

mpesa_sdk/mpesa_client.py

@@ -0,0 +1,85 @@
+"""MpesaClient: A unified client for M-PESA services."""
+
+from mpesa_sdk.auth import TokenManager
+from mpesa_sdk.http_client import MpesaHttpClient
+from mpesa_sdk.services import (
+    B2BService,
+    B2CService,
+    BalanceService,
+    BillService,
+    C2BService,
+    DynamicQRCodeService,
+    StkPushService,
+    RatibaService,
+    ReversalService,
+    TaxService,
+    TransactionService,
+)
+
+
+class MpesaClient:
+    """Unified client for all M-PESA services."""
+
+    def __init__(self, consumer_key: str, consumer_secret: str) -> None:
+        """Initialize the MpesaClient with all service facades."""
+        self.http_client = MpesaHttpClient()
+        self.token_manager = TokenManager(
+            http_client=self.http_client,
+            consumer_key=consumer_key,
+            consumer_secret=consumer_secret,
+        )
+
+        # express => M-PESA STK Push
+        self.express = StkPushService(
+            http_client=self.http_client, token_manager=self.token_manager
+        )
+
+        # b2c => M-PESA Business to Customer services
+        self.b2c = B2CService(
+            http_client=self.http_client, token_manager=self.token_manager
+        )
+
+        # b2b => M-PESA Business to Business services
+        self.b2b = B2BService(
+            http_client=self.http_client, token_manager=self.token_manager
+        )
+
+        # transaction => M-PESA Transaction status services
+        self.transactions = TransactionService(
+            http_client=self.http_client, token_manager=self.token_manager
+        )
+
+        # tax => M-PESA Tax services
+        self.tax = TaxService(
+            http_client=self.http_client, token_manager=self.token_manager
+        )
+
+        # balance => M-PESA Account balance services
+        self.balance = BalanceService(
+            http_client=self.http_client, token_manager=self.token_manager
+        )
+
+        # reversal => M-PESA Transaction reversal services
+        self.reversal = ReversalService(
+            http_client=self.http_client, token_manager=self.token_manager
+        )
+
+        # bill => M-PESA Bill services
+        self.bill = BillService(
+            http_client=self.http_client, token_manager=self.token_manager
+        )
+
+        # dynamic_qr => M-PESA Dynamic QR services
+        self.dynamic_qr = DynamicQRCodeService(
+            http_client=self.http_client, token_manager=self.token_manager
+        )
+
+        # c2b => M-PESA Customer to Business services
+        self.c2b = C2BService(
+            http_client=self.http_client, token_manager=self.token_manager
+        )
+
+        # ratiba => M-PESA Ratiba services
+        self.ratiba = RatibaService(
+            http_client=self.http_client, token_manager=self.token_manager
+        )

mpesa_sdk/reversal/schemas.py

@@ -3,7 +3,6 @@
 It includes models for reversal requests, responses, and result notifications.
 """
 
-from enum import Enum
 from pydantic import BaseModel, Field, ConfigDict, model_validator
 from typing import Optional, List