Offline credit card payment: Option to exclude credit card types

Author: mgesing

src/Plugins/SmartStore.OfflinePayment/Controllers/OfflinePaymentController.cs

@@ -38,6 +38,18 @@ public OfflinePaymentController(
 
 		#region Global
 
+		private List<SelectListItem> GetTransactModes()
+		{
+			var list = new List<SelectListItem>
+			{
+				new SelectListItem { Text = T("Enums.SmartStore.Core.Domain.Payments.PaymentStatus.Pending"), Value = ((int)TransactMode.Pending).ToString() },
+				new SelectListItem { Text = T("Enums.SmartStore.Core.Domain.Payments.PaymentStatus.Authorized"), Value = ((int)TransactMode.Authorize).ToString() },
+				new SelectListItem { Text = T("Enums.SmartStore.Core.Domain.Payments.PaymentStatus.Paid"), Value = ((int)TransactMode.Paid).ToString() }
+			};
+
+			return list;
+		}
+
 		[NonAction]
 		private TModel ConfigureGet<TModel, TSetting>(Action<TModel, TSetting> fn = null)
 			where TModel : ConfigurationModelBase, new()
@@ -414,7 +426,17 @@ public ActionResult ManualConfigure()
 			var model = ConfigureGet<ManualConfigurationModel, ManualPaymentSettings>((m, s) => 
 			{
 				m.TransactMode = s.TransactMode;
-				m.TransactModeValues = s.TransactMode.ToSelectList();		
+				m.TransactModeValues = GetTransactModes();
+				m.ExcludedCreditCards = s.ExcludedCreditCards.SplitSafe(",");		
+
+				m.AvailableCreditCards = ManualProvider.CreditCardTypes
+					.Select(x => new SelectListItem
+					{
+						Text = x.Text,
+						Value = x.Value,
+						Selected = m.ExcludedCreditCards.Contains(x.Value)
+					})
+					.ToList();
 			});
 
 			return View(model);
@@ -429,66 +451,51 @@ public ActionResult ManualConfigure(ManualConfigurationModel model, FormCollecti
 			ConfigurePost<ManualConfigurationModel, ManualPaymentSettings>(model, form, s =>
 			{
 				s.TransactMode = model.TransactMode;
-
-				model.TransactModeValues = s.TransactMode.ToSelectList();
+				s.ExcludedCreditCards = string.Join(",", model.ExcludedCreditCards ?? new string[0]);
 			});
 
 			return ManualConfigure();
 		}
 
 		public ActionResult ManualPaymentInfo()
 		{
-			var model = PaymentInfoGet<ManualPaymentInfoModel, ManualPaymentSettings>();
-
-			// CC types
-			model.CreditCardTypes.Add(new SelectListItem()
+			var model = PaymentInfoGet<ManualPaymentInfoModel, ManualPaymentSettings>((m, s) =>
 			{
-				Text = "Visa",
-				Value = "Visa",
-			});
-			model.CreditCardTypes.Add(new SelectListItem()
-			{
-				Text = "Master card",
-				Value = "MasterCard",
-			});
-			model.CreditCardTypes.Add(new SelectListItem()
-			{
-				Text = "Discover",
-				Value = "Discover",
-			});
-			model.CreditCardTypes.Add(new SelectListItem()
-			{
-				Text = "Amex",
-				Value = "Amex",
+				var excludedCreditCards = s.ExcludedCreditCards.SplitSafe(",");
+
+				foreach (var creditCard in ManualProvider.CreditCardTypes)
+				{
+					if (!excludedCreditCards.Any(x => x.IsCaseInsensitiveEqual(creditCard.Value)))
+					{
+						m.CreditCardTypes.Add(new SelectListItem
+						{
+							Text = creditCard.Text,
+							Value = creditCard.Value
+						});
+					}
+				}
 			});
 
 			// years
 			for (int i = 0; i < 15; i++)
 			{
 				string year = Convert.ToString(DateTime.Now.Year + i);
-				model.ExpireYears.Add(new SelectListItem()
-				{
-					Text = year,
-					Value = year,
-				});
+				model.ExpireYears.Add(new SelectListItem { Text = year,	Value = year });
 			}
 
 			// months
 			for (int i = 1; i <= 12; i++)
 			{
 				string text = (i < 10) ? "0" + i.ToString() : i.ToString();
-				model.ExpireMonths.Add(new SelectListItem()
-				{
-					Text = text,
-					Value = i.ToString(),
-				});
+				model.ExpireMonths.Add(new SelectListItem { Text = text, Value = i.ToString() });
 			}
 
 			// set postback values
 			var form = this.GetPaymentData();
 			model.CardholderName = form["CardholderName"];
 			model.CardNumber = form["CardNumber"];
 			model.CardCode = form["CardCode"];
+
 			var selectedCcType = model.CreditCardTypes.Where(x => x.Value.Equals(form["CreditCardType"], StringComparison.InvariantCultureIgnoreCase)).FirstOrDefault();
 			if (selectedCcType != null)
 				selectedCcType.Selected = true;

src/Plugins/SmartStore.OfflinePayment/Localization/resources.de-de.xml

@@ -25,7 +25,7 @@
   <LocaleResource Name="AdditionalFeePercentage.Hint">
     <Value>Zusätzliche prozentuale Gebühr zum Gesamtbetrag. Ein fester Wert wird verwendet, falls diese Option nicht aktiviert ist.</Value>
   </LocaleResource>
-  
+
   <!-- CashOnDelivery -->
   <LocaleResource Name="Plugins.FriendlyName.Payments.CashOnDelivery" AppendRootKey="false">
     <Value>Nachnahme</Value>
@@ -122,10 +122,16 @@
         </Value>
       </LocaleResource>
       <LocaleResource Name="Fields.TransactMode">
-        <Value>Markiere die Zahlung nach dem Abschluß der Bestellung als</Value>
+        <Value>Zahlungsstatus nach Bestellabschluss</Value>
       </LocaleResource>
       <LocaleResource Name="Fields.TransactMode.Hint">
-        <Value>Bestimmen Sie den Transaktionsmodus.</Value>
+        <Value>Legt den Zahlungsstatus nach Bestellabschluss fest.</Value>
+      </LocaleResource>
+      <LocaleResource Name="ExcludedCreditCards">
+        <Value>Auszuschließende Kreditkarten</Value>
+      </LocaleResource>
+      <LocaleResource Name="ExcludedCreditCards.Hint">
+        <Value>Kreditkarten mit denen Kunden nicht zahlen dürfen.</Value>
       </LocaleResource>
     </Children>
   </LocaleResource>

src/Plugins/SmartStore.OfflinePayment/Localization/resources.en-us.xml

@@ -115,10 +115,16 @@
         </Value>
       </LocaleResource>
       <LocaleResource Name="Fields.TransactMode">
-        <Value>After checkout mark payment as</Value>
+        <Value>Payment status after order completion</Value>
       </LocaleResource>
       <LocaleResource Name="Fields.TransactMode.Hint">
-        <Value>Specify transaction mode.</Value>
+        <Value>Specifies the payment status after order completion.</Value>
+      </LocaleResource>
+      <LocaleResource Name="ExcludedCreditCards">
+        <Value>Excluded credit cards</Value>
+      </LocaleResource>
+      <LocaleResource Name="ExcludedCreditCards.Hint">
+        <Value>Credit cards that customers may not pay with.</Value>
       </LocaleResource>
     </Children>
   </LocaleResource>

src/Plugins/SmartStore.OfflinePayment/Models/ConfigurationModel.cs

@@ -35,7 +35,11 @@ public class ManualConfigurationModel : ConfigurationModelBase
 	{
 		[SmartResourceDisplayName("Plugins.Payments.Manual.Fields.TransactMode")]
 		public TransactMode TransactMode { get; set; }
-		public SelectList TransactModeValues { get; set; }
+		public List<SelectListItem> TransactModeValues { get; set; }
+
+		[SmartResourceDisplayName("Plugins.Payments.Manual.ExcludedCreditCards")]
+		public string[] ExcludedCreditCards { get; set; }
+		public List<SelectListItem> AvailableCreditCards { get; set; }
 	}
 
 	public class PayInStoreConfigurationModel : ConfigurationModelBase

src/Plugins/SmartStore.OfflinePayment/Providers/ManualProvider.cs

@@ -1,3 +1,5 @@
+using System.Collections.Generic;
+using System.Web.Mvc;
 using SmartStore.Core.Domain.Payments;
 using SmartStore.Core.Plugins;
 using SmartStore.OfflinePayment.Settings;
@@ -10,12 +12,28 @@ namespace SmartStore.OfflinePayment
 	[DisplayOrder(1)]
 	public class ManualProvider : OfflinePaymentProviderBase<ManualPaymentSettings>, IConfigurable
 	{
+		public static List<SelectListItem> CreditCardTypes
+		{
+			get
+			{
+				var creditCardTypes = new List<SelectListItem>
+				{
+					new SelectListItem { Text = "Visa", Value = "Visa" },
+					new SelectListItem { Text = "Master Card", Value = "MasterCard" },
+					new SelectListItem { Text = "Discover", Value = "Discover" },
+					new SelectListItem { Text = "Amex", Value = "Amex" }
+				};
+				return creditCardTypes;
+			}
+		}
+
 		public override ProcessPaymentResult ProcessPayment(ProcessPaymentRequest processPaymentRequest)
 		{
 			var result = new ProcessPaymentResult();
 			var settings = CommonServices.Settings.LoadSetting<ManualPaymentSettings>(processPaymentRequest.StoreId);
 
 			result.AllowStoringCreditCardNumber = true;
+
 			switch (settings.TransactMode)
 			{
 				case TransactMode.Pending:
@@ -24,14 +42,12 @@ public override ProcessPaymentResult ProcessPayment(ProcessPaymentRequest proces
 				case TransactMode.Authorize:
 					result.NewPaymentStatus = PaymentStatus.Authorized;
 					break;
-				case TransactMode.AuthorizeAndCapture:
+				case TransactMode.Paid:
 					result.NewPaymentStatus = PaymentStatus.Paid;
 					break;
 				default:
-					{
-						result.AddError(T("Common.Payment.TranactionTypeNotSupported"));
-						return result;
-					}
+					result.AddError(T("Common.Payment.TranactionTypeNotSupported"));
+					return result;
 			}
 
 			return result;
@@ -51,7 +67,7 @@ public override ProcessPaymentResult ProcessRecurringPayment(ProcessPaymentReque
 				case TransactMode.Authorize:
 					result.NewPaymentStatus = PaymentStatus.Authorized;
 					break;
-				case TransactMode.AuthorizeAndCapture:
+				case TransactMode.Paid:
 					result.NewPaymentStatus = PaymentStatus.Paid;
 					break;
 				default:

src/Plugins/SmartStore.OfflinePayment/Providers/PurchaseOrderNumberProvider.cs

@@ -39,7 +39,7 @@ public override ProcessPaymentResult ProcessPayment(ProcessPaymentRequest proces
                 case TransactMode.Authorize:
                     result.NewPaymentStatus = PaymentStatus.Authorized;
                     break;
-                case TransactMode.AuthorizeAndCapture:
+                case TransactMode.Paid:
                     result.NewPaymentStatus = PaymentStatus.Paid;
                     break;
                 default:

src/Plugins/SmartStore.OfflinePayment/Settings/OfflinePaymentSettings.cs

@@ -1,6 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
+using System.Collections.Generic;
 using SmartStore.Core.Configuration;
 
 namespace SmartStore.OfflinePayment.Settings
@@ -27,6 +25,7 @@ public class InvoicePaymentSettings : PaymentSettingsBase, ISettings
 	public class ManualPaymentSettings : PaymentSettingsBase, ISettings
 	{
 		public TransactMode TransactMode { get; set; }
+		public string ExcludedCreditCards { get; set; }
 	}
 
     public class PurchaseOrderNumberPaymentSettings : PaymentSettingsBase, ISettings
@@ -45,19 +44,21 @@ public class PrepaymentPaymentSettings : PaymentSettingsBase, ISettings
 	/// <summary>
 	/// Represents manual payment processor transaction mode
 	/// </summary>
-	public enum TransactMode : int
+	public enum TransactMode
 	{
 		/// <summary>
 		/// Pending
 		/// </summary>
 		Pending = 0,
+
 		/// <summary>
 		/// Authorize
 		/// </summary>
 		Authorize = 1,
+
 		/// <summary>
-		/// Authorize and capture
+		/// Paid
 		/// </summary>
-		AuthorizeAndCapture = 2
+		Paid = 2
 	}
 }

src/Plugins/SmartStore.OfflinePayment/Views/OfflinePayment/ManualConfigure.cshtml

@@ -1,6 +1,5 @@
 @model SmartStore.OfflinePayment.Models.ManualConfigurationModel
 @using SmartStore.Web.Framework;
-
 @{
 	Layout = "";
 }
@@ -16,9 +15,19 @@
             </td>
             <td class="adminData">
 				@Html.SettingOverrideCheckbox(model => model.TransactMode)
-                @Html.DropDownList("TransactMode", Model.TransactModeValues)
+                @Html.DropDownListFor(model => model.TransactMode, Model.TransactModeValues)
             </td>
         </tr>
+		<tr>
+			<td class="adminTitle">
+				@Html.SmartLabelFor(model => model.ExcludedCreditCards)
+			</td>
+			<td class="adminData">
+				@Html.SettingOverrideCheckbox(model => model.ExcludedCreditCards)
+				@Html.ListBoxFor(x => x.ExcludedCreditCards, new MultiSelectList(Model.AvailableCreditCards, "Value", "Text"), new { multiple = "multiple" })
+				@Html.ValidationMessageFor(model => model.ExcludedCreditCards)
+			</td>
+		</tr>
         <tr>
             <td class="adminTitle">
                 @Html.SmartLabelFor(model => model.AdditionalFee)

src/Plugins/SmartStore.OfflinePayment/changelog.md

@@ -1,5 +1,9 @@
-#Release Notes#
+#Release Notes
 
-##Offline Payment Methods 1.1##
-###Improvements###
+##Offline Payment Methods 2.5.0
+###New Features
+* Option to exclude credit card types
+
+##Offline Payment Methods 1.1
+###Improvements
 * Multistore configuration