Merge pull request #13 from nnnLik/feature/get-coupons-status

Add PromoOffersRevocationStatus class and corresponding tests

Author: pehas

admitad/items/promo_offers.py

@@ -4,6 +4,7 @@
 __all__ = [
     'PromoOffersForCampaign',
     'PromoOfferRequestTrackingCode',
+    'PromoOffersRevocationStatus',
 ]
 
 
@@ -107,3 +108,39 @@ def get(self, request_id: int) -> dict:
             .set_data(request_data)
             .request(url=self.GET_STATUS_URL)
         )
+
+
+class PromoOffersRevocationStatus(Item):
+    """
+    Get revocation status of promo codes for specific promo offer
+    """
+
+    SCOPE = 'public_data'
+
+    REVOCATION_STATUS_URL = Item.prepare_url('promo_offers/revocation_status/%(pk)s')
+
+    def get(self, _id: int, website_id: int) -> dict:
+        """
+        Args:
+            _id (int): promo offer id
+            website_id (int): website id
+
+        Returns:
+            list: Revocation status of promo codes that have history for this website
+            [
+                {"promocode_value": "promocode1", "status": "active"},
+                {"promocode_value": "promocode2", "status": "revoked"},
+                ...
+            ]
+        """
+        request_data = {
+            'url': self.REVOCATION_STATUS_URL,
+            'pk': Item.sanitize_id(_id),
+            'website_id': Item.sanitize_id(website_id)
+        }
+
+        return (
+            self.transport.get()
+            .set_data(request_data)
+            .request(url=self.REVOCATION_STATUS_URL, pk=Item.sanitize_id(_id))
+        )

admitad/tests/test_promo_offers.py

@@ -2,7 +2,7 @@
 import responses
 
 from admitad.exceptions import HttpException
-from admitad.items import PromoOffersForCampaign, PromoOfferRequestTrackingCode
+from admitad.items import PromoOffersForCampaign, PromoOfferRequestTrackingCode, PromoOffersRevocationStatus
 from admitad.tests.base import BaseTestCase
 
 
@@ -171,5 +171,113 @@ def test_get_tracking_promo_code_request_invalid_id(self) -> None:
             self.client.PromoOfferRequestTrackingCode.get(request_id=0)
 
 
+class PromoOffersRevocationStatusTestCase(BaseTestCase):
+
+    def test_get_promo_offers_revocation_status_success_multiple_codes(self) -> None:
+        with responses.RequestsMock() as resp:
+            resp.add(
+                resp.GET,
+                self.prepare_url(PromoOffersRevocationStatus.REVOCATION_STATUS_URL, pk=123, params={
+                    'website_id': 456
+                }),
+                match_querystring=True,
+                json=[
+                    {"promocode_value": "SAVE20", "status": "active"},
+                    {"promocode_value": "DISCOUNT15", "status": "revoked"},
+                    {"promocode_value": "PROMO50", "status": "active"}
+                ],
+                status=200
+            )
+            result = self.client.PromoOffersRevocationStatus.get(
+                _id=123,
+                website_id=456
+            )
+
+        self.assertEqual(len(result), 3)
+        self.assertEqual(result[0]['promocode_value'], 'SAVE20')
+        self.assertEqual(result[0]['status'], 'active')
+        self.assertEqual(result[1]['promocode_value'], 'DISCOUNT15')
+        self.assertEqual(result[1]['status'], 'revoked')
+        self.assertEqual(result[2]['promocode_value'], 'PROMO50')
+        self.assertEqual(result[2]['status'], 'active')
+
+    def test_get_promo_offers_revocation_status_empty_response(self) -> None:
+        with responses.RequestsMock() as resp:
+            resp.add(
+                resp.GET,
+                self.prepare_url(PromoOffersRevocationStatus.REVOCATION_STATUS_URL, pk=123, params={
+                    'website_id': 456
+                }),
+                match_querystring=True,
+                json=[],
+                status=200
+            )
+            result = self.client.PromoOffersRevocationStatus.get(
+                _id=123,
+                website_id=456
+            )
+
+        self.assertEqual(result, [])
+
+    def test_get_promo_offers_revocation_status_missing_website_id(self) -> None:
+        with responses.RequestsMock() as resp:
+            resp.add(
+                resp.GET,
+                self.prepare_url(PromoOffersRevocationStatus.REVOCATION_STATUS_URL, pk=123),
+                json={"error": "Missing required parameter: website_id"},
+                status=400
+            )
+            with self.assertRaises(HttpException):
+                self.client.PromoOffersRevocationStatus.get(_id=123)
+
+    def test_get_promo_offers_revocation_status_invalid_website_id(self) -> None:
+        with responses.RequestsMock() as resp:
+            resp.add(
+                resp.GET,
+                self.prepare_url(PromoOffersRevocationStatus.REVOCATION_STATUS_URL, pk=123, params={
+                    'website_id': 'invalid'
+                }),
+                match_querystring=True,
+                json={"error": "website_id must be an integer"},
+                status=400
+            )
+            with self.assertRaises(HttpException):
+                self.client.PromoOffersRevocationStatus.get(
+                    _id=123,
+                    website_id='invalid'
+                )
+
+    def test_get_promo_offers_revocation_status_offer_not_found(self) -> None:
+        with responses.RequestsMock() as resp:
+            resp.add(
+                resp.GET,
+                self.prepare_url(PromoOffersRevocationStatus.REVOCATION_STATUS_URL, pk=999, params={
+                    'website_id': 456
+                }),
+                match_querystring=True,
+                json={"error": "Promo offer not found or has no active promo codes"},
+                status=404
+            )
+            with self.assertRaises(HttpException):
+                self.client.PromoOffersRevocationStatus.get(
+                    _id=999,
+                    website_id=456
+                )
+
+    def test_get_promo_offers_revocation_status_invalid_offer_id(self) -> None:
+        with self.assertRaises(ValueError):
+            self.client.PromoOffersRevocationStatus.get(
+                _id=0,
+                website_id=456
+            )
+
+    def test_get_promo_offers_revocation_status_invalid_website_id_zero(self) -> None:
+        with self.assertRaises(ValueError):
+            self.client.PromoOffersRevocationStatus.get(
+                _id=123,
+                website_id=0
+            )
+
+
 if __name__ == '__main__':
     unittest.main()