Merge branch 'master' into feature/#1663_AddPaginationHandlingToMisce…

…llaneousClients

.travis.yml

@@ -5,10 +5,10 @@ matrix:
     - os: linux
       dist: trusty
       sudo: required
-      dotnet: 1.0.1
+      dotnet: 1.0.4
     - os: osx
       osx_image: xcode8
-      dotnet: 1.0.1
+      dotnet: 1.0.4
 
 before_script:
   - if test "$TRAVIS_OS_NAME" == "osx"; then export FrameworkPathOverride=/Library/Frameworks/Mono.framework/Versions/Current/lib/mono/4.5/; else export FrameworkPathOverride=/usr/lib/mono/4.5/; fi

Octokit.Reactive/Clients/IObservableReferencesClient.cs

@@ -50,6 +50,18 @@ public interface IObservableReferencesClient
         /// <returns></returns>
         IObservable<Reference> GetAll(string owner, string name);
 
+        /// <summary>
+        /// Gets all references for a given repository
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/git/refs/#get-all-references
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns></returns>
+        IObservable<Reference> GetAll(string owner, string name, ApiOptions options);
+
         /// <summary>
         /// Gets all references for a given repository
         /// </summary>
@@ -60,6 +72,17 @@ public interface IObservableReferencesClient
         /// <returns></returns>
         IObservable<Reference> GetAll(long repositoryId);
 
+        /// <summary>
+        /// Gets all references for a given repository
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/git/refs/#get-all-references
+        /// </remarks>
+        /// <param name="repositoryId">The Id of the repository</param>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns></returns>
+        IObservable<Reference> GetAll(long repositoryId, ApiOptions options);
+
         /// <summary>
         /// Gets references for a given repository by sub-namespace, i.e. "tags" or "heads"
         /// </summary>
@@ -72,6 +95,19 @@ public interface IObservableReferencesClient
         /// <returns></returns>
         IObservable<Reference> GetAllForSubNamespace(string owner, string name, string subNamespace);
 
+        /// <summary>
+        /// Gets references for a given repository by sub-namespace, i.e. "tags" or "heads"
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/git/refs/#get-all-references
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="subNamespace">The sub-namespace to get references for</param>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns></returns>
+        IObservable<Reference> GetAllForSubNamespace(string owner, string name, string subNamespace, ApiOptions options);
+
         /// <summary>
         /// Gets references for a given repository by sub-namespace, i.e. "tags" or "heads"
         /// </summary>
@@ -83,6 +119,18 @@ public interface IObservableReferencesClient
         /// <returns></returns>
         IObservable<Reference> GetAllForSubNamespace(long repositoryId, string subNamespace);
 
+        /// <summary>
+        /// Gets references for a given repository by sub-namespace, i.e. "tags" or "heads"
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/git/refs/#get-all-references
+        /// </remarks>
+        /// <param name="repositoryId">The Id of the repository</param>
+        /// <param name="subNamespace">The sub-namespace to get references for</param>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns></returns>
+        IObservable<Reference> GetAllForSubNamespace(long repositoryId, string subNamespace, ApiOptions options);
+
         /// <summary>
         /// Creates a reference for a given repository
         /// </summary>

Octokit.Reactive/Clients/IObservableRepositoryInvitationsClient.cs

@@ -43,6 +43,16 @@ public interface IObservableRepositoryInvitationsClient
         [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
         IObservable<RepositoryInvitation> GetAllForCurrent();
 
+        /// <summary>
+        /// Gets all invitations for the current user.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="options">Options for changing the API response</param>        
+        [SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
+        IObservable<RepositoryInvitation> GetAllForCurrent(ApiOptions options);
+
         /// <summary>
         /// Gets all the invitations on a repository.
         /// </summary>
@@ -52,6 +62,16 @@ public interface IObservableRepositoryInvitationsClient
         /// <param name="repositoryId">The id of the repository</param>         
         IObservable<RepositoryInvitation> GetAllForRepository(long repositoryId);
 
+        /// <summary>
+        /// Gets all the invitations on a repository.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository">API documentation</a> for more information.
+        /// </remarks>        
+        /// <param name="repositoryId">The id of the repository</param>
+        /// /// <param name="options">Options for changing the API response</param>        
+        IObservable<RepositoryInvitation> GetAllForRepository(long repositoryId, ApiOptions options);
+
         /// <summary>
         /// Updates a repository invitation.
         /// </summary>

Octokit.Reactive/Clients/ObservableReferencesClient.cs

@@ -69,11 +69,27 @@ public IObservable<Reference> Get(long repositoryId, string reference)
         /// <param name="name">The name of the repository</param>
         /// <returns></returns>
         public IObservable<Reference> GetAll(string owner, string name)
+        {
+            return GetAll(owner, name, ApiOptions.None);
+        }
+
+        /// <summary>
+        /// Gets all references for a given repository
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/git/refs/#get-all-references
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns></returns>
+        public IObservable<Reference> GetAll(string owner, string name, ApiOptions options)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
             Ensure.ArgumentNotNullOrEmptyString(name, "name");
+            Ensure.ArgumentNotNull(options, "options");
 
-            return _connection.GetAndFlattenAllPages<Reference>(ApiUrls.Reference(owner, name));
+            return _connection.GetAndFlattenAllPages<Reference>(ApiUrls.Reference(owner, name), options);
         }
 
         /// <summary>
@@ -86,7 +102,23 @@ public IObservable<Reference> GetAll(string owner, string name)
         /// <returns></returns>
         public IObservable<Reference> GetAll(long repositoryId)
         {
-            return _connection.GetAndFlattenAllPages<Reference>(ApiUrls.Reference(repositoryId));
+            return GetAll(repositoryId, ApiOptions.None);
+        }
+
+        /// <summary>
+        /// Gets all references for a given repository
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/git/refs/#get-all-references
+        /// </remarks>
+        /// <param name="repositoryId">The Id of the repository</param>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns></returns>
+        public IObservable<Reference> GetAll(long repositoryId, ApiOptions options)
+        {
+            Ensure.ArgumentNotNull(options, "options");
+
+            return _connection.GetAndFlattenAllPages<Reference>(ApiUrls.Reference(repositoryId), options);
         }
 
         /// <summary>
@@ -100,12 +132,29 @@ public IObservable<Reference> GetAll(long repositoryId)
         /// <param name="subNamespace">The sub-namespace to get references for</param>
         /// <returns></returns>
         public IObservable<Reference> GetAllForSubNamespace(string owner, string name, string subNamespace)
+        {
+            return GetAllForSubNamespace(owner, name, subNamespace, ApiOptions.None);
+        }
+
+        /// <summary>
+        /// Gets references for a given repository by sub-namespace, i.e. "tags" or "heads"
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/git/refs/#get-all-references
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <param name="subNamespace">The sub-namespace to get references for</param>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns></returns>
+        public IObservable<Reference> GetAllForSubNamespace(string owner, string name, string subNamespace, ApiOptions options)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
             Ensure.ArgumentNotNullOrEmptyString(name, "name");
             Ensure.ArgumentNotNullOrEmptyString(subNamespace, "subNamespace");
+            Ensure.ArgumentNotNull(options, "options");
 
-            return _connection.GetAndFlattenAllPages<Reference>(ApiUrls.Reference(owner, name, subNamespace));
+            return _connection.GetAndFlattenAllPages<Reference>(ApiUrls.Reference(owner, name, subNamespace), options);
         }
 
         /// <summary>
@@ -118,10 +167,26 @@ public IObservable<Reference> GetAllForSubNamespace(string owner, string name, s
         /// <param name="subNamespace">The sub-namespace to get references for</param>
         /// <returns></returns>
         public IObservable<Reference> GetAllForSubNamespace(long repositoryId, string subNamespace)
+        {
+            return GetAllForSubNamespace(repositoryId, subNamespace, ApiOptions.None);
+        }
+
+        /// <summary>
+        /// Gets references for a given repository by sub-namespace, i.e. "tags" or "heads"
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/git/refs/#get-all-references
+        /// </remarks>
+        /// <param name="repositoryId">The Id of the repository</param>
+        /// <param name="subNamespace">The sub-namespace to get references for</param>
+        /// <param name="options">Options for changing the API response</param>
+        /// <returns></returns>
+        public IObservable<Reference> GetAllForSubNamespace(long repositoryId, string subNamespace, ApiOptions options)
         {
             Ensure.ArgumentNotNullOrEmptyString(subNamespace, "subNamespace");
+            Ensure.ArgumentNotNull(options, "options");
 
-            return _connection.GetAndFlattenAllPages<Reference>(ApiUrls.Reference(repositoryId, subNamespace));
+            return _connection.GetAndFlattenAllPages<Reference>(ApiUrls.Reference(repositoryId, subNamespace), options);
         }
 
         /// <summary>

Octokit.Reactive/Clients/ObservableRepositoryInvitationsClient.cs

@@ -80,7 +80,20 @@ public IObservable<RepositoryInvitation> Edit(long repositoryId, int invitationI
         /// </remarks>        
         public IObservable<RepositoryInvitation> GetAllForCurrent()
         {
-            return _connection.GetAndFlattenAllPages<RepositoryInvitation>(ApiUrls.UserInvitations(), null, AcceptHeaders.InvitationsApiPreview, ApiOptions.None);
+            return GetAllForCurrent(ApiOptions.None);
+        }
+
+        /// <summary>
+        /// Gets all invitations for the current user.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations">API documentation</a> for more information.
+        /// </remarks>
+        /// <param name="options">Options for changing the API response</param>        
+        public IObservable<RepositoryInvitation> GetAllForCurrent(ApiOptions options)
+        {
+            Ensure.ArgumentNotNull(options, "options");
+            return _connection.GetAndFlattenAllPages<RepositoryInvitation>(ApiUrls.UserInvitations(), null, AcceptHeaders.InvitationsApiPreview, options);
         }
 
         /// <summary>
@@ -92,7 +105,21 @@ public IObservable<RepositoryInvitation> GetAllForCurrent()
         /// <param name="repositoryId">The id of the repository</param>  
         public IObservable<RepositoryInvitation> GetAllForRepository(long repositoryId)
         {
-            return _connection.GetAndFlattenAllPages<RepositoryInvitation>(ApiUrls.RepositoryInvitations(repositoryId), null, AcceptHeaders.InvitationsApiPreview, ApiOptions.None);
+            return GetAllForRepository(repositoryId, ApiOptions.None);
+        }
+
+        /// <summary>
+        /// Gets all the invitations on a repository.
+        /// </summary>
+        /// <remarks>
+        /// See the <a href="https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository">API documentation</a> for more information.
+        /// </remarks>        
+        /// <param name="repositoryId">The id of the repository</param>
+        /// <param name="options">Options for changing the API response</param>
+        public IObservable<RepositoryInvitation> GetAllForRepository(long repositoryId, ApiOptions options)
+        {
+            Ensure.ArgumentNotNull(options, "options");
+            return _connection.GetAndFlattenAllPages<RepositoryInvitation>(ApiUrls.RepositoryInvitations(repositoryId), null, AcceptHeaders.InvitationsApiPreview, options);
         }
     }
 }

Octokit.Reactive/Octokit.Reactive.csproj

@@ -7,6 +7,7 @@
     <Version>0.0.0-dev</Version>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <TargetFrameworks>netstandard1.1;net45</TargetFrameworks>
+    <NetStandardImplicitPackageVersion>1.6.0</NetStandardImplicitPackageVersion>
     <AssemblyName>Octokit.Reactive</AssemblyName>
     <PackageId>Octokit.Reactive</PackageId>
     <DebugType>embedded</DebugType>