Merge branch 'master' into bump-libgit2sharp-octokit

Author: shana

.gitignore

@@ -238,4 +238,4 @@ WiX.Toolset.DummyFile.txt
 nunit-UnitTests.xml
 nunit-TrackingCollectionTests.xml
 GitHubVS.sln.DotSettings
-**/generated/*.cs
+**/generated/*.cs

CONTRIBUTING.md

@@ -31,9 +31,33 @@ There are certain areas of the extension that are restricted in what they can do
 - Team Explorer content outside the Home page is slightly less restricted, but not by much
 - Dialogs and views that don't inherit from TeamExplorer classes are free to use what they need.
 
+## Submitting an Issue
+
+### Bug Reporting
+
+Here are a few helpful tips when reporting a bug:
+- Verify the bug resides in the GitHub for Visual Studio extension
+  - A lot of functionality provided by this extension resides in the Team Explorer pane, alongside other non-GitHub tools to manage and collaborate on source code, including Visual Studio's Git support, which is owned by Microsoft.
+  - If this bug not is related to the GitHub extension, visit the [Visual Studio support page](https://www.visualstudio.com/support/support-overview-vs) for help
+- Screenshots are very helpful in diagnosing bugs and understanding the state of the extension when it's experiencing problems. Please include them whenever possible.
+- A log file is helpful in diagnosing bug issues. To include log files in your issue:
+
+  1. Close Visual Studio if it's open
+  2. Open a Developer Command Prompt for VS2015
+  3. Run devenv /log
+  4. Reproduce your issue
+  5. Close VS
+  6. Locate the following files on your system and email them to [email protected] or create a gist and link it in the issue report:
+    - `%appdata%\Microsoft\VisualStudio\14.0\ActivityLog.xml`
+    - `%localappdata%\temp\extension.log`
+    - `%localappdata%\GitHubVisualStudio\extension.log`
+
+### Feature Requests
+If you have a feature that you think would be a great addition to the extension, we might already have thought about it too, so be sure to check if your suggestion matches our [roadmap](#roadmap-and-future-feature-ideas) before making a request. Also take a peek at our [pull requests](https://github.com/github/VisualStudio/pulls) to see what we're currently working on. Additionally, someone might have already thought of your idea, so check out Issues labeled as [features](https://github.com/github/VisualStudio/issues?q=is%3Aopen+is%3Aissue+label%3Afeature) to see if it already exists.
+
 ## Things to improve in the current version
 
-- Localization
+- [Localization](https://github.com/github/VisualStudio/issues/18)
 
 ## Roadmap and future feature ideas
 

GitHubVS.sln

@@ -524,8 +524,8 @@ Global
 		{161DBF01-1DBF-4B00-8551-C5C00F26720D}.Release|Any CPU.Build.0 = Release|Any CPU
 		{161DBF01-1DBF-4B00-8551-C5C00F26720D}.Release|x86.ActiveCfg = Release|Any CPU
 		{161DBF01-1DBF-4B00-8551-C5C00F26720D}.Release|x86.Build.0 = Release|Any CPU
-		{161DBF01-1DBF-4B00-8551-C5C00F26720D}.XamlDesign|Any CPU.ActiveCfg = Release|Any CPU
-		{161DBF01-1DBF-4B00-8551-C5C00F26720D}.XamlDesign|Any CPU.Build.0 = Release|Any CPU
+		{161DBF01-1DBF-4B00-8551-C5C00F26720D}.XamlDesign|Any CPU.ActiveCfg = Debug|Any CPU
+		{161DBF01-1DBF-4B00-8551-C5C00F26720D}.XamlDesign|Any CPU.Build.0 = Debug|Any CPU
 		{161DBF01-1DBF-4B00-8551-C5C00F26720D}.XamlDesign|x86.ActiveCfg = Release|Any CPU
 		{161DBF01-1DBF-4B00-8551-C5C00F26720D}.XamlDesign|x86.Build.0 = Release|Any CPU
 		{161DBF01-1DBF-4B00-8551-C5C00F26720E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
@@ -540,8 +540,8 @@ Global
 		{161DBF01-1DBF-4B00-8551-C5C00F26720E}.Release|Any CPU.Build.0 = Release|Any CPU
 		{161DBF01-1DBF-4B00-8551-C5C00F26720E}.Release|x86.ActiveCfg = Release|Any CPU
 		{161DBF01-1DBF-4B00-8551-C5C00F26720E}.Release|x86.Build.0 = Release|Any CPU
-		{161DBF01-1DBF-4B00-8551-C5C00F26720E}.XamlDesign|Any CPU.ActiveCfg = Release|Any CPU
-		{161DBF01-1DBF-4B00-8551-C5C00F26720E}.XamlDesign|Any CPU.Build.0 = Release|Any CPU
+		{161DBF01-1DBF-4B00-8551-C5C00F26720E}.XamlDesign|Any CPU.ActiveCfg = Debug|Any CPU
+		{161DBF01-1DBF-4B00-8551-C5C00F26720E}.XamlDesign|Any CPU.Build.0 = Debug|Any CPU
 		{161DBF01-1DBF-4B00-8551-C5C00F26720E}.XamlDesign|x86.ActiveCfg = Release|Any CPU
 		{161DBF01-1DBF-4B00-8551-C5C00F26720E}.XamlDesign|x86.Build.0 = Release|Any CPU
 		{D1DFBB0C-B570-4302-8F1E-2E3A19C41961}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
@@ -556,8 +556,8 @@ Global
 		{D1DFBB0C-B570-4302-8F1E-2E3A19C41961}.Release|Any CPU.Build.0 = Release|Any CPU
 		{D1DFBB0C-B570-4302-8F1E-2E3A19C41961}.Release|x86.ActiveCfg = Release|Any CPU
 		{D1DFBB0C-B570-4302-8F1E-2E3A19C41961}.Release|x86.Build.0 = Release|Any CPU
-		{D1DFBB0C-B570-4302-8F1E-2E3A19C41961}.XamlDesign|Any CPU.ActiveCfg = Release|Any CPU
-		{D1DFBB0C-B570-4302-8F1E-2E3A19C41961}.XamlDesign|Any CPU.Build.0 = Release|Any CPU
+		{D1DFBB0C-B570-4302-8F1E-2E3A19C41961}.XamlDesign|Any CPU.ActiveCfg = Debug|Any CPU
+		{D1DFBB0C-B570-4302-8F1E-2E3A19C41961}.XamlDesign|Any CPU.Build.0 = Debug|Any CPU
 		{D1DFBB0C-B570-4302-8F1E-2E3A19C41961}.XamlDesign|x86.ActiveCfg = Release|Any CPU
 		{D1DFBB0C-B570-4302-8F1E-2E3A19C41961}.XamlDesign|x86.Build.0 = Release|Any CPU
 	EndGlobalSection

README.md

@@ -44,6 +44,6 @@ Visit the [Contributor Guidelines](CONTRIBUTING.md) for details on how to contri
 
 ## Copyright
 
-Copyright 2015 GitHub, Inc.
+Copyright 2015 - 2016 GitHub, Inc.
 
 Licensed under the [MIT License](LICENSE.md)

documentation/UIController.md

@@ -0,0 +1,59 @@
+The `UIController` class creates views and associated viewmodels for each UI we have,
+and controls the UI logic graph. It uses various state machines to define
+the UI logic graph.
+
+**State machines**
+
+The UI logic graph is controlled by various state machines defined in 
+`ConfigureLogicStates` and `ConfigureUIHandlingStates`
+
+**ConfigureLogicStates**
+
+`ConfigureLogicStates` defines the one state machine per UI group:
+    - Authentication
+    - Repository Clone
+    - Repository Creation
+    - Repository Publish,
+    - Pull Requests (List, Detail, Creation)
+
+All state machines have a common state of `None` (nothing happened yet),
+`End` (we're done, cleanup) and `Finish` (final state once cleanup is done), and
+UI-specific states that relate to what views the UI needs to show (Login, TwoFactor,
+PullRequestList, etc). States are defined in the enum `UIViewType`
+
+All state machines support a variety of triggers for going from one state to another.
+These triggers are defined in the enum `Trigger`. `Cancel` and `Finish` are
+supported by all states (any state machine regardless of its current state supports
+exiting via `Cancel` (ends with success flag set to false) and `Finish` (ends with success flag set to true).
+Since most UI flows we support are linear (login followed by 2fa followed by clone
+followed by ending the flow), most states support the `Next` trigger to continue,
+and when at the end of a ui flow, `Next` ends it with success.
+
+The Pull Requests UI flow is non-linear (there are more than one transition from the
+list view - it can go to the detail view, or the pr creation view, or other views),
+it does not support the `Next` trigger and instead has its own triggers.
+
+**ConfigureUIHandlingStates**
+
+`ConfigureUIHandlingStates` defines a state machine `uiStateMachine` connected
+to the `transition` observable, and executes whatever logic is needed to load the
+requested state, usually by creating the view and viewmodel that the UI state requires.
+Whenever a state transition happens in `uiStateMachine`, if the state requires
+loading a view, this view is sent back to the rendering code via the `transition`
+observable. When the state machine reaches the `End` state, the `completion` observable
+is completed with a flag indicating whether the ui flow ended successfully or was
+cancelled (via the `Next`/`Finish` triggers or the `Cancel` trigger) .
+
+The transitions between states are dynamically evaluated at runtime based on the logic
+defined in `ConfigureLogicStates`. When `uiStateMachine` receives a trigger request,
+it passes that trigger to the state machine corresponding to the ui flow that's currently
+running (Authentication, Clone, etc), and that state machine determines which state
+to go to next.
+
+In theory, `uiStateMachine` has no knowledge of the logic graph, and
+the only thing it's responsible for is loading UI whenever a state is entered, and cleaning
+up objects when things are done - making it essentially a big switch with nice entry and exit
+conditions. In practice, we need to configure the valid triggers from one state to the other
+just so we can call the corresponding state machine that handles the logic (defined in `ConfigureLogicStates`).
+There is a bit of code duplication because of this, and there's some room for improvement
+here, but because we have a small number of triggers, it's not a huge deal.

script

@@ -1,4 +1,5 @@
-using System;
+using GitHub.UI;
+using System;
 using System.Windows;
 using System.Windows.Controls;
 
@@ -11,11 +12,11 @@ public partial class WindowController : Window
     {
         IDisposable disposable;
 
-        public WindowController(IObservable<UserControl> controls)
+        public WindowController(IObservable<LoadData> controls)
         {
             InitializeComponent();
 
-            disposable = controls.Subscribe(c => Load(c),
+            disposable = controls.Subscribe(c => Load(c.View),
             Close
             );
         }
@@ -26,8 +27,9 @@ protected override void OnClosed(EventArgs e)
             base.OnClosed(e);
         }
 
-        public void Load(UserControl control)
+        public void Load(IView view)
         {
+            var control = view as UserControl;
             Container.Children.Clear();
             Container.Children.Add(control);
         }

src/DesignTimeStyleHelper/WindowController.xaml.cs

@@ -13,21 +13,27 @@
 using Octokit;
 using Octokit.Reactive;
 using ReactiveUI;
+using System.Threading.Tasks;
+using System.Reactive.Threading.Tasks;
+using Octokit.Internal;
+using System.Collections.Generic;
+using GitHub.Models;
 
 namespace GitHub.Api
 {
     public partial class ApiClient : IApiClient
     {
-        static readonly Logger log = LogManager.GetCurrentClassLogger();
-
+        const string ScopesHeader = "X-OAuth-Scopes";
         const string ProductName = Info.ApplicationInfo.ApplicationDescription;
+        static readonly Logger log = LogManager.GetCurrentClassLogger();
+        static readonly Uri userEndpoint = new Uri("user", UriKind.Relative);
 
         readonly IObservableGitHubClient gitHubClient;
         // There are two sets of authorization scopes, old and new:
         // The old scopes must be used by older versions of Enterprise that don't support the new scopes:
-        readonly string[] oldAuthorizationScopes = { "user", "repo" };
+        readonly string[] oldAuthorizationScopes = { "user", "repo", "gist" };
         // These new scopes include write:public_key, which allows us to add public SSH keys to an account:
-        readonly string[] newAuthorizationScopes = { "user", "repo", "write:public_key" };
+        readonly string[] newAuthorizationScopes = { "user", "repo", "gist", "write:public_key" };
         readonly static Lazy<string> lazyNote = new Lazy<string>(() => ProductName + " on " + GetMachineNameSafe());
         readonly static Lazy<string> lazyFingerprint = new Lazy<string>(GetFingerprint);
 
@@ -52,9 +58,35 @@ public IObservable<Repository> CreateRepository(NewRepository repository, string
             return (isUser ? client.Create(repository) : client.Create(login, repository));
         }
 
-        public IObservable<User> GetUser()
+        public IObservable<Gist> CreateGist(NewGist newGist)
+        {
+            return gitHubClient.Gist.Create(newGist);
+        }
+
+        public IObservable<UserAndScopes> GetUser()
         {
-            return gitHubClient.User.Current();
+            return GetUserInternal().ToObservable();
+        }
+
+        async Task<UserAndScopes> GetUserInternal()
+        {
+            var response = await gitHubClient.Connection.Get<User>(
+                userEndpoint, null, null).ConfigureAwait(false);
+            var scopes = default(string[]);
+
+            if (response.HttpResponse.Headers.ContainsKey(ScopesHeader))
+            {
+                scopes = response.HttpResponse.Headers[ScopesHeader]
+                    .Split(',')
+                    .Select(x => x.Trim())
+                    .ToArray();
+            }
+            else
+            {
+                log.Error($"Error reading scopes: /user succeeded but {ScopesHeader} was not present.");
+            }
+
+            return new UserAndScopes(response.Body, scopes);
         }
 
         public IObservable<ApplicationAuthorization> GetOrCreateApplicationAuthenticationCode(