raqm-core 0.2.5__tar.gz → 0.3.0__tar.gz

{raqm_core-0.2.5 → raqm_core-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: raqm-core
-Version: 0.2.5
+Version: 0.3.0
 Summary: Unified Python SDK for Pakistani payment gateways (EasyPaisa, JazzCash, HBL, ABL, UBL, etc.)
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -19,7 +19,7 @@ Requires-Dist: pydantic>=2.0
 
 One async, type-safe interface across multiple processors — EasyPaisa, JazzCash, HBL, ABL, UBL, and more.
 
-> ⚠️ **Work in progress.** Currently only EasyPaisa is fully implemented. JazzCash is in progress. Contributions welcome!
+> ⚠️ **Work in progress.** EasyPaisa and JazzCash (MWALLET) are implemented. Contributions welcome!
 >
 > ⚠️ **Breaking change in v0.2.4** — methods now **raise `PaymentError`** on business-level failures instead of returning a result with a non-success response code. Wrap calls in try/except to handle errors gracefully.
 
@@ -30,7 +30,7 @@ One async, type-safe interface across multiple processors — EasyPaisa, JazzCas
 | Gateway | Status |
 |---------|--------|
 | [EasyPaisa](https://easypaisa.com.pk) | ✅ Live |
-| [JazzCash](https://jazzcash.com.pk) | 🚧 In progress |
+| [JazzCash](https://jazzcash.com.pk) | ✅ Live (MWALLET) |
 | HBL | 📅 Planned |
 | ABL | 📅 Planned |
 | UBL | 📅 Planned |
@@ -231,6 +231,7 @@ src/
     └── jazzcash.py            # JazzCash Pydantic models
 
 tests/
+├── conftest.py               # Shared fixtures & mock helpers
 ├── test_easypaisa.py         # EasyPaisa integration tests
 ├── test_jazzcash.py          # JazzCash integration tests
 └── headers/
@@ -303,24 +304,53 @@ class HBL:
 
 ### 5. Write integration tests
 
-`tests/test_<gateway>.py` — use `httpx.MockTransport` to mock responses.
+`tests/test_<gateway>.py` — use `httpx.MockTransport` to mock responses. Add shared helpers to `tests/conftest.py`.
 
-```python
-# tests/test_hbl.py
-import httpx
-import pytest
-from raqm_core import HBL
+**conftest.py** — add a success body constant and a factory:
 
+```python
+# tests/conftest.py
+from raqm_core.hbl import HBL
+
+HBL_SUCCESS_BODY = {
+    "orderId": "abc123",
+    "responseCode": "0000",
+    "responseDesc": "SUCCESS",
+}
+
+def make_hbl(response_body: dict) -> HBL:
+    return HBL(
+        api_key="test",
+        sandbox=True,
+        client=make_client(response_body),
+    )
+```
 
-@pytest.mark.asyncio
-async def test_pay_success():
-    def handler(request: httpx.Request) -> httpx.Response:
-        return httpx.Response(status_code=200, json={...})
+**test file** — import from `conftest`:
 
-    client = httpx.AsyncClient(transport=httpx.MockTransport(handler))
-    hbl = HBL(api_key="test", sandbox=True, client=client)
-    result = await hbl.pay(...)
-    assert result.responseCode == "0000"
+```python
+# tests/test_hbl.py
+import pytest
+from raqm_core.exceptions.exceptions import PaymentError
+from tests.conftest import HBL_SUCCESS_BODY, make_client, make_hbl
+
+
+class TestPay:
+    @pytest.mark.asyncio
+    async def test_success(self):
+        hbl = make_hbl(HBL_SUCCESS_BODY)
+        result = await hbl.pay(...)
+        assert result.responseCode == "0000"
+
+    @pytest.mark.asyncio
+    async def test_network_error(self):
+        hbl = HBL(
+            api_key="test",
+            sandbox=True,
+            client=make_client({"error": "timeout"}, status_code=500),
+        )
+        with pytest.raises(NetworkError):
+            await hbl.pay(...)
 ```
 
 ### 6. Update this README
@@ -332,7 +362,7 @@ Add the new gateway to the **Supported Gateways** table with the appropriate sta
 ## Roadmap
 
 - [x] EasyPaisa (MA, OTC, inquiry)
-- [ ] JazzCash client + schemas
+- [x] JazzCash client + schemas (MWALLET)
 - [ ] HBL payment gateway
 - [ ] ABL payment gateway
 - [ ] UBL payment gateway

{raqm_core-0.2.5 → raqm_core-0.3.0}/README.md

@@ -4,7 +4,7 @@
 
 One async, type-safe interface across multiple processors — EasyPaisa, JazzCash, HBL, ABL, UBL, and more.
 
-> ⚠️ **Work in progress.** Currently only EasyPaisa is fully implemented. JazzCash is in progress. Contributions welcome!
+> ⚠️ **Work in progress.** EasyPaisa and JazzCash (MWALLET) are implemented. Contributions welcome!
 >
 > ⚠️ **Breaking change in v0.2.4** — methods now **raise `PaymentError`** on business-level failures instead of returning a result with a non-success response code. Wrap calls in try/except to handle errors gracefully.
 
@@ -15,7 +15,7 @@ One async, type-safe interface across multiple processors — EasyPaisa, JazzCas
 | Gateway | Status |
 |---------|--------|
 | [EasyPaisa](https://easypaisa.com.pk) | ✅ Live |
-| [JazzCash](https://jazzcash.com.pk) | 🚧 In progress |
+| [JazzCash](https://jazzcash.com.pk) | ✅ Live (MWALLET) |
 | HBL | 📅 Planned |
 | ABL | 📅 Planned |
 | UBL | 📅 Planned |
@@ -216,6 +216,7 @@ src/
     └── jazzcash.py            # JazzCash Pydantic models
 
 tests/
+├── conftest.py               # Shared fixtures & mock helpers
 ├── test_easypaisa.py         # EasyPaisa integration tests
 ├── test_jazzcash.py          # JazzCash integration tests
 └── headers/
@@ -288,24 +289,53 @@ class HBL:
 
 ### 5. Write integration tests
 
-`tests/test_<gateway>.py` — use `httpx.MockTransport` to mock responses.
+`tests/test_<gateway>.py` — use `httpx.MockTransport` to mock responses. Add shared helpers to `tests/conftest.py`.
 
-```python
-# tests/test_hbl.py
-import httpx
-import pytest
-from raqm_core import HBL
+**conftest.py** — add a success body constant and a factory:
 
+```python
+# tests/conftest.py
+from raqm_core.hbl import HBL
+
+HBL_SUCCESS_BODY = {
+    "orderId": "abc123",
+    "responseCode": "0000",
+    "responseDesc": "SUCCESS",
+}
+
+def make_hbl(response_body: dict) -> HBL:
+    return HBL(
+        api_key="test",
+        sandbox=True,
+        client=make_client(response_body),
+    )
+```
 
-@pytest.mark.asyncio
-async def test_pay_success():
-    def handler(request: httpx.Request) -> httpx.Response:
-        return httpx.Response(status_code=200, json={...})
+**test file** — import from `conftest`:
 
-    client = httpx.AsyncClient(transport=httpx.MockTransport(handler))
-    hbl = HBL(api_key="test", sandbox=True, client=client)
-    result = await hbl.pay(...)
-    assert result.responseCode == "0000"
+```python
+# tests/test_hbl.py
+import pytest
+from raqm_core.exceptions.exceptions import PaymentError
+from tests.conftest import HBL_SUCCESS_BODY, make_client, make_hbl
+
+
+class TestPay:
+    @pytest.mark.asyncio
+    async def test_success(self):
+        hbl = make_hbl(HBL_SUCCESS_BODY)
+        result = await hbl.pay(...)
+        assert result.responseCode == "0000"
+
+    @pytest.mark.asyncio
+    async def test_network_error(self):
+        hbl = HBL(
+            api_key="test",
+            sandbox=True,
+            client=make_client({"error": "timeout"}, status_code=500),
+        )
+        with pytest.raises(NetworkError):
+            await hbl.pay(...)
 ```
 
 ### 6. Update this README
@@ -317,7 +347,7 @@ Add the new gateway to the **Supported Gateways** table with the appropriate sta
 ## Roadmap
 
 - [x] EasyPaisa (MA, OTC, inquiry)
-- [ ] JazzCash client + schemas
+- [x] JazzCash client + schemas (MWALLET)
 - [ ] HBL payment gateway
 - [ ] ABL payment gateway
 - [ ] UBL payment gateway

{raqm_core-0.2.5 → raqm_core-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "raqm-core"
-version = "0.2.5"
+version = "0.3.0"
 description = "Unified Python SDK for Pakistani payment gateways (EasyPaisa, JazzCash, HBL, ABL, UBL, etc.)"
 readme = "README.md"
 requires-python = ">=3.9"

{raqm_core-0.2.5 → raqm_core-0.3.0}/src/raqm_core/headers/jazzcash.py

@@ -1,11 +1,8 @@
+import hmac
 from hashlib import sha256
 
 
 def generate_secure_hash(hash_key: str, params: dict) -> str:
-
     values = "&".join(param[1] for param in sorted(params.items()) if param[1])
     my_str = hash_key + ("&" + values if values else "")
-
-    my_bytes = str.encode(my_str)
-    my_sha256 = sha256(my_bytes)
-    return my_sha256.hexdigest()
+    return hmac.new(hash_key.encode(), my_str.encode(), sha256).hexdigest()

{raqm_core-0.2.5 → raqm_core-0.3.0}/src/raqm_core/jazzcash.py

@@ -45,6 +45,7 @@ class JazzCash:
 
     async def pay_via_mwallet(
         self,
+        cnic: str,
         mobile_number: str,
         amount: str,
         description: str,
@@ -71,13 +72,16 @@ class JazzCash:
             pp_Description=description,
             pp_TxnExpiryDateTime=pp_TxnExpiryDateTime,
             pp_MobileNumber=mobile_number,
+            pp_CNIC=cnic,
         )  # type: ignore
 
         payload = request.model_dump()
         secure_hash = generate_secure_hash(hash_key=self.hash_key, params=payload)
 
         payload["pp_SecureHash"] = secure_hash
-        data = await self._post(endpoint="DoMWalletTransaction", payload=payload)
+        data = await self._post(
+            endpoint="Purchase/DoMWalletTransaction", payload=payload
+        )
 
         result = JazzcashResponse(**data)
 

{raqm_core-0.2.5 → raqm_core-0.3.0}/src/raqm_core/schemas/jazzcash.py

@@ -16,9 +16,6 @@ class JazzCashResponseCode(str, Enum):
     INSUFFICIENT_BALANCE = "405"
 
 
-# ── REQUEST MODELS ────────────────────────────────────────────────────────────
-
-
 class JazzcashRequest(BaseModel):
     pp_Version: str = Field("1.1", description="Payment Portal Version.")
     pp_Language: str = Field("EN", description="Display language. Fixed value 'EN'.")
@@ -29,10 +26,6 @@ class JazzcashRequest(BaseModel):
         "", description="Sub merchant ID, leave empty if unused."
     )
     pp_Password: str = Field(..., description="Password assigned by JazzCash.")
-    pp_BankID: str = Field("", description="Bank identifier, leave empty if unused.")
-    pp_ProductID: str = Field(
-        "", description="Product identifier, leave empty if unused."
-    )
     pp_TxnRefNo: str = Field(..., description="Unique transaction reference number.")
     pp_Amount: str = Field(..., description="Transaction amount, no decimal places.")
     pp_TxnCurrency: str = Field(
@@ -56,15 +49,17 @@ class JazzcashRequest(BaseModel):
 class JazzcashMWalletRequest(JazzcashRequest):
     pp_TxnType: str = Field("MWALLET", description="Transaction type.")
     pp_MobileNumber: str = Field(..., description="Customer's JazzCash mobile number.")
-
-
-# ── RESPONSE MODELS ───────────────────────────────────────────────────────────
+    pp_CNIC: str = Field(
+        ..., min_length=6, max_length=6, description="Last 6 digits of customer's CNIC."
+    )
+    pp_DiscountedAmount: str = Field(
+        "", description="Discounted amount, leave empty if unused."
+    )
 
 
 class JazzcashResponse(BaseModel):
     pp_Amount: str = Field(..., description="Transaction amount.")
     pp_AuthCode: Optional[str] = None
-    pp_BankID: Optional[str] = None
     pp_BillReference: Optional[str] = None
     pp_Language: Optional[str] = None
     pp_MerchantID: str = Field(..., description="Merchant ID.")
@@ -72,19 +67,17 @@ class JazzcashResponse(BaseModel):
         ..., description="Response code."
     )
     pp_ResponseMessage: str = Field(..., description="Response message.")
-    pp_RetreivalReferenceNo: Optional[str] = None
-    pp_SubMerchantId: Optional[str] = None
+    pp_RetrievalReferenceNo: Optional[str] = None  # fixed JazzCash typo from v1
+    pp_RetreivalReferenceNo: Optional[str] = None  # kept for v1 backwards compat
+    pp_SubMerchantID: Optional[str] = None
     pp_TxnCurrency: Optional[str] = None
     pp_TxnDateTime: Optional[str] = None
     pp_TxnRefNo: str = Field(..., description="Transaction reference number.")
-    pp_SettlementExpiry: Optional[str] = None
     pp_TxnType: Optional[str] = None
     pp_Version: Optional[str] = None
-    ppmbf_1: Optional[str] = None
-    ppmbf_2: Optional[str] = None
-    ppmbf_3: Optional[str] = None
-    ppmbf_4: Optional[str] = None
-    ppmbf_5: Optional[str] = None
+    pp_MobileNumber: Optional[str] = None
+    pp_CNIC: Optional[str] = None
+    pp_DiscountedAmount: Optional[str] = None
     ppmpf_1: Optional[str] = None
     ppmpf_2: Optional[str] = None
     ppmpf_3: Optional[str] = None

{raqm_core-0.2.5 → raqm_core-0.3.0}/src/raqm_core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: raqm-core
-Version: 0.2.5
+Version: 0.3.0
 Summary: Unified Python SDK for Pakistani payment gateways (EasyPaisa, JazzCash, HBL, ABL, UBL, etc.)
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -19,7 +19,7 @@ Requires-Dist: pydantic>=2.0
 
 One async, type-safe interface across multiple processors — EasyPaisa, JazzCash, HBL, ABL, UBL, and more.
 
-> ⚠️ **Work in progress.** Currently only EasyPaisa is fully implemented. JazzCash is in progress. Contributions welcome!
+> ⚠️ **Work in progress.** EasyPaisa and JazzCash (MWALLET) are implemented. Contributions welcome!
 >
 > ⚠️ **Breaking change in v0.2.4** — methods now **raise `PaymentError`** on business-level failures instead of returning a result with a non-success response code. Wrap calls in try/except to handle errors gracefully.
 
@@ -30,7 +30,7 @@ One async, type-safe interface across multiple processors — EasyPaisa, JazzCas
 | Gateway | Status |
 |---------|--------|
 | [EasyPaisa](https://easypaisa.com.pk) | ✅ Live |
-| [JazzCash](https://jazzcash.com.pk) | 🚧 In progress |
+| [JazzCash](https://jazzcash.com.pk) | ✅ Live (MWALLET) |
 | HBL | 📅 Planned |
 | ABL | 📅 Planned |
 | UBL | 📅 Planned |
@@ -231,6 +231,7 @@ src/
     └── jazzcash.py            # JazzCash Pydantic models
 
 tests/
+├── conftest.py               # Shared fixtures & mock helpers
 ├── test_easypaisa.py         # EasyPaisa integration tests
 ├── test_jazzcash.py          # JazzCash integration tests
 └── headers/
@@ -303,24 +304,53 @@ class HBL:
 
 ### 5. Write integration tests
 
-`tests/test_<gateway>.py` — use `httpx.MockTransport` to mock responses.
+`tests/test_<gateway>.py` — use `httpx.MockTransport` to mock responses. Add shared helpers to `tests/conftest.py`.
 
-```python
-# tests/test_hbl.py
-import httpx
-import pytest
-from raqm_core import HBL
+**conftest.py** — add a success body constant and a factory:
 
+```python
+# tests/conftest.py
+from raqm_core.hbl import HBL
+
+HBL_SUCCESS_BODY = {
+    "orderId": "abc123",
+    "responseCode": "0000",
+    "responseDesc": "SUCCESS",
+}
+
+def make_hbl(response_body: dict) -> HBL:
+    return HBL(
+        api_key="test",
+        sandbox=True,
+        client=make_client(response_body),
+    )
+```
 
-@pytest.mark.asyncio
-async def test_pay_success():
-    def handler(request: httpx.Request) -> httpx.Response:
-        return httpx.Response(status_code=200, json={...})
+**test file** — import from `conftest`:
 
-    client = httpx.AsyncClient(transport=httpx.MockTransport(handler))
-    hbl = HBL(api_key="test", sandbox=True, client=client)
-    result = await hbl.pay(...)
-    assert result.responseCode == "0000"
+```python
+# tests/test_hbl.py
+import pytest
+from raqm_core.exceptions.exceptions import PaymentError
+from tests.conftest import HBL_SUCCESS_BODY, make_client, make_hbl
+
+
+class TestPay:
+    @pytest.mark.asyncio
+    async def test_success(self):
+        hbl = make_hbl(HBL_SUCCESS_BODY)
+        result = await hbl.pay(...)
+        assert result.responseCode == "0000"
+
+    @pytest.mark.asyncio
+    async def test_network_error(self):
+        hbl = HBL(
+            api_key="test",
+            sandbox=True,
+            client=make_client({"error": "timeout"}, status_code=500),
+        )
+        with pytest.raises(NetworkError):
+            await hbl.pay(...)
 ```
 
 ### 6. Update this README
@@ -332,7 +362,7 @@ Add the new gateway to the **Supported Gateways** table with the appropriate sta
 ## Roadmap
 
 - [x] EasyPaisa (MA, OTC, inquiry)
-- [ ] JazzCash client + schemas
+- [x] JazzCash client + schemas (MWALLET)
 - [ ] HBL payment gateway
 - [ ] ABL payment gateway
 - [ ] UBL payment gateway

{raqm_core-0.2.5 → raqm_core-0.3.0}/tests/test_easypaisa.py

@@ -1,61 +1,14 @@
-import httpx
 import pytest
 
 from src.raqm_core.exceptions.exceptions import NetworkError, PaymentError
 from src.raqm_core.easypaisa import EasyPaisa
-
-MA_SUCCESS_BODY = {
-    "orderId": "abc123",
-    "storeId": 43,
-    "transactionId": "253184",
-    "transactionDateTime": "11/08/2018 11:30 PM",
-    "responseCode": "0000",
-    "responseDesc": "SUCCESS",
-}
-
-OTC_SUCCESS_BODY = {
-    "orderId": "abc123",
-    "storeId": 43,
-    "transactionDateTime": "11/08/2021 11:30 PM",
-    "responseCode": "0000",
-    "responseDesc": "SUCCESS",
-    "paymentToken": "tok_abc123",
-    "paymentTokenExpiryDateTime": "12/08/2021 11:30 PM",
-}
-
-INQUIRE_SUCCESS_BODY = {
-    "orderId": "abc123",
-    "storeId": 43,
-    "transactionId": "253184",
-    "transactionDateTime": "11/08/2021 11:30 PM",
-    "responseCode": "0000",
-    "responseDesc": "SUCCESS",
-    "accountNum": "123456789",
-    "storeName": "Test Store",
-    "paymentToken": None,
-    "transactionStatus": "COMPLETED",
-    "transactionAmount": "1.23",
-    "paymentTokenExpiryDateTime": None,
-    "msisdn": "03458508726",
-    "paymentMode": "MA",
-}
-
-
-def make_client(response_body: dict, status_code: int = 200) -> httpx.AsyncClient:
-    def handler(request: httpx.Request) -> httpx.Response:
-        return httpx.Response(status_code=status_code, json=response_body)
-
-    return httpx.AsyncClient(transport=httpx.MockTransport(handler))
-
-
-def make_ep(response_body: dict) -> EasyPaisa:
-    return EasyPaisa(
-        store_id="43",
-        username="admin",
-        password="123",
-        sandbox=True,
-        client=make_client(response_body),
-    )
+from tests.conftest import (
+    INQUIRE_SUCCESS_BODY,
+    MA_SUCCESS_BODY,
+    OTC_SUCCESS_BODY,
+    make_client,
+    make_ep,
+)
 
 
 class TestPayViaMA:

{raqm_core-0.2.5 → raqm_core-0.3.0}/tests/test_jazzcash.py

@@ -1,46 +1,8 @@
-import httpx
 import pytest
 
 from src.raqm_core.exceptions.exceptions import NetworkError, PaymentError
 from src.raqm_core.jazzcash import JazzCash
-
-MWALLET_SUCCESS_BODY = {
-    "pp_Amount": "1000",
-    "pp_AuthCode": "123456",
-    "pp_BankID": "",
-    "pp_BillReference": "bill123",
-    "pp_Language": "EN",
-    "pp_MerchantID": "MERCH123",
-    "pp_ResponseCode": "000",
-    "pp_ResponseMessage": "Success",
-    "pp_RetreivalReferenceNo": "RET123",
-    "pp_SubMerchantId": "SUBMERCH123",
-    "pp_TxnCurrency": "PKR",
-    "pp_TxnDateTime": "20260101120000",
-    "pp_TxnRefNo": "TXN123456",
-    "pp_SettlementExpiry": "20260101130000",
-    "pp_TxnType": "MWALLET",
-    "pp_Version": "1.1",
-    "pp_SecureHash": "abc123hash",
-}
-
-
-def make_client(response_body: dict, status_code: int = 200) -> httpx.AsyncClient:
-    def handler(request: httpx.Request) -> httpx.Response:
-        return httpx.Response(status_code=status_code, json=response_body)
-
-    return httpx.AsyncClient(transport=httpx.MockTransport(handler))
-
-
-def make_jc(response_body: dict) -> JazzCash:
-    return JazzCash(
-        merchant_id="MERCH123",
-        sub_merchant_id="SUBMERCH123",
-        hash_key="test_hash_key",
-        password="test_password",
-        sandbox=True,
-        client=make_client(response_body),
-    )
+from tests.conftest import MWALLET_SUCCESS_BODY, make_client, make_jc
 
 
 class TestPayViaMWallet:
@@ -48,6 +10,7 @@ class TestPayViaMWallet:
     async def test_success(self):
         jc = make_jc(MWALLET_SUCCESS_BODY)
         result = await jc.pay_via_mwallet(
+            cnic="123456",
             mobile_number="03001234567",
             amount="1000",
             description="Test payment",
@@ -77,6 +40,7 @@ class TestPayViaMWallet:
         jc = make_jc(payload)
         with pytest.raises(PaymentError) as exc_info:
             await jc.pay_via_mwallet(
+                cnic="123456",
                 mobile_number="03001234567",
                 amount="1000",
                 description="Test payment",
@@ -97,6 +61,7 @@ class TestPayViaMWallet:
         )
         with pytest.raises(NetworkError):
             await jc.pay_via_mwallet(
+                cnic="123456",
                 mobile_number="03001234567",
                 amount="1000",
                 description="Test payment",