chore(iss-1)!: version 2.0.0 overhaul

.github/workflows/deploy_to_nuget.yml

@@ -0,0 +1,69 @@
+name: Deploy to NuGet
+
+on:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release:
+    name: Release Using Release Please
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        dotnet-version: [6.0]
+    steps:
+      # Checkout the code
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # Set up .NET
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '6.0.x'
+          cache: true
+          cache-dependency-path: "./UrlboxSDK"
+
+      # Restore dependencies
+      - name: Restore dependencies
+        run: dotnet restore ./UrlboxSDK
+
+      # Run tests
+      - name: Run tests
+        run: dotnet test
+
+      # https://github.com/googleapis/release-please/blob/72b0ab360c3d6635397e8b02f4d3f9f53932e23c/docs/customizing.md
+      - name: Create Release
+        id: create_release
+        uses: googleapis/release-please-action@v4
+        with:
+          target-branch: release-please-test
+    outputs:
+      release_created: ${{ steps.create_release.outputs.release_created }}
+
+  deploy:
+    needs: release
+    if: ${{ needs.release.outputs.release_created }}
+    name: Push to NuGet registry
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        dotnet-version: [6.0]
+    steps:
+      # Build the project
+      - name: Build the project
+        run: dotnet build ./UrlboxSDK --configuration Release --no-restore
+
+      # Pack the NuGet package somewhere unique
+      - name: Pack NuGet package
+        run: dotnet pack --configuration Release --no-build --output ./package
+
+      # Push the NuGet package to NuGet.org
+      - name: Publish to NuGet
+        run: dotnet nuget push "./package/*.nupkg" --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json
+

.github/workflows/run_tests.yml

@@ -0,0 +1,28 @@
+name: run tests
+
+on:
+  push:
+
+jobs:
+  test:
+    permissions:
+      contents: read
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        dotnet-version: [6.0]
+    steps:
+      - name: Checkout urlbox-dotnet
+        uses: actions/checkout@v4
+
+      - uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '6.0.x'
+          cache: true
+          cache-dependency-path: "./UrlboxSDK"
+
+      - name: Install dependencies
+        run: dotnet restore
+
+      - name: Run tests
+        run: dotnet test

.gitignore

@@ -38,3 +38,5 @@ Thumbs.db
 
 # dotCover
 *.dotCover
+
+.idea

.release-please-manifest.json

@@ -0,0 +1,4 @@
+{
+    ".": "1.3.0"
+}
+

Example/Example.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="../UrlboxSDK/UrlboxSDK.csproj" />
+  </ItemGroup>
+
+</Project>

Example/Program.cs

@@ -0,0 +1,95 @@
+using UrlboxSDK.DI.Extension;
+using UrlboxSDK;
+using UrlboxSDK.Response.Resource;
+using UrlboxSDK.Exception;
+using UrlboxSDK.Options.Resource;
+using UrlboxSDK.Webhook.Resource;
+using System.Text.Json;
+
+var builder = WebApplication.CreateBuilder(args);
+
+// Add Urlbox to the service container
+builder.Services.AddUrlbox(options =>
+{
+    // TODO Replace these with your keys from the dashboard: https://urlbox.com/dashboard/api 
+    options.Key = "YOUR PUBLISHABLE API KEY HERE";
+    options.Secret = "YOUR SECRET KEY HERE";
+    // TODO optionally add this in to test out webhooks
+    options.WebhookSecret = "YOUR WEBHOOK SECRET KEY HERE";
+    // if you need to use one of our specific subdomains
+    // options.BaseUrl = "https://api-eu.urlbox.com";
+});
+
+var app = builder.Build();
+
+// Urlbox gets injected by the service container
+app.MapGet("/", async (HttpContext context, IUrlbox urlbox) =>
+{
+    try
+    {
+        // Use the static .Options() method to choose your options
+        UrlboxOptions options = Urlbox.Options(url: "https://urlbox.com/docs")
+            // Play around with various options here
+            .Format(Format.Jpeg)
+            // Want to test out webhooks? see the POST endpoint below
+            // .WebhookUrl("https://YOUR NGROK FORWARDING ENDPOINT/webhook/urlbox")
+            .Build();
+
+        // Runs an async render, polls for success
+        // AsyncUrlboxResponse takeScreenshotResponse = await urlbox.TakeScreenshot(options);
+
+        // Runs an async render, gives status response
+        AsyncUrlboxResponse renderAsyncResponse = await urlbox.RenderAsync(options);
+
+        // Runs an sync render, waits for success before returning
+        // SyncUrlboxResponse renderSyncResponse = await urlbox.Render(options);
+
+        return Results.Json(new
+        {
+            message = "Screenshot generated!",
+            // ResponseFromTakeScreenshot = takeScreenshotResponse,
+            ResponseFromRenderAsync = renderAsyncResponse,
+            // ResponseFromRenderSync = renderSyncResponse
+        });
+    }
+    // Want to test how the exception looks? try this as the url in options: "https://notresolvableurlbox.com"
+    catch (UrlboxException ex)
+    {
+        Console.WriteLine(ex.Message);
+        Console.WriteLine(ex.RequestId);
+        return Results.Json(new { message = "Failed to generate screenshot, urlbox exception", error = ex.Message, reqId = ex.RequestId });
+    }
+});
+
+/* 
+    Webhook Example:
+
+    1. Make sure you've set your webhook secret in your Urlbox instantiation (line 16)
+    2. Get ngrok (make an account and install on your computer) https://ngrok.com/
+    3. Run this project with `dotnet run`.
+    4. Using ngrok expose the localhost port the .net server runs on EG for 5096 `ngrok http 5096`
+    4. Take the ngrok forwarding address shown in CLI EG https://2c85-80-41-190-113.ngrok-free.app and 
+        replace the above .WebhookUrl() arg with it in your options, including the /webhook/urlbox endpoint.
+    5. Make a request to the GET endpoint "/" above with one of the render methods, and Urlbox will make a POST to your ngrok endpoint /webhook/urlbox.
+        EG: curl -i http://localhost:5096
+*/
+app.MapPost("/webhook/urlbox", async (HttpContext context, IUrlbox urlbox) =>
+{
+    using StreamReader stream = new StreamReader(context.Request.Body);
+
+    if (!context.Request.Headers.TryGetValue("x-urlbox-signature", out var headerValue))
+    {
+        throw new Exception("Header 'x-urlbox-signature' not found.");
+    }
+
+    UrlboxWebhookResponse verifiedResponse = urlbox.VerifyWebhookSignature(headerValue.ToString(), await stream.ReadToEndAsync());
+
+    string json = JsonSerializer.Serialize(verifiedResponse, new JsonSerializerOptions
+    {
+        WriteIndented = true
+    });
+
+    Console.WriteLine(json);
+});
+
+app.Run();

Example/Properties/launchSettings.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "http://json.schemastore.org/launchsettings.json",
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:52163",
+      "sslPort": 44353
+    }
+  },
+  "profiles": {
+    "http": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": false,
+      "applicationUrl": "http://localhost:5096",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "https": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": false,
+      "applicationUrl": "https://localhost:7078;http://localhost:5096",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": false,
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}

Example/appsettings.Development.json

@@ -0,0 +1,8 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  }
+}

Example/appsettings.json

@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  },
+  "AllowedHosts": "*"
+}