public void Can_save_and_load_returnRequest()
{
var rr = new ReturnRequest()
{
StoreId = 1,
Customer = GetTestCustomer(),
Quantity = 2,
ReasonForReturn = "Wrong product",
RequestedAction = "Refund",
CustomerComments = "Some comment",
StaffNotes = "Some notes",
ReturnRequestStatus = ReturnRequestStatus.ItemsRefunded,
CreatedOnUtc = new DateTime(2010, 01, 01),
UpdatedOnUtc = new DateTime(2010, 01, 02),
};
var fromDb = SaveAndLoadEntity(rr);
fromDb.ShouldNotBeNull();
fromDb.StoreId.ShouldEqual(1);
fromDb.Customer.ShouldNotBeNull();
fromDb.Quantity.ShouldEqual(2);
fromDb.ReasonForReturn.ShouldEqual("Wrong product");
fromDb.RequestedAction.ShouldEqual("Refund");
fromDb.CustomerComments.ShouldEqual("Some comment");
fromDb.StaffNotes.ShouldEqual("Some notes");
fromDb.ReturnRequestStatus.ShouldEqual(ReturnRequestStatus.ItemsRefunded);
fromDb.CreatedOnUtc.ShouldEqual(new DateTime(2010, 01, 01));
fromDb.UpdatedOnUtc.ShouldEqual(new DateTime(2010, 01, 02));
}
private bool PrepareReturnRequestModel(ReturnRequestModel model,
ReturnRequest returnRequest, bool excludeProperties)
{
if (model == null)
throw new ArgumentNullException("model");
if (returnRequest == null)
throw new ArgumentNullException("returnRequest");
var orderItem = _orderService.GetOrderItemById(returnRequest.OrderItemId);
if (orderItem == null)
return false;
model.Id = returnRequest.Id;
model.ProductId = orderItem.ProductId;
model.ProductName = orderItem.Product.Name;
model.ProductTypeName = orderItem.Product.GetProductTypeLabel(_localizationService);
model.ProductTypeLabelHint = orderItem.Product.ProductTypeLabelHint;
model.OrderId = orderItem.OrderId;
model.CustomerId = returnRequest.CustomerId;
model.CustomerFullName = returnRequest.Customer.GetFullName();
model.Quantity = returnRequest.Quantity;
model.ReturnRequestStatusStr = returnRequest.ReturnRequestStatus.GetLocalizedEnum(_localizationService, _workContext);
model.CreatedOn = _dateTimeHelper.ConvertToUserTime(returnRequest.CreatedOnUtc, DateTimeKind.Utc);
if (!excludeProperties)
{
model.ReasonForReturn = returnRequest.ReasonForReturn;
model.RequestedAction = returnRequest.RequestedAction;
model.CustomerComments = returnRequest.CustomerComments;
model.StaffNotes = returnRequest.StaffNotes;
model.ReturnRequestStatusId = returnRequest.ReturnRequestStatusId;
}
//model is successfully prepared
return true;
}
/// <summary>
/// Deletes a return request
/// </summary>
/// <param name="returnRequest">Return request</param>
public virtual void DeleteReturnRequest(ReturnRequest returnRequest)
{
if (returnRequest == null)
throw new ArgumentNullException("returnRequest");
int orderItemId = returnRequest.OrderItemId;
_returnRequestRepository.Delete(returnRequest);
//event notifications
_eventPublisher.EntityDeleted(returnRequest);
var orderItem = GetOrderItemById(orderItemId);
_eventPublisher.PublishOrderUpdated(orderItem.Order);
}
public virtual void AddReturnRequestTokens(IList<Token> tokens, ReturnRequest returnRequest, OrderItem orderItem)
{
tokens.Add(new Token("ReturnRequest.ID", returnRequest.Id.ToString()));
tokens.Add(new Token("ReturnRequest.Product.Quantity", returnRequest.Quantity.ToString()));
tokens.Add(new Token("ReturnRequest.Product.Name", orderItem.Product.Name));
tokens.Add(new Token("ReturnRequest.Reason", returnRequest.ReasonForReturn));
tokens.Add(new Token("ReturnRequest.RequestedAction", returnRequest.RequestedAction));
tokens.Add(new Token("ReturnRequest.CustomerComment", HtmlUtils.FormatText(returnRequest.CustomerComments, false, true, false, false, false, false), true));
tokens.Add(new Token("ReturnRequest.StaffNotes", HtmlUtils.FormatText(returnRequest.StaffNotes, false, true, false, false, false, false), true));
tokens.Add(new Token("ReturnRequest.Status", returnRequest.ReturnRequestStatus.GetLocalizedEnum(_localizationService, _workContext)));
//event notification
_eventPublisher.EntityTokensAdded(returnRequest, tokens);
}
/// <summary>
/// Sends 'Return Request status changed' message to a customer
/// </summary>
/// <param name="returnRequest">Return request</param>
/// <param name="orderItem">Order item</param>
/// <param name="languageId">Message language identifier</param>
/// <returns>Queued email identifier</returns>
public virtual int SendReturnRequestStatusChangedCustomerNotification(ReturnRequest returnRequest, OrderItem orderItem, int languageId)
{
if (returnRequest == null)
throw new ArgumentNullException("returnRequest");
var store = _storeService.GetStoreById(orderItem.Order.StoreId) ?? _storeContext.CurrentStore;
languageId = EnsureLanguageIsActive(languageId, store.Id);
var messageTemplate = GetLocalizedActiveMessageTemplate("ReturnRequestStatusChanged.CustomerNotification", languageId, store.Id);
if (messageTemplate == null)
return 0;
//tokens
var tokens = new List<Token>();
_messageTokenProvider.AddStoreTokens(tokens, store);
_messageTokenProvider.AddCustomerTokens(tokens, returnRequest.Customer);
_messageTokenProvider.AddReturnRequestTokens(tokens, returnRequest, orderItem);
//event notification
_eventPublisher.MessageTokensAdded(messageTemplate, tokens);
var emailAccount = GetEmailAccountOfMessageTemplate(messageTemplate, languageId);
var toEmail = returnRequest.Customer.Email;
var toName = returnRequest.Customer.GetFullName();
return SendNotification(messageTemplate, emailAccount,
languageId, tokens,
toEmail, toName);
}
/// <summary>
/// Sends 'New Return Request' message to a store owner
/// </summary>
/// <param name="returnRequest">Return request</param>
/// <param name="orderItem">Order item</param>
/// <param name="languageId">Message language identifier</param>
/// <returns>Queued email identifier</returns>
public virtual int SendNewReturnRequestStoreOwnerNotification(ReturnRequest returnRequest, OrderItem orderItem, int languageId)
{
if (returnRequest == null)
throw new ArgumentNullException("returnRequest");
var store = _storeService.GetStoreById(orderItem.Order.StoreId) ?? _storeContext.CurrentStore;
languageId = EnsureLanguageIsActive(languageId, store.Id);
var messageTemplate = GetActiveMessageTemplate("NewReturnRequest.StoreOwnerNotification", store.Id);
if (messageTemplate == null)
return 0;
//tokens
var tokens = new List<Token>();
_messageTokenProvider.AddStoreTokens(tokens, store);
_messageTokenProvider.AddCustomerTokens(tokens, returnRequest.Customer);
_messageTokenProvider.AddReturnRequestTokens(tokens, returnRequest, orderItem);
//event notification
_eventPublisher.MessageTokensAdded(messageTemplate, tokens);
var emailAccount = GetEmailAccountOfMessageTemplate(messageTemplate, languageId);
var toEmail = emailAccount.Email;
var toName = emailAccount.DisplayName;
// use customer email as reply address
var replyTo = GetReplyToEmail(returnRequest.Customer);
return SendNotification(messageTemplate, emailAccount,
languageId, tokens,
toEmail, toName,
replyTo.Item1, replyTo.Item2);
}
public ActionResult ReturnRequestSubmit(int id /* orderId */, SubmitReturnRequestModel model, FormCollection form)
{
var order = _orderService.GetOrderById(id);
if (order == null || order.Deleted || _workContext.CurrentCustomer.Id != order.CustomerId)
return new HttpUnauthorizedResult();
if (!_orderProcessingService.IsReturnRequestAllowed(order))
return RedirectToRoute("HomePage");
int count = 0;
foreach (var orderItem in order.OrderItems)
{
int quantity = 0; //parse quantity
foreach (string formKey in form.AllKeys)
if (formKey.Equals(string.Format("quantity{0}", orderItem.Id), StringComparison.InvariantCultureIgnoreCase))
{
int.TryParse(form[formKey], out quantity);
break;
}
if (quantity > 0)
{
var rr = new ReturnRequest()
{
StoreId = _storeContext.CurrentStore.Id,
OrderItemId = orderItem.Id,
Quantity = quantity,
CustomerId = _workContext.CurrentCustomer.Id,
ReasonForReturn = model.ReturnReason,
RequestedAction = model.ReturnAction,
CustomerComments = model.Comments,
StaffNotes = string.Empty,
ReturnRequestStatus = ReturnRequestStatus.Pending,
CreatedOnUtc = DateTime.UtcNow,
UpdatedOnUtc = DateTime.UtcNow
};
_workContext.CurrentCustomer.ReturnRequests.Add(rr);
_customerService.UpdateCustomer(_workContext.CurrentCustomer);
//notify store owner here (email)
_workflowMessageService.SendNewReturnRequestStoreOwnerNotification(rr, orderItem, _localizationSettings.DefaultAdminLanguageId);
count++;
}
}
model = PrepareReturnRequestModel(model, order);
if (count > 0)
model.Result = _localizationService.GetResource("ReturnRequests.Submitted");
else
model.Result = _localizationService.GetResource("ReturnRequests.NoItemsSubmitted");
return View(model);
}
public ActionResult AddReturnRequest(int id, FormCollection form)
{
if (!_permissionService.Authorize(StandardPermissionProvider.ManageReturnRequests))
return AccessDeniedView();
var order = _orderService.GetOrderById(id);
if (order == null)
return RedirectToAction("List");
//get order item identifier
int orderItemId = 0;
foreach (var formValue in form.AllKeys)
if (formValue.StartsWith("btnAddReturnRequest", StringComparison.InvariantCultureIgnoreCase))
orderItemId = Convert.ToInt32(formValue.Substring("btnAddReturnRequest".Length));
var orderItem = order.OrderItems.Where(x => x.Id == orderItemId).FirstOrDefault();
if (orderItem == null)
throw new ArgumentException("No order item found with the specified id");
if (orderItem.Quantity > 0)
{
var returnRequest = new ReturnRequest()
{
StoreId = order.StoreId,
OrderItemId = orderItem.Id,
Quantity = orderItem.Quantity,
CustomerId = order.CustomerId,
ReasonForReturn = "",
RequestedAction = "",
StaffNotes = "",
ReturnRequestStatus = ReturnRequestStatus.Pending,
CreatedOnUtc = DateTime.UtcNow,
UpdatedOnUtc = DateTime.UtcNow
};
order.Customer.ReturnRequests.Add(returnRequest);
_customerService.UpdateCustomer(order.Customer);
return RedirectToAction("Edit", "ReturnRequest", new { id = returnRequest.Id });
}
var model = new OrderModel();
PrepareOrderDetailsModel(model, order);
return View(model);
}
/// <summary>
/// Deletes a return request
/// </summary>
/// <param name="returnRequest">Return request</param>
public virtual void DeleteReturnRequest(ReturnRequest returnRequest)
{
if (returnRequest == null)
throw new ArgumentNullException("returnRequest");
_returnRequestRepository.Delete(returnRequest);
//event notification
_eventPublisher.EntityDeleted(returnRequest);
}
private bool PrepareReturnRequestModel(ReturnRequestModel model, ReturnRequest returnRequest, bool excludeProperties)
{
if (model == null)
throw new ArgumentNullException("model");
if (returnRequest == null)
throw new ArgumentNullException("returnRequest");
var orderItem = _orderService.GetOrderItemById(returnRequest.OrderItemId);
if (orderItem == null)
return false;
var store = _storeService.GetStoreById(returnRequest.StoreId);
model.Id = returnRequest.Id;
model.ProductId = orderItem.ProductId;
model.ProductSku = orderItem.Product.Sku;
model.ProductName = orderItem.Product.Name;
model.ProductTypeName = orderItem.Product.GetProductTypeLabel(_localizationService);
model.ProductTypeLabelHint = orderItem.Product.ProductTypeLabelHint;
model.StoreName = (store != null ? store.Name : "".NaIfEmpty());
model.OrderId = orderItem.OrderId;
model.OrderNumber = orderItem.Order.GetOrderNumber();
model.CustomerId = returnRequest.CustomerId;
model.CustomerFullName = returnRequest.Customer.GetFullName().NaIfEmpty();
model.CanSendEmailToCustomer = returnRequest.Customer.FindEmail().HasValue();
model.Quantity = returnRequest.Quantity;
model.ReturnRequestStatusStr = returnRequest.ReturnRequestStatus.GetLocalizedEnum(_localizationService, _workContext);
model.CreatedOn = _dateTimeHelper.ConvertToUserTime(returnRequest.CreatedOnUtc, DateTimeKind.Utc);
model.UpdatedOn = _dateTimeHelper.ConvertToUserTime(returnRequest.UpdatedOnUtc, DateTimeKind.Utc);
if (!excludeProperties)
{
model.ReasonForReturn = returnRequest.ReasonForReturn;
model.RequestedAction = returnRequest.RequestedAction;
if (returnRequest.RequestedActionUpdatedOnUtc.HasValue)
model.RequestedActionUpdated = _dateTimeHelper.ConvertToUserTime(returnRequest.RequestedActionUpdatedOnUtc.Value, DateTimeKind.Utc);
model.CustomerComments = returnRequest.CustomerComments;
model.StaffNotes = returnRequest.StaffNotes;
model.AdminComment = returnRequest.AdminComment;
model.ReturnRequestStatusId = returnRequest.ReturnRequestStatusId;
}
string unspec = _localizationService.GetResource("Common.Unspecified");
model.AvailableReasonForReturn.Add(new SelectListItem() { Text = unspec, Value = "" });
model.AvailableRequestedAction.Add(new SelectListItem() { Text = unspec, Value = "" });
// that's what we also offer in frontend
string returnRequestReasons = _orderSettings.GetLocalized(x => x.ReturnRequestReasons, orderItem.Order.CustomerLanguageId, true, false);
string returnRequestActions = _orderSettings.GetLocalized(x => x.ReturnRequestActions, orderItem.Order.CustomerLanguageId, true, false);
foreach (var rrr in returnRequestReasons.SplitSafe(","))
{
model.AvailableReasonForReturn.Add(new SelectListItem() { Text = rrr, Value = rrr, Selected = (rrr == returnRequest.ReasonForReturn) });
}
foreach (var rra in returnRequestActions.SplitSafe(","))
{
model.AvailableRequestedAction.Add(new SelectListItem() { Text = rra, Value = rra, Selected = (rra == returnRequest.RequestedAction) });
}
var urlHelper = new UrlHelper(Request.RequestContext);
model.AutoUpdateOrderItem.Id = returnRequest.Id;
model.AutoUpdateOrderItem.Caption = _localizationService.GetResource("Admin.ReturnRequests.Accept.Caption");
model.AutoUpdateOrderItem.PostUrl = urlHelper.Action("Accept", "ReturnRequest");
model.AutoUpdateOrderItem.ShowUpdateTotals = (orderItem.Order.OrderStatusId <= (int)OrderStatus.Pending);
model.AutoUpdateOrderItem.ShowUpdateRewardPoints = (orderItem.Order.OrderStatusId > (int)OrderStatus.Pending && orderItem.Order.RewardPointsWereAdded);
model.AutoUpdateOrderItem.UpdateTotals = model.AutoUpdateOrderItem.ShowUpdateTotals;
model.AutoUpdateOrderItem.UpdateRewardPoints = orderItem.Order.RewardPointsWereAdded;
model.ReturnRequestInfo = TempData[AutoUpdateOrderItemContext.InfoKey] as string;
return true;
}
