Release v0.24 - A Sight For Sore Eyes (#1539)

* Add release notes and bump version to 0.24

* run "build FormatCode" to fix up whitespace/formatting issues

* Fix failing Ssh key tests due to "validation exception".  This key must be in use on github (under another user, most likely from these tests failing).  Changed to a new SSH key and tweaked tests to reduce chance of a key being created and not destroyed

* Assignee and Assignees cant both be specified on NewIssue.  We missed this one in the PR.  Marked Assignee as [Obsolete] and fixed tests to use Assignees

* Fix a couple of Reactions tests that were calling the wrong client methods

* Fix timeline tests - looks like the response class has changed shape a bit, it now has an Issue object in the payload and Id field isnt present (leaving Id field there in case other timeline events do use it)

* Fix some following tests that require the test user to follow more than 1 other user

* Unskip these Event tests now because apparently they work!

* add breaking changes notes

* Update ApiErrorMessageSafe to return null for empty and whitespace strings (#1540)

* return null if ApiError.Message is empty or whitespace

* Uncomment test, which now passes

* update release notes to include PR1540

* Add "Bot" AccountType, was causing a deserialization exception when running the integration test "SearchForExcludedLanguage" (#1541)

* Update to include PR1541

* add bullets to make release notes easier to read

* markup additional code mentions in notes

* Fix grammar

fields => field

Octokit.Reactive/Clients/IObservableCommitCommentReactionsClient.cs

@@ -40,7 +40,7 @@ public interface IObservableCommitCommentReactionsClient
         /// <param name="number">The comment id</param>        
         /// <returns></returns>
         IObservable<Reaction> GetAll(string owner, string name, int number);
-        
+
         /// <summary>
         /// List reactions for a specified Commit Comment
         /// </summary>

Octokit.Reactive/Clients/IObservableCommitStatusClient.cs

@@ -19,7 +19,7 @@ public interface IObservableCommitStatusClient
         /// <param name="name">The name of the repository</param>
         /// <param name="reference">The reference (SHA, branch name, or tag name) to list commits for</param>
         IObservable<CommitStatus> GetAll(string owner, string name, string reference);
-        
+
         /// <summary>
         /// Retrieves commit statuses for the specified reference. A reference can be a commit SHA, a branch name, or
         /// a tag name.

Octokit.Reactive/Clients/IObservableCommitsClient.cs

@@ -46,7 +46,7 @@ public interface IObservableCommitsClient
         /// <param name="name">The name of the repository</param>
         /// <param name="commit">The commit to create</param>
         IObservable<Commit> Create(string owner, string name, NewCommit commit);
-        
+
         /// <summary>
         /// Create a commit for a given repository
         /// </summary>

Octokit.Reactive/Clients/IObservableDeploymentsClient.cs

@@ -21,7 +21,7 @@ public interface IObservableDeploymentsClient
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         IObservable<Deployment> GetAll(string owner, string name);
-        
+
         /// <summary>
         /// Gets all the deployments for the specified repository. Any user with pull access
         /// to a repository can view deployments.
@@ -43,7 +43,7 @@ public interface IObservableDeploymentsClient
         /// <param name="name">The name of the repository</param>
         /// <param name="options">Options for changing the API response</param>
         IObservable<Deployment> GetAll(string owner, string name, ApiOptions options);
-        
+
         /// <summary>
         /// Gets all the deployments for the specified repository. Any user with pull access
         /// to a repository can view deployments.

Octokit.Reactive/Clients/IObservableIssueTimelineClient.cs

@@ -32,7 +32,7 @@ public interface IObservableIssueTimelineClient
         /// <param name="number">The issue number</param>
         /// <param name="options">Options for changing the API response</param>
         IObservable<TimelineEventInfo> GetAllForIssue(string owner, string repo, int number, ApiOptions options);
-        
+
         /// <summary>
         /// Gets all the various events that have occurred around an issue or pull request.
         /// </summary>

Octokit.Reactive/Clients/IObservableIssuesEventsClient.cs

@@ -21,7 +21,7 @@ public interface IObservableIssuesEventsClient
         /// <param name="name">The name of the repository</param>
         /// <param name="number">The issue number</param>
         IObservable<EventInfo> GetAllForIssue(string owner, string name, int number);
-        
+
         /// <summary>
         /// Gets all events for the issue.
         /// </summary>

Octokit.Reactive/Clients/IObservableMilestonesClient.cs

@@ -22,7 +22,7 @@ public interface IObservableMilestonesClient
         [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
         Justification = "Method makes a network request")]
         IObservable<Milestone> Get(string owner, string name, int number);
-        
+
         /// <summary>
         /// Gets a single Milestone by number.
         /// </summary>
@@ -44,7 +44,7 @@ public interface IObservableMilestonesClient
         /// <param name="name">The name of the repository</param>
         /// <returns></returns>
         IObservable<Milestone> GetAllForRepository(string owner, string name);
-        
+
         /// <summary>
         /// Gets all open milestones for the repository.
         /// </summary>

Octokit.Reactive/Clients/IObservableOrganizationsClient.cs

@@ -55,7 +55,7 @@ public interface IObservableOrganizationsClient
         /// <param name="user">The login for the user</param>
         /// <param name="options">Options for changing the API response</param>
         /// <returns></returns>
-        [Obsolete("Please use IObservableOrganizationsClient.GetAllForUser() instead. This method will be removed in a future version")]  
+        [Obsolete("Please use IObservableOrganizationsClient.GetAllForUser() instead. This method will be removed in a future version")]
         IObservable<Organization> GetAll(string user, ApiOptions options);
 
         /// <summary>

Octokit.Reactive/Clients/IObservableReferencesClient.cs

@@ -25,7 +25,7 @@ public interface IObservableReferencesClient
         [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
             Justification = "Method makes a network request")]
         IObservable<Reference> Get(string owner, string name, string reference);
-        
+
         /// <summary>
         /// Gets a reference for a given repository by reference name
         /// </summary>

Octokit.Reactive/Clients/IObservableReleasesClient.cs

@@ -231,7 +231,7 @@ public interface IObservableReleasesClient
         /// <param name="data">Description of the asset with its data</param>
         /// <exception cref="ApiException">Thrown when a general API error occurs.</exception>
         IObservable<ReleaseAsset> UploadAsset(Release release, ReleaseAssetUpload data);
-        
+
         /// <summary>
         /// Gets the specified <see cref="ReleaseAsset"/> for the specified release of the specified repository.
         /// </summary>

Octokit.Reactive/Clients/IObservableRepositoryContentsClient.cs

@@ -36,7 +36,7 @@ public interface IObservableRepositoryContentsClient
         /// </summary>
         /// <param name="repositoryId">The Id of the repository</param>
         IObservable<string> GetReadmeHtml(long repositoryId);
-        
+
         /// <summary>
         /// Get an archive of a given repository's contents
         /// </summary>
@@ -167,7 +167,7 @@ public interface IObservableRepositoryContentsClient
         /// <param name="reference">The name of the commit/branch/tag. Default: the repository’s default branch (usually master)</param>
         /// <param name="path">The content path</param>
         IObservable<RepositoryContent> GetAllContentsByRef(long repositoryId, string reference, string path);
-        
+
         /// <summary>
         /// Returns the contents of the home directory in a repository.
         /// </summary>

Octokit.Reactive/Clients/IObservableRepositoryHooksClient.cs

@@ -35,7 +35,7 @@ public interface IObservableRepositoryHooksClient
         /// <param name="options">Options for changing the API response</param>
         /// <remarks>See <a href="http://developer.github.com/v3/repos/hooks/#list">API documentation</a> for more information.</remarks>
         IObservable<RepositoryHook> GetAll(string owner, string name, ApiOptions options);
-        
+
         /// <summary>
         /// Gets the list of hooks defined for a repository
         /// </summary>

Octokit.Reactive/Clients/IObservableStarredClient.cs

@@ -33,7 +33,7 @@ public interface IObservableStarredClient
         /// <param name="options">Options for changing the API response</param>
         /// <exception cref="AuthorizationException">Thrown if the client is not authenticated</exception>
         IObservable<User> GetAllStargazers(string owner, string name, ApiOptions options);
-        
+
         /// <summary>
         /// Retrieves all of the stargazers for the passed repository
         /// </summary>
@@ -49,7 +49,7 @@ public interface IObservableStarredClient
         /// <param name="name">The name of the repository</param>
         /// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
         IObservable<UserStar> GetAllStargazersWithTimestamps(string owner, string name);
-        
+
         /// <summary>
         /// Retrieves all of the stargazers for the passed repository with star creation timestamps.
         /// </summary>
@@ -79,7 +79,7 @@ public interface IObservableStarredClient
         /// </summary>
         /// <exception cref="AuthorizationException">Thrown if the client is not authenticated</exception>
         IObservable<Repository> GetAllForCurrent();
-        
+
         /// <summary>
         /// Retrieves all of the starred <see cref="Repository"/>(ies) for the current user
         /// </summary>
@@ -91,7 +91,7 @@ public interface IObservableStarredClient
         /// </summary>
         /// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
         IObservable<RepositoryStar> GetAllForCurrentWithTimestamps();
-        
+
         /// <summary>
         /// Retrieves all of the starred <see cref="Repository"/>(ies) for the current user with star creation timestamps.
         /// </summary>

Octokit.Reactive/Clients/ObservableCommitStatusClient.cs

@@ -37,7 +37,7 @@ public IObservable<CommitStatus> GetAll(string owner, string name, string refere
             Ensure.ArgumentNotNullOrEmptyString(name, "name");
             Ensure.ArgumentNotNullOrEmptyString(reference, "reference");
 
-            return GetAll(owner, name ,reference, ApiOptions.None);
+            return GetAll(owner, name, reference, ApiOptions.None);
         }
 
         /// <summary>
@@ -68,7 +68,7 @@ public IObservable<CommitStatus> GetAll(string owner, string name, string refere
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
             Ensure.ArgumentNotNullOrEmptyString(name, "name");
             Ensure.ArgumentNotNullOrEmptyString(reference, "reference");
-            Ensure.ArgumentNotNull(options, "options"); 
+            Ensure.ArgumentNotNull(options, "options");
 
             return _connection.GetAndFlattenAllPages<CommitStatus>(ApiUrls.CommitStatuses(owner, name, reference), options);
         }

Octokit.Reactive/Clients/ObservableEventsClient.cs

@@ -382,7 +382,7 @@ public IObservable<Activity> GetAllForAnOrganization(string user, string organiz
             Ensure.ArgumentNotNullOrEmptyString(organization, "organization");
             Ensure.ArgumentNotNull(options, "options");
 
-            return _connection.GetAndFlattenAllPages<Activity>(ApiUrls.OrganizationEvents(user, organization),options);            
+            return _connection.GetAndFlattenAllPages<Activity>(ApiUrls.OrganizationEvents(user, organization), options);
         }
     }
 }

Octokit.Reactive/Clients/ObservableGistCommentsClient.cs

@@ -38,7 +38,7 @@ public IObservable<GistComment> Get(string gistId, int commentId)
         /// <returns>IObservable{GistComment}.</returns>
         public IObservable<GistComment> GetAllForGist(string gistId)
         {
-            Ensure.ArgumentNotNullOrEmptyString(gistId, "gistId");             
+            Ensure.ArgumentNotNullOrEmptyString(gistId, "gistId");
 
             return GetAllForGist(gistId, ApiOptions.None);
         }

Octokit.Reactive/Clients/ObservableGistsClient.cs

@@ -111,7 +111,7 @@ public IObservable<Gist> GetAll(ApiOptions options)
         /// </remarks>
         /// <param name="since">Only gists updated at or after this time are returned</param>
         public IObservable<Gist> GetAll(DateTimeOffset since)
-        {            
+        {
             return GetAll(since, ApiOptions.None);
         }
 
@@ -179,7 +179,7 @@ public IObservable<Gist> GetAllPublic(DateTimeOffset since)
         /// <param name="options">Options for changing the API response</param>
         public IObservable<Gist> GetAllPublic(DateTimeOffset since, ApiOptions options)
         {
-            Ensure.ArgumentNotNull(options, "options"); 
+            Ensure.ArgumentNotNull(options, "options");
 
             var request = new GistRequest(since);
             return _connection.GetAndFlattenAllPages<Gist>(ApiUrls.PublicGists(), request.ToParametersDictionary(), options);

Octokit.Reactive/Clients/ObservableOrganizationsClient.cs

@@ -102,9 +102,9 @@ public IObservable<Organization> GetAll(string user, ApiOptions options)
         /// <returns></returns>
         public IObservable<Organization> GetAllForUser(string user)
         {
-          Ensure.ArgumentNotNullOrEmptyString(user, "user");
+            Ensure.ArgumentNotNullOrEmptyString(user, "user");
 
-          return _connection.GetAndFlattenAllPages<Organization>(ApiUrls.UserOrganizations(user));
+            return _connection.GetAndFlattenAllPages<Organization>(ApiUrls.UserOrganizations(user));
         }
 
         /// <summary>
@@ -115,10 +115,10 @@ public IObservable<Organization> GetAllForUser(string user)
         /// <returns></returns>
         public IObservable<Organization> GetAllForUser(string user, ApiOptions options)
         {
-          Ensure.ArgumentNotNullOrEmptyString(user, "user");
-          Ensure.ArgumentNotNull(options, "options");
+            Ensure.ArgumentNotNullOrEmptyString(user, "user");
+            Ensure.ArgumentNotNull(options, "options");
 
-          return _connection.GetAndFlattenAllPages<Organization>(ApiUrls.UserOrganizations(user), options);
+            return _connection.GetAndFlattenAllPages<Organization>(ApiUrls.UserOrganizations(user), options);
         }
 
         /// <summary>

Octokit.Reactive/Clients/ObservableRepositoryCommentsClient.cs

@@ -15,7 +15,7 @@ public class ObservableRepositoryCommentsClient : IObservableRepositoryCommentsC
     {
         readonly IRepositoryCommentsClient _client;
         readonly IConnection _connection;
-        
+
         public ObservableRepositoryCommentsClient(IGitHubClient client)
         {
             Ensure.ArgumentNotNull(client, "client");

Octokit.Reactive/Clients/ObservableRepositoryHooksClient.cs

@@ -15,7 +15,7 @@ public class ObservableRepositoryHooksClient : IObservableRepositoryHooksClient
     {
         readonly IRepositoryHooksClient _client;
         readonly IConnection _connection;
-        
+
         public ObservableRepositoryHooksClient(IGitHubClient client)
         {
             Ensure.ArgumentNotNull(client, "client");

Octokit.Tests.Conventions/ClientConstructorTests.cs

@@ -15,7 +15,7 @@ public void CheckTestConstructorNames(Type type)
             const string constructorTestMethodName = "EnsuresNonNullArguments";
 
             var classes = new HashSet<string>(type.GetNestedTypes().Select(t => t.Name));
-            
+
             if (!classes.Contains(constructorTestClassName))
             {
                 throw new MissingClientConstructorTestClassException(type);

Octokit.Tests.Conventions/Exception/ApiOptionsMissingException.cs

@@ -8,7 +8,8 @@ namespace Octokit.Tests.Conventions
     public class ApiOptionsMissingException : Exception
     {
         public ApiOptionsMissingException(Type type, IEnumerable<MethodInfo> methods)
-            : base(CreateMessage(type, methods)) { }
+            : base(CreateMessage(type, methods))
+        { }
 
         static string CreateMessage(Type type, IEnumerable<MethodInfo> methods)
         {

Octokit.Tests.Integration/Clients/AuthorizationClientTests.cs

@@ -30,7 +30,7 @@ public async Task CanCreatePersonalToken()
         public async Task CanGetAuthorization()
         {
             var github = Helper.GetBasicAuthClient();
-            
+
             var authorizations = await github.Authorization.GetAll();
             Assert.NotEmpty(authorizations);
         }

Octokit.Tests.Integration/Clients/DeploymentStatusClientTests.cs

@@ -162,7 +162,7 @@ public async Task ReturnsCorrectCountOfDeploymentStatusesWithStartWithRepository
         var newStatus1 = new NewDeploymentStatus(DeploymentState.Success);
         var newStatus2 = new NewDeploymentStatus(DeploymentState.Success);
         var newStatus3 = new NewDeploymentStatus(DeploymentState.Success);
-        await _deploymentsClient.Status.Create(_context.Repository.Id,_deployment.Id, newStatus1);
+        await _deploymentsClient.Status.Create(_context.Repository.Id, _deployment.Id, newStatus1);
         await _deploymentsClient.Status.Create(_context.Repository.Id, _deployment.Id, newStatus2);
         await _deploymentsClient.Status.Create(_context.Repository.Id, _deployment.Id, newStatus3);
 

Octokit.Tests.Integration/Clients/EventsClientTests.cs

@@ -109,7 +109,7 @@ public async Task ReturnsCorrectCountOfEventsWithStartWithRepositoryId()
             public async Task ReturnsDistinctEventsBasedOnStartPage()
             {
                 var github = Helper.GetAuthenticatedClient();
-                 
+
                 var startOptions = new ApiOptions
                 {
                     PageSize = 1,
@@ -134,7 +134,7 @@ public async Task ReturnsDistinctEventsBasedOnStartPage()
             public async Task ReturnsDistinctEventsBasedOnStartPageWithRepositoryId()
             {
                 var github = Helper.GetAuthenticatedClient();
-                 
+
                 var startOptions = new ApiOptions
                 {
                     PageSize = 1,
@@ -158,7 +158,7 @@ public async Task ReturnsDistinctEventsBasedOnStartPageWithRepositoryId()
 
         public class TheGetAllIssuesForRepositoryMethod
         {
-            [IntegrationTest(Skip = "Fails because of SimpleJsonSerializer, see https://github.com/octokit/octokit.net/issues/1374 for details.")]
+            [IntegrationTest]
             public async Task CanListIssues()
             {
                 var github = Helper.GetAuthenticatedClient();
@@ -167,7 +167,7 @@ public async Task CanListIssues()
                 Assert.NotEmpty(issues);
             }
 
-            [IntegrationTest(Skip = "Fails because of SimpleJsonSerializer, see https://github.com/octokit/octokit.net/issues/1374 for details.")]
+            [IntegrationTest]
             public async Task CanListIssuesWithRepositoryId()
             {
                 var github = Helper.GetAuthenticatedClient();
@@ -176,7 +176,7 @@ public async Task CanListIssuesWithRepositoryId()
                 Assert.NotEmpty(issues);
             }
 
-            [IntegrationTest(Skip = "Fails because of SimpleJsonSerializer, see https://github.com/octokit/octokit.net/issues/1374 for details.")]
+            [IntegrationTest]
             public async Task ReturnsCorrectCountOfEventsWithoutStart()
             {
                 var github = Helper.GetAuthenticatedClient();
@@ -192,7 +192,7 @@ public async Task ReturnsCorrectCountOfEventsWithoutStart()
                 Assert.Equal(3, eventInfos.Count);
             }
 
-            [IntegrationTest(Skip = "Fails because of SimpleJsonSerializer, see https://github.com/octokit/octokit.net/issues/1374 for details.")]
+            [IntegrationTest]
             public async Task ReturnsCorrectCountOfEventsWithoutStartWitRepositoryId()
             {
                 var github = Helper.GetAuthenticatedClient();
@@ -208,7 +208,7 @@ public async Task ReturnsCorrectCountOfEventsWithoutStartWitRepositoryId()
                 Assert.Equal(3, eventInfos.Count);
             }
 
-            [IntegrationTest(Skip = "Fails because of SimpleJsonSerializer, see https://github.com/octokit/octokit.net/issues/1374 for details.")]
+            [IntegrationTest]
             public async Task ReturnsCorrectCountOfEventsWithStart()
             {
                 var github = Helper.GetAuthenticatedClient();
@@ -225,7 +225,7 @@ public async Task ReturnsCorrectCountOfEventsWithStart()
                 Assert.Equal(2, eventInfos.Count);
             }
 
-            [IntegrationTest(Skip = "Fails because of SimpleJsonSerializer, see https://github.com/octokit/octokit.net/issues/1374 for details.")]
+            [IntegrationTest]
             public async Task ReturnsCorrectCountOfEventsWithStartWithRepositoryId()
             {
                 var github = Helper.GetAuthenticatedClient();
@@ -242,7 +242,7 @@ public async Task ReturnsCorrectCountOfEventsWithStartWithRepositoryId()
                 Assert.Equal(2, eventInfos.Count);
             }
 
-            [IntegrationTest(Skip = "Fails because of SimpleJsonSerializer, see https://github.com/octokit/octokit.net/issues/1374 for details.")]
+            [IntegrationTest]
             public async Task ReturnsDistinctEventsBasedOnStartPage()
             {
                 var github = Helper.GetAuthenticatedClient();
@@ -267,7 +267,7 @@ public async Task ReturnsDistinctEventsBasedOnStartPage()
                 Assert.NotEqual(firstPage[0].Id, secondPage[0].Id);
             }
 
-            [IntegrationTest(Skip = "Fails because of SimpleJsonSerializer, see https://github.com/octokit/octokit.net/issues/1374 for details.")]
+            [IntegrationTest]
             public async Task ReturnsDistinctEventsBasedOnStartPageWithRepositoryId()
             {
                 var github = Helper.GetAuthenticatedClient();