ILoginCache -> IKeychain

github · jcansdale · Nov 21, 2017 · Aug 25, 2017 · Aug 25, 2017 · Aug 25, 2017
commit b790d965c9ab27a1fc49b8b42e6fe2f390c2630f
diff --git a/src/GitHub.Api/ILoginCache.cs → src/GitHub.Api/IKeychain.cs b/src/GitHub.Api/ILoginCache.cs → src/GitHub.Api/IKeychain.cs
@@ -5,33 +5,33 @@
 namespace GitHub.Api
 {
     /// <summary>
-    /// Stores login details.
+    /// Represents a keychain used to store credentials.
     /// </summary>
-    public interface ILoginCache
+    public interface IKeychain
     {
         /// <summary>
-        /// Gets the login details for the specified host address.
+        /// Loads the credentials for the specified host address.
         /// </summary>
         /// <param name="hostAddress">The host address.</param>
         /// <returns>
-        /// A task returning a tuple containing the retrieved username and password.
+        /// A task returning a tuple consisting of the retrieved username and password.
         /// </returns>
-        Task<Tuple<string, string>> GetLogin(HostAddress hostAddress);
+        Task<Tuple<string, string>> Load(HostAddress hostAddress);
 
         /// <summary>
-        /// Saves the login details for the specified host address.
+        /// Saves the credentials for the specified host address.
         /// </summary>
         /// <param name="userName">The username.</param>
         /// <param name="password">The password.</param>
         /// <param name="hostAddress">The host address.</param>
         /// <returns>A task tracking the operation.</returns>
-        Task SaveLogin(string userName, string password, HostAddress hostAddress);
+        Task Save(string userName, string password, HostAddress hostAddress);
 
         /// <summary>
-        /// Removes the login details for the specified host address.
+        /// Deletes the login details for the specified host address.
         /// </summary>
         /// <param name="hostAddress"></param>
         /// <returns>A task tracking the operation.</returns>
-        Task EraseLogin(HostAddress hostAddress);
+        Task Delete(HostAddress hostAddress);
     }
 }
diff --git a/src/GitHub.Api/LoginManager.cs b/src/GitHub.Api/LoginManager.cs
@@ -13,7 +13,7 @@ namespace GitHub.Api
     public class LoginManager : ILoginManager
     {
         readonly string[] scopes = { "user", "repo", "gist", "write:public_key" };
-        readonly ILoginCache loginCache;
+        readonly IKeychain loginCache;
         readonly ITwoFactorChallengeHandler twoFactorChallengeHandler;
         readonly string clientId;
         readonly string clientSecret;
@@ -30,7 +30,7 @@ public class LoginManager : ILoginManager
         /// <param name="authorizationNote">An note to store with the authorization.</param>
         /// <param name="fingerprint">The machine fingerprint.</param>
         public LoginManager(
-            ILoginCache loginCache,
+            IKeychain loginCache,
             ITwoFactorChallengeHandler twoFactorChallengeHandler,
             string clientId,
             string clientSecret,
@@ -64,7 +64,7 @@ public async Task<User> Login(
 
             // Start by saving the username and password, these will be used by the `IGitHubClient`
             // until an authorization token has been created and acquired:
-            await loginCache.SaveLogin(userName, password, hostAddress).ConfigureAwait(false);
+            await loginCache.Save(userName, password, hostAddress).ConfigureAwait(false);
 
             var newAuth = new NewAuthorization
             {
@@ -99,13 +99,13 @@ public async Task<User> Login(
                     }
                     else
                     {
-                        await loginCache.EraseLogin(hostAddress).ConfigureAwait(false);
+                        await loginCache.Delete(hostAddress).ConfigureAwait(false);
                         throw;
                     }
                 }
             } while (auth == null);
 
-            await loginCache.SaveLogin(userName, auth.Token, hostAddress).ConfigureAwait(false);
+            await loginCache.Save(userName, auth.Token, hostAddress).ConfigureAwait(false);
 
             var retry = 0;
 
@@ -141,7 +141,7 @@ public async Task Logout(HostAddress hostAddress, IGitHubClient client)
             Guard.ArgumentNotNull(hostAddress, nameof(hostAddress));
             Guard.ArgumentNotNull(client, nameof(client));
 
-            await loginCache.EraseLogin(hostAddress);
+            await loginCache.Delete(hostAddress);
         }
 
         async Task<ApplicationAuthorization> CreateAndDeleteExistingApplicationAuthorization(
@@ -219,7 +219,7 @@ async Task<ApplicationAuthorization> HandleTwoFactorAuthorization(
                     catch (Exception e)
                     {
                         await twoFactorChallengeHandler.ChallengeFailed(e);
-                        await loginCache.EraseLogin(hostAddress).ConfigureAwait(false);
+                        await loginCache.Delete(hostAddress).ConfigureAwait(false);
                         throw;
                     }
                 }

diff --git a/src/GitHub.Api/WindowsLoginCache.cs → src/GitHub.Api/WindowsKeychain.cs b/src/GitHub.Api/WindowsLoginCache.cs → src/GitHub.Api/WindowsKeychain.cs
@@ -8,14 +8,14 @@
 namespace GitHub.Api
 {
     /// <summary>
-    /// A login cache that stores logins in the windows credential cache.
+    /// A keychain that stores logins in the windows credential store.
     /// </summary>
-    [Export(typeof(ILoginCache))]
+    [Export(typeof(IKeychain))]
     [PartCreationPolicy(CreationPolicy.Shared)]
-    public class WindowsLoginCache : ILoginCache
+    public class WindowsKeychain : IKeychain
     {
         /// <inheritdoc/>
-        public Task<Tuple<string, string>> GetLogin(HostAddress hostAddress)
+        public Task<Tuple<string, string>> Load(HostAddress hostAddress)
         {
             Guard.ArgumentNotNull(hostAddress, nameof(hostAddress));
 
@@ -33,7 +33,7 @@ public Task<Tuple<string, string>> GetLogin(HostAddress hostAddress)
         }
 
         /// <inheritdoc/>
-        public Task SaveLogin(string userName, string password, HostAddress hostAddress)
+        public Task Save(string userName, string password, HostAddress hostAddress)
         {
             Guard.ArgumentNotEmptyString(userName, nameof(userName));
             Guard.ArgumentNotEmptyString(password, nameof(password));
@@ -56,7 +56,7 @@ public Task SaveLogin(string userName, string password, HostAddress hostAddress)
         }
 
         /// <inheritdoc/>
-        public Task EraseLogin(HostAddress hostAddress)
+        public Task Delete(HostAddress hostAddress)
         {
             Guard.ArgumentNotNull(hostAddress, nameof(hostAddress));
 

diff --git a/src/UnitTests/GitHub.Api/LoginManagerTests.cs b/src/UnitTests/GitHub.Api/LoginManagerTests.cs
@@ -21,13 +21,13 @@ public async Task LoginTokenIsSavedToCache()
             client.Authorization.GetOrCreateApplicationAuthentication("id", "secret", Arg.Any<NewAuthorization>())
                 .Returns(new ApplicationAuthorization("123abc"));
 
-            var loginCache = Substitute.For<ILoginCache>();
+            var loginCache = Substitute.For<IKeychain>();
             var tfa = Substitute.For<ITwoFactorChallengeHandler>();
 
             var target = new LoginManager(loginCache, tfa, "id", "secret");
             await target.Login(host, client, "foo", "bar");
 
-            await loginCache.Received().SaveLogin("foo", "123abc", host);
+            await loginCache.Received().Save("foo", "123abc", host);
         }
 
         [Fact]
@@ -39,7 +39,7 @@ public async Task LoggedInUserIsReturned()
                 .Returns(new ApplicationAuthorization("123abc"));
             client.User.Current().Returns(user);
 
-            var loginCache = Substitute.For<ILoginCache>();
+            var loginCache = Substitute.For<IKeychain>();
             var tfa = Substitute.For<ITwoFactorChallengeHandler>();
 
             var target = new LoginManager(loginCache, tfa, "id", "secret");
@@ -62,15 +62,15 @@ public async Task DeletesExistingAuthenticationIfNullTokenReturned()
                     new ApplicationAuthorization("123abc"));
             client.User.Current().Returns(user);
 
-            var loginCache = Substitute.For<ILoginCache>();
+            var loginCache = Substitute.For<IKeychain>();
             var tfa = Substitute.For<ITwoFactorChallengeHandler>();
 
             var target = new LoginManager(loginCache, tfa, "id", "secret");
             var result = await target.Login(host, client, "foo", "bar");
 
             await client.Authorization.Received(2).GetOrCreateApplicationAuthentication("id", "secret", Arg.Any<NewAuthorization>());
             await client.Authorization.Received(1).Delete(0);
-            await loginCache.Received().SaveLogin("foo", "123abc", host);
+            await loginCache.Received().Save("foo", "123abc", host);
         }
 
         [Fact]
@@ -84,7 +84,7 @@ public async Task TwoFactorExceptionIsPassedToHandler()
             client.Authorization.GetOrCreateApplicationAuthentication("id", "secret", Arg.Any<NewAuthorization>(), "123456")
                 .Returns(new ApplicationAuthorization("123abc"));
 
-            var loginCache = Substitute.For<ILoginCache>();
+            var loginCache = Substitute.For<IKeychain>();
             var tfa = Substitute.For<ITwoFactorChallengeHandler>();
             tfa.HandleTwoFactorException(exception).Returns(new TwoFactorChallengeResult("123456"));
 
@@ -111,7 +111,7 @@ public async Task Failed2FACodeResultsInRetry()
             client.Authorization.GetOrCreateApplicationAuthentication("id", "secret", Arg.Any<NewAuthorization>(), "123456")
                 .Returns(new ApplicationAuthorization("123abc"));
 
-            var loginCache = Substitute.For<ILoginCache>();
+            var loginCache = Substitute.For<IKeychain>();
             var tfa = Substitute.For<ITwoFactorChallengeHandler>();
             tfa.HandleTwoFactorException(exception).Returns(
                 new TwoFactorChallengeResult("111111"),
@@ -146,7 +146,7 @@ public async Task HandlerNotifiedOfExceptionIn2FAChallengeResponse()
             client.Authorization.GetOrCreateApplicationAuthentication("id", "secret", Arg.Any<NewAuthorization>(), "111111")
                 .Returns<ApplicationAuthorization>(_ => { throw loginAttemptsException; });
 
-            var loginCache = Substitute.For<ILoginCache>();
+            var loginCache = Substitute.For<IKeychain>();
             var tfa = Substitute.For<ITwoFactorChallengeHandler>();
             tfa.HandleTwoFactorException(twoFaException).Returns(
                 new TwoFactorChallengeResult("111111"),
@@ -176,7 +176,7 @@ public async Task RequestResendCodeResultsInRetryingLogin()
                 .Returns(new ApplicationAuthorization("456def"));
             client.User.Current().Returns(user);
 
-            var loginCache = Substitute.For<ILoginCache>();
+            var loginCache = Substitute.For<IKeychain>();
             var tfa = Substitute.For<ITwoFactorChallengeHandler>();
             tfa.HandleTwoFactorException(exception).Returns(
                 TwoFactorChallengeResult.RequestResendCode,
@@ -201,13 +201,13 @@ public async Task UsesUsernameAndPasswordInsteadOfAuthorizationTokenWhenEnterpri
                 });
             client.User.Current().Returns(user);
 
-            var loginCache = Substitute.For<ILoginCache>();
+            var loginCache = Substitute.For<IKeychain>();
             var tfa = Substitute.For<ITwoFactorChallengeHandler>();
 
             var target = new LoginManager(loginCache, tfa, "id", "secret");
             await target.Login(enterprise, client, "foo", "bar");
 
-            await loginCache.Received().SaveLogin("foo", "bar", enterprise);
+            await loginCache.Received().Save("foo", "bar", enterprise);
         }
 
         [Fact]
@@ -219,13 +219,13 @@ public async Task ErasesLoginWhenUnauthorized()
             client.Authorization.GetOrCreateApplicationAuthentication("id", "secret", Arg.Any<NewAuthorization>())
                 .Returns<ApplicationAuthorization>(_ => { throw new AuthorizationException(); });
 
-            var loginCache = Substitute.For<ILoginCache>();
+            var loginCache = Substitute.For<IKeychain>();
             var tfa = Substitute.For<ITwoFactorChallengeHandler>();
 
             var target = new LoginManager(loginCache, tfa, "id", "secret");
             await Assert.ThrowsAsync<AuthorizationException>(async () => await target.Login(enterprise, client, "foo", "bar"));
 
-            await loginCache.Received().EraseLogin(enterprise);
+            await loginCache.Received().Delete(enterprise);
         }
 
         [Fact]
@@ -237,13 +237,13 @@ public async Task ErasesLoginWhenNonOctokitExceptionThrown()
             client.Authorization.GetOrCreateApplicationAuthentication("id", "secret", Arg.Any<NewAuthorization>())
                 .Returns<ApplicationAuthorization>(_ => { throw new InvalidOperationException(); });
 
-            var loginCache = Substitute.For<ILoginCache>();
+            var loginCache = Substitute.For<IKeychain>();
             var tfa = Substitute.For<ITwoFactorChallengeHandler>();
 
             var target = new LoginManager(loginCache, tfa, "id", "secret");
             await Assert.ThrowsAsync<InvalidOperationException>(async () => await target.Login(host, client, "foo", "bar"));
 
-            await loginCache.Received().EraseLogin(host);
+            await loginCache.Received().Delete(host);
         }
 
         [Fact]
@@ -259,14 +259,14 @@ public async Task ErasesLoginWhenNonOctokitExceptionThrownIn2FA()
                 .Returns<ApplicationAuthorization>(_ => { throw new InvalidOperationException(); });
             client.User.Current().Returns(user);
 
-            var loginCache = Substitute.For<ILoginCache>();
+            var loginCache = Substitute.For<IKeychain>();
             var tfa = Substitute.For<ITwoFactorChallengeHandler>();
             tfa.HandleTwoFactorException(exception).Returns(new TwoFactorChallengeResult("123456"));
 
             var target = new LoginManager(loginCache, tfa, "id", "secret");
             await Assert.ThrowsAsync<InvalidOperationException>(async () => await target.Login(host, client, "foo", "bar"));
 
-            await loginCache.Received().EraseLogin(host);
+            await loginCache.Received().Delete(host);
         }
     }
 }