Rename AddOEmbedProvider() and Obsolete OEmbedProviders() (#11703)

* Rename AddOEmbedProvider to AddEmbedProvider

* Obsolete  OEmbedProviders()

Obsolete OEmbedProviders() and proxy it to a new EmbedProviders()

* Rename EmbedProviderBase to OEmbedProviderBase

Rename EmbedProviderBase to OEmbedProviderBase
Add an obsoleted  class EmbedProviderBase
Add todo's to all implementations

* remove unintentionally comment

Rem: automatic tests failures not linked to this PR.

Author: erikjanwestendorp

src/Umbraco.Core/DependencyInjection/UmbracoBuilder.CollectionBuilders.cs

@@ -77,10 +77,10 @@ public static IUmbracoBuilder AddMediaUrlProvider<T>(this IUmbracoBuilder builde
         /// </summary>
         /// <typeparam name="T">The type of the embed provider.</typeparam>
         /// <param name="builder">The builder.</param>
-        public static IUmbracoBuilder AddOEmbedProvider<T>(this IUmbracoBuilder builder)
+        public static IUmbracoBuilder AddEmbedProvider<T>(this IUmbracoBuilder builder)
             where T : class, IEmbedProvider
         {
-            builder.OEmbedProviders().Append<T>();
+            builder.EmbedProviders().Append<T>();
             return builder;
         }
 

src/Umbraco.Core/DependencyInjection/UmbracoBuilder.Collections.cs

@@ -1,3 +1,4 @@
+using System;
 using Umbraco.Cms.Core.Actions;
 using Umbraco.Cms.Core.Cache;
 using Umbraco.Cms.Core.Composing;
@@ -102,7 +103,7 @@ internal static void AddAllCoreCollectionBuilders(this IUmbracoBuilder builder)
             builder.ManifestFilters();
             builder.MediaUrlGenerators();
             // register OEmbed providers - no type scanning - all explicit opt-in of adding types, IEmbedProvider is not IDiscoverable
-            builder.OEmbedProviders()
+            builder.EmbedProviders()
                 .Append<YouTube>()
                 .Append<Twitter>()
                 .Append<Vimeo>()
@@ -265,7 +266,15 @@ public static MediaUrlGeneratorCollectionBuilder MediaUrlGenerators(this IUmbrac
         /// Gets the backoffice OEmbed Providers collection builder.
         /// </summary>
         /// <param name="builder">The builder.</param>
+        [Obsolete("Use EmbedProviders() instead")]
         public static EmbedProvidersCollectionBuilder OEmbedProviders(this IUmbracoBuilder builder)
+            => EmbedProviders(builder);
+
+        /// <summary>
+        /// Gets the backoffice Embed Providers collection builder.
+        /// </summary>
+        /// <param name="builder">The builder.</param>
+        public static EmbedProvidersCollectionBuilder EmbedProviders(this IUmbracoBuilder builder)
             => builder.WithCollectionBuilder<EmbedProvidersCollectionBuilder>();
 
         /// <summary>

src/Umbraco.Core/Media/EmbedProviders/DailyMotion.cs

@@ -1,8 +1,9 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using Umbraco.Cms.Core.Serialization;
 
 namespace Umbraco.Cms.Core.Media.EmbedProviders
 {
+    // TODO (V10): change base class to OEmbedProviderBase
     public class DailyMotion : EmbedProviderBase
     {
         public override string ApiEndpoint => "https://www.dailymotion.com/services/oembed";

src/Umbraco.Core/Media/EmbedProviders/EmbedProviderBase.cs

@@ -1,85 +1,14 @@
-using System;
-using System.Collections.Generic;
-using System.Net;
-using System.Net.Http;
-using System.Text;
-using System.Xml;
+using System;
 using Umbraco.Cms.Core.Serialization;
 
 namespace Umbraco.Cms.Core.Media.EmbedProviders
 {
-    public abstract class EmbedProviderBase : IEmbedProvider
+    [Obsolete("Use OEmbedProviderBase instead")]
+    public abstract class EmbedProviderBase : OEmbedProviderBase
     {
-        private readonly IJsonSerializer _jsonSerializer;
-
         protected EmbedProviderBase(IJsonSerializer jsonSerializer)
+            : base(jsonSerializer)
         {
-            _jsonSerializer = jsonSerializer;
-        }
-
-        private static HttpClient _httpClient;
-
-        public abstract string ApiEndpoint { get; }
-
-        public abstract string[] UrlSchemeRegex { get; }
-
-        public abstract Dictionary<string, string> RequestParams { get; }
-
-        public abstract string GetMarkup(string url, int maxWidth = 0, int maxHeight = 0);
-
-        public virtual string GetEmbedProviderUrl(string url, int maxWidth, int maxHeight)
-        {
-            if (Uri.IsWellFormedUriString(url, UriKind.RelativeOrAbsolute) == false)
-                throw new ArgumentException("Not a valid URL.", nameof(url));
-
-            var fullUrl = new StringBuilder();
-
-            fullUrl.Append(ApiEndpoint);
-            fullUrl.Append("?url=" + WebUtility.UrlEncode(url));
-
-            foreach (var param in RequestParams)
-                fullUrl.Append($"&{param.Key}={param.Value}");
-
-            if (maxWidth > 0)
-                fullUrl.Append("&maxwidth=" + maxWidth);
-
-            if (maxHeight > 0)
-                fullUrl.Append("&maxheight=" + maxHeight);
-
-            return fullUrl.ToString();
-        }
-
-        public virtual string DownloadResponse(string url)
-        {
-            if (_httpClient == null)
-                _httpClient = new HttpClient();
-
-            using (var request = new HttpRequestMessage(HttpMethod.Get, url))
-            {
-                var response = _httpClient.SendAsync(request).Result;
-                return response.Content.ReadAsStringAsync().Result;
-            }
-        }
-
-        public virtual T GetJsonResponse<T>(string url) where T : class
-        {
-            var response = DownloadResponse(url);
-            return _jsonSerializer.Deserialize<T>(response);
-        }
-
-        public virtual XmlDocument GetXmlResponse(string url)
-        {
-            var response = DownloadResponse(url);
-            var doc = new XmlDocument();
-            doc.LoadXml(response);
-
-            return doc;
-        }
-
-        public virtual string GetXmlProperty(XmlDocument doc, string property)
-        {
-            var selectSingleNode = doc.SelectSingleNode(property);
-            return selectSingleNode != null ? selectSingleNode.InnerText : string.Empty;
         }
     }
-};
+}

src/Umbraco.Core/Media/EmbedProviders/Flickr.cs

@@ -1,9 +1,10 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Net;
 using Umbraco.Cms.Core.Serialization;
 
 namespace Umbraco.Cms.Core.Media.EmbedProviders
 {
+    // TODO(V10) : change base class to OEmbedProviderBase
     public class Flickr : EmbedProviderBase
     {
         public override string ApiEndpoint => "http://www.flickr.com/services/oembed/";

src/Umbraco.Core/Media/EmbedProviders/GettyImages.cs

@@ -1,8 +1,9 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using Umbraco.Cms.Core.Serialization;
 
 namespace Umbraco.Cms.Core.Media.EmbedProviders
 {
+    // TODO(V10) : change base class to OEmbedProviderBase
     public class GettyImages : EmbedProviderBase
     {
         public override string ApiEndpoint => "http://embed.gettyimages.com/oembed";

src/Umbraco.Core/Media/EmbedProviders/Giphy.cs

@@ -1,11 +1,12 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using Umbraco.Cms.Core.Serialization;
 
 namespace Umbraco.Cms.Core.Media.EmbedProviders
 {
     /// <summary>
     /// Embed Provider for Giphy.com the popular online GIFs and animated sticker provider.
     /// </summary>
+    /// TODO(V10) : change base class to OEmbedProviderBase
     public class Giphy : EmbedProviderBase
     {
         public override string ApiEndpoint => "https://giphy.com/services/oembed?url=";

src/Umbraco.Core/Media/EmbedProviders/Hulu.cs

@@ -1,8 +1,9 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using Umbraco.Cms.Core.Serialization;
 
 namespace Umbraco.Cms.Core.Media.EmbedProviders
 {
+    // TODO(V10) : change base class to OEmbedProviderBase
     public class Hulu : EmbedProviderBase
     {
         public override string ApiEndpoint => "http://www.hulu.com/api/oembed.json";

src/Umbraco.Core/Media/EmbedProviders/Issuu.cs

@@ -1,8 +1,9 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using Umbraco.Cms.Core.Serialization;
 
 namespace Umbraco.Cms.Core.Media.EmbedProviders
 {
+    // TODO(V10) : change base class to OEmbedProviderBase
     public class Issuu : EmbedProviderBase
     {
         public override string ApiEndpoint => "https://issuu.com/oembed";

src/Umbraco.Core/Media/EmbedProviders/Kickstarter.cs

@@ -1,8 +1,9 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using Umbraco.Cms.Core.Serialization;
 
 namespace Umbraco.Cms.Core.Media.EmbedProviders
 {
+    // TODO(V10) : change base class to OEmbedProviderBase
     public class Kickstarter : EmbedProviderBase
     {
         public override string ApiEndpoint => "http://www.kickstarter.com/services/oembed";