refactor!: remove json property attributes (#100)

Author: peterdeme

.github/workflows/ci.yaml

@@ -12,6 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     env:
       DOTNET_CLI_TELEMETRY_OPTOUT: "true"
+      DOTNET_SKIP_FIRST_TIME_EXPERIENCE: "true"
     steps:
       - uses: actions/checkout@v2
         with:
@@ -20,7 +21,7 @@ jobs:
       - uses: wagoid/commitlint-github-action@v4
 
       - name: Setup dotnet
-        uses: actions/setup-dotnet@v1
+        uses: actions/setup-dotnet@v2
         with:
           dotnet-version: 6.0.x
 

.github/workflows/release.yaml

@@ -13,6 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     env:
       DOTNET_CLI_TELEMETRY_OPTOUT: "true"
+      DOTNET_SKIP_FIRST_TIME_EXPERIENCE: "true"
     steps:
       - uses: actions/checkout@v2
         with:
@@ -30,7 +31,7 @@ jobs:
             core.exportVariable('VERSION', version)
   
       - name: Setup dotnet
-        uses: actions/setup-dotnet@v1
+        uses: actions/setup-dotnet@v2
         with:
           dotnet-version: "6.0.x"
 

.github/workflows/reviewdog.yml

@@ -16,7 +16,7 @@ jobs:
       - uses: reviewdog/action-setup@v1
 
       - name: Setup dotnet
-        uses: actions/setup-dotnet@v1
+        uses: actions/setup-dotnet@v2
         with:
           dotnet-version: 6.0.x
 

README.md

@@ -178,7 +178,7 @@ messageClient.SendMessageAsync(channel.Type, channel.Id, bob.Id, "Hey, I'm Bob!"
 
 // With custom data
 var msgReq = new MessageRequest { Text = "Hi june!" };
-msgReq.SetData('location', 'amsterdam');
+msgReq.SetData("location", "amsterdam");
 
 var bobMessageResp = await messageClient.SendMessageAsync(channelType, channel.Id, msgReq, bob.Id);
 
@@ -242,7 +242,7 @@ var junePhone = new Device
 {
     ID = "iOS Device Token",
     PushProvider = PushProvider.APN,
-    UserID = june.ID
+    UserId = june.ID
 };
 
 await deviceClient.AddDeviceAsync(junePhone);
@@ -268,14 +268,15 @@ while (!complete && iterations < 1000)
     if (resp.Status == AsyncTaskStatus.Completed)
     {
         complete = true;
+        break;
     }
     iterations++;
     await Task.Delay(100);
 }
 
 if (complete)
 {
-    Console.WriteLine(resp.Result.URL);
+    Console.WriteLine(resp.Result["url"]);
 }
 ```
 

src/Clients/AppClient.cs

@@ -71,7 +71,7 @@ public bool VerifyWebhook(string requestBody, string xSignature)
             using (var sha = new HMACSHA256(Encoding.UTF8.GetBytes(_apiSecret)))
             {
                 var sigBytes = sha.ComputeHash(Encoding.UTF8.GetBytes(requestBody));
-                var sig = BitConverter.ToString(sigBytes).Replace("-", string.Empty).ToLower();
+                var sig = BitConverter.ToString(sigBytes).Replace("-", string.Empty).ToLowerInvariant();
                 return sig == xSignature;
             }
         }

src/Clients/ChannelClient.Crud.cs

@@ -16,7 +16,7 @@ public async Task<ChannelGetResponse> GetOrCreateAsync(string channelType, strin
                     Data = new ChannelRequest
                     {
                         CreatedBy = new UserRequest { Id = createdBy },
-                        Members = members.Select(x => new ChannelMember { UserID = x }),
+                        Members = members.Select(x => new ChannelMember { UserId = x }),
                     },
                 });
 

src/Clients/ClientBase.cs

@@ -3,10 +3,10 @@
 using System.Net;
 using System.Net.Http;
 using System.Threading.Tasks;
-using Newtonsoft.Json;
 using StreamChat.Exceptions;
 using StreamChat.Models;
 using StreamChat.Rest;
+using StreamChat.Utils;
 using HttpMethod = StreamChat.Rest.HttpMethod;
 
 namespace StreamChat.Clients
@@ -38,7 +38,7 @@ protected async Task<T> ExecuteRequestAsync<T>(
 
                 try
                 {
-                    deserialized = JsonConvert.DeserializeObject<T>(resp.Content);
+                    deserialized = StreamJsonConverter.DeserializeObject<T>(resp.Content);
                 }
                 catch (Exception ex)
                 {

src/Clients/CommandClient.cs

@@ -1,4 +1,3 @@
-using System.Collections.Generic;
 using System.Net;
 using System.Threading.Tasks;
 using StreamChat.Models;

src/Clients/JwtGeneratorClient.cs

@@ -34,7 +34,7 @@ public string GenerateJwt(object payload, string apiSecret)
                 segments.Add(Base64UrlEncode(signature));
             }
 
-            return string.Join(".", segments.ToArray());
+            return string.Join(".", segments);
         }
 
         private static string Base64UrlEncode(byte[] input)

src/Clients/MessageClient.cs

@@ -3,9 +3,9 @@
 using System.Net;
 using System.Net.Http;
 using System.Threading.Tasks;
-using Newtonsoft.Json;
 using StreamChat.Models;
 using StreamChat.Rest;
+using StreamChat.Utils;
 using HttpMethod = StreamChat.Rest.HttpMethod;
 
 namespace StreamChat.Clients
@@ -135,7 +135,7 @@ public async Task<FileUrlResponse> UploadFileAsync(string channelType, string ch
         {
             var body = new MultipartFormDataContent();
             body.Add(new ByteArrayContent(file), "file", fileName);
-            body.Add(new StringContent(JsonConvert.SerializeObject(user)), "user");
+            body.Add(new StringContent(StreamJsonConverter.SerializeObject(user)), "user");
 
             return await ExecuteRequestAsync<FileUrlResponse>($"channels/{channelType}/{channelId}/file",
                 HttpMethod.POST,
@@ -164,11 +164,11 @@ public async Task<FileUrlResponse> UploadImageAsync(string channelType,
         {
             var body = new MultipartFormDataContent();
             body.Add(new ByteArrayContent(file), "file", fileName);
-            body.Add(new StringContent(JsonConvert.SerializeObject(user)), "user");
+            body.Add(new StringContent(StreamJsonConverter.SerializeObject(user)), "user");
 
             if (uploadSizes != null)
             {
-                body.Add(new StringContent(JsonConvert.SerializeObject(uploadSizes)), "upload_sizes");
+                body.Add(new StringContent(StreamJsonConverter.SerializeObject(uploadSizes)), "upload_sizes");
             }
 
             return await ExecuteRequestAsync<FileUrlResponse>($"channels/{channelType}/{channelId}/image",

src/Clients/StreamClientFactory.cs

@@ -29,7 +29,7 @@ public class StreamClientFactory : IStreamClientFactory
         /// Initializes a new instance of the <see cref="StreamClientFactory"/> class.
         /// This constructor uses STREAM_KEY and STREAM_SECRET environment
         /// variables to initialize the client.
-        /// If they don't exist, it'll throw an <see cref="ArgumentNullException"/>.
+        /// If they don't exist, <see cref="ArgumentNullException"/> will be thrown.
         /// </summary>
         /// <exception cref="ArgumentNullException">If API key or API secret is null.</exception>
         public StreamClientFactory() : this(null, null, null)
@@ -67,11 +67,12 @@ public StreamClientFactory(string apiKey, string apiSecret, Action<ClientOptions
             var opts = new ClientOptions();
             opts.OverrideWithEnvVars();
             clientOptionsConfigurer?.Invoke(opts);
+            opts.EnsureValid();
 
             var jwtGeneratorClient = new JwtGeneratorClient();
             var generatedJwt = jwtGeneratorClient.GenerateServerSideJwt(apiSecret);
             var assemblyVersion = typeof(StreamClientFactory).GetTypeInfo().Assembly.GetName().Version;
-            var sdkVersion = string.Join(".", assemblyVersion.Major, assemblyVersion.Minor, assemblyVersion.Build);
+            var sdkVersion = assemblyVersion.ToString(3);
             var restClient = new RestClient(opts, generatedJwt, apiKey, sdkVersion);
 
             _appClient = new AppClient(restClient, apiSecret);
@@ -90,29 +91,17 @@ public StreamClientFactory(string apiKey, string apiSecret, Action<ClientOptions
         }
 
         public IAppClient GetAppClient() => _appClient;
-
         public IBlocklistClient GetBlocklistClient() => _blocklistClient;
-
         public IChannelClient GetChannelClient() => _channelClient;
-
         public IChannelTypeClient GetChannelTypeClient() => _channelTypeClient;
-
         public ICommandClient GetCommandClient() => _commandClient;
-
         public IDeviceClient GetDeviceClient() => _deviceClient;
-
         public IEventClient GetEventClient() => _eventClient;
-
         public IFlagClient GetFlagClient() => _flagClient;
-
         public IMessageClient GetMessageClient() => _messageClient;
-
         public IPermissionClient GetPermissionClient() => _permissionClient;
-
         public IReactionClient GetReactionClient() => _reactionClient;
-
         public ITaskClient GetTaskClient() => _taskClient;
-
         public IUserClient GetUserClient() => _userClient;
     }
 }

src/Clients/UserClient.cs

@@ -3,9 +3,9 @@
 using System.Linq;
 using System.Net;
 using System.Threading.Tasks;
-using Newtonsoft.Json;
 using StreamChat.Models;
 using StreamChat.Rest;
+using StreamChat.Utils;
 
 namespace StreamChat.Clients
 {
@@ -202,7 +202,7 @@ public async Task<QueryUsersResponse> QueryAsync(QueryUserOptions opts)
                 HttpStatusCode.OK,
                 queryParams: new List<KeyValuePair<string, string>>
                 {
-                    new KeyValuePair<string, string>("payload", JsonConvert.SerializeObject(payload)),
+                    new KeyValuePair<string, string>("payload", StreamJsonConverter.SerializeObject(payload)),
                 });
         }
     }

src/Exceptions/InvalidClientOptionsException.cs

@@ -0,0 +1,12 @@
+namespace StreamChat.Exceptions
+{
+    /// <summary>
+    /// Thrown when invalid ClientOptions are provided.
+    /// </summary>
+    public class InvalidClientOptionsException : StreamBaseException
+    {
+        internal InvalidClientOptionsException(string message) : base(message)
+        {
+        }
+    }
+}

src/Exceptions/StreamChatException.cs

@@ -1,9 +1,8 @@
-using System;
 using System.Collections.Generic;
 using System.Net;
-using Newtonsoft.Json;
 using StreamChat.Models;
 using StreamChat.Rest;
+using StreamChat.Utils;
 
 namespace StreamChat.Exceptions
 {
@@ -42,7 +41,7 @@ internal static StreamChatException FromResponse(RestResponse response)
 
             if (!string.IsNullOrWhiteSpace(response.Content))
             {
-                resp = JsonConvert.DeserializeObject<ExceptionResponse>(response.Content);
+                resp = StreamJsonConverter.DeserializeObject<ExceptionResponse>(response.Content);
                 resp.HttpStatusCode = response.StatusCode;
             }
 
@@ -58,17 +57,10 @@ internal static StreamChatException FromResponse(RestResponse response)
     internal class ExceptionResponse
     {
         public int Code { get; set; }
-
         public string Message { get; set; }
-
-        [JsonProperty("exception_fields")]
         public Dictionary<string, string> ExceptionFields { get; set; }
-
-        [JsonProperty("more_info")]
         public string MoreInfo { get; set; }
-
         public HttpStatusCode HttpStatusCode { get; set; }
-
         public RateLimitsInfo RateLimit { get; set; }
     }
 }

src/Models/ApiResponse.cs

@@ -35,14 +35,9 @@ public RateLimitsInfo GetRateLimit()
         /// </summary>
         public bool TryGetRateLimit(out RateLimitsInfo rateLimits)
         {
-            if (_rateLimits == null)
-            {
-                rateLimits = null;
-                return false;
-            }
-
             rateLimits = _rateLimits;
-            return true;
+
+            return rateLimits != null;
         }
     }