Prepare for 3.2.0 release

billp · Dec 16, 2022 · a14e4d0 · a14e4d0
1 parent 63663b5
commit a14e4d0
Show file tree

Hide file tree

Showing 78 changed files with 1,506 additions and 237 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,31 @@
 
 ## [Unreleased](https://github.com/billp/TermiNetwork/tree/HEAD)
 
-[Full Changelog](https://github.com/billp/TermiNetwork/compare/3.1.0...HEAD)
+[Full Changelog](https://github.com/billp/TermiNetwork/compare/3.1.1...HEAD)
+
+**Implemented enhancements:**
+
+- Write test cases covering task cancelation [\#44](https://github.com/billp/TermiNetwork/issues/44)
+- Wrap all async functions with withTaskCancellationHandler that cancels the request if needed [\#43](https://github.com/billp/TermiNetwork/issues/43)
+- Support task cancellation on async functions [\#42](https://github.com/billp/TermiNetwork/issues/42)
+
+**Closed issues:**
+
+- Unescape escaped slashes of response from logger [\#49](https://github.com/billp/TermiNetwork/issues/49)
+- Fix duplicated debug print on codable deserialisation error [\#46](https://github.com/billp/TermiNetwork/issues/46)
+- No need to handle middleware if there is already an error [\#40](https://github.com/billp/TermiNetwork/issues/40)
+- Change access level of Transformer's internal protocol type [\#37](https://github.com/billp/TermiNetwork/issues/37)
+
+**Merged pull requests:**
+
+- Support task cancellation on async functions \(\#42\) [\#51](https://github.com/billp/TermiNetwork/pull/51) ([billp](https://github.com/billp))
+- Unescape escaped slashes of response from logger \(\#49\) [\#50](https://github.com/billp/TermiNetwork/pull/50) ([billp](https://github.com/billp))
+- Fix duplicated debug print on codable deserialisation error \(\#46\) [\#47](https://github.com/billp/TermiNetwork/pull/47) ([billp](https://github.com/billp))
+- if there is already an error, then no need to handle the middleware [\#39](https://github.com/billp/TermiNetwork/pull/39) ([voynovia](https://github.com/voynovia))
+
+## [3.1.1](https://github.com/billp/TermiNetwork/tree/3.1.1) (2022-12-04)
+
+[Full Changelog](https://github.com/billp/TermiNetwork/compare/3.1.0...3.1.1)
 
 **Closed issues:**
 

diff --git a/README.md b/README.md
@@ -76,19 +76,19 @@ You can install **TermiNetwork** with one of the following ways...
 
 Add the following line to your **Podfile** and run **pod install** in your terminal:
 ```ruby
-pod 'TermiNetwork', '~> 3.0.0'
+pod 'TermiNetwork', '~> 3.2.0'
 ```
 
 ### Carthage
 
 Add the following line to your **Carthage** and run **carthage update** in your terminal:
 ```ruby
-github "billp/TermiNetwork" ~> 3.0.0
+github "billp/TermiNetwork" ~> 3.2.0
 ```
 
 ### Swift Package Manager
 
-Go to **File** > **Swift Packages** > **Add Package Dependency** and add the following URL :
+Go to **File** > **Swift Packages** > **Add Package Dependency** and add the following URL:
 ```
 https://github.com/billp/TermiNetwork
 ```

diff --git a/TermiNetwork.podspec b/TermiNetwork.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'TermiNetwork'
-  s.version          = '3.1.1'
+  s.version          = '3.2.0'
   s.summary          = 'A zero-dependency networking solution for building modern and secure iOS, watchOS, macOS and tvOS applications.'
   s.homepage         = 'https://github.com/billp/TermiNetwork.git'
   s.license          = 'MIT'

diff --git a/docs/Classes.html b/docs/Classes.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="index.html">
-          TermiNetwork 3.0.0 Docs
+          TermiNetwork 3.2.0 Docs
         </a>
-         (100% documented)
+         (98% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -149,6 +149,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="Protocols/RouteProtocol.html">RouteProtocol</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="Protocols/TransformerProtocol.html">TransformerProtocol</a>
+              </li>
             </ul>
           </li>
           <li class="nav-group-name">
@@ -346,7 +349,7 @@ <h4>Declaration</h4>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Transformer</span><span class="o">&lt;</span><span class="kt">FromType</span><span class="p">,</span> <span class="kt">ToType</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">TransformerProtocol</span></code></pre>
+                          <pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">Transformer</span><span class="o">&lt;</span><span class="kt">FromType</span><span class="p">,</span> <span class="kt">ToType</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt"><a href="Protocols/TransformerProtocol.html">TransformerProtocol</a></span></code></pre>
 
                         </div>
                       </div>
@@ -543,7 +546,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-01)</p>
+      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-16)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/Cache.html b/docs/Classes/Cache.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          TermiNetwork 3.0.0 Docs
+          TermiNetwork 3.2.0 Docs
         </a>
-         (100% documented)
+         (98% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -149,6 +149,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/RouteProtocol.html">RouteProtocol</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/TransformerProtocol.html">TransformerProtocol</a>
+              </li>
             </ul>
           </li>
           <li class="nav-group-name">
@@ -359,7 +362,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-01)</p>
+      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-16)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/Configuration.html b/docs/Classes/Configuration.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          TermiNetwork 3.0.0 Docs
+          TermiNetwork 3.2.0 Docs
         </a>
-         (100% documented)
+         (98% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -149,6 +149,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/RouteProtocol.html">RouteProtocol</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/TransformerProtocol.html">TransformerProtocol</a>
+              </li>
             </ul>
           </li>
           <li class="nav-group-name">
@@ -820,7 +823,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-01)</p>
+      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-16)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/Environment.html b/docs/Classes/Environment.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          TermiNetwork 3.0.0 Docs
+          TermiNetwork 3.2.0 Docs
         </a>
-         (100% documented)
+         (98% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -149,6 +149,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/RouteProtocol.html">RouteProtocol</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/TransformerProtocol.html">TransformerProtocol</a>
+              </li>
             </ul>
           </li>
           <li class="nav-group-name">
@@ -612,7 +615,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-01)</p>
+      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-16)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/Operation.html b/docs/Classes/Operation.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          TermiNetwork 3.0.0 Docs
+          TermiNetwork 3.2.0 Docs
         </a>
-         (100% documented)
+         (98% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -149,6 +149,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/RouteProtocol.html">RouteProtocol</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/TransformerProtocol.html">TransformerProtocol</a>
+              </li>
             </ul>
           </li>
           <li class="nav-group-name">
@@ -300,7 +303,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-01)</p>
+      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-16)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/Queue.html b/docs/Classes/Queue.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          TermiNetwork 3.0.0 Docs
+          TermiNetwork 3.2.0 Docs
         </a>
-         (100% documented)
+         (98% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -149,6 +149,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/RouteProtocol.html">RouteProtocol</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/TransformerProtocol.html">TransformerProtocol</a>
+              </li>
             </ul>
           </li>
           <li class="nav-group-name">
@@ -523,7 +526,7 @@ <h4>Parameters</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-01)</p>
+      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-16)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/Reachability.html b/docs/Classes/Reachability.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          TermiNetwork 3.0.0 Docs
+          TermiNetwork 3.2.0 Docs
         </a>
-         (100% documented)
+         (98% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -149,6 +149,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/RouteProtocol.html">RouteProtocol</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/TransformerProtocol.html">TransformerProtocol</a>
+              </li>
             </ul>
           </li>
           <li class="nav-group-name">
@@ -387,7 +390,7 @@ <h4>Declaration</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-01)</p>
+      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-16)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>

diff --git a/docs/Classes/Request.html b/docs/Classes/Request.html
@@ -21,9 +21,9 @@
     <header class="header">
       <p class="header-col header-col--primary">
         <a class="header-link" href="../index.html">
-          TermiNetwork 3.0.0 Docs
+          TermiNetwork 3.2.0 Docs
         </a>
-         (100% documented)
+         (98% documented)
       </p>
 
       <div class="header-col--secondary">
@@ -149,6 +149,9 @@
               <li class="nav-group-task">
                 <a class="nav-group-task-link" href="../Protocols/RouteProtocol.html">RouteProtocol</a>
               </li>
+              <li class="nav-group-task">
+                <a class="nav-group-task-link" href="../Protocols/TransformerProtocol.html">TransformerProtocol</a>
+              </li>
             </ul>
           </li>
           <li class="nav-group-name">
@@ -2648,6 +2651,46 @@ <h4>Return Value</h4>
                     </section>
                   </div>
                 </li>
+              </ul>
+            </div>
+            <div class="task-group">
+              <div class="task-name-container">
+                <a name="/Helpers"></a>
+                <a name="//apple_ref/swift/Section/Helpers" class="dashAnchor"></a>
+                <div class="section-name-container">
+                  <a class="section-name-link" href="#/Helpers"></a>
+                  <h3 class="section-name"><span>Helpers</span>
+</h3>
+                </div>
+              </div>
+              <ul class="item-container">
+                <li class="item">
+                  <div>
+                    <code>
+                    <a name="/s:12TermiNetwork7RequestC21checkTaskCancellationyyKF"></a>
+                    <a name="//apple_ref/swift/Method/checkTaskCancellation()" class="dashAnchor"></a>
+                    <a class="token" href="#/s:12TermiNetwork7RequestC21checkTaskCancellationyyKF">checkTaskCancellation()</a>
+                    </code>
+                  </div>
+                  <div class="height-container">
+                    <div class="pointer-container"></div>
+                    <section class="section">
+                      <div class="pointer"></div>
+                      <div class="abstract">
+                        <p>Checks if the task has been cancelled and throws an Error in that case.</p>
+
+                      </div>
+                      <div class="declaration">
+                        <h4>Declaration</h4>
+                        <div class="language">
+                          <p class="aside-title">Swift</p>
+                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">checkTaskCancellation</span><span class="p">()</span> <span class="k">throws</span></code></pre>
+
+                        </div>
+                      </div>
+                    </section>
+                  </div>
+                </li>
                 <li class="item">
                   <div>
                     <code>
@@ -2730,7 +2773,7 @@ <h4>Parameters</h4>
       </article>
     </div>
     <section class="footer">
-      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-01)</p>
+      <p>&copy; 2022 <a class="link" href="https://github.com/billp/TermiNetwork" target="_blank" rel="external noopener">Vasilis Panagiotopoulos</a>. All rights reserved. (Last updated: 2022-12-16)</p>
       <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
     </section>
   </body>