nullable ref types, installation model updates

octokit · Sep 20, 2023 · f42cc88 · f42cc88
1 parent 1ba2289
commit f42cc88
Show file tree

Hide file tree

Showing 3 changed files with 171 additions and 3 deletions.
diff --git a/Octokit.Tests/Models/InstallationTests.cs b/Octokit.Tests/Models/InstallationTests.cs
@@ -0,0 +1,165 @@
+using System.Collections.Generic;
+using System.Linq;
+using Octokit.Internal;
+using Xunit;
+
+namespace Octokit.Tests.Models
+{
+  public class InstallationResponseTests
+  {
+    [Fact]
+    public void CanBeDeserialized()
+    {
+      const string json = @"[
+  {
+    ""id"": 1,
+    ""account"": {
+      ""login"": ""octocat"",
+      ""id"": 1,
+      ""node_id"": ""MDQ6VXNlcjE="",
+      ""avatar_url"": ""https://github.com/images/error/octocat_happy.gif"",
+      ""gravatar_id"": """",
+      ""url"": ""https://api.github.com/users/octocat"",
+      ""html_url"": ""https://github.com/octocat"",
+      ""followers_url"": ""https://api.github.com/users/octocat/followers"",
+      ""following_url"": ""https://api.github.com/users/octocat/following{/other_user}"",
+      ""gists_url"": ""https://api.github.com/users/octocat/gists{/gist_id}"",
+      ""starred_url"": ""https://api.github.com/users/octocat/starred{/owner}{/repo}"",
+      ""subscriptions_url"": ""https://api.github.com/users/octocat/subscriptions"",
+      ""organizations_url"": ""https://api.github.com/users/octocat/orgs"",
+      ""repos_url"": ""https://api.github.com/users/octocat/repos"",
+      ""events_url"": ""https://api.github.com/users/octocat/events{/privacy}"",
+      ""received_events_url"": ""https://api.github.com/users/octocat/received_events"",
+      ""type"": ""User"",
+      ""site_admin"": false
+    },
+    ""access_tokens_url"": ""https://api.github.com/app/installations/1/access_tokens"",
+    ""repositories_url"": ""https://api.github.com/installation/repositories"",
+    ""html_url"": ""https://github.com/organizations/github/settings/installations/1"",
+    ""app_id"": 1,
+    ""target_id"": 1,
+    ""target_type"": ""Organization"",
+    ""permissions"": {
+      ""checks"": ""write"",
+      ""metadata"": ""read"",
+      ""contents"": ""read""
+    },
+    ""events"": [
+      ""push"",
+      ""pull_request""
+    ],
+    ""single_file_name"": ""config.yaml"",
+    ""has_multiple_single_files"": true,
+    ""single_file_paths"": [
+      ""config.yml"",
+      "".github/issue_TEMPLATE.md""
+    ],
+    ""repository_selection"": ""selected"",
+    ""created_at"": ""2017-07-08T16:18:44-04:00"",
+    ""updated_at"": ""2017-07-08T16:18:44-04:00"",
+    ""app_slug"": ""github-actions"",
+    ""suspended_at"": null,
+    ""suspended_by"": null
+  }
+]";
+
+      var serializer = new SimpleJsonSerializer();
+
+      var installations = serializer.Deserialize<IReadOnlyList<Installation>>(json);
+
+      Assert.NotNull(installations);
+      Assert.NotEmpty(installations);
+      Assert.Equal(1, installations.Count);
+      Assert.Null(installations.First().SuspendedAt);
+      Assert.Null(installations.First().SuspendedBy);
+
+    }
+
+    [Fact]
+    public void CanBeDeserializedWithSuspendedAtValues()
+    {
+      const string json = @"[
+  {
+    ""id"": 1,
+    ""account"": {
+      ""login"": ""octocat"",
+      ""id"": 1,
+      ""node_id"": ""MDQ6VXNlcjE="",
+      ""avatar_url"": ""https://github.com/images/error/octocat_happy.gif"",
+      ""gravatar_id"": """",
+      ""url"": ""https://api.github.com/users/octocat"",
+      ""html_url"": ""https://github.com/octocat"",
+      ""followers_url"": ""https://api.github.com/users/octocat/followers"",
+      ""following_url"": ""https://api.github.com/users/octocat/following{/other_user}"",
+      ""gists_url"": ""https://api.github.com/users/octocat/gists{/gist_id}"",
+      ""starred_url"": ""https://api.github.com/users/octocat/starred{/owner}{/repo}"",
+      ""subscriptions_url"": ""https://api.github.com/users/octocat/subscriptions"",
+      ""organizations_url"": ""https://api.github.com/users/octocat/orgs"",
+      ""repos_url"": ""https://api.github.com/users/octocat/repos"",
+      ""events_url"": ""https://api.github.com/users/octocat/events{/privacy}"",
+      ""received_events_url"": ""https://api.github.com/users/octocat/received_events"",
+      ""type"": ""User"",
+      ""site_admin"": false
+    },
+    ""access_tokens_url"": ""https://api.github.com/app/installations/1/access_tokens"",
+    ""repositories_url"": ""https://api.github.com/installation/repositories"",
+    ""html_url"": ""https://github.com/organizations/github/settings/installations/1"",
+    ""app_id"": 1,
+    ""target_id"": 1,
+    ""target_type"": ""Organization"",
+    ""permissions"": {
+      ""checks"": ""write"",
+      ""metadata"": ""read"",
+      ""contents"": ""read""
+    },
+    ""events"": [
+      ""push"",
+      ""pull_request""
+    ],
+    ""single_file_name"": ""config.yaml"",
+    ""has_multiple_single_files"": true,
+    ""single_file_paths"": [
+      ""config.yml"",
+      "".github/issue_TEMPLATE.md""
+    ],
+    ""repository_selection"": ""selected"",
+    ""created_at"": ""2017-07-08T16:18:44-04:00"",
+    ""updated_at"": ""2017-07-08T16:18:44-04:00"",
+    ""app_slug"": ""github-actions"",
+    ""suspended_at"": ""2017-07-08T16:18:44-04:00"",
+    ""suspended_by"": {
+      ""login"": ""octocat"",
+      ""id"": 1,
+      ""node_id"": ""MDQ6VXNlcjE="",
+      ""avatar_url"": ""https://github.com/images/error/octocat_happy.gif"",
+      ""gravatar_id"": """",
+      ""url"": ""https://api.github.com/users/octocat"",
+      ""html_url"": ""https://github.com/octocat"",
+      ""followers_url"": ""https://api.github.com/users/octocat/followers"",
+      ""following_url"": ""https://api.github.com/users/octocat/following{/other_user}"",
+      ""gists_url"": ""https://api.github.com/users/octocat/gists{/gist_id}"",
+      ""starred_url"": ""https://api.github.com/users/octocat/starred{/owner}{/repo}"",
+      ""subscriptions_url"": ""https://api.github.com/users/octocat/subscriptions"",
+      ""organizations_url"": ""https://api.github.com/users/octocat/orgs"",
+      ""repos_url"": ""https://api.github.com/users/octocat/repos"",
+      ""events_url"": ""https://api.github.com/users/octocat/events{/privacy}"",
+      ""received_events_url"": ""https://api.github.com/users/octocat/received_events"",
+      ""type"": ""User"",
+      ""site_admin"": false
+    }
+  }
+]";
+
+      var serializer = new SimpleJsonSerializer();
+
+      var installations = serializer.Deserialize<IReadOnlyList<Installation>>(json);
+
+      Assert.NotNull(installations);
+      Assert.NotEmpty(installations);
+      Assert.Equal(1, installations.Count);
+      Assert.NotNull(installations.First().SuspendedAt);
+      Assert.NotNull(installations.First().SuspendedBy);
+
+    }
+  }
+}
diff --git a/Octokit/Models/Response/Installation.cs b/Octokit/Models/Response/Installation.cs
@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.Globalization;
 using Octokit.Internal;
@@ -16,7 +17,7 @@ public class Installation : InstallationId
     {
         public Installation() { }
 
-        public Installation(long id, User account, string accessTokensUrl, string repositoriesUrl, string htmlUrl, long appId, long targetId, AccountType targetType, InstallationPermissions permissions, IReadOnlyList<string> events, string singleFileName, string repositorySelection, User suspendedBy, DateTimeOffset? suspendedAt) : base(id)
+        public Installation(long id, User account, string accessTokensUrl, string repositoriesUrl, string htmlUrl, long appId, long targetId, AccountType targetType, InstallationPermissions permissions, IReadOnlyList<string> events, string singleFileName, string repositorySelection, User? suspendedBy, DateTimeOffset? suspendedAt) : base(id)
         {
             Account = account;
             AccessTokensUrl = accessTokensUrl;
@@ -85,7 +86,7 @@ public Installation(long id, User account, string accessTokensUrl, string reposi
         /// <summary>
         /// The user who suspended the Installation. Can be null if the Installation is not suspended.
         /// </summary>
-        public User SuspendedBy { get; private set; }
+        public User? SuspendedBy { get; private set; }
 
         /// <summary>
         /// The date the Installation was suspended. Can be null if the Installation is not suspended.

diff --git a/Octokit/Octokit.csproj b/Octokit/Octokit.csproj
@@ -17,6 +17,8 @@
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<PackageTags>GitHub API Octokit linqpad-samples dotnetcore</PackageTags>
 		<Copyright>Copyright GitHub 2017</Copyright>
+    <LangVersion>9</LangVersion>
+    <Nullable>enable</Nullable>
 	</PropertyGroup>
 
 	<PropertyGroup>