Merge pull request #155 from takecy/noti_v2

Add struct for v2 response of app store notification

Author: takecy

.github/workflows/unit_test.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go: [ '1.15', '1.16' ]
+        go: [ '1.15', '1.16', '1.17' ]
     name: Go ${{ matrix.go }} test
     steps:
       - uses: actions/checkout@v2

Makefile

@@ -25,7 +25,7 @@ generate:
 update: update_all tidy
 
 tidy:
-	GO111MODULE=on GOPRIVATE="github.com/awa/*" go mod tidy
+	GO111MODULE=on go mod tidy
 
 update_all:
-	GO111MODULE=on GOPRIVATE="github.com/awa/*" go get -v all
+	GO111MODULE=on go get -v -u ./...

appstore/model.go

@@ -13,14 +13,17 @@ func (n *numericString) UnmarshalJSON(b []byte) error {
 	return nil
 }
 
+// Environment is alias
 type Environment string
 
+// list of Environment
 const (
 	Sandbox    Environment = "Sandbox"
 	Production Environment = "Production"
 )
 
 type (
+	// IAPRequest is struct
 	// https://developer.apple.com/library/content/releasenotes/General/ValidateAppStoreReceipt/Chapters/ValidateRemotely.html
 	// The IAPRequest type has the request parameter
 	IAPRequest struct {
@@ -140,6 +143,7 @@ type (
 		PreorderDate
 	}
 
+	// PendingRenewalInfo is struct
 	// A pending renewal may refer to a renewal that is scheduled in the future or a renewal that failed in the past for some reason.
 	PendingRenewalInfo struct {
 		SubscriptionExpirationIntent   string `json:"expiration_intent"`
@@ -169,6 +173,7 @@ type (
 		IsRetryable        bool                 `json:"is-retryable,omitempty"`
 	}
 
+	// StatusResponse is struct
 	// The HttpStatusResponse struct contains the status code returned by the store
 	// Used as a workaround to detect when to hit the production appstore or sandbox appstore regardless of receipt type
 	StatusResponse struct {
@@ -189,6 +194,7 @@ type (
 		Status                   int            `json:"status"`
 	}
 
+	// ReceiptForIOS6 is struct
 	ReceiptForIOS6 struct {
 		AppItemID numericString `json:"app_item_id"`
 		BID       string        `json:"bid"`

appstore/notification.go

@@ -45,12 +45,14 @@ const (
 	NotificationProduction NotificationEnvironment = "PROD"
 )
 
+// NotificationExpiresDate is struct
 type NotificationExpiresDate struct {
 	ExpiresDateMS  string `json:"expires_date"`
 	ExpiresDateUTC string `json:"expires_date_formatted"`
 	ExpiresDatePST string `json:"expires_date_formatted_pst"`
 }
 
+// NotificationReceipt is struct
 type NotificationReceipt struct {
 	UniqueIdentifier          string `json:"unique_identifier"`
 	AppItemID                 string `json:"app_item_id"`
@@ -73,6 +75,7 @@ type NotificationReceipt struct {
 	CancellationDate
 }
 
+// NotificationUnifiedReceipt is struct
 type NotificationUnifiedReceipt struct {
 	Status             int                  `json:"status"`
 	Environment        Environment          `json:"environment"`
@@ -82,7 +85,7 @@ type NotificationUnifiedReceipt struct {
 }
 
 // SubscriptionNotification is struct for
-// https://developer.apple.com/documentation/appstoreservernotifications/responsebody
+// https://developer.apple.com/documentation/appstoreservernotifications/responsebodyv1
 type SubscriptionNotification struct {
 	Environment      NotificationEnvironment `json:"environment"`
 	NotificationType NotificationType        `json:"notification_type"`

appstore/notification_v2.go

@@ -0,0 +1,86 @@
+package appstore
+
+// NotificationTypeV2 is type
+type NotificationTypeV2 string
+
+// list of notificationType
+// https://developer.apple.com/documentation/appstoreservernotifications/notificationtype
+const (
+	NotificationTypeV2ConsumptionRequest     NotificationTypeV2 = "CONSUMPTION_REQUEST"
+	NotificationTypeV2DidChangeRenewalPref   NotificationTypeV2 = "DID_CHANGE_RENEWAL_PREF"
+	NotificationTypeV2DidChangeRenewalStatus NotificationTypeV2 = "DID_CHANGE_RENEWAL_STATUS"
+	NotificationTypeV2DidFailToRenew         NotificationTypeV2 = "DID_FAIL_TO_RENEW"
+	NotificationTypeV2DidRenew               NotificationTypeV2 = "DID_RENEW"
+	NotificationTypeV2Expired                NotificationTypeV2 = "EXPIRED"
+	NotificationTypeV2GracePeriodExpired     NotificationTypeV2 = "GRACE_PERIOD_EXPIRED"
+	NotificationTypeV2OfferRedeemed          NotificationTypeV2 = "OFFER_REDEEMED"
+	NotificationTypeV2PriceIncrease          NotificationTypeV2 = "PRICE_INCREASE"
+	NotificationTypeV2Refund                 NotificationTypeV2 = "REFUND"
+	NotificationTypeV2RefundDeclined         NotificationTypeV2 = "REFUND_DECLINED"
+	NotificationTypeV2RenewalExtended        NotificationTypeV2 = "RENEWAL_EXTENDED"
+	NotificationTypeV2Revoke                 NotificationTypeV2 = "REVOKE"
+	NotificationTypeV2Subscribed             NotificationTypeV2 = "SUBSCRIBED"
+)
+
+// SubtypeV2 is type
+type SubtypeV2 string
+
+// list of subtypes
+// https://developer.apple.com/documentation/appstoreservernotifications/subtype
+const (
+	SubTypeV2InitialBuy        = "INITIAL_BUY"
+	SubTypeV2Resubscribe       = "RESUBSCRIBE"
+	SubTypeV2Downgrade         = "DOWNGRADE"
+	SubTypeV2Upgrade           = "UPGRADE"
+	SubTypeV2AutoRenewEnabled  = "AUTO_RENEW_ENABLED"
+	SubTypeV2AutoRenewDisabled = "AUTO_RENEW_DISABLED"
+	SubTypeV2Voluntary         = "VOLUNTARY"
+	SubTypeV2BillingRetry      = "BILLING_RETRY"
+	SubTypeV2PriceIncrease     = "PRICE_INCREASE"
+	SubTypeV2GracePeriod       = "GRACE_PERIOD"
+	SubTypeV2BillingRecovery   = "BILLING_RECOVERY"
+	SubTypeV2Pending           = "PENDING"
+	SubTypeV2Accepted          = "ACCEPTED"
+)
+
+type (
+	// SubscriptionNotificationV2 is struct for
+	// https://developer.apple.com/documentation/appstoreservernotifications/responsebodyv2
+	SubscriptionNotificationV2 struct {
+		SignedPayload SubscriptionNotificationV2SignedPayload `json:"signedPayload"`
+	}
+
+	// SubscriptionNotificationV2SignedPayload is struct
+	// https://developer.apple.com/documentation/appstoreservernotifications/signedpayload
+	SubscriptionNotificationV2SignedPayload struct {
+		SignedPayload string `json:"signedPayload"`
+	}
+
+	// SubscriptionNotificationV2DecodedPayload is struct
+	// https://developer.apple.com/documentation/appstoreservernotifications/responsebodyv2decodedpayload
+	SubscriptionNotificationV2DecodedPayload struct {
+		NotificationType    NotificationTypeV2             `json:"notificationType"`
+		Subtype             SubtypeV2                      `json:"subtype"`
+		NotificationUUID    string                         `json:"notificationUUID"`
+		NotificationVersion string                         `json:"notificationVersion"`
+		Data                SubscriptionNotificationV2Data `json:"data"`
+	}
+
+	// SubscriptionNotificationV2Data is struct
+	// https://developer.apple.com/documentation/appstoreservernotifications/data
+	SubscriptionNotificationV2Data struct {
+		AppAppleID            int    `json:"appAppleId"`
+		BundleID              string `json:"bundleId"`
+		BundleVersion         string `json:"bundleVersion"`
+		Environment           string `json:"environment"`
+		SignedRenewalInfo     string `json:"signedRenewalInfo"`
+		SignedTransactionInfo string `json:"signedTransactionInfo"`
+	}
+
+	// SubscriptionNotificationV2JWSDecodedHeader is struct
+	SubscriptionNotificationV2JWSDecodedHeader struct {
+		Alg string   `json:"alg"`
+		Kid string   `json:"kid"`
+		X5c []string `json:"x5c"`
+	}
+)

appstore/validator.go

@@ -34,6 +34,7 @@ type Client struct {
 	httpCli       *http.Client
 }
 
+// list of errore
 var (
 	ErrAppStoreServer = errors.New("AppStore server error")