From a39b20484f06b99cfc8fe2a4018fa0d1dcffa875 Mon Sep 17 00:00:00 2001 From: Aaron Yarborough Date: Mon, 13 Feb 2017 13:05:48 +0000 Subject: [PATCH 1/2] Changed login to not return respose The login method now throws specific exceptions if something goes wrong during the login process. This is the ideal way for a developer using this API to handle errors. --- .../LoginManagers/BarclaysLoginManager.cs | 7 +-- .../LoginManagers/LloydsLoginManager.cs | 56 ++++++++----------- .../LoginManagers/LoginManager.cs | 4 +- BankingBot/BankingClient.cs | 11 +--- BankingBot/Contracts/IClient.cs | 2 +- BankingBot/Contracts/ILoginManager.cs | 2 +- BankingBot/Contracts/IProviderLoginManager.cs | 2 +- 7 files changed, 31 insertions(+), 53 deletions(-) diff --git a/BankingBot/ActionManagers/LoginManagers/BarclaysLoginManager.cs b/BankingBot/ActionManagers/LoginManagers/BarclaysLoginManager.cs index 842f069..c83103a 100644 --- a/BankingBot/ActionManagers/LoginManagers/BarclaysLoginManager.cs +++ b/BankingBot/ActionManagers/LoginManagers/BarclaysLoginManager.cs @@ -28,7 +28,7 @@ namespace BankingBot.ActionManagers.LoginManagers this.scriptManager = scriptManager; } - public Response Login(ILoginCredentials credentials) + public void Login(ILoginCredentials credentials) { _credentials = credentials as BarclaysLoginCredentials; @@ -100,11 +100,6 @@ namespace BankingBot.ActionManagers.LoginManagers }; scriptManager.Execute("barclays-login.js", scriptData, ScriptBundles.ProviderLogin); - - return new Response - { - Status = ResponseStatus.Success - }; } } } diff --git a/BankingBot/ActionManagers/LoginManagers/LloydsLoginManager.cs b/BankingBot/ActionManagers/LoginManagers/LloydsLoginManager.cs index e8d6139..e0e98bc 100644 --- a/BankingBot/ActionManagers/LoginManagers/LloydsLoginManager.cs +++ b/BankingBot/ActionManagers/LoginManagers/LloydsLoginManager.cs @@ -16,8 +16,10 @@ namespace BankingBot.ActionManagers.LoginManagers [ProviderIdentifier(Provider.Lloyds)] public class LloydsLoginManager : IProviderLoginManager { - private readonly IBrowserBot _browserBot; - private readonly IScriptManager _scriptManager; + readonly IBrowserBot _browserBot; + readonly IScriptManager _scriptManager; + + private LloydsLoginCredentials _credentials; public LloydsLoginManager( IBrowserBot browserBot, @@ -27,63 +29,49 @@ namespace BankingBot.ActionManagers.LoginManagers _scriptManager = scriptManager; } - public Response Login(ILoginCredentials credentials) + public void Login(ILoginCredentials credentials) { - var response = new Response(); - var lloydsCreds = (LloydsLoginCredentials)credentials; + _credentials = (LloydsLoginCredentials)credentials; - try - { - LoginStep1(lloydsCreds); - - if (!_browserBot.WebDriver.Url.Contains(LloydsUrls.MemorableInfo)) - throw new InvalidCredentialsException("Invalid login credentials"); - - LoginStep2(lloydsCreds); - - if (!_browserBot.WebDriver.Url.Contains(LloydsUrls.AccountOverview)) - throw new InvalidCredentialsException("Invalid passphrase for account"); - - response.Status = ResponseStatus.Success; - } - catch (Exception ex) - { - response.Exception = ex; - response.Status = ResponseStatus.Error; - } - - return response; + LoginStep1(); + LoginStep2(); } - private void LoginStep1(LloydsLoginCredentials credentials) + private void LoginStep1() { _browserBot.WebDriver.Url = LloydsUrls.Login; _browserBot.WebDriver.Navigate(); - _browserBot.WebDriver.FindElement(By.Id("frmLogin:strCustomerLogin_userID")).SendKeys(credentials.Username); - _browserBot.WebDriver.FindElement(By.Id("frmLogin:strCustomerLogin_pwd")).SendKeys(credentials.Password); + _browserBot.WebDriver.FindElement(By.Id("frmLogin:strCustomerLogin_userID")).SendKeys(_credentials.Username); + _browserBot.WebDriver.FindElement(By.Id("frmLogin:strCustomerLogin_pwd")).SendKeys(_credentials.Password); _browserBot.WebDriver.FindElement(By.Id("frmLogin:btnLogin2")).Click(); + + if (!_browserBot.WebDriver.Url.Contains(LloydsUrls.MemorableInfo)) + throw new InvalidCredentialsException("Invalid login credentials"); } - private void LoginStep2(LloydsLoginCredentials credentials) + private void LoginStep2() { var passphraseIndexes = GetPassphraseIndexes(); var maxPassphraseLength = passphraseIndexes[2]; - if (credentials.Passphrase.Length < maxPassphraseLength) + if (_credentials.Passphrase.Length < maxPassphraseLength) throw new InvalidCredentialsException("Passphrase is too short"); _browserBot.WebDriver.FindElement(By.Id(GetPassphraseDdlId(1))).SendKeys( - credentials.Passphrase[passphraseIndexes[0]].ToString()); + _credentials.Passphrase[passphraseIndexes[0]].ToString()); _browserBot.WebDriver.FindElement(By.Id(GetPassphraseDdlId(2))).SendKeys( - credentials.Passphrase[passphraseIndexes[1]].ToString()); + _credentials.Passphrase[passphraseIndexes[1]].ToString()); _browserBot.WebDriver.FindElement(By.Id(GetPassphraseDdlId(3))).SendKeys( - credentials.Passphrase[passphraseIndexes[2]].ToString()); + _credentials.Passphrase[passphraseIndexes[2]].ToString()); _browserBot.WebDriver.FindElement(By.Id("frmentermemorableinformation1:btnContinue")).Click(); + + if (!_browserBot.WebDriver.Url.Contains(LloydsUrls.AccountOverview)) + throw new InvalidCredentialsException("Invalid passphrase for account"); } private int[] GetPassphraseIndexes() diff --git a/BankingBot/ActionManagers/LoginManagers/LoginManager.cs b/BankingBot/ActionManagers/LoginManagers/LoginManager.cs index fa07ae0..cfd87f1 100644 --- a/BankingBot/ActionManagers/LoginManagers/LoginManager.cs +++ b/BankingBot/ActionManagers/LoginManagers/LoginManager.cs @@ -13,7 +13,7 @@ namespace BankingBot.ActionManagers.LoginManagers : base(browserBot) { } - public Response Login(ILoginCredentials credentials) + public void Login(ILoginCredentials credentials) { // TODO: THIS NEEDS TO BE MOVED var scriptManager = new ScriptManager(BrowserBot); @@ -21,7 +21,7 @@ namespace BankingBot.ActionManagers.LoginManagers var providerLoginManagerType = GetTypeFromInterface(credentials.GetProvider(), typeof(IProviderLoginManager)); var provLoginManager = (IProviderLoginManager)Activator.CreateInstance(providerLoginManagerType, BrowserBot, scriptManager); - return provLoginManager.Login(credentials); + provLoginManager.Login(credentials); } } } diff --git a/BankingBot/BankingClient.cs b/BankingBot/BankingClient.cs index 1fd7645..d2ee02f 100644 --- a/BankingBot/BankingClient.cs +++ b/BankingBot/BankingClient.cs @@ -36,18 +36,13 @@ namespace BankingBot #region Actions - Login Manager - public Response Login(ILoginCredentials credentials) + public void Login(ILoginCredentials credentials) { LoginCredentials = credentials; Provider = credentials.GetProvider(); - var response = loginManager.Login(credentials); - if (response.Status == ResponseStatus.Success) - { - accountManager.Init(Provider); - } - - return response; + loginManager.Login(credentials); + accountManager.Init(Provider); } #endregion diff --git a/BankingBot/Contracts/IClient.cs b/BankingBot/Contracts/IClient.cs index 7e5e1c6..1cba793 100644 --- a/BankingBot/Contracts/IClient.cs +++ b/BankingBot/Contracts/IClient.cs @@ -7,7 +7,7 @@ namespace BankingBot.Contracts { public interface IClient { - Response Login(ILoginCredentials credentials); + void Login(ILoginCredentials credentials); decimal GetBalance(); diff --git a/BankingBot/Contracts/ILoginManager.cs b/BankingBot/Contracts/ILoginManager.cs index a4ecfd7..7ebc6a1 100644 --- a/BankingBot/Contracts/ILoginManager.cs +++ b/BankingBot/Contracts/ILoginManager.cs @@ -4,6 +4,6 @@ namespace BankingBot.Contracts { public interface ILoginManager { - Response Login(ILoginCredentials credentials); + void Login(ILoginCredentials credentials); } } \ No newline at end of file diff --git a/BankingBot/Contracts/IProviderLoginManager.cs b/BankingBot/Contracts/IProviderLoginManager.cs index 45c4656..ad504f3 100644 --- a/BankingBot/Contracts/IProviderLoginManager.cs +++ b/BankingBot/Contracts/IProviderLoginManager.cs @@ -4,6 +4,6 @@ namespace BankingBot.Contracts { public interface IProviderLoginManager { - Response Login(ILoginCredentials credentials); + void Login(ILoginCredentials credentials); } } \ No newline at end of file From f5e9908e8304ebec36cab79ab87553c94df6fdba Mon Sep 17 00:00:00 2001 From: Aaron Yarborough Date: Mon, 13 Feb 2017 13:13:27 +0000 Subject: [PATCH 2/2] Refactoring --- .../LoginManagers/BarclaysLoginManager.cs | 1 - .../LoginManagers/LloydsLoginManager.cs | 3 --- .../LoginManagers/LoginManager.cs | 3 --- BankingBot/BankingBot.csproj | 2 -- BankingBot/BankingClient.cs | 1 - BankingBot/Contracts/IClient.cs | 4 +--- BankingBot/Contracts/ILoginManager.cs | 4 +--- BankingBot/Contracts/IProviderLoginManager.cs | 4 +--- .../LoginCredentials/LloydsLoginCredentials.cs | 8 +------- BankingBot/LoginCredentials/LoginCredentials.cs | 7 +------ BankingBot/Responses/LoginResponse.cs | 14 -------------- BankingBot/Responses/Response.cs | 17 ----------------- 12 files changed, 5 insertions(+), 63 deletions(-) delete mode 100644 BankingBot/Responses/LoginResponse.cs delete mode 100644 BankingBot/Responses/Response.cs diff --git a/BankingBot/ActionManagers/LoginManagers/BarclaysLoginManager.cs b/BankingBot/ActionManagers/LoginManagers/BarclaysLoginManager.cs index c83103a..2571ef8 100644 --- a/BankingBot/ActionManagers/LoginManagers/BarclaysLoginManager.cs +++ b/BankingBot/ActionManagers/LoginManagers/BarclaysLoginManager.cs @@ -2,7 +2,6 @@ using BankingBot.Contracts; using BankingBot.Enums; using BankingBot.LoginCredentials; -using BankingBot.Responses; using System.Collections.Generic; using BankingBot.ScriptManagement; diff --git a/BankingBot/ActionManagers/LoginManagers/LloydsLoginManager.cs b/BankingBot/ActionManagers/LoginManagers/LloydsLoginManager.cs index e0e98bc..b688c60 100644 --- a/BankingBot/ActionManagers/LoginManagers/LloydsLoginManager.cs +++ b/BankingBot/ActionManagers/LoginManagers/LloydsLoginManager.cs @@ -1,13 +1,10 @@ using System; -using System.Collections.Generic; using System.Text.RegularExpressions; using BankingBot.Attributes; using BankingBot.Contracts; using BankingBot.LoginCredentials; using OpenQA.Selenium; -using BankingBot.Responses; using BankingBot.Enums; -using BankingBot.ScriptManagement; using BankingBot.Urls; using BankingBot.Exceptions; diff --git a/BankingBot/ActionManagers/LoginManagers/LoginManager.cs b/BankingBot/ActionManagers/LoginManagers/LoginManager.cs index cfd87f1..a0ab6c4 100644 --- a/BankingBot/ActionManagers/LoginManagers/LoginManager.cs +++ b/BankingBot/ActionManagers/LoginManagers/LoginManager.cs @@ -1,8 +1,5 @@ using System; -using System.Linq; -using BankingBot.Attributes; using BankingBot.Contracts; -using BankingBot.Responses; using BankingBot.ScriptManagement; namespace BankingBot.ActionManagers.LoginManagers diff --git a/BankingBot/BankingBot.csproj b/BankingBot/BankingBot.csproj index 7ba7802..2731ea6 100644 --- a/BankingBot/BankingBot.csproj +++ b/BankingBot/BankingBot.csproj @@ -77,8 +77,6 @@ - - diff --git a/BankingBot/BankingClient.cs b/BankingBot/BankingClient.cs index d2ee02f..3eba517 100644 --- a/BankingBot/BankingClient.cs +++ b/BankingBot/BankingClient.cs @@ -5,7 +5,6 @@ using BankingBot.ActionManagers.LoginManagers; using BankingBot.Models; using OpenQA.Selenium; using BankingBot.ActionManagers.AccountManagers; -using BankingBot.Responses; using BankingBot.Enums; namespace BankingBot diff --git a/BankingBot/Contracts/IClient.cs b/BankingBot/Contracts/IClient.cs index 1cba793..387118b 100644 --- a/BankingBot/Contracts/IClient.cs +++ b/BankingBot/Contracts/IClient.cs @@ -1,7 +1,5 @@ -using System.Collections; -using System.Collections.Generic; +using System.Collections.Generic; using BankingBot.Models; -using BankingBot.Responses; namespace BankingBot.Contracts { diff --git a/BankingBot/Contracts/ILoginManager.cs b/BankingBot/Contracts/ILoginManager.cs index 7ebc6a1..18cda3b 100644 --- a/BankingBot/Contracts/ILoginManager.cs +++ b/BankingBot/Contracts/ILoginManager.cs @@ -1,6 +1,4 @@ -using BankingBot.Responses; - -namespace BankingBot.Contracts +namespace BankingBot.Contracts { public interface ILoginManager { diff --git a/BankingBot/Contracts/IProviderLoginManager.cs b/BankingBot/Contracts/IProviderLoginManager.cs index ad504f3..22479d7 100644 --- a/BankingBot/Contracts/IProviderLoginManager.cs +++ b/BankingBot/Contracts/IProviderLoginManager.cs @@ -1,6 +1,4 @@ -using BankingBot.Responses; - -namespace BankingBot.Contracts +namespace BankingBot.Contracts { public interface IProviderLoginManager { diff --git a/BankingBot/LoginCredentials/LloydsLoginCredentials.cs b/BankingBot/LoginCredentials/LloydsLoginCredentials.cs index 4ee4ea0..e52cd9c 100644 --- a/BankingBot/LoginCredentials/LloydsLoginCredentials.cs +++ b/BankingBot/LoginCredentials/LloydsLoginCredentials.cs @@ -1,10 +1,4 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; -using BankingBot.Attributes; -using BankingBot.Contracts; +using BankingBot.Attributes; namespace BankingBot.LoginCredentials { diff --git a/BankingBot/LoginCredentials/LoginCredentials.cs b/BankingBot/LoginCredentials/LoginCredentials.cs index ea501de..69d95bb 100644 --- a/BankingBot/LoginCredentials/LoginCredentials.cs +++ b/BankingBot/LoginCredentials/LoginCredentials.cs @@ -1,9 +1,4 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; -using BankingBot.Attributes; +using BankingBot.Attributes; using BankingBot.Contracts; using BankingBot.Enums; diff --git a/BankingBot/Responses/LoginResponse.cs b/BankingBot/Responses/LoginResponse.cs deleted file mode 100644 index 947b982..0000000 --- a/BankingBot/Responses/LoginResponse.cs +++ /dev/null @@ -1,14 +0,0 @@ -using BankingBot.Enums; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; - -namespace BankingBot.Responses -{ - public class LoginResponse : Response - { - Provider Provider { get; } - } -} diff --git a/BankingBot/Responses/Response.cs b/BankingBot/Responses/Response.cs deleted file mode 100644 index b1410c9..0000000 --- a/BankingBot/Responses/Response.cs +++ /dev/null @@ -1,17 +0,0 @@ -using BankingBot.Contracts; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; -using BankingBot.Enums; - -namespace BankingBot.Responses -{ - public class Response : IResponse - { - public Exception Exception { get; set; } - - public ResponseStatus Status { get; set; } - } -}