am-wd/cloudflare-api
1
0
Fork 0
Code Issues Actions Activity

Add "ZoneSubscriptions" extensions

Browse Source
This commit is contained in:
Andreas Müller
2025-07-09 09:29:31 +02:00
parent a916d49b11
commit 450aa5f1c9
9 changed files with 411 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Extensions/Cloudflare.Zones/Internals/InternalCreateZoneSubscriptionRequest.cs Normal file
View File

@@ -0,0 +1,11 @@
namespace AMWD.Net.Api.Cloudflare.Zones.Internals
{
internal class InternalCreateZoneSubscriptionRequest
{
[JsonProperty("frequency")]
public RenewFrequency? Frequency { get; set; }
[JsonProperty("rate_plan")]
public RatePlan? RatePlan { get; set; }
}
}

11
Extensions/Cloudflare.Zones/Internals/InternalUpdateZoneSubscriptionRequest.cs Normal file
View File

@@ -0,0 +1,11 @@
namespace AMWD.Net.Api.Cloudflare.Zones.Internals
{
internal class InternalUpdateZoneSubscriptionRequest
{
[JsonProperty("frequency")]
public RenewFrequency? Frequency { get; set; }
[JsonProperty("rate_plan")]
public RatePlan? RatePlan { get; set; }
}
}

8
Extensions/Cloudflare.Zones/README.md
View File

@@ -52,6 +52,13 @@ This package contains the feature set of the _Domain/Zone Management_ section of
- **DEPRECATED** [Get All Zone Settings](https://developers.cloudflare.com/api/resources/zones/subresources/settings/methods/list/)
##### [Subscriptions]
- [Create Zone Subscription](https://developers.cloudflare.com/api/resources/zones/subresources/subscriptions/methods/create/)
- [Zone Subscription Details](https://developers.cloudflare.com/api/resources/zones/subresources/subscriptions/methods/get/)
- [Update Zone Subscription](https://developers.cloudflare.com/api/resources/zones/subresources/subscriptions/methods/update/)
---
@@ -68,3 +75,4 @@ Published under MIT License (see [choose a license])
[Plans]: https://developers.cloudflare.com/api/resources/zones/subresources/plans/
[Rate Plans]: https://developers.cloudflare.com/api/resources/zones/subresources/rate_plans/
[Settings]: https://developers.cloudflare.com/api/resources/zones/subresources/settings/
[Subscriptions]: https://developers.cloudflare.com/api/resources/zones/subresources/subscriptions/

32
Extensions/Cloudflare.Zones/Requests/CreateZoneSubscriptionRequest.cs Normal file
View File

@@ -0,0 +1,32 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Represents a request to create a zone subscription.
/// </summary>
public class CreateZoneSubscriptionRequest
{
/// <summary>
/// Initializes a new instance of the <see cref="CreateZoneSubscriptionRequest"/> class.
/// </summary>
/// <param name="zoneId">The zone identifier.</param>
public CreateZoneSubscriptionRequest(string zoneId)
{
ZoneId = zoneId;
}
/// <summary>
/// The zone identifier.
/// </summary>
public string ZoneId { get; set; }
/// <summary>
/// How often the subscription is renewed automatically.
/// </summary>
public RenewFrequency? Frequency { get; set; }
/// <summary>
/// The rate plan applied to the subscription.
/// </summary>
public RatePlan? RatePlan { get; set; }
}
}

32
Extensions/Cloudflare.Zones/Requests/UpdateZoneSubscriptionRequest.cs Normal file
View File

@@ -0,0 +1,32 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Represents a request to update a zone subscription.
/// </summary>
public class UpdateZoneSubscriptionRequest
{
/// <summary>
/// Initializes a new instance of the <see cref="UpdateZoneSubscriptionRequest"/> class.
/// </summary>
/// <param name="zoneId">The zone identifier.</param>
public UpdateZoneSubscriptionRequest(string zoneId)
{
ZoneId = zoneId;
}
/// <summary>
/// The zone identifier.
/// </summary>
public string ZoneId { get; set; }
/// <summary>
/// How often the subscription is renewed automatically.
/// </summary>
public RenewFrequency? Frequency { get; set; }
/// <summary>
/// The rate plan applied to the subscription.
/// </summary>
public RatePlan? RatePlan { get; set; }
}
}

63
Extensions/Cloudflare.Zones/ZoneSubscriptionsExtensions.cs Normal file
View File

@@ -0,0 +1,63 @@
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare.Zones.Internals;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Extensions for <see href="https://developers.cloudflare.com/api/resources/zones/subresources/subscriptions/">Zone Subscriptions</see>.
/// </summary>
public static class ZoneSubscriptionsExtensions
{
/// <summary>
/// Create a zone subscription, either plan or add-ons.
/// </summary>
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
/// <param name="request">The request.</param>
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
public static Task<CloudflareResponse<Subscription>> CreateZoneSubscription(this ICloudflareClient client, CreateZoneSubscriptionRequest request, CancellationToken cancellationToken = default)
{
request.ZoneId.ValidateCloudflareId();
var req = new InternalCreateZoneSubscriptionRequest
{
Frequency = request.Frequency,
RatePlan = request.RatePlan
};
return client.PostAsync<Subscription, InternalCreateZoneSubscriptionRequest>($"/zones/{request.ZoneId}/subscription", req, null, cancellationToken);
}
/// <summary>
/// Lists zone subscription details.
/// </summary>
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
/// <param name="zoneId">The zone identifier.</param>
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
public static Task<CloudflareResponse<Subscription>> ZoneSubscriptionDetails(this ICloudflareClient client, string zoneId, CancellationToken cancellationToken = default)
{
zoneId.ValidateCloudflareId();
return client.GetAsync<Subscription>($"/zones/{zoneId}/subscription", null, cancellationToken);
}
/// <summary>
/// Updates zone subscriptions, either plan or add-ons.
/// </summary>
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
/// <param name="request">The request.</param>
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
public static Task<CloudflareResponse<Subscription>> UpdateZoneSubscription(this ICloudflareClient client, UpdateZoneSubscriptionRequest request, CancellationToken cancellationToken = default)
{
request.ZoneId.ValidateCloudflareId();
var req = new InternalUpdateZoneSubscriptionRequest
{
Frequency = request.Frequency,
RatePlan = request.RatePlan
};
return client.PutAsync<Subscription, InternalUpdateZoneSubscriptionRequest>($"/zones/{request.ZoneId}/subscription", req, cancellationToken);
}
}
}

90
UnitTests/Cloudflare.Zones.Tests/ZoneSubscriptionsExtensions/CreateZoneSubscriptionTest.cs Normal file
View File

@@ -0,0 +1,90 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare;
using AMWD.Net.Api.Cloudflare.Zones;
using AMWD.Net.Api.Cloudflare.Zones.Internals;
using Moq;
namespace Cloudflare.Zones.Tests.ZoneSubscriptionsExtensions
{
[TestClass]
public class CreateZoneSubscriptionTest
{
private const string ZoneId = "023e105f4ecef8ad9ca31a8372d0c353";
private Mock<ICloudflareClient> _clientMock;
private CloudflareResponse<Subscription> _response;
private List<(string RequestPath, InternalCreateZoneSubscriptionRequest Request)> _callbacks;
private CreateZoneSubscriptionRequest _request;
[TestInitialize]
public void Initialize()
{
_callbacks = [];
_response = new CloudflareResponse<Subscription>
{
Success = true,
Messages = [
new ResponseInfo(1000, "Message 1")
],
Errors = [
new ResponseInfo(1000, "Error 1")
],
Result = new Subscription()
};
_request = new CreateZoneSubscriptionRequest(ZoneId)
{
Frequency = RenewFrequency.Quarterly,
RatePlan = new RatePlan
{
Id = RatePlanId.Business,
PublicName = "Business Plan"
}
};
}
[TestMethod]
public async Task ShouldCreateZoneSubscription()
{
// Arrange
var client = GetClient();
// Act
var response = await client.CreateZoneSubscription(_request);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/subscription", callback.RequestPath);
Assert.IsNotNull(callback.Request);
Assert.AreEqual(_request.Frequency, callback.Request.Frequency);
Assert.AreEqual(_request.RatePlan, callback.Request.RatePlan);
_clientMock.Verify(m => m.PostAsync<Subscription, InternalCreateZoneSubscriptionRequest>($"/zones/{ZoneId}/subscription", It.IsAny<InternalCreateZoneSubscriptionRequest>(), null, It.IsAny<CancellationToken>()), Times.Once);
_clientMock.VerifyNoOtherCalls();
}
private ICloudflareClient GetClient()
{
_clientMock = new Mock<ICloudflareClient>();
_clientMock
.Setup(m => m.PostAsync<Subscription, InternalCreateZoneSubscriptionRequest>(It.IsAny<string>(), It.IsAny<InternalCreateZoneSubscriptionRequest>(), It.IsAny<IQueryParameterFilter>(), It.IsAny<CancellationToken>()))
.Callback<string, InternalCreateZoneSubscriptionRequest, IQueryParameterFilter, CancellationToken>((requestPath, request, _, _) => _callbacks.Add((requestPath, request)))
.ReturnsAsync(() => _response);
return _clientMock.Object;
}
}
}

90
UnitTests/Cloudflare.Zones.Tests/ZoneSubscriptionsExtensions/UpdateZoneSubscriptionTest.cs Normal file
View File

@@ -0,0 +1,90 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare;
using AMWD.Net.Api.Cloudflare.Zones;
using AMWD.Net.Api.Cloudflare.Zones.Internals;
using Moq;
namespace Cloudflare.Zones.Tests.ZoneSubscriptionsExtensions
{
[TestClass]
public class UpdateZoneSubscriptionTest
{
private const string ZoneId = "023e105f4ecef8ad9ca31a8372d0c353";
private Mock<ICloudflareClient> _clientMock;
private CloudflareResponse<Subscription> _response;
private List<(string RequestPath, InternalUpdateZoneSubscriptionRequest Request)> _callbacks;
private UpdateZoneSubscriptionRequest _request;
[TestInitialize]
public void Initialize()
{
_callbacks = [];
_response = new CloudflareResponse<Subscription>
{
Success = true,
Messages = [
new ResponseInfo(1000, "Message 1")
],
Errors = [
new ResponseInfo(1000, "Error 1")
],
Result = new Subscription()
};
_request = new UpdateZoneSubscriptionRequest(ZoneId)
{
Frequency = RenewFrequency.Quarterly,
RatePlan = new RatePlan
{
Id = RatePlanId.Business,
PublicName = "Business Plan"
}
};
}
[TestMethod]
public async Task ShouldUpdateZoneSubscription()
{
// Arrange
var client = GetClient();
// Act
var response = await client.UpdateZoneSubscription(_request);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/subscription", callback.RequestPath);
Assert.IsNotNull(callback.Request);
Assert.AreEqual(_request.Frequency, callback.Request.Frequency);
Assert.AreEqual(_request.RatePlan, callback.Request.RatePlan);
_clientMock.Verify(m => m.PutAsync<Subscription, InternalUpdateZoneSubscriptionRequest>($"/zones/{ZoneId}/subscription", It.IsAny<InternalUpdateZoneSubscriptionRequest>(), It.IsAny<CancellationToken>()), Times.Once);
_clientMock.VerifyNoOtherCalls();
}
private ICloudflareClient GetClient()
{
_clientMock = new Mock<ICloudflareClient>();
_clientMock
.Setup(m => m.PutAsync<Subscription, InternalUpdateZoneSubscriptionRequest>(It.IsAny<string>(), It.IsAny<InternalUpdateZoneSubscriptionRequest>(), It.IsAny<CancellationToken>()))
.Callback<string, InternalUpdateZoneSubscriptionRequest, CancellationToken>((requestPath, request, _) => _callbacks.Add((requestPath, request)))
.ReturnsAsync(() => _response);
return _clientMock.Object;
}
}
}

74
UnitTests/Cloudflare.Zones.Tests/ZoneSubscriptionsExtensions/ZoneSubscriptionDetailsTest.cs Normal file
View File

@@ -0,0 +1,74 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare;
using AMWD.Net.Api.Cloudflare.Zones;
using Moq;
namespace Cloudflare.Zones.Tests.ZoneSubscriptionsExtensions
{
[TestClass]
public class ZoneSubscriptionDetailsTest
{
private const string ZoneId = "023e105f4ecef8ad9ca31a8372d0c353";
private Mock<ICloudflareClient> _clientMock;
private CloudflareResponse<Subscription> _response;
private List<(string RequestPath, IQueryParameterFilter QueryFilter)> _callbacks;
[TestInitialize]
public void Initialize()
{
_callbacks = [];
_response = new CloudflareResponse<Subscription>
{
Success = true,
Messages = [
new ResponseInfo(1000, "Message 1")
],
Errors = [
new ResponseInfo(1000, "Error 1")
],
Result = new Subscription()
};
}
[TestMethod]
public async Task ShouldGetZoneSubscriptionDetails()
{
// Arrange
var client = GetClient();
// Act
var response = await client.ZoneSubscriptionDetails(ZoneId);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/subscription", callback.RequestPath);
Assert.IsNull(callback.QueryFilter);
_clientMock.Verify(m => m.GetAsync<Subscription>($"/zones/{ZoneId}/subscription", null, It.IsAny<CancellationToken>()), Times.Once);
_clientMock.VerifyNoOtherCalls();
}
private ICloudflareClient GetClient()
{
_clientMock = new Mock<ICloudflareClient>();
_clientMock
.Setup(m => m.GetAsync<Subscription>(It.IsAny<string>(), It.IsAny<IQueryParameterFilter>(), It.IsAny<CancellationToken>()))
.Callback<string, IQueryParameterFilter, CancellationToken>((requestPath, queryFilter, _) => _callbacks.Add((requestPath, queryFilter)))
.ReturnsAsync(() => _response);
return _clientMock.Object;
}
}
}