Rename the ToJson() method to ToDictionary()

Author: Cédric Belin

src/author.cs

@@ -39,10 +39,10 @@ public sealed class Author(string ipAddress) {
 	public string UserAgent { get; set; } = string.Empty;
 
 	/// <summary>
-	/// Returns a JSON representation of this object.
+	/// Converts this object into a dictionary.
 	/// </summary>
-	/// <returns>The JSON representation of this object.</returns>
-	internal IDictionary<string, string> ToJson() {
+	/// <returns>The dictionary corresponding to this object.</returns>
+	internal IDictionary<string, string> ToDictionary() {
 		var map = new Dictionary<string, string> { ["user_ip"] = IPAddress.ToString() };
 		if (!string.IsNullOrWhiteSpace(Email)) map["comment_author_email"] = Email;
 		if (!string.IsNullOrWhiteSpace(Name)) map["comment_author"] = Name;

src/blog.cs

@@ -24,10 +24,10 @@ public sealed class Blog(string url) {
 	public Uri Url { get; set; } = new Uri(url);
 
 	/// <summary>
-	/// Returns a JSON representation of this object.
+	/// Converts this object into a dictionary.
 	/// </summary>
-	/// <returns>The JSON representation of this object.</returns>
-	internal IDictionary<string, string> ToJson() {
+	/// <returns>The dictionary corresponding to this object.</returns>
+	internal IDictionary<string, string> ToDictionary() {
 		var map = new Dictionary<string, string> { ["blog"] = Url.ToString() };
 		if (Charset is not null) map["blog_charset"] = Charset.WebName;
 		if (Languages.Count != 0) map["blog_lang"] = string.Join(',', Languages);

src/client.cs

@@ -51,7 +51,7 @@ public class Client(string apiKey, Blog blog, string baseUrl = "https://rest.aki
 	/// <returns>A value indicating whether the specified comment is spam.</returns>
 	/// <exception cref="HttpRequestException">The remote server returned an invalid response.</exception>
 	public async Task<CheckResult> CheckComment(Comment comment, CancellationToken cancellationToken = default) {
-		using var response = await Fetch("1.1/comment-check", comment.ToJson(), cancellationToken);
+		using var response = await Fetch("1.1/comment-check", comment.ToDictionary(), cancellationToken);
 		if (await response.Content.ReadAsStringAsync(cancellationToken) == "false") return CheckResult.Ham;
 		if (!response.Headers.TryGetValues("X-akismet-pro-tip", out var proTips)) return CheckResult.Spam;
 		return proTips.First() == "discard" ? CheckResult.PervasiveSpam : CheckResult.Spam;
@@ -65,7 +65,7 @@ public async Task<CheckResult> CheckComment(Comment comment, CancellationToken c
 	/// <returns>Completes once the comment has been submitted.</returns>
 	/// <exception cref="HttpRequestException">The remote server returned an invalid response.</exception>
 	public async Task SubmitHam(Comment comment, CancellationToken cancellationToken = default) {
-		using var response = await Fetch("1.1/submit-ham", comment.ToJson(), cancellationToken);
+		using var response = await Fetch("1.1/submit-ham", comment.ToDictionary(), cancellationToken);
 		var body = await response.Content.ReadAsStringAsync(cancellationToken);
 		if (body != Success) throw new HttpRequestException("Invalid server response.");
 	}
@@ -78,7 +78,7 @@ public async Task SubmitHam(Comment comment, CancellationToken cancellationToken
 	/// <returns>Completes once the comment has been submitted.</returns>
 	/// <exception cref="HttpRequestException">The remote server returned an invalid response.</exception>
 	public async Task SubmitSpam(Comment comment, CancellationToken cancellationToken = default) {
-		using var response = await Fetch("1.1/submit-spam", comment.ToJson(), cancellationToken);
+		using var response = await Fetch("1.1/submit-spam", comment.ToDictionary(), cancellationToken);
 		var body = await response.Content.ReadAsStringAsync(cancellationToken);
 		if (body != Success) throw new HttpRequestException("Invalid server response.");
 	}
@@ -107,7 +107,7 @@ public async Task<bool> VerifyKey(CancellationToken cancellationToken = default)
 	/// <returns>The server response.</returns>
 	/// <exception cref="HttpRequestException">An error occurred while querying the end point.</exception>
 	private async Task<HttpResponseMessage> Fetch(string endpoint, IDictionary<string, string>? fields = null, CancellationToken cancellationToken = default) {
-		var postFields = Blog.ToJson();
+		var postFields = Blog.ToDictionary();
 		postFields.Add("api_key", ApiKey);
 		if (IsTest) postFields.Add("is_test", "1");
 		if (fields is not null) foreach (var item in fields) postFields.Add(item.Key, item.Value);

src/comment.cs

@@ -52,11 +52,11 @@ public sealed class Comment(Author author) {
 	public string Type { get; set; } = string.Empty;
 
 	/// <summary>
-	/// Returns a JSON representation of this object.
+	/// Converts this object into a dictionary.
 	/// </summary>
-	/// <returns>The JSON representation of this object.</returns>
-	internal IDictionary<string, string> ToJson() {
-		var map = Author.ToJson();
+	/// <returns>The dictionary corresponding to this object.</returns>
+	internal IDictionary<string, string> ToDictionary() {
+		var map = Author.ToDictionary();
 		if (!string.IsNullOrWhiteSpace(Content)) map["comment_content"] = Content;
 		// TODO if (Context.Count > 0) map["comment_context"] = string.Join(',', Context);
 		if (Date is not null) map["comment_date_gmt"] = Date?.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ssZ")!;

test/author_test.cs

@@ -7,9 +7,9 @@ namespace Belin.Akismet;
 public sealed class AuthorTest {
 
 	[TestMethod]
-	public void ToJson() {
+	public void ToDictionary() {
 		// It should return only the IP address with a newly created instance.
-		var map = new Author(ipAddress: "127.0.0.1").ToJson();
+		var map = new Author(ipAddress: "127.0.0.1").ToDictionary();
 		AreEqual(1, map.Count);
 		AreEqual("127.0.0.1", map["user_ip"]);
 
@@ -21,7 +21,7 @@ public void ToJson() {
 			UserAgent = "Mozilla/5.0"
 		};
 
-		map = author.ToJson();
+		map = author.ToDictionary();
 		AreEqual(5, map.Count);
 		AreEqual("Cédric Belin", map["comment_author"]);
 		AreEqual("cedric@belin.io", map["comment_author_email"]);

test/blog_test.cs

@@ -9,14 +9,14 @@ namespace Belin.Akismet;
 public sealed class BlogTest {
 
 	[TestMethod]
-	public void ToJson() {
+	public void ToDictionary() {
 		// It should return only the blog URL with a newly created instance.
-		var map = new Blog(url: "https://github.com/cedx/akismet.cs").ToJson();
+		var map = new Blog(url: "https://github.com/cedx/akismet.cs").ToDictionary();
 		AreEqual(1, map.Count);
 		AreEqual("https://github.com/cedx/akismet.cs", map["blog"]);
 
 		// It should return a non-empty map with an initialized instance.
-		map = new Blog(url: "https://github.com/cedx/akismet.cs") { Charset = Encoding.UTF8, Languages = ["en", "fr"] }.ToJson();
+		map = new Blog(url: "https://github.com/cedx/akismet.cs") { Charset = Encoding.UTF8, Languages = ["en", "fr"] }.ToDictionary();
 		AreEqual(3, map.Count);
 		AreEqual("https://github.com/cedx/akismet.cs", map["blog"]);
 		AreEqual("utf-8", map["blog_charset"]);

test/comment_test.cs

@@ -7,9 +7,9 @@ namespace Belin.Akismet;
 public sealed class CommentTest {
 
 	[TestMethod]
-	public void ToJson() {
+	public void ToDictionary() {
 		// It should return only the author info with a newly created instance.
-		var map = new Comment(new Author(ipAddress: "127.0.0.1")).ToJson();
+		var map = new Comment(new Author(ipAddress: "127.0.0.1")).ToDictionary();
 		AreEqual(1, map.Count);
 		AreEqual("127.0.0.1", map["user_ip"]);
 
@@ -26,7 +26,7 @@ public void ToJson() {
 			Type = "blog-post"
 		};
 
-		map = comment.ToJson();
+		map = comment.ToDictionary();
 		AreEqual(7, map.Count);
 		AreEqual("Cédric Belin", map["comment_author"]);
 		AreEqual("A user comment.", map["comment_content"]);