Adds state support to OTS API requests

Enables specifying the 'state' (e.g., normal, staging) for retrieving projects from the WebTrends Optimize (OTS) API.

This change introduces a `State` enum and includes it as an optional parameter in the `GetProjectAsync` and `GetProjectsAsync` methods of the `IControlOperations` interface and `ControlOperations` class. The state is then passed as the `s_mode` parameter in the OTS request.

This allows consumers to retrieve project configurations specific to different environments.

Author: Antaris

apps/WebTrendsSDK.ConsoleSample/Program.cs

@@ -14,7 +14,7 @@
 
 const string UserAgent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36 Edg/124.0.0.0";
 
-var project = await api.Ots.Control.GetProjectAsync("ta_YieldManagement", userAgent: UserAgent);
+var project = await api.Ots.Control.GetProjectAsync("ta_1614ReducedCheckout", userAgent: UserAgent);
 
 var projects = await api.Ots.Control.GetProjectsAsync(userAgent: UserAgent);
 

libs/WebTrendsSDK/Api/Ots/Control/ControlOperations.cs

@@ -14,7 +14,9 @@ partial interface IOtsOperations
 partial class OtsOperations
 {
 	Lazy<IControlOperations> _control;
-	public IControlOperations Control => (_control ??= client.Defer<IControlOperations>(c => new ControlOperations(path + "/control", c))).Value;
+	public IControlOperations Control
+		=> (_control ??= _client.Defer<IControlOperations>(
+					c => new ControlOperations(_path + "/control", c))).Value;
 }
 
 public interface IControlOperations
@@ -26,12 +28,14 @@ public interface IControlOperations
 	/// <param name="projectAlias">The project alias.</param>
 	/// <param name="websiteUrl">The website URL.</param>
 	/// <param name="userAgent">The user agent.</param>
+	/// <param name="state">The state identity, which controls which tests apply. Default is <see cref="State.Normal"/></param>
 	/// <param name="cancellationToken">The cancellation token.</param>
 	/// <returns>The WebTrends response.</returns>
 	Task<WebTrendsResponse<Project>> GetProjectAsync(
 		string projectAlias,
 		string? websiteUrl = null,
 		string? userAgent = null,
+		State? state = null,
 		CancellationToken cancellationToken = default);
 
 	/// <summary>
@@ -44,50 +48,58 @@ Task<WebTrendsResponse<Project>> GetProjectAsync(
 	Task<WebTrendsResponse<Project[]>> GetProjectsAsync(
 		string? websiteUrl = null,
 		string? userAgent = null,
+		State? state = State.Normal,
 		CancellationToken cancellationToken = default);
 }
 
 public class ControlOperations(PathString path, ApiClient client) : IControlOperations
 {
+	readonly PathString _path = path;
+	readonly ApiClient _client = client;
+
 	public async Task<WebTrendsResponse<Project>> GetProjectAsync(
 		string projectAlias,
 		string? websiteUrl = null,
 		string? userAgent = null,
+		State? state = null,
 		CancellationToken cancellationToken = default)
 	{
 		Ensure.IsNotNullOrEmpty(projectAlias, nameof(projectAlias));
 
-		var operationPath = path + $"/{client.Settings.AccountId}-{projectAlias}";
+		var operationPath = _path + $"/{_client.Settings.AccountId}-{projectAlias}";
 
 		var request = new WebTrendsRequest<OtsRequest>(
 			HttpMethod.Post,
 			operationPath,
-			CreateOtsRequest(websiteUrl),
-			BuildQuery(client.Settings),
+			CreateOtsRequest(websiteUrl, state),
+			BuildQuery(_client.Settings),
 			userAgent);
 
-		return await client.FetchSingleAsync<OtsRequest, Project, ProjectBody>(request, cancellationToken).ConfigureAwait(false);
+		return await _client.FetchSingleAsync<OtsRequest, Project, ProjectBody>(request, cancellationToken).ConfigureAwait(false);
 	}
 
 	public async Task<WebTrendsResponse<Project[]>> GetProjectsAsync(
 		string? websiteUrl = null,
 		string? userAgent = null,
+		State? state = null,
 		CancellationToken cancellationToken = default)
 	{
-		var operationPath = path + $"/{client.Settings.AccountId}";
+		var operationPath = _path + $"/{_client.Settings.AccountId}";
 
 		var request = new WebTrendsRequest<OtsRequest>(
 			HttpMethod.Post,
 			operationPath,
-			CreateOtsRequest(websiteUrl),
-			BuildQuery(client.Settings),
+			CreateOtsRequest(websiteUrl, state),
+			BuildQuery(_client.Settings),
 			userAgent);
 
-		return await client.FetchManyAsync<OtsRequest, Project, ProjectBody>(request, cancellationToken).ConfigureAwait(false);
+		return await _client.FetchManyAsync<OtsRequest, Project, ProjectBody>(request, cancellationToken).ConfigureAwait(false);
 	}
 
-	OtsRequest CreateOtsRequest(string? websiteUrl)
-		=> new OtsRequest(websiteUrl is { Length: > 0 } ? websiteUrl : client.Settings.WebsiteUrl);
+	OtsRequest CreateOtsRequest(string? websiteUrl, State? state)
+		=> new OtsRequest(
+				websiteUrl is { Length: > 0 } ? websiteUrl : _client.Settings.WebsiteUrl,
+				state.GetValueOrDefault(_client.Settings.State).ToString().ToLower());
 
 	QueryString BuildQuery(WebTrendsSettings settings)
 		=> new QueryStringBuilder()

libs/WebTrendsSDK/Api/Ots/Control/Project.cs

@@ -1,6 +1,8 @@
 // This work is licensed under the terms of the MIT license.
 // For a copy, see <https://opensource.org/licenses/MIT>.
 
+using System.ComponentModel.DataAnnotations;
+using System.Runtime.Serialization;
 using System.Text.Json.Serialization;
 
 using WebTrendsSDK.Api;
@@ -39,3 +41,9 @@ public class ProjectFactor
 	[JsonPropertyName("value")]
 	public string? Value { get; set; }
 }
+
+public enum State
+{
+	Normal,
+	Staging
+}

libs/WebTrendsSDK/Api/Ots/OtsOperations.cs

@@ -18,8 +18,7 @@ public IOtsOperations Ots
 	{
 		get
 		{
-			return (_ots ??= Defer<IOtsOperations>(
-		c => new OtsOperations(new("/ots/api/rest-1.2"), c))).Value;
+			return (_ots ??= Defer<IOtsOperations>(c => new OtsOperations(new("/ots/api/rest-1.2"), c))).Value;
 		}
 	}
 }
@@ -32,9 +31,8 @@ public partial interface IOtsOperations
 
 }
 
-public partial class OtsOperations(
-	PathString path,
-	ApiClient client) : IOtsOperations
+public partial class OtsOperations(PathString path, ApiClient client) : IOtsOperations
 {
-
+	readonly PathString _path = path;
+	readonly ApiClient _client = client;
 }

libs/WebTrendsSDK/Api/Ots/OtsRequest.cs

@@ -1,6 +1,10 @@
 // This work is licensed under the terms of the MIT license.
 // For a copy, see <https://opensource.org/licenses/MIT>.
 
+using System.Text.Json.Serialization;
+
 namespace WebTrendsSDK.Api;
 
-internal record OtsRequest(string url);
+internal record OtsRequest(
+	string url,
+	[property: JsonPropertyName("s_mode")] string state);

libs/WebTrendsSDK/Api/WebTrendsApiClient.cs

@@ -8,8 +8,6 @@ public partial interface IWebTrendsApiClient
 
 }
 
-public partial class WebTrendsApiClient : ApiClient, IWebTrendsApiClient
-{
-	public WebTrendsApiClient(HttpClient http, WebTrendsSettings settings)
-		: base(http, settings) { }
-}
+public partial class WebTrendsApiClient(HttpClient http, WebTrendsSettings settings)
+	: ApiClient(http, settings), IWebTrendsApiClient
+{ }

libs/WebTrendsSDK/Api/WebTrendsApiClientFactory.cs

@@ -15,12 +15,10 @@ public interface IWebTrendsApiClientFactory
 	IWebTrendsApiClient CreateApiClient(WebTrendsSettings settings);
 }
 
-public class WebTrendsApiClientFactory : IWebTrendsApiClientFactory
+public class WebTrendsApiClientFactory(IWebTrendsHttpClientFactory httpClientFactory) : IWebTrendsApiClientFactory
 {
-	readonly IWebTrendsHttpClientFactory _httpClientFactory;
-
-	public WebTrendsApiClientFactory(IWebTrendsHttpClientFactory httpClientFactory) =>
-		_httpClientFactory = Ensure.IsNotNull(httpClientFactory, nameof(httpClientFactory));
+	readonly IWebTrendsHttpClientFactory _httpClientFactory
+		= Ensure.IsNotNull(httpClientFactory, nameof(httpClientFactory));
 
 	public IWebTrendsApiClient CreateApiClient(WebTrendsSettings settings)
 	{

libs/WebTrendsSDK/WebTrendsSettings.cs

@@ -49,6 +49,11 @@ public class WebTrendsSettings
 	/// </summary>
 	public string OtsBaseUrl { get; set; } = "https://ots.webtrends-optimize.com";
 
+	/// <summary>
+	/// Gets or sets the default state for the WebTrends API.
+	/// </summary>
+	public State State { get; set; } = State.Normal;
+
 	/// <summary>
 	/// Gets or sets whether to track the returned content as a View in WebTrends.
 	/// </summary>