Prepare for NuGet package

Author: flagbug

.github/workflows/build.yml

@@ -5,24 +5,27 @@ name: build
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v4
-      with:
-        dotnet-version: 8.0.x
-    - name: Restore dependencies
-      run: dotnet restore
-    - name: Build
-      run: dotnet build --no-restore
-    - name: Test
-      run: dotnet test --no-build --verbosity normal
+      - uses: actions/checkout@v4
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 8.0.x
+
+      - name: Restore dependencies
+        run: dotnet restore
+
+      - name: Build
+        run: dotnet build --no-restore
+
+      - name: Test
+        run: dotnet test --no-build --verbosity normal

.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release to NuGet
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 8.0.x
+
+      - name: Test
+        run: dotnet test --verbosity normal
+
+      - name: Pack
+        run: dotnet pack src/AppStoreServerLibrary.csproj --configuration Release
+
+      - name: Push to NuGet
+        run: dotnet nuget push src/bin/Release/*.nupkg --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json

app-store-server-library-dotnet.sln AppStoreServerLibrary.slnapp-store-server-library-dotnet.sln renamed to AppStoreServerLibrary.sln

@@ -1,8 +1,8 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AppStoreServerLibraryDotnet", "src\AppStoreServerLibraryDotnet.csproj", "{07591682-FEF0-4441-A504-C479651AA37A}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AppStoreServerLibrary", "src\AppStoreServerLibrary.csproj", "{07591682-FEF0-4441-A504-C479651AA37A}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AppStoreServerLibraryDotnetTests", "tests\AppStoreServerLibraryDotnetTests.csproj", "{3640D40C-C3F9-46C3-B39F-C903BDEDEB80}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AppStoreServerLibraryTests", "tests\AppStoreServerLibraryTests.csproj", "{3640D40C-C3F9-46C3-B39F-C903BDEDEB80}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

README.md

@@ -1,12 +1,8 @@
-# app-store-server-library-dotnet
+# App Store Server Library for .NET
 
-An unofficial .NET SDK for App Store Server Notifications and API
+An unofficial .NET SDK for App Store Server Notifications v2 and API
 
-This library started as helpers to work with the App Store Server Notifications. Using it you can verify and decode notifications, transactions and renewal infos. It implements the required security protocols to verify the payload.
-
-It also provides a way to interact with the App Store API and to decode the Store kit 1 receipt data to retrieve the Transaction Id.
-
-The library design is copied from the official Apple libraries and it is intended to be used in the same way.
+The overall library and API design is copied from the official Apple libraries and it is intended to be used in the same way.
 More resources:
 
 - [Meet the App Store Server Library](https://developer.apple.com/videos/play/wwdc2023/10143/)
@@ -34,20 +30,16 @@ This is a list of the features that are currently implemented in the library, co
 | Extending the renewal date for auto-renewable subscriptions |  ✅   |              |
 | Request a Test Notification                                 |  ✅   |              |
 
-To summarize, it's missing a full coverage on the API endpoints.
-
 ## Installation
 
 The library is available on NuGet. You can install it using the following command:
 
 ```bash
-TBD
+dotnet add package Mimo.AppStoreServerLibrary
 ```
 
 ## Usage
 
-The library is designed to be used in the same way as the official Apple libraries.
-
 ### Obtaining Apple Root Certificates
 
 Download and store the root certificates found in the Apple Root Certificates section of the Apple PKI site. Provide these certificates as an array to a SignedDataVerifier to allow verifying the signed data comes from Apple.
@@ -57,29 +49,22 @@ Download and store the root certificates found in the Apple Root Certificates se
 Here is an example of how to verify a notification:
 
 ```csharp
-//This is the endpoint you could use to receive the notifications from Apple
-app.MapPost("/verify-decode-notification", async (ISignedDataVerifier signedDataVerifier, [FromBody] ResponseBodyV2 request) =>
-    {
-        //First decode the notification
-        var decodedNotificaiton =  await signedDataVerifier.VerifyAndDecodeNotification(request.SignedPayload);
-
-        //Then you can decode the transaction
-        JwsTransactionDecodedPayload decodedTransaction =
-            await signedDataVerifier.VerifyAndDecodeTransaction(decodedNotificaiton.Data.SignedTransactionInfo!);
-
-        //And the renewal info
-        JWSRenewalInfoDecodedPayload decodedRenewalInfo =
-            await signedDataVerifier.VerifyAndDecodeRenewalInfo(decodedNotificaiton.Data.SignedRenewalInfo!);
+var signedDataVerifier = new SignedDataVerifier(
+    appleRootCertificates: rootCertificatesBytes,
+    enableOnlineChecks: true,
+    environment: AppStoreEnvironment.Sandbox,
+    bundleId: "com.example.app"
+);
+
+try {
+    var decodedPayload = await signedDataVerifier.VerifyAndDecodeNotification(signedPayload);
+
+} catch (VerificationException ex) {
+    Console.WriteLine($"Verification failed: {ex.Message}");
+}
 
-        return decodedNotificaiton;
-    })
-    .WithName("VerifyAndDecodeNotification")
-    .WithOpenApi();
 ```
 
-If the verification fails it will raise a `VerificationException` exception with failure details.
-Once you get the decoded transaction, you can use `VerifyAndDecodeTransaction` and `VerifyAndDecodeRenewalInfo` to decode the transaction and renewal info.
-
 > [!IMPORTANT]  
 > The `SignedDataVerifier` will not verify the payload if the `environment` parameter is `LocalTesting`. This was done to allow testing fake payloads locally without the need to verify them.
 
@@ -88,66 +73,41 @@ Once you get the decoded transaction, you can use `VerifyAndDecodeTransaction` a
 Here is an example of how to get all notification history for a specific transaction using the `Pagination token` :
 
 ```csharp
-GetAppStoreNotificationHistoryResponse results = new([]);
-
-NotificationHistoryRequest appStoreRequest = new()
+// Create a request for notification history
+NotificationHistoryRequest request = new()
 {
-    //At which date the history should start
-    StartDate = request.StartDate.ToUnixTimeMilliseconds(),
-    //At which date the history should end
-    EndDate = request.EndDate.ToUnixTimeMilliseconds(),
-    //The transaction id to get the history for, if not set it will get all the history
-    TransactionId = request.TransactionId
+    StartDate = DateTimeOffset.UtcNow.AddDays(-7).ToUnixTimeMilliseconds(),
+    EndDate = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds(),
+    // Optional: filter by transaction ID
+    TransactionId = "your-transaction-id"
 };
 
+// Get initial page of notifications
 NotificationHistoryResponse? notifications =
-    await appStoreServerClient.GetNotificationHistory(appStoreRequest);
+    await appStoreServerClient.GetNotificationHistory(request);
 
 if (notifications != null)
 {
-    //For clarity of this example, ExtractNotificationInfo is a helper method that will
-    //call ISignedDataVerifier.VerifyAndDecodeNotification for each notification and
-    //extract any required info
-    results.Transactions.AddRange(await this.ExtractNotificationInfo(notifications));
-
-    //While there are more notifications to get, get them
-    while (notifications!.HasMore)
+    // Process notifications on current page
+    foreach (var notification in notifications.NotificationHistory)
     {
-        notifications = await appStoreHelper.GetNotificationHistory(appStoreRequest,
-            notifications.PaginationToken);
+        Console.WriteLine($"Notification ID: {notification.SignedPayload}");
+    }
 
-        results.Transactions.AddRange(await this.ExtractNotificationInfo(notifications!));
+    // Get additional pages if they exist
+    while (notifications.HasMore)
+    {
+        notifications = await appStoreServerClient.GetNotificationHistory(
+            request,
+            notifications.PaginationToken
+        );
+
+        foreach (var notification in notifications!.NotificationHistory)
+        {
+            Console.WriteLine($"Notification ID: {notification.SignedPayload}");
+        }
     }
 }
-
-//Return the list of retrieved and decoded notifications
-return results;
-```
-
-And another example on how to get the subscription status for a specific subscription using the `Transaction Id` :
-
-```csharp
-string transactionId = "your-transaction-id";
-
-//Inject IAppStoreServerAPIClient as appStoreServerClient to use the API
-SubscriptionStatusResponse response = await appStoreServerClient.GetAllSubscriptionStatuses(transactionId);
-
-//As we retrieved the subscription status based on the original transaction id, the response already contains only
-//the TransactionItem related to the subscription we are looking for
-//Also the LastTransactions property, if we believe the documentation, only contains the most recent transaction.
-//It means that even if it's a list it should contain only one item.
-SubscriptionStatusLastTransactionsItem lastRemoteTransaction = response.Data
-    .Last()
-    .LastTransactions.Last();
-
-//And inject ISignedDataVerifier as signedDataVerifier to decode the transaction and renewal info
-JwsTransactionDecodedPayload decodedTransaction =
-    await signedDataVerifier.VerifyAndDecodeTransaction(lastRemoteTransaction.SignedTransactionInfo!);
-
-JWSRenewalInfoDecodedPayload decodedRenewalInfo =
-    await signedDataVerifier.VerifyAndDecodeRenewalInfo(lastRemoteTransaction.SignedRenewalInfo!);
-
-Console.WriteLine($"The subscription status is {lastRemoteTransaction.Status} for transaction Id {decodedTransaction.TransactionId}");
 ```
 
 ### Receipt Utility
@@ -156,9 +116,7 @@ Here is an example of how to extract the transaction id from a receipt:
 
 ```csharp
 string receiptData = "your-receipt-data";
-ReceiptUtility utility = new ReceiptUtility();
+ReceiptUtility utility = new();
 
 string transactionId = utility.ExtractTransactionIdFromAppReceipt(receiptData);
 ```
-
-Note that the Receipt Utility is not injectable and should be instantiated when needed.

src/AppStoreServerApiClient.cs

@@ -4,12 +4,12 @@
 using System.Text;
 using System.Text.Json;
 using System.Web;
-using Mimo.AppStoreServerLibraryDotnet.Exceptions;
-using Mimo.AppStoreServerLibraryDotnet.Models;
+using Mimo.AppStoreServerLibrary.Exceptions;
+using Mimo.AppStoreServerLibrary.Models;
 using Microsoft.IdentityModel.JsonWebTokens;
 using Microsoft.IdentityModel.Tokens;
 
-namespace Mimo.AppStoreServerLibraryDotnet;
+namespace Mimo.AppStoreServerLibrary;
 
 /// <summary>
 /// Create an App Store Server API client

src/AppStoreServerLibraryDotnet.csproj src/AppStoreServerLibrary.csprojsrc/AppStoreServerLibraryDotnet.csproj renamed to src/AppStoreServerLibrary.csproj

@@ -5,9 +5,10 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <Company>Mimo</Company>
-    <PackageId>Mimo.AppStoreServerLibraryDotnet</PackageId>
+    <PackageId>Mimo.AppStoreServerLibrary</PackageId>
+    <Version>0.0.1</Version>
     <Authors>Mimo</Authors>
-    <Title>Mimo.AppStoreServerLibraryDotnet</Title>
+    <Title>Mimo.AppStoreServerLibrary</Title>
     <Description>An unofficial .NET SDK for App Store Server Notifications and API</Description>
     <Copyright>Copyright © Mimo GmbH 2024</Copyright>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
@@ -16,8 +17,8 @@
     <PackageTags>Apple, StoreKit 2, App Store Server Notifications, App Store Server API, App Store Server Library, AppStore</PackageTags>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <PackageReadmeFile>README.md</PackageReadmeFile>
-    <AssemblyName>Mimo.AppStoreServerLibraryDotnet</AssemblyName>
-    <RootNamespace>Mimo.AppStoreServerLibraryDotnet</RootNamespace>
+    <AssemblyName>Mimo.AppStoreServerLibrary</AssemblyName>
+    <RootNamespace>Mimo.AppStoreServerLibrary</RootNamespace>
   </PropertyGroup>
 
   <ItemGroup>

src/Exceptions/ApiException.cs

@@ -1,7 +1,7 @@
 using System.Net;
-using Mimo.AppStoreServerLibraryDotnet.Models;
+using Mimo.AppStoreServerLibrary.Models;
 
-namespace Mimo.AppStoreServerLibraryDotnet.Exceptions;
+namespace Mimo.AppStoreServerLibrary.Exceptions;
 
 public class ApiException(HttpStatusCode? httpStatusCode, ErrorResponse? errorResponse = null, Exception? innerException = null) : Exception(errorResponse?.ErrorMessage, innerException)
 {

src/Exceptions/VerificationException.cs

@@ -1,5 +1,5 @@
 
-namespace Mimo.AppStoreServerLibraryDotnet.Exceptions;
+namespace Mimo.AppStoreServerLibrary.Exceptions;
 
 public class VerificationException(string message) : Exception(message)
 {

src/Models/AppStoreDataTypes.cs

@@ -1,4 +1,4 @@
-namespace Mimo.AppStoreServerLibraryDotnet.Models;
+namespace Mimo.AppStoreServerLibrary.Models;
 
 /// <summary>
 /// The response body the App Store sends in a version 2 server notification.

src/Models/AppStoreEnvironment.cs

@@ -1,4 +1,4 @@
-namespace Mimo.AppStoreServerLibraryDotnet.Models;
+namespace Mimo.AppStoreServerLibrary.Models;
 
 public record AppStoreEnvironment
 {