1 files changed, 76 insertions, 39 deletions

diff --git a/src/DotNetOpenAuth.AspNet/Clients/OpenID/OpenIDClient.cs b/src/DotNetOpenAuth.AspNet/Clients/OpenID/OpenIDClient.cs
index ee1ddc1..4f31529 100644
--- a/src/DotNetOpenAuth.AspNet/Clients/OpenID/OpenIDClient.cs
+++ b/src/DotNetOpenAuth.AspNet/Clients/OpenID/OpenIDClient.cs
@@ -7,6 +7,7 @@
 namespace DotNetOpenAuth.AspNet.Clients {
 	using System;
 	using System.Collections.Generic;
+	using System.Diagnostics.CodeAnalysis;
 	using System.Globalization;
 	using System.Web;
 	using DotNetOpenAuth.AspNet.Resources;
@@ -17,54 +18,83 @@ namespace DotNetOpenAuth.AspNet.Clients {
 	/// Base classes for OpenID clients.
 	/// </summary>
 	public class OpenIdClient : IAuthenticationClient {
+		#region Constants and Fields
+
+		/// <summary>
+		/// The _openid relaying party.
+		/// </summary>
+		private static readonly OpenIdRelyingParty _openidRelayingParty =
+			new OpenIdRelyingParty(new StandardRelyingPartyApplicationStore());
+
+		/// <summary>
+		/// The _provider identifier.
+		/// </summary>
 		private readonly Identifier _providerIdentifier;
+
+		/// <summary>
+		/// The _provider name.
+		/// </summary>
 		private readonly string _providerName;
 
-		private static OpenIdRelyingParty _openidRelayingParty =
-			new OpenIdRelyingParty(new StandardRelyingPartyApplicationStore());
+		#endregion
+
+		#region Constructors and Destructors
 
 		/// <summary>
 		/// Initializes a new instance of the <see cref="OpenIdClient"/> class.
 		/// </summary>
-		/// <param name="providerName">Name of the provider.</param>
-		/// <param name="providerIdentifier">The provider identifier, which is the usually the login url of the specified provider.</param>
+		/// <param name="providerName">
+		/// Name of the provider. 
+		/// </param>
+		/// <param name="providerIdentifier">
+		/// The provider identifier, which is the usually the login url of the specified provider. 
+		/// </param>
 		public OpenIdClient(string providerName, string providerIdentifier) {
-			if (String.IsNullOrEmpty(providerIdentifier)) {
+			if (string.IsNullOrEmpty(providerIdentifier)) {
 				throw new ArgumentException(
-					String.Format(CultureInfo.CurrentCulture, WebResources.Argument_Cannot_Be_Null_Or_Empty, "providerIdentifier"),
+					string.Format(CultureInfo.CurrentCulture, WebResources.Argument_Cannot_Be_Null_Or_Empty, "providerIdentifier"), 
 					"providerIdentifier");
 			}
 
-			if (String.IsNullOrEmpty(providerName)) {
+			if (string.IsNullOrEmpty(providerName)) {
 				throw new ArgumentException(
-					String.Format(CultureInfo.CurrentCulture, WebResources.Argument_Cannot_Be_Null_Or_Empty, "providerName"),
+					string.Format(CultureInfo.CurrentCulture, WebResources.Argument_Cannot_Be_Null_Or_Empty, "providerName"), 
 					"providerName");
 			}
 
-			_providerName = providerName;
-			if (!Identifier.TryParse(providerIdentifier, out _providerIdentifier) || _providerIdentifier == null) {
+			this._providerName = providerName;
+			if (!Identifier.TryParse(providerIdentifier, out this._providerIdentifier) || this._providerIdentifier == null) {
 				throw new ArgumentException(WebResources.OpenIDInvalidIdentifier, "providerIdentifier");
 			}
 		}
 
+		#endregion
+
+		#region Public Properties
+
 		/// <summary>
 		/// Gets the name of the provider which provides authentication service.
 		/// </summary>
 		public string ProviderName {
 			get {
-				return _providerName;
+				return this._providerName;
 			}
 		}
 
+		#endregion
+
+		#region Public Methods and Operators
+
 		/// <summary>
-		/// Attempts to authenticate users by forwarding them to an external website, and
-		/// upon succcess or failure, redirect users back to the specified url.
+		/// Attempts to authenticate users by forwarding them to an external website, and upon succcess or failure, redirect users back to the specified url.
 		/// </summary>
-		/// <param name="context">The context of the current request.</param>
-		/// <param name="returnUrl">The return url after users have completed authenticating against external website.</param>
-		[System.Diagnostics.CodeAnalysis.SuppressMessage(
-			"Microsoft.Usage",
-			"CA2234:PassSystemUriObjectsInsteadOfStrings",
+		/// <param name="context">
+		/// The context of the current request. 
+		/// </param>
+		/// <param name="returnUrl">
+		/// The return url after users have completed authenticating against external website. 
+		/// </param>
+		[SuppressMessage("Microsoft.Usage", "CA2234:PassSystemUriObjectsInsteadOfStrings", 
 			Justification = "We don't have a Uri object handy.")]
 		public virtual void RequestAuthentication(HttpContextBase context, Uri returnUrl) {
 			if (returnUrl == null) {
@@ -72,27 +102,22 @@ namespace DotNetOpenAuth.AspNet.Clients {
 			}
 
 			var realm = new Realm(returnUrl.GetComponents(UriComponents.SchemeAndServer, UriFormat.Unescaped));
-			IAuthenticationRequest request = _openidRelayingParty.CreateRequest(_providerIdentifier, realm, returnUrl);
+			IAuthenticationRequest request = _openidRelayingParty.CreateRequest(this._providerIdentifier, realm, returnUrl);
 
 			// give subclasses a chance to modify request message, e.g. add extension attributes, etc.
-			OnBeforeSendingAuthenticationRequest(request);
+			this.OnBeforeSendingAuthenticationRequest(request);
 
 			request.RedirectToProvider();
 		}
 
 		/// <summary>
-		/// Called just before the authentication request is sent to service provider.
-		/// </summary>
-		/// <param name="request">The request.</param>
-		protected virtual void OnBeforeSendingAuthenticationRequest(IAuthenticationRequest request) {
-		}
-
-		/// <summary>
 		/// Check if authentication succeeded after user is redirected back from the service provider.
 		/// </summary>
-		/// <param name="context">The context of the current request.</param>
+		/// <param name="context">
+		/// The context of the current request. 
+		/// </param>
 		/// <returns>
-		/// An instance of <see cref="AuthenticationResult"/> containing authentication result.
+		/// An instance of <see cref="AuthenticationResult"/> containing authentication result. 
 		/// </returns>
 		public virtual AuthenticationResult VerifyAuthentication(HttpContextBase context) {
 			IAuthenticationResponse response = _openidRelayingParty.GetResponse();
@@ -104,30 +129,42 @@ namespace DotNetOpenAuth.AspNet.Clients {
 				string id = response.ClaimedIdentifier;
 				string username;
 
-				Dictionary<string, string> extraData = GetExtraData(response) ?? new Dictionary<string, string>();
+				Dictionary<string, string> extraData = this.GetExtraData(response) ?? new Dictionary<string, string>();
+
 				// try to look up username from the 'username' or 'email' property. If not found, fall back to 'friendly id'
 				if (!extraData.TryGetValue("username", out username) && !extraData.TryGetValue("email", out username)) {
 					username = response.FriendlyIdentifierForDisplay;
 				}
 
-				return new AuthenticationResult(
-					true,
-					ProviderName,
-					id,
-					username,
-					extraData);
+				return new AuthenticationResult(true, this.ProviderName, id, username, extraData);
 			}
 
 			return AuthenticationResult.Failed;
 		}
 
+		#endregion
+
+		#region Methods
+
 		/// <summary>
 		/// Gets the extra data obtained from the response message when authentication is successful.
 		/// </summary>
-		/// <param name="response">The response message.</param>
-		/// <returns></returns>
+		/// <param name="response">
+		/// The response message. 
+		/// </param>
+		/// <returns>
+		/// </returns>
 		protected virtual Dictionary<string, string> GetExtraData(IAuthenticationResponse response) {
 			return null;
 		}
+
+		/// <summary>
+		/// Called just before the authentication request is sent to service provider.
+		/// </summary>
+		/// <param name="request">
+		/// The request. 
+		/// </param>
+		protected virtual void OnBeforeSendingAuthenticationRequest(IAuthenticationRequest request) {}
+		#endregion
 	}
-}
\ No newline at end of file
+}