com.utilities.rest 1.2.3 (#10)

- added PATCH - updated dependencies
RageAgainstThePixel · Mar 10, 2023 · fd52007 · fd52007
1 parent 46e3116
commit fd52007
Show file tree

Hide file tree

Showing 10 changed files with 93 additions and 53 deletions.
diff --git a/Documentation~/README.md b/Documentation~/README.md
@@ -41,6 +41,7 @@ Advanced features includes progress notifications, authentication and native mul
 - [Get](#get)
 - [Post](#post)
 - [Put](#put)
+- [Patch](#patch)
 - [Delete](#delete)
 - [Download Multimedia](#multimedia)
  - [Caching](#caching)
@@ -112,6 +113,24 @@ catch (Exception e)
 Debug.Log($"[{response.ResponseCode}] {response.ResponseBody}");
 ```
 
+### Patch
+
+```csharp
+Response response;
+string jsonData = "{\"data\":\"content\"}";
+
+try
+{
+ response = await Rest.PatchAsync("www.your.api/endpoint", jsonData);
+}
+catch (Exception e)
+{
+ Debug.LogError(e);
+}
+
+Debug.Log($"[{response.ResponseCode}] {response.ResponseBody}");
+```
+
 ### Delete
 
 ```csharp

diff --git a/Editor.meta b/Editor.meta
diff --git a/Editor/AssemblyInfo.cs b/Editor/AssemblyInfo.cs
diff --git a/Editor/AssemblyInfo.cs.meta b/Editor/AssemblyInfo.cs.meta
diff --git a/Editor/Utilities.Rest.Editor.asmdef b/Editor/Utilities.Rest.Editor.asmdef
diff --git a/Editor/Utilities.Rest.Editor.asmdef.meta b/Editor/Utilities.Rest.Editor.asmdef.meta
diff --git a/Runtime/Rest.cs b/Runtime/Rest.cs
@@ -19,6 +19,8 @@ namespace Utilities.WebRequestRest
  /// </summary>
  public static class Rest
  {
+ private const string khttpVerbPATCH = "PATCH";
+
  #region Authentication
 
  /// <summary>
@@ -131,9 +133,9 @@ public static string GetBearerOAuthToken(string authToken)
  CancellationToken cancellationToken = default)
  {
 #if UNITY_2022_2_OR_NEWER
- using var webRequest = UnityWebRequest.PostWwwForm(query, "POST");
+ using var webRequest = UnityWebRequest.PostWwwForm(query, UnityWebRequest.kHttpVerbPOST);
 #else
- using var webRequest = UnityWebRequest.Post(query, "POST");
+ using var webRequest = UnityWebRequest.Post(query, UnityWebRequest.kHttpVerbPOST);
 #endif
  var data = new UTF8Encoding().GetBytes(jsonData);
  webRequest.uploadHandler = new UploadHandlerRaw(data);
@@ -162,9 +164,9 @@ public static string GetBearerOAuthToken(string authToken)
  CancellationToken cancellationToken = default)
  {
 #if UNITY_2022_2_OR_NEWER
- using var webRequest = UnityWebRequest.PostWwwForm(query, "POST");
+ using var webRequest = UnityWebRequest.PostWwwForm(query, UnityWebRequest.kHttpVerbPOST);
 #else
- using var webRequest = UnityWebRequest.Post(query, "POST");
+ using var webRequest = UnityWebRequest.Post(query, UnityWebRequest.kHttpVerbPOST);
 #endif
  webRequest.uploadHandler = new UploadHandlerRaw(bodyData);
  webRequest.downloadHandler = new DownloadHandlerBuffer();
@@ -224,6 +226,58 @@ public static string GetBearerOAuthToken(string authToken)
 
  #endregion PUT
 
+ #region PATCH
+
+ /// <summary>
+ /// Rest PATCH.
+ /// </summary>
+ /// <param name="query">Finalized Endpoint Query with parameters.</param>
+ /// <param name="jsonData">Data to be submitted.</param>
+ /// <param name="headers">Optional, header information for the request.</param>
+ /// <param name="progress">Optional, <see cref="IProgress{T}"/> handler.</param>
+ /// <param name="timeout">Optional, time in seconds before request expires.</param>
+ /// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
+ /// <returns>The response data.</returns>
+ public static async Task<Response> PatchAsync(
+ string query,
+ string jsonData,
+ Dictionary<string, string> headers = null,
+ IProgress<float> progress = null,
+ int timeout = -1,
+ CancellationToken cancellationToken = default)
+ {
+ using var webRequest = UnityWebRequest.Put(query, jsonData);
+ webRequest.method = khttpVerbPATCH;
+ webRequest.SetRequestHeader("Content-Type", "application/json");
+ return await ProcessRequestAsync(webRequest, headers, progress, timeout, cancellationToken);
+ }
+
+ /// <summary>
+ /// Rest PATCH.
+ /// </summary>
+ /// <param name="query">Finalized Endpoint Query with parameters.</param>
+ /// <param name="bodyData">Data to be submitted.</param>
+ /// <param name="headers">Optional, header information for the request.</param>
+ /// <param name="progress">Optional, <see cref="IProgress{T}"/> handler.</param>
+ /// <param name="timeout">Optional, time in seconds before request expires.</param>
+ /// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
+ /// <returns>The response data.</returns>
+ public static async Task<Response> PatchAsync(
+ string query,
+ byte[] bodyData,
+ Dictionary<string, string> headers = null,
+ IProgress<float> progress = null,
+ int timeout = -1,
+ CancellationToken cancellationToken = default)
+ {
+ using var webRequest = UnityWebRequest.Put(query, bodyData);
+ webRequest.method = khttpVerbPATCH;
+ webRequest.SetRequestHeader("Content-Type", "application/octet-stream");
+ return await ProcessRequestAsync(webRequest, headers, progress, timeout, cancellationToken);
+ }
+
+ #endregion PATCH
+
  #region DELETE
 
  /// <summary>
@@ -680,7 +734,8 @@ private static bool TryGetFileNameFromUrl(string url, out string fileName)
 
  var isUpload = webRequest.method is
  UnityWebRequest.kHttpVerbPOST or
- UnityWebRequest.kHttpVerbPUT;
+ UnityWebRequest.kHttpVerbPUT or
+ khttpVerbPATCH;
 
  // HACK: Workaround for extra quotes around boundary.
  if (isUpload)

diff --git a/Runtime/Utilities.Rest.asmdef b/Runtime/Utilities.Rest.asmdef
@@ -1,6 +1,6 @@
 {
  "name": "Utilities.Rest",
- "rootNamespace": "",
+ "rootNamespace": "Utilities.Rest",
  "references": [
  "GUID:a6609af893242c7438d701ddd4cce46a",
  "GUID:84651a3751eca9349aac36a66bba901b"

diff --git a/Tests/Utilities.Rest.Tests.asmdef b/Tests/Utilities.Rest.Tests.asmdef
@@ -1,8 +1,11 @@
 {
  "name": "Utilities.Rest.Tests",
+ "rootNamespace": "Utilities.Rest.Tests",
  "references": [
  "GUID:27619889b8ba8c24980f49ee34dbb44a",
- "GUID:0acc523941302664db1f4e527237feb3"
+ "GUID:0acc523941302664db1f4e527237feb3",
+ "GUID:a6609af893242c7438d701ddd4cce46a",
+ "GUID:7958db66189566541a6363568aee1575"
  ],
  "includePlatforms": [
  "Editor"

diff --git a/package.json b/package.json
@@ -3,22 +3,27 @@
  "displayName": "Utilities.Rest",
  "description": "This package contains useful RESTful utilities for the Unity Game Engine.",
  "keywords": [],
- "version": "1.2.2",
+ "version": "1.2.3",
  "unity": "2021.3",
  "documentationUrl": "https://github.com/RageAgainstThePixel/com.utilities.rest#documentation",
  "changelogUrl": "https://github.com/RageAgainstThePixel/com.utilities.rest/releases",
  "license": "MIT",
  "repository": {
- "type": "git"
+ "type": "git",
+ "repository": "https://github.com/RageAgainstThePixel/com.utilities.rest.git"
  },
  "author": "Stephen Hodgson",
+ "url": "https://github.com/StephenHodgson",
  "dependencies": {
- "com.utilities.async": "1.2.0",
+ "com.utilities.async": "1.2.1",
  "com.unity.modules.unitywebrequest": "1.0.0",
  "com.unity.modules.unitywebrequestassetbundle": "1.0.0",
  "com.unity.modules.unitywebrequestaudio": "1.0.0",
  "com.unity.modules.unitywebrequesttexture": "1.0.0",
  "com.unity.modules.unitywebrequestwww": "1.0.0"
  },
- "hideInEditor": true
+ "hideInEditor": true,
+ "publishConfig": {
+ "registry": "https://package.openupm.com"
+ }
 }