Adding the correct version of plugin

Adding the correct version of the plugin

Author: FredericoMetelo

Nop.Plugin.Widgets.AzPersonalizer/.editorconfig

@@ -0,0 +1,128 @@
+namespace Nop.Plugin.Widgets.AzPersonalizer
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Threading.Tasks;
+    using Nop.Core;
+    using Nop.Services.Cms;
+    using Nop.Services.Configuration;
+    using Nop.Services.Localization;
+    using Nop.Services.Logging;
+    using Nop.Services.Plugins;
+    using Nop.Web.Framework.Infrastructure;
+
+    /// <summary>
+    ///     Represents the plugin implementation
+    /// </summary>
+    public class AzPersonalizerPlugin : BasePlugin, IWidgetPlugin
+    {
+
+        #region fields
+
+        private readonly ILocalizationService _localizationService;
+        private readonly ISettingService _settingService;
+        private readonly IWebHelper _webHelper;
+        private readonly ILogger _logger;
+
+        #endregion
+
+        #region ctor
+
+        public AzPersonalizerPlugin (ILocalizationService localizationService,
+            ISettingService settingService,
+            IWebHelper webHelper,
+            ILogger logger)
+        {
+            _localizationService = localizationService;
+            _logger = logger;
+            _settingService = settingService;
+            _webHelper = webHelper;
+        }
+
+        #endregion
+
+        #region methods
+
+        /// <summary>
+        ///     Gets widget zones where this widget should be rendered
+        /// </summary>
+        /// <returns>
+        ///     A task that represents the asynchronous operation
+        ///     The task result contains the widget zones
+        /// </returns>
+        public Task<IList<string>> GetWidgetZonesAsync () =>
+            Task.FromResult<IList<string>>(new List<string> {PublicWidgetZones.ProductDetailsEssentialBottom});
+
+        /// <summary>
+        ///     Gets a configuration page URL
+        /// </summary>
+        public override string GetConfigurationPageUrl () =>
+            _webHelper.GetStoreLocation() + "Admin/AzPersonalizer/Configure";
+
+        /// <summary>
+        ///     Gets a name of a view component for displaying widget
+        /// </summary>
+        /// <param name="widgetZone">Name of the widget zone</param>
+        /// <returns>View component name</returns>
+        public string GetWidgetViewComponentName (string widgetZone) => "WidgetsAzPersonalizer";
+
+        /// <summary>
+        ///     Install plugin
+        /// </summary>
+        /// <returns>A task that represents the asynchronous operation</returns>
+        public async override Task InstallAsync ()
+        {
+            //settings
+            AzPersonalizerSettings settings = new() {APIkey = "", Endpoint = ""};
+            try
+            {
+                await _settingService.SaveSettingAsync(settings);
+
+                await _localizationService.AddLocaleResourceAsync(new Dictionary<string, string> {
+                   ["Plugins.Widgets.AzPersonalizer.ApiKey"] = "Api key",
+                   ["Plugins.Widgets.AzPersonalizer.Endpoint"] = "Endpoint"
+                });
+                await base.InstallAsync();
+            }
+            catch (Exception e)
+            {
+                await _logger.ErrorAsync($"failed to install plugin. Cause is Exception:{e.Message}", e);
+            }
+        }
+
+        /// <summary>
+        ///     Uninstall plugin
+        /// </summary>
+        /// <returns>A task that represents the asynchronous operation</returns>
+        public async override Task UninstallAsync ()
+        {
+            try
+            {
+                //settings
+                await _settingService.DeleteSettingAsync<AzPersonalizerSettings>();
+
+                //locales
+                await _localizationService.DeleteLocaleResourcesAsync("Plugins.Widgets.AzPersonalizer");
+
+                await base.UninstallAsync();
+            }
+            catch (Exception e)
+            {
+                await _logger.ErrorAsync($"failed to install plugin. Cause is Exception:{e.Message}", e);
+            }
+        }
+
+        /// <summary>
+        ///     Gets a value indicating whether to hide this plugin on the widget list page in the admin area
+        /// </summary>
+        public bool HideInWidgetList
+        {
+            get
+            {
+                return false;
+            }
+        }
+
+        #endregion
+    }
+}

Nop.Plugin.Widgets.AzPersonalizer/AzPersonalizerPlugin.cs

@@ -0,0 +1,20 @@
+namespace Nop.Plugin.Widgets.AzPersonalizer
+{
+    using Nop.Core.Configuration;
+
+    /// <summary>
+    ///     Represents plugin settings
+    /// </summary>
+    public class AzPersonalizerSettings : ISettings
+    {
+        /// <summary>
+        ///     Gets or sets the azure personalizer resource Api key
+        /// </summary>
+        public string APIkey { get; set; }
+
+        /// <summary>
+        ///     Gets or sets the azure personalizer resource endpoint
+        /// </summary>
+        public string Endpoint { get; set; }
+    }
+}

Nop.Plugin.Widgets.AzPersonalizer/AzPersonalizerSettings.cs

@@ -0,0 +1,198 @@
+namespace Nop.Plugin.Widgets.AzPersonalizer.Components
+{
+
+    using System;
+    using System.Collections.Generic;
+    using System.Globalization;
+    using System.Linq;
+    using System.Text;
+    using System.Threading.Tasks;
+    using Microsoft.AspNetCore.Mvc;
+    using Microsoft.Azure.CognitiveServices.Personalizer.Models;
+    using Nop.Core;
+    using Nop.Core.Domain.Catalog;
+    using Nop.Core.Domain.Logging;
+    using Nop.Plugin.Widgets.AzPersonalizer.Controllers;
+    using Nop.Plugin.Widgets.AzPersonalizer.Models;
+    using Nop.Plugin.Widgets.AzPersonalizer.Services;
+    using Nop.Services.Catalog;
+    using Nop.Services.Logging;
+    using Nop.Web.Factories;
+    using Nop.Web.Framework.Components;
+    using Nop.Web.Framework.Infrastructure;
+    using Nop.Web.Models.Catalog;
+
+    /// <summary>
+    ///     Represents the view component to place a widget into pages
+    /// </summary>
+   [ViewComponent(Name = "WidgetsAzPersonalizer")]
+    public class WidgetsAzPersonalizerViewComponent : NopViewComponent
+    {
+
+        #region fields
+
+        private readonly IWebHelper _webHelper;
+        private readonly IProductService _productService;
+        private readonly IProductModelFactory _productModelFactory;
+        private readonly ILogger _logger;
+        private readonly PersonalizerClientService _personalizerClientService;
+
+        #endregion
+
+        #region ctor
+
+        public WidgetsAzPersonalizerViewComponent (PersonalizerClientService personalizerClientService,
+            IProductService productService,
+            IProductModelFactory productModelFactory,
+            IWebHelper webHelper,
+            ILogger logger)
+        {
+            _logger = logger;
+            _webHelper = webHelper;
+            _personalizerClientService = personalizerClientService;
+            _productService = productService;
+            _productModelFactory = productModelFactory;
+        }
+
+        #endregion
+
+        #region methods
+
+        /// <summary>
+        ///     Invoke view component
+        /// </summary>
+        /// <param name="widgetZone">Widget zone name</param>
+        /// <param name="additionalData">Additional data</param>
+        /// <returns>
+        ///     A task that represents the asynchronous operation
+        ///     The task result contains the view component result
+        /// </returns
+        public async Task<IViewComponentResult> InvokeAsync (string widgetZone, object additionalData)
+        {
+            if (widgetZone == null)
+            {
+                await _logger.ErrorAsync("Widget Zone was null");
+                throw new ArgumentNullException(widgetZone);
+            }
+
+            if (widgetZone.Equals(PublicWidgetZones.ProductDetailsEssentialBottom,
+                StringComparison.InvariantCultureIgnoreCase))
+            {
+                try
+                {
+                    string[] url = _webHelper.GetThisPageUrl(true)?.Split("?");
+                    if (TempData["RewardID"] != null
+                        && TempData["OrderedIDs"] != null)
+                    {
+                        string id = TempData["RewardID"] is string rewardID ? rewardID : null;
+                        string pos = TempData["OrderedIDs"] is string position ? position : null;
+
+                        await ProcessRewardAsync(id, pos, additionalData);
+                    }
+
+                    IViewComponentResult list = await RecommendedListAsync(additionalData);
+                    if (list == null)
+                    {
+                        await _logger.ErrorAsync("Confirm everything is corret in the plugin settings.");
+                        return View("~/Plugins/Widgets.AzPersonalizer/Views/Default.cshtml");
+                    }
+
+                    return list;
+                }
+                catch (Exception e)
+                {
+                    await _logger.ErrorAsync(e.Message, e);
+                    return View("~/Plugins/Widgets.AzPersonalizer/Views/Default.cshtml");
+                }
+            }
+
+            // While there is only one widget zone in the plugin this shouldn't return anything. If you want to add
+            // recommendations to multiple widget zones, then you should make this an else if and return the appropriate view.
+            return View("~/Plugins/Widgets.AzPersonalizer/Views/Default.cshtml");
+        }
+
+
+        /// <summary>
+        ///     Prepares the view component with a list of Ranked Actions
+        /// </summary>
+        /// <param name="azPersonalizerSettings"></param>
+        /// <param name="additionalData"></param>
+        /// <returns>
+        ///     A task that represents the asynchronous operation
+        ///     The task result contains the view component result
+        /// </returns>
+        private async Task<IViewComponentResult> RecommendedListAsync (object additionalData)
+        {
+            try
+            {
+                RankResponse rankedActions =
+                    await _personalizerClientService?.GetRankedActionsAsync(additionalData);
+                IList<RankedAction> model = rankedActions.Ranking.OrderByDescending(r => r.Probability).ToList();
+                TempDataTokenController tdt = new(rankedActions.EventId);
+                TempData["RewardID"] = rankedActions.EventId;
+                IList<Product> products = new List<Product>(model.Count);
+                StringBuilder odds = new(rankedActions.EventId + ": ");
+
+                for (int i = 0; i < model.Count; i++)
+                {
+                    odds.Append("(" + model[i]?.Id + "," + model[i].Probability + ");");
+                    products.Insert(i,
+                        await _productService?.GetProductByIdAsync(int.Parse(model[i]?.Id,
+                            new CultureInfo("en-UK"))));
+                    tdt.AddId(model[i]?.Id);
+                }
+
+                TempData["OrderedIDs"] = tdt.OrderedIDs;
+
+                await _logger.InsertLogAsync(LogLevel.Debug, odds.ToString());
+
+                return View("~/Plugins/Widgets.AzPersonalizer/Views/Recommendations.cshtml",
+                    new ProductOverviewToRankingList(
+                        (await _productModelFactory.PrepareProductOverviewModelsAsync(products)).ToList(),
+                        rankedActions.EventId));
+            }
+            catch (Exception e)
+            {
+                await _logger.ErrorAsync(
+                    $"Failed to get recommendations: Exception type:{e.GetType()} and message:{e.Message}", e);
+                return null;
+            }
+        }
+
+        /// <summary>
+        ///     Calculates and sends a reward to a given Event.
+        /// </summary>
+        /// <param name="ID"></param>
+        /// <param name="orderIDs"></param>
+        /// <param name="additionalData"></param>
+        /// <returns>An empty task.</returns>
+        private async Task ProcessRewardAsync (string eventID, string orderIDs, object additionalData)
+        {
+            try
+            {
+                ProductDetailsModel product = additionalData is ProductDetailsModel model ? model : null;
+                if (string.IsNullOrEmpty(eventID) || string.IsNullOrEmpty(orderIDs) || product == null)
+                {
+                    return;
+                }
+
+                string[] products = orderIDs.Split("-");
+                for (int i = 0; i < products.Length; i++)
+                {
+                    if (products[i].Equals(product.Id.ToString(new CultureInfo("en-UK")),
+                        StringComparison.InvariantCultureIgnoreCase))
+                    {
+                        await _personalizerClientService.RewardAnActionAsync(eventID, i);
+                        return;
+                    }
+                }
+            }
+            catch (Exception e)
+            {
+                await _logger.ErrorAsync($"Failed to reward event with EventId:{eventID}", e);
+            }
+        }
+
+        #endregion
+    }
+}