From 470d289fa331bf64f410b33ac19d7b17da9f1419 Mon Sep 17 00:00:00 2001
From: James R Sconfitto <jugglingnutcase@gmail.com>
Date: Wed, 13 Nov 2013 21:54:26 -0500
Subject: [PATCH] Add the observable starred client interface

---
 .../Clients/IObservableStarredClient.cs       | 73 +++++++++++++++++++
 Octokit.Reactive/Octokit.Reactive.csproj      |  1 +
 2 files changed, 74 insertions(+)
 create mode 100644 Octokit.Reactive/Clients/IObservableStarredClient.cs

diff --git a/Octokit.Reactive/Clients/IObservableStarredClient.cs b/Octokit.Reactive/Clients/IObservableStarredClient.cs
new file mode 100644
index 00000000..df4a269f
--- /dev/null
+++ b/Octokit.Reactive/Clients/IObservableStarredClient.cs
@@ -0,0 +1,73 @@
+using System;
+
+namespace Octokit.Reactive
+{
+    public interface IObservableStarredClient
+    {
+        /// <summary>
+        /// Retrieves all of the stargazers for the passed repository.
+        /// </summary>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
+        /// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/>.</returns>
+        IObservable<User> GetAllStargazers(string owner, string name);
+
+        /// <summary>
+        /// Retrieves all of the starred <see cref="Repository"/>(ies) for the current user.
+        /// </summary>
+        /// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
+        /// <returns>A <see cref="IObservable{Repository}"/> of <see cref="Repository"/>.</returns>
+        IObservable<Repository> GetAllForCurrent();
+
+        /// <summary>
+        /// Retrieves all of the starred <see cref="Repository"/>(ies) for the current user.
+        /// </summary>
+        /// <param name="request">Star-specific request parameters that sort the results</param>
+        /// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
+        /// <returns>A <see cref="IObservable{Repository}"/> of <see cref="Repository"/>.</returns>
+        IObservable<Repository> GetAllForCurrent(StarredRequest request);
+
+        /// <summary>
+        /// Retrieves all of the <see cref="Repository"/>(ies) starred by the specified user.
+        /// </summary>
+        /// <param name="user">The login of the user</param>
+        /// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
+        /// <returns>A <see cref="IObservable{Repository}"/> starred by the specified user.</returns>
+        IObservable<Repository> GetAllForUser(string user);
+
+        /// <summary>
+        /// Retrieves all of the <see cref="Repository"/>(ies) starred by the specified user.
+        /// </summary>
+        /// <param name="user">The login of the user</param>
+        /// <param name="request">Star-specific request parameters that sort the results</param>
+        /// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
+        /// <returns>A <see cref="IObservable{Repository}"/> starred by the specified user.</returns>
+        IObservable<Repository> GetAllForUser(string user, StarredRequest request);
+
+        /// <summary>
+        /// Check if a repository is starred by the current authenticated user.
+        /// </summary>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <exception cref="AuthorizationException">Thrown if the client is not authenticated.</exception>
+        /// <returns>A <c>bool</c> representing the success of the operation</returns>
+        IObservable<bool> CheckStarred(string owner, string name);
+
+        /// <summary>
+        /// Stars a repository for the authenticated user.
+        /// </summary>
+        /// <param name="owner">The owner of the repository to star</param>
+        /// <param name="name">The name of the repository to star</param>
+        /// <returns>A <c>bool</c> representing the success of starring</returns>
+        IObservable<bool> StarRepo(string owner, string name);
+
+        /// <summary>
+        /// Unstars a repository for the authenticated user.
+        /// </summary>
+        /// <param name="owner">The owner of the repository to unstar</param>
+        /// <param name="name">The name of the repository to unstar</param>
+        /// <returns>A <c>bool</c> representing the success of the operation</returns>
+        IObservable<bool> RemoveStarFromRepo(string owner, string name);
+    }
+}
diff --git a/Octokit.Reactive/Octokit.Reactive.csproj b/Octokit.Reactive/Octokit.Reactive.csproj
index 6561cf94..b9df22ed 100644
--- a/Octokit.Reactive/Octokit.Reactive.csproj
+++ b/Octokit.Reactive/Octokit.Reactive.csproj
@@ -76,6 +76,7 @@
     <Compile Include="Clients\ObservableOrganizationTeamsClient.cs" />
     <Compile Include="Clients\IObservableOrganizationTeamsClient.cs" />
     <Compile Include="Clients\IObservableCommitsClient.cs" />
+    <Compile Include="Clients\IObservableStarredClient.cs" />
     <Compile Include="Clients\ObservableCommitsClient.cs" />
     <Compile Include="Clients\IObservableEventsClient.cs" />
     <Compile Include="Clients\ObservableEventsClient.cs" />