Merge pull request #65 from alexanderjordanbaker/ASSNv2.10

Updating for App Store Server Notifications v2.10

Author: alexanderjordanbaker

appstoreserverlibrary/models/ExternalPurchaseToken.py

@@ -0,0 +1,43 @@
+# Copyright (c) 2024 Apple Inc. Licensed under MIT License.
+from typing import Optional
+
+from attr import define
+import attr
+
+from .LibraryUtility import AttrsRawValueAware
+
+@define
+class ExternalPurchaseToken(AttrsRawValueAware):
+    """
+    The payload data that contains an external purchase token.
+    
+    https://developer.apple.com/documentation/appstoreservernotifications/externalpurchasetoken
+    """
+
+    externalPurchaseId: Optional[str] = attr.ib(default=None)
+    """
+    The field of an external purchase token that uniquely identifies the token.
+    
+    https://developer.apple.com/documentation/appstoreservernotifications/externalpurchaseid
+    """
+
+    tokenCreationDate: Optional[int] = attr.ib(default=None)
+    """
+    The field of an external purchase token that contains the UNIX date, in milliseconds, when the system created the token.
+    
+    https://developer.apple.com/documentation/appstoreservernotifications/tokencreationdate
+    """
+
+    appAppleId: Optional[int] = attr.ib(default=None)
+    """
+    The unique identifier of an app in the App Store.
+    
+    https://developer.apple.com/documentation/appstoreservernotifications/appappleid
+    """
+
+    bundleId: Optional[str] = attr.ib(default=None)
+    """
+    The bundle identifier of an app.
+    
+    https://developer.apple.com/documentation/appstoreservernotifications/bundleid
+    """

appstoreserverlibrary/models/NotificationTypeV2.py

@@ -27,3 +27,4 @@ class NotificationTypeV2(str, Enum, metaclass=AppStoreServerLibraryEnumMeta):
     TEST = "TEST"
     RENEWAL_EXTENSION = "RENEWAL_EXTENSION"
     REFUND_REVERSED = "REFUND_REVERSED"
+    EXTERNAL_PURCHASE_TOKEN = "EXTERNAL_PURCHASE_TOKEN"

appstoreserverlibrary/models/ResponseBodyV2DecodedPayload.py

@@ -3,8 +3,9 @@
 
 from attr import define
 import attr
-from .Data import Data
 
+from .Data import Data
+from .ExternalPurchaseToken import ExternalPurchaseToken
 from .LibraryUtility import AttrsRawValueAware
 from .NotificationTypeV2 import NotificationTypeV2
 from .Subtype import Subtype
@@ -53,7 +54,7 @@ class ResponseBodyV2DecodedPayload(AttrsRawValueAware):
     data: Optional[Data] = attr.ib(default=None)
     """
     The object that contains the app metadata and signed renewal and transaction information.
-    The data and summary fields are mutually exclusive. The payload contains one of the fields, but not both.
+    The data, summary, and externalPurchaseToken fields are mutually exclusive. The payload contains only one of these fields.
     
     https://developer.apple.com/documentation/appstoreservernotifications/data
     """
@@ -75,7 +76,15 @@ class ResponseBodyV2DecodedPayload(AttrsRawValueAware):
     summary: Optional[Summary] = attr.ib(default=None)
     """
     The summary data that appears when the App Store server completes your request to extend a subscription renewal date for eligible subscribers.
-    The data and summary fields are mutually exclusive. The payload contains one of the fields, but not both.
+    The data, summary, and externalPurchaseToken fields are mutually exclusive. The payload contains only one of these fields.
     
     https://developer.apple.com/documentation/appstoreservernotifications/summary
+    """
+
+    externalPurchaseToken: Optional[ExternalPurchaseToken] = attr.ib(default=None)
+    """
+    This field appears when the notificationType is EXTERNAL_PURCHASE_TOKEN.
+    The data, summary, and externalPurchaseToken fields are mutually exclusive. The payload contains only one of these fields.
+    
+    https://developer.apple.com/documentation/appstoreservernotifications/externalpurchasetoken
     """

appstoreserverlibrary/models/Subtype.py

@@ -26,3 +26,4 @@ class Subtype(str, Enum, metaclass=AppStoreServerLibraryEnumMeta):
     PRODUCT_NOT_FOR_SALE = "PRODUCT_NOT_FOR_SALE"
     SUMMARY = "SUMMARY"
     FAILURE = "FAILURE"
+    UNREPORTED = "UNREPORTED"

appstoreserverlibrary/signed_data_verifier.py

@@ -1,6 +1,6 @@
 # Copyright (c) 2023 Apple Inc. Licensed under MIT License.
 
-from typing import List
+from typing import List, Optional
 from base64 import b64decode
 from enum import IntEnum
 import time
@@ -94,11 +94,21 @@ def verify_and_decode_notification(self, signed_payload: str) -> ResponseBodyV2D
             bundle_id = decoded_signed_notification.summary.bundleId
             app_apple_id = decoded_signed_notification.summary.appAppleId
             environment = decoded_signed_notification.summary.environment
+        elif decoded_signed_notification.externalPurchaseToken:
+            bundle_id = decoded_signed_notification.externalPurchaseToken.bundleId
+            app_apple_id = decoded_signed_notification.externalPurchaseToken.appAppleId
+            if decoded_signed_notification.externalPurchaseToken.externalPurchaseId and decoded_signed_notification.externalPurchaseToken.externalPurchaseId.startswith("SANDBOX"):
+                environment = Environment.SANDBOX
+            else:
+                environment = Environment.PRODUCTION
+        self._verify_notification(bundle_id, app_apple_id, environment)
+        return decoded_signed_notification
+
+    def _verify_notification(self, bundle_id: Optional[str], app_apple_id: Optional[int], environment: Optional[Environment]):
         if bundle_id != self._bundle_id or (self._environment == Environment.PRODUCTION and app_apple_id != self._app_apple_id):
             raise VerificationException(VerificationStatus.INVALID_APP_IDENTIFIER)
         if environment != self._environment:
             raise VerificationException(VerificationStatus.INVALID_ENVIRONMENT)
-        return decoded_signed_notification
 
     def verify_and_decode_app_transaction(self, signed_app_transaction: str) -> AppTransaction:
         """

tests/resources/models/signedExternalPurchaseTokenNotification.json

@@ -0,0 +1,13 @@
+{
+    "notificationType": "EXTERNAL_PURCHASE_TOKEN",
+    "subtype": "UNREPORTED",
+    "notificationUUID": "002e14d5-51f5-4503-b5a8-c3a1af68eb20",
+    "version": "2.0",
+    "signedDate": 1698148900000,
+    "externalPurchaseToken": {
+      "externalPurchaseId": "b2158121-7af9-49d4-9561-1f588205523e",
+      "tokenCreationDate": 1698148950000,
+      "appAppleId": 55555,
+      "bundleId": "com.example"
+    }
+  }

tests/resources/models/signedExternalPurchaseTokenSandboxNotification.json

@@ -0,0 +1,13 @@
+{
+    "notificationType": "EXTERNAL_PURCHASE_TOKEN",
+    "subtype": "UNREPORTED",
+    "notificationUUID": "002e14d5-51f5-4503-b5a8-c3a1af68eb20",
+    "version": "2.0",
+    "signedDate": 1698148900000,
+    "externalPurchaseToken": {
+      "externalPurchaseId": "SANDBOX_b2158121-7af9-49d4-9561-1f588205523e",
+      "tokenCreationDate": 1698148950000,
+      "appAppleId": 55555,
+      "bundleId": "com.example"
+    }
+  }

tests/test_decoded_payloads.py

@@ -1,5 +1,6 @@
 # Copyright (c) 2023 Apple Inc. Licensed under MIT License.
 
+from typing import Optional
 import unittest
 from appstoreserverlibrary.models.AutoRenewStatus import AutoRenewStatus
 from appstoreserverlibrary.models.Environment import Environment
@@ -15,7 +16,7 @@
 from appstoreserverlibrary.models.TransactionReason import TransactionReason
 from appstoreserverlibrary.models.Type import Type
 
-from tests.util import create_signed_data_from_json, get_default_signed_data_verifier
+from tests.util import create_signed_data_from_json, get_default_signed_data_verifier, get_signed_data_verifier
 
 class DecodedPayloads(unittest.TestCase):
     def test_app_transaction_decoding(self):
@@ -122,6 +123,7 @@ def test_notificaiton_decoding(self):
         self.assertEqual(1698148900000, notification.signedDate)
         self.assertIsNotNone(notification.data)
         self.assertIsNone(notification.summary)
+        self.assertIsNone(notification.externalPurchaseToken)
         self.assertEqual(Environment.LOCAL_TESTING, notification.data.environment)
         self.assertEqual("LocalTesting", notification.data.rawEnvironment)
         self.assertEqual(41234, notification.data.appAppleId)
@@ -148,6 +150,7 @@ def test_summary_notification_decoding(self):
         self.assertEqual(1698148900000, notification.signedDate)
         self.assertIsNone(notification.data)
         self.assertIsNotNone(notification.summary)
+        self.assertIsNone(notification.externalPurchaseToken)
         self.assertEqual(Environment.LOCAL_TESTING, notification.summary.environment)
         self.assertEqual("LocalTesting", notification.summary.rawEnvironment)
         self.assertEqual(41234, notification.summary.appAppleId)
@@ -156,4 +159,62 @@ def test_summary_notification_decoding(self):
         self.assertEqual("efb27071-45a4-4aca-9854-2a1e9146f265", notification.summary.requestIdentifier)
         self.assertEqual(["CAN", "USA", "MEX"], notification.summary.storefrontCountryCodes)
         self.assertEqual(5, notification.summary.succeededCount)
-        self.assertEqual(2, notification.summary.failedCount)
+        self.assertEqual(2, notification.summary.failedCount)
+    
+    def test_external_purchase_token_notification_decoding(self):
+        signed_external_purchase_token_notification = create_signed_data_from_json('tests/resources/models/signedExternalPurchaseTokenNotification.json')
+        
+        signed_data_verifier = get_default_signed_data_verifier()
+
+        def check_environment_and_bundle_id(bundle_id: Optional[str], app_apple_id: Optional[int], environment: Optional[Environment]):
+            self.assertEqual("com.example", bundle_id)
+            self.assertEqual(55555, app_apple_id)
+            self.assertEqual(Environment.PRODUCTION, environment)
+
+        signed_data_verifier._verify_notification = check_environment_and_bundle_id
+
+        notification = signed_data_verifier.verify_and_decode_notification(signed_external_purchase_token_notification)
+        
+        self.assertEqual(NotificationTypeV2.EXTERNAL_PURCHASE_TOKEN, notification.notificationType)
+        self.assertEqual("EXTERNAL_PURCHASE_TOKEN", notification.rawNotificationType)
+        self.assertEqual(Subtype.UNREPORTED, notification.subtype)
+        self.assertEqual("UNREPORTED", notification.rawSubtype)
+        self.assertEqual("002e14d5-51f5-4503-b5a8-c3a1af68eb20", notification.notificationUUID)
+        self.assertEqual("2.0", notification.version)
+        self.assertEqual(1698148900000, notification.signedDate)
+        self.assertIsNone(notification.data)
+        self.assertIsNone(notification.summary)
+        self.assertIsNotNone(notification.externalPurchaseToken)
+        self.assertEqual("b2158121-7af9-49d4-9561-1f588205523e", notification.externalPurchaseToken.externalPurchaseId)
+        self.assertEqual(1698148950000, notification.externalPurchaseToken.tokenCreationDate)
+        self.assertEqual(55555, notification.externalPurchaseToken.appAppleId)
+        self.assertEqual("com.example", notification.externalPurchaseToken.bundleId)
+    
+    def test_external_purchase_token_sandbox_notification_decoding(self):
+        signed_external_purchase_token_notification = create_signed_data_from_json('tests/resources/models/signedExternalPurchaseTokenSandboxNotification.json')
+        
+        signed_data_verifier = get_default_signed_data_verifier()
+
+        def check_environment_and_bundle_id(bundle_id: Optional[str], app_apple_id: Optional[int], environment: Optional[Environment]):
+            self.assertEqual("com.example", bundle_id)
+            self.assertEqual(55555, app_apple_id)
+            self.assertEqual(Environment.SANDBOX, environment)
+
+        signed_data_verifier._verify_notification = check_environment_and_bundle_id
+
+        notification = signed_data_verifier.verify_and_decode_notification(signed_external_purchase_token_notification)
+        
+        self.assertEqual(NotificationTypeV2.EXTERNAL_PURCHASE_TOKEN, notification.notificationType)
+        self.assertEqual("EXTERNAL_PURCHASE_TOKEN", notification.rawNotificationType)
+        self.assertEqual(Subtype.UNREPORTED, notification.subtype)
+        self.assertEqual("UNREPORTED", notification.rawSubtype)
+        self.assertEqual("002e14d5-51f5-4503-b5a8-c3a1af68eb20", notification.notificationUUID)
+        self.assertEqual("2.0", notification.version)
+        self.assertEqual(1698148900000, notification.signedDate)
+        self.assertIsNone(notification.data)
+        self.assertIsNone(notification.summary)
+        self.assertIsNotNone(notification.externalPurchaseToken)
+        self.assertEqual("SANDBOX_b2158121-7af9-49d4-9561-1f588205523e", notification.externalPurchaseToken.externalPurchaseId)
+        self.assertEqual(1698148950000, notification.externalPurchaseToken.tokenCreationDate)
+        self.assertEqual(55555, notification.externalPurchaseToken.appAppleId)
+        self.assertEqual("com.example", notification.externalPurchaseToken.bundleId)