com.utilities.rest 2.5.0

- moved optional debug parameter for multimedia endpoints into RestParameters

Utilities.Rest/Packages/com.utilities.rest/Runtime/AbstractAuthentication.cs

@@ -46,9 +46,6 @@ public virtual TAuthentication LoadDefaultsReversed()
  LoadFromDirectory() ??
  LoadFromAsset();
 
- [Obsolete("Use LoadFromAsset (remove angle bracket type specification)")]
- public TAuthentication LoadFromAsset<T>() => LoadFromAsset();
-
  /// <summary>
  /// Attempts to load the authentication from a <see cref="ScriptableObject"/> asset that implements <see cref="IConfiguration"/>.
  /// </summary>

Utilities.Rest/Packages/com.utilities.rest/Runtime/Rest.cs

@@ -498,31 +498,19 @@ public static bool TryGetFileNameFromUrl(string url, out string fileName)
 
  #endregion Download Cache
 
- [Obsolete("use new overload with debug support")]
- public static async Task<Texture2D> DownloadTextureAsync(
- string url,
- string fileName = null,
- RestParameters parameters = null,
- CancellationToken cancellationToken = default)
- {
- return await DownloadTextureAsync(url, fileName, parameters, false, cancellationToken);
- }
-
  /// <summary>
  /// Download a <see cref="Texture2D"/> from the provided <see cref="url"/>.
  /// </summary>
  /// <param name="url">The url to download the <see cref="Texture2D"/> from.</param>
  /// <param name="fileName">Optional, file name to download (including extension).</param>
  /// <param name="parameters">Optional, <see cref="RestParameters"/>.</param>
- /// <param name="debug">Optional, debug http request.</param>
  /// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
  /// <returns>A new <see cref="Texture2D"/> instance.</returns>
  public static async Task<Texture2D> DownloadTextureAsync(
- string url,
- string fileName = null,
- RestParameters parameters = null,
- bool debug = false,
- CancellationToken cancellationToken = default)
+ string url,
+ string fileName = null,
+ RestParameters parameters = null,
+ CancellationToken cancellationToken = default)
  {
  await Awaiters.UnityMainThread;
 
@@ -557,7 +545,7 @@ public static bool TryGetFileNameFromUrl(string url, out string fileName)
  try
  {
  var response = await webRequest.SendAsync(parameters, cancellationToken);
- response.Validate(debug);
+ response.Validate(parameters.Debug);
 
  if (!isCached)
  {
@@ -580,16 +568,6 @@ public static bool TryGetFileNameFromUrl(string url, out string fileName)
  return texture;
  }
 
- [Obsolete("Use new overload with debug support")]
- public static async Task<AudioClip> DownloadAudioClipAsync(
- string url,
- AudioType audioType,
- RestParameters parameters = null,
- CancellationToken cancellationToken = default)
- {
- return await DownloadAudioClipAsync(url, audioType, httpMethod: UnityWebRequest.kHttpVerbGET, parameters: parameters, cancellationToken: cancellationToken);
- }
-
  /// <summary>
  /// Download a <see cref="AudioClip"/> from the provided <see cref="url"/>.
  /// </summary>
@@ -600,7 +578,6 @@ public static bool TryGetFileNameFromUrl(string url, out string fileName)
  /// <param name="jsonData">Optional, json payload. Only <see cref="jsonData"/> OR <see cref="payload"/> can be supplied.</param>
  /// <param name="payload">Optional, raw byte payload. Only <see cref="payload"/> OR <see cref="jsonData"/> can be supplied.</param>
  /// <param name="parameters">Optional, <see cref="RestParameters"/>.</param>
- /// <param name="debug">Optional, debug http request.</param>
  /// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
  /// <returns>A new <see cref="AudioClip"/> instance.</returns>
  public static async Task<AudioClip> DownloadAudioClipAsync(
@@ -611,7 +588,6 @@ public static bool TryGetFileNameFromUrl(string url, out string fileName)
  string jsonData = null,
  byte[] payload = null,
  RestParameters parameters = null,
- bool debug = false,
  CancellationToken cancellationToken = default)
  {
  await Awaiters.UnityMainThread;
@@ -684,7 +660,7 @@ public static bool TryGetFileNameFromUrl(string url, out string fileName)
  try
  {
  var response = await webRequest.SendAsync(parameters, cancellationToken);
- response.Validate(debug);
+ response.Validate(parameters.Debug);
 
  if (!isCached)
  {
@@ -721,7 +697,6 @@ public static bool TryGetFileNameFromUrl(string url, out string fileName)
  /// <param name="fileName">Optional, file name to download (including extension).</param>
  /// <param name="playbackAmountThreshold">Optional, the amount of data to to download before signaling that streaming is ready.</param>
  /// <param name="parameters">Optional, <see cref="RestParameters"/>.</param>
- /// <param name="debug">Optional, debug http request.</param>
  /// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
  /// <returns>A new <see cref="AudioClip"/> instance.</returns>
  public static async Task<AudioClip> StreamAudioAsync(
@@ -734,7 +709,6 @@ public static bool TryGetFileNameFromUrl(string url, out string fileName)
  byte[] payload = null,
  ulong playbackAmountThreshold = 10000,
  RestParameters parameters = null,
- bool debug = false,
  CancellationToken cancellationToken = default)
  {
  await Awaiters.UnityMainThread;
@@ -828,7 +802,7 @@ public static bool TryGetFileNameFromUrl(string url, out string fileName)
 
  var response = await webRequest.SendAsync(parameters, cancellationToken);
  uploadHandler?.Dispose();
- response.Validate(debug);
+ response.Validate(parameters.Debug);
 
  var loadedClip = downloadHandler.audioClip;
 
@@ -906,61 +880,40 @@ public static bool TryGetFileNameFromUrl(string url, out string fileName)
 
  using (webRequest)
  {
- Response response;
+ parameters ??= new RestParameters();
+ parameters.Timeout = options?.Timeout ?? -1;
+ parameters.DisposeDownloadHandler = false;
+ var response = await webRequest.SendAsync(parameters, cancellationToken);
+ response.Validate(parameters.Debug);
 
- try
- {
- parameters ??= new RestParameters();
- parameters.Timeout = options?.Timeout ?? -1;
- parameters.DisposeDownloadHandler = false;
- response = await webRequest.SendAsync(parameters, cancellationToken);
- }
- catch (Exception e)
- {
- Debug.LogError(e);
- throw;
- }
+ var downloadHandler = (DownloadHandlerAssetBundle)webRequest.downloadHandler;
+ var assetBundle = downloadHandler.assetBundle;
+ downloadHandler.Dispose();
 
- if (!response.Successful)
+ if (assetBundle == null)
  {
- Debug.LogError($"Failed to download asset bundle from \"{url}\"!\n{response.Code}:{response.Body}");
- return null;
+ throw new RestException(response, $"Failed to download asset bundle from \"{url}\"!");
  }
 
- var downloadHandler = (DownloadHandlerAssetBundle)webRequest.downloadHandler;
- var assetBundle = downloadHandler.assetBundle;
- downloadHandler.Dispose();
  return assetBundle;
  }
  }
 
 #endif // UNITY_ADDRESSABLES
 
- [Obsolete("use new overload with debug support")]
- public static async Task<string> DownloadFileAsync(
- string url,
- string fileName = null,
- RestParameters parameters = null,
- CancellationToken cancellationToken = default)
- {
- return await DownloadFileAsync(url, fileName, parameters, false, cancellationToken);
- }
-
  /// <summary>
  /// Download a file from the provided <see cref="url"/>.
  /// </summary>
  /// <param name="url">The url to download the file from.</param>
  /// <param name="fileName">Optional, file name to download (including extension).</param>
  /// <param name="parameters">Optional, <see cref="RestParameters"/>.</param>
- /// <param name="debug">Optional, debug http request.</param>
  /// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
  /// <returns>The path to the downloaded file.</returns>
  public static async Task<string> DownloadFileAsync(
- string url,
- string fileName = null,
- RestParameters parameters = null,
- bool debug = false,
- CancellationToken cancellationToken = default)
+ string url,
+ string fileName = null,
+ RestParameters parameters = null,
+ CancellationToken cancellationToken = default)
  {
  await Awaiters.UnityMainThread;
 
@@ -979,7 +932,7 @@ public static bool TryGetFileNameFromUrl(string url, out string fileName)
  fileDownloadHandler.removeFileOnAbort = true;
  webRequest.downloadHandler = fileDownloadHandler;
  var response = await webRequest.SendAsync(parameters, cancellationToken);
- response.Validate(debug);
+ response.Validate(parameters?.Debug ?? false);
  return filePath;
  }
 

Utilities.Rest/Packages/com.utilities.rest/Runtime/RestParameters.cs

@@ -21,14 +21,16 @@ public class RestParameters
  /// <param name="disposeUploadHandler">Optional, dispose the <see cref="UploadHandler"/>?<br/>Default is true.</param>
  /// <param name="certificateHandler">Optional, certificate handler for the request.</param>
  /// <param name="disposeCertificateHandler">Optional, dispose the <see cref="CertificateHandler"/>?<br/>Default is true.</param>
+ /// <param name="debug">Optional,Enabled printing for the debug output of the request.</param>
  public RestParameters(
  IReadOnlyDictionary<string, string> headers = null,
  IProgress<Progress> progress = null,
  int timeout = -1,
  bool disposeDownloadHandler = true,
  bool disposeUploadHandler = true,
  CertificateHandler certificateHandler = null,
- bool disposeCertificateHandler = true)
+ bool disposeCertificateHandler = true,
+ bool debug = false)
  {
  Headers = headers;
  Progress = progress;
@@ -37,6 +39,7 @@ public class RestParameters
  DisposeUploadHandler = disposeUploadHandler;
  CertificateHandler = certificateHandler;
  DisposeCertificateHandler = disposeCertificateHandler;
+ Debug = debug;
  }
 
  /// <summary>
@@ -78,5 +81,10 @@ public class RestParameters
  public bool DisposeUploadHandler { get; internal set; }
 
  internal int ServerSentEventCount { get; set; }
+
+ /// <summary>
+ /// Enabled printing for the debug output of the request.
+ /// </summary>
+ public bool Debug { get; set; }
  }
 }

Utilities.Rest/Packages/com.utilities.rest/package.json

@@ -3,7 +3,7 @@
  "displayName": "Utilities.Rest",
  "description": "This package contains useful RESTful utilities for the Unity Game Engine.",
  "keywords": [],
- "version": "2.4.6",
+ "version": "2.5.0",
  "unity": "2021.3",
  "documentationUrl": "https://github.com/RageAgainstThePixel/com.utilities.rest#documentation",
  "changelogUrl": "https://github.com/RageAgainstThePixel/com.utilities.rest/releases",

Utilities.Rest/Packages/manifest.json

@@ -1,5 +1,6 @@
 {
  "dependencies": {
+ "com.unity.addressables": "1.21.19",
  "com.unity.ide.rider": "3.0.27",
  "com.unity.ide.visualstudio": "2.0.22",
  "com.utilities.buildpipeline": "1.1.9"