Merge pull request #1140 from prayankmathur/master

Added enum ItemStateFilter to differentiate between search and list APIs
octokit · Mar 29, 2016 · 6455001 · 6455001
2 parents 9e4435a + c51bb07
commit 6455001
Show file tree

Hide file tree

Showing 13 changed files with 45 additions and 27 deletions.
diff --git a/Octokit.Tests.Integration/Clients/IssuesClientTests.cs b/Octokit.Tests.Integration/Clients/IssuesClientTests.cs
@@ -121,7 +121,7 @@ await _issuesClient.Update(_context.RepositoryOwner, _context.RepositoryName, cl
             new IssueUpdate { State = ItemState.Closed });
 
         var issues = await _issuesClient.GetAllForRepository(_context.RepositoryOwner, _context.RepositoryName,
-            new RepositoryIssueRequest { State = ItemState.Closed });
+            new RepositoryIssueRequest { State = ItemStateFilter.Closed });
 
         Assert.Equal(1, issues.Count);
         Assert.Equal("A closed issue", issues[0].Title);
@@ -158,7 +158,7 @@ await _issuesClient.Update(_context.RepositoryOwner, _context.RepositoryName, is
         new IssueUpdate { State = ItemState.Closed });
 
         var retrieved = await _issuesClient.GetAllForRepository(_context.RepositoryOwner, _context.RepositoryName,
-            new RepositoryIssueRequest { State = ItemState.All });
+            new RepositoryIssueRequest { });
 
         Assert.True(retrieved.Count >= 4);
         Assert.True(retrieved.Any(i => i.Number == issue1.Number));

diff --git a/Octokit.Tests.Integration/Clients/MilestonesClientTests.cs b/Octokit.Tests.Integration/Clients/MilestonesClientTests.cs
@@ -85,7 +85,7 @@ public async Task CanListClosedMilestones()
         await _milestonesClient.Create(_context.RepositoryOwner, _context.RepositoryName, milestone3);
 
         var milestones = await _milestonesClient.GetAllForRepository(_context.RepositoryOwner, _context.RepositoryName,
-            new MilestoneRequest { State = ItemState.Closed });
+            new MilestoneRequest { State = ItemStateFilter.Closed });
 
         Assert.Equal(1, milestones.Count);
         Assert.Equal("milestone 3", milestones[0].Title);
@@ -103,7 +103,7 @@ await _github.Issue.Update(_context.RepositoryOwner, _context.RepositoryName, is
         new IssueUpdate { State = ItemState.Closed });
 
         var retrieved = await _github.Issue.GetAllForRepository(_context.RepositoryOwner, _context.RepositoryName,
-            new RepositoryIssueRequest { State = ItemState.Closed });
+            new RepositoryIssueRequest { State = ItemStateFilter.Closed });
 
         Assert.True(retrieved.Count >= 2);
         Assert.True(retrieved.Any(i => i.Number == issue1.Number));

diff --git a/Octokit.Tests.Integration/Clients/PullRequestsClientTests.cs b/Octokit.Tests.Integration/Clients/PullRequestsClientTests.cs
@@ -60,7 +60,7 @@ public async Task CanGetOpenPullRequest()
         var newPullRequest = new NewPullRequest("a pull request", branchName, "master");
         var result = await _fixture.Create(Helper.UserName, _context.RepositoryName, newPullRequest);
 
-        var openPullRequests = new PullRequestRequest { State = ItemState.Open };
+        var openPullRequests = new PullRequestRequest { State = ItemStateFilter.Open };
         var pullRequests = await _fixture.GetAllForRepository(Helper.UserName, _context.RepositoryName, openPullRequests);
 
         Assert.Equal(1, pullRequests.Count);
@@ -75,7 +75,7 @@ public async Task IgnoresOpenPullRequest()
         var newPullRequest = new NewPullRequest("a pull request", branchName, "master");
         await _fixture.Create(Helper.UserName, _context.RepositoryName, newPullRequest);
 
-        var openPullRequests = new PullRequestRequest { State = ItemState.Closed };
+        var openPullRequests = new PullRequestRequest { State = ItemStateFilter.Closed };
         var pullRequests = await _fixture.GetAllForRepository(Helper.UserName, _context.RepositoryName, openPullRequests);
 
         Assert.Empty(pullRequests);
@@ -123,7 +123,7 @@ public async Task CanFindClosedPullRequest()
         var updatePullRequest = new PullRequestUpdate { State = ItemState.Closed };
         await _fixture.Update(Helper.UserName, _context.RepositoryName, pullRequest.Number, updatePullRequest);
 
-        var closedPullRequests = new PullRequestRequest { State = ItemState.Closed };
+        var closedPullRequests = new PullRequestRequest { State = ItemStateFilter.Closed };
         var pullRequests = await _fixture.GetAllForRepository(Helper.UserName, _context.RepositoryName, closedPullRequests);
 
         Assert.Equal(1, pullRequests.Count);

diff --git a/Octokit.Tests.Integration/Clients/SearchClientTests.cs b/Octokit.Tests.Integration/Clients/SearchClientTests.cs
@@ -91,7 +91,6 @@ public async Task SearchForAllIssues()
     {
         var request = new SearchIssuesRequest("phone");
         request.Repos.Add("caliburn-micro", "caliburn.micro");
-        request.State = ItemState.All;
 
         var issues = await _gitHubClient.Search.SearchIssues(request);
 

diff --git a/Octokit.Tests.Integration/Reactive/ObservableMilestonesClientTests.cs b/Octokit.Tests.Integration/Reactive/ObservableMilestonesClientTests.cs
@@ -31,7 +31,7 @@ public async Task ReturnsAllMilestones()
                 var github = Helper.GetAuthenticatedClient();
 
                 var client = new ObservableMilestonesClient(github);
-                var milestones = await client.GetAllForRepository("libgit2", "libgit2sharp", new MilestoneRequest { State = ItemState.Closed }).ToList();
+                var milestones = await client.GetAllForRepository("libgit2", "libgit2sharp", new MilestoneRequest { State = ItemStateFilter.Closed }).ToList();
 
                 Assert.NotEmpty(milestones);
                 Assert.True(milestones.All(m => m.State == ItemState.Closed));

diff --git a/Octokit.Tests/Models/IssueRequestTests.cs b/Octokit.Tests/Models/IssueRequestTests.cs
@@ -13,7 +13,7 @@ public void ContainsSetValues()
             var request = new IssueRequest
             {
                 Filter = IssueFilter.All,
-                State = ItemState.Closed,
+                State = ItemStateFilter.Closed,
                 SortProperty = IssueSort.Comments,
                 SortDirection = SortDirection.Ascending,
                 Since = DateTimeOffset.ParseExact("Wed 23 Jan 2013 8:30 AM -08:00",

diff --git a/Octokit.Tests/Models/MilestoneRequestTests.cs b/Octokit.Tests/Models/MilestoneRequestTests.cs
@@ -10,7 +10,7 @@ public void ContainsSetValues()
         {
             var request = new MilestoneRequest
             {
-                State = ItemState.Closed,
+                State = ItemStateFilter.Closed,
                 SortProperty = MilestoneSort.Completeness,
                 SortDirection = SortDirection.Descending
             };

diff --git a/Octokit.Tests/Models/PullRequestRequestTests.cs b/Octokit.Tests/Models/PullRequestRequestTests.cs
@@ -10,7 +10,7 @@ public void ContainsSetValues()
         {
             var request = new PullRequestRequest
             {
-                State = ItemState.Closed,
+                State = ItemStateFilter.Closed,
                 Head = "user:ref-name",
                 Base = "fake_base_branch"
             };

diff --git a/Octokit/Models/Request/IssueRequest.cs b/Octokit/Models/Request/IssueRequest.cs
@@ -18,7 +18,7 @@ public class IssueRequest : RequestParameters
         public IssueRequest()
         {
             Filter = IssueFilter.Assigned;
-            State = ItemState.Open;
+            State = ItemStateFilter.Open;
             Labels = new Collection<string>();
             SortProperty = IssueSort.Created;
             SortDirection = SortDirection.Descending;
@@ -33,12 +33,12 @@ public IssueRequest()
         public IssueFilter Filter { get; set; }
 
         /// <summary>
-        /// Gets or sets the <see cref="ItemState"/> for the issues to return.
+        /// Gets or sets the <see cref="ItemStateFilter"/> for the issues to return.
         /// </summary>
         /// <value>
         /// The state.
         /// </value>
-        public ItemState State { get; set; }
+        public ItemStateFilter State { get; set; }
 
         /// <summary>
         /// Gets the labels to filter by. Add labels to the collection to only request issues with those labels.
@@ -121,26 +121,42 @@ public enum IssueFilter
     }
 
     /// <summary>
-    /// The range of states that an issue can be in.
+    /// Range of states for Issues, Milestones and PullRequest API.
     /// </summary>
-    public enum ItemState
+    public enum ItemStateFilter
     {
         /// <summary>
-        /// Isuses that are open (default).
+        /// Items that are open.
         /// </summary>
         Open,
 
         /// <summary>
-        /// Isuses that are closed.
+        /// Items that are closed.
         /// </summary>
         Closed,
 
         /// <summary>
-        /// All the issues.
+        /// All the items.
         /// </summary>
         All
     }
 
+    /// <summary>
+    /// Items that are open OR closed
+    /// </summary>
+    public enum ItemState
+    {
+        /// <summary>
+        /// Items that are open
+        /// </summary>
+        Open,
+
+        /// <summary>
+        /// Items that are closed
+        /// </summary>
+        Closed
+    }
+
     /// <summary>
     /// The available properties to sort issues by.
     /// </summary>

diff --git a/Octokit/Models/Request/IssueUpdate.cs b/Octokit/Models/Request/IssueUpdate.cs
@@ -92,4 +92,4 @@ public void ClearLabels()
             }
         }
     }
-}
+}
diff --git a/Octokit/Models/Request/MilestoneRequest.cs b/Octokit/Models/Request/MilestoneRequest.cs
@@ -12,12 +12,15 @@ public class MilestoneRequest : RequestParameters
     {
         public MilestoneRequest()
         {
-            State = ItemState.Open;
+            State = ItemStateFilter.Open;
             SortProperty = MilestoneSort.DueDate;
             SortDirection = SortDirection.Ascending;
         }
 
-        public ItemState State { get; set; }
+        /// <summary>
+        /// Which Milestones to get. The default is <see cref="ItemStateFilter.Open"/>.
+        /// </summary>
+        public ItemStateFilter State { get; set; }
 
         [Parameter(Key = "sort")]
         public MilestoneSort SortProperty { get; set; }

diff --git a/Octokit/Models/Request/PullRequestRequest.cs b/Octokit/Models/Request/PullRequestRequest.cs
@@ -12,15 +12,15 @@ public class PullRequestRequest : RequestParameters
     {
         public PullRequestRequest()
         {
-            State = ItemState.Open;
+            State = ItemStateFilter.Open;
             SortProperty = PullRequestSort.Created;
             SortDirection = SortDirection.Descending;
         }
 
         /// <summary>
-        /// "open" or "closed" to filter by state. Default is "open".
+        /// Which PullRequests to get. The default is <see cref="ItemStateFilter.Open"/>
         /// </summary>
-        public ItemState State { get; set; }
+        public ItemStateFilter State { get; set; }
 
         /// <summary>
         /// Filter pulls by head user and branch name in the format of "user:ref-name".

diff --git a/Octokit/Models/Response/Issue.cs b/Octokit/Models/Response/Issue.cs
@@ -155,4 +155,4 @@ public IssueUpdate ToUpdate()
             return issueUpdate;
         }
     }
-}
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -92,4 +92,4 @@ public void ClearLabels() @@
                 }
             }
         }
-    }
+    }