feat(okhttp-android): update documents

ghasemdev · Aug 22, 2022 · 6a61d58 · 6a61d58
1 parent 00eb394
commit 6a61d58
Show file tree

Hide file tree

Showing 33 changed files with 2,537 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,14 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [🎉 1.5.0 Structure, Logger] - 2022-08-22
+## [🎉 1.5.0 Structure, Logger, OkHttp] - 2022-08-22
 
 ### 🚀 Features
 
+* Add `okhttp-android` module
+	* okhttp builder extension `okhttpClient {}` , `Response.new {}` and `OkHttpClient.new {}`.
+	* download and upload progress listener `DownloadStreamResponseBody`, `UploadStreamRequestBody`.
 * Add `logger-android` module
-  * `LogLevel` enum.
-  * `logcat` extension.
-  * Singleton `Logger`.
+	* `LogLevel` enum.
+	* `logcat` extension.
+	* Singleton `Logger`.
 
 ### 💥 Breaking Changes
 

diff --git a/README.md b/README.md
@@ -81,6 +81,19 @@ data class Foo(val bar: String)
 YandexMetricaX.reportEvent("event_name", Foo("bar"))
 ```
 
+### [Okhttp](https://github.com/ghasemdev/affogato/wiki/Okhttp)
+
+Okhttp builder is part of this module. You can use it for building okhttp client with a simple
+syntax. Also, you can track download and upload progress with `DownloadStreamResponseBody`
+and `UploadStreamRequestBody`.
+
+```kotlin
+val client = okHttp {
+  addInterceptor(HttpLoggingInterceptor())
+  cache(Cache(cacheDir, cacheSize))
+}
+```
+
 ### [Structure](https://github.com/ghasemdev/affogato/wiki/Structure)
 
 This module contains useful structure class like `DataState` and `EntityMapper`. Also, it contains

diff --git a/docs/affogato-core-ktx/navigation.html b/docs/affogato-core-ktx/navigation.html
@@ -444,6 +444,36 @@
    </div> 
   </div> 
  </div>  
+ <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu" pageid="affogato-okhttp-android::////PointingToDeclaration//-924715819"> 
+  <div class="overview">
+   <span class="navButton" onclick="document.getElementById(&quot;affogato-okhttp-android-nav-submenu&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-okhttp-android/index.html"><span><span>affogato-okhttp-android</span></span></a>
+  </div> 
+  <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-0" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android////PointingToDeclaration//-924715819"> 
+   <div class="overview">
+    <span class="navButton" onclick="document.getElementById(&quot;affogato-okhttp-android-nav-submenu-0&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android/index.html"><span>com.</span><wbr><span>parsuomash.</span><wbr><span>affogato.</span><wbr><span>okhttp.</span><wbr><span>android</span></a>
+   </div> 
+   <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-0-0" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android/OkHttpKt///PointingToDeclaration//-924715819"> 
+    <div class="overview">
+     <a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android/-ok-http-kt/index.html"><span>Ok</span><wbr><span>Http</span><wbr><span><span>Kt</span></span></a>
+    </div> 
+   </div> 
+  </div> 
+  <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-1" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android.progress////PointingToDeclaration//-924715819"> 
+   <div class="overview">
+    <span class="navButton" onclick="document.getElementById(&quot;affogato-okhttp-android-nav-submenu-1&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android.progress/index.html"><span>com.</span><wbr><span>parsuomash.</span><wbr><span>affogato.</span><wbr><span>okhttp.</span><wbr><span>android.</span><wbr><span>progress</span></a>
+   </div> 
+   <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-1-0" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android.progress/DownloadStreamResponseBody///PointingToDeclaration//-924715819"> 
+    <div class="overview">
+     <a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android.progress/-download-stream-response-body/index.html"><span>Download</span><wbr><span>Stream</span><wbr><span>Response</span><wbr><span><span>Body</span></span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-1-1" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android.progress/UploadStreamRequestBody///PointingToDeclaration//-924715819"> 
+    <div class="overview">
+     <a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android.progress/-upload-stream-request-body/index.html"><span>Upload</span><wbr><span>Stream</span><wbr><span>Request</span><wbr><span><span>Body</span></span></a>
+    </div> 
+   </div> 
+  </div> 
+ </div>  
  <div class="sideMenuPart" id="affogato-structure-nav-submenu" pageid="affogato-structure::////PointingToDeclaration//-390748097"> 
   <div class="overview">
    <span class="navButton" onclick="document.getElementById(&quot;affogato-structure-nav-submenu&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-structure/index.html"><span><span>affogato-structure</span></span></a>

diff --git a/docs/affogato-coroutines-core/navigation.html b/docs/affogato-coroutines-core/navigation.html
@@ -444,6 +444,36 @@
    </div> 
   </div> 
  </div>  
+ <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu" pageid="affogato-okhttp-android::////PointingToDeclaration//-924715819"> 
+  <div class="overview">
+   <span class="navButton" onclick="document.getElementById(&quot;affogato-okhttp-android-nav-submenu&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-okhttp-android/index.html"><span><span>affogato-okhttp-android</span></span></a>
+  </div> 
+  <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-0" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android////PointingToDeclaration//-924715819"> 
+   <div class="overview">
+    <span class="navButton" onclick="document.getElementById(&quot;affogato-okhttp-android-nav-submenu-0&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android/index.html"><span>com.</span><wbr><span>parsuomash.</span><wbr><span>affogato.</span><wbr><span>okhttp.</span><wbr><span>android</span></a>
+   </div> 
+   <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-0-0" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android/OkHttpKt///PointingToDeclaration//-924715819"> 
+    <div class="overview">
+     <a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android/-ok-http-kt/index.html"><span>Ok</span><wbr><span>Http</span><wbr><span><span>Kt</span></span></a>
+    </div> 
+   </div> 
+  </div> 
+  <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-1" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android.progress////PointingToDeclaration//-924715819"> 
+   <div class="overview">
+    <span class="navButton" onclick="document.getElementById(&quot;affogato-okhttp-android-nav-submenu-1&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android.progress/index.html"><span>com.</span><wbr><span>parsuomash.</span><wbr><span>affogato.</span><wbr><span>okhttp.</span><wbr><span>android.</span><wbr><span>progress</span></a>
+   </div> 
+   <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-1-0" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android.progress/DownloadStreamResponseBody///PointingToDeclaration//-924715819"> 
+    <div class="overview">
+     <a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android.progress/-download-stream-response-body/index.html"><span>Download</span><wbr><span>Stream</span><wbr><span>Response</span><wbr><span><span>Body</span></span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-1-1" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android.progress/UploadStreamRequestBody///PointingToDeclaration//-924715819"> 
+    <div class="overview">
+     <a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android.progress/-upload-stream-request-body/index.html"><span>Upload</span><wbr><span>Stream</span><wbr><span>Request</span><wbr><span><span>Body</span></span></a>
+    </div> 
+   </div> 
+  </div> 
+ </div>  
  <div class="sideMenuPart" id="affogato-structure-nav-submenu" pageid="affogato-structure::////PointingToDeclaration//-390748097"> 
   <div class="overview">
    <span class="navButton" onclick="document.getElementById(&quot;affogato-structure-nav-submenu&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-structure/index.html"><span><span>affogato-structure</span></span></a>

diff --git a/docs/affogato-logger-android/navigation.html b/docs/affogato-logger-android/navigation.html
@@ -444,6 +444,36 @@
    </div> 
   </div> 
  </div>  
+ <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu" pageid="affogato-okhttp-android::////PointingToDeclaration//-924715819"> 
+  <div class="overview">
+   <span class="navButton" onclick="document.getElementById(&quot;affogato-okhttp-android-nav-submenu&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-okhttp-android/index.html"><span><span>affogato-okhttp-android</span></span></a>
+  </div> 
+  <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-0" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android////PointingToDeclaration//-924715819"> 
+   <div class="overview">
+    <span class="navButton" onclick="document.getElementById(&quot;affogato-okhttp-android-nav-submenu-0&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android/index.html"><span>com.</span><wbr><span>parsuomash.</span><wbr><span>affogato.</span><wbr><span>okhttp.</span><wbr><span>android</span></a>
+   </div> 
+   <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-0-0" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android/OkHttpKt///PointingToDeclaration//-924715819"> 
+    <div class="overview">
+     <a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android/-ok-http-kt/index.html"><span>Ok</span><wbr><span>Http</span><wbr><span><span>Kt</span></span></a>
+    </div> 
+   </div> 
+  </div> 
+  <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-1" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android.progress////PointingToDeclaration//-924715819"> 
+   <div class="overview">
+    <span class="navButton" onclick="document.getElementById(&quot;affogato-okhttp-android-nav-submenu-1&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android.progress/index.html"><span>com.</span><wbr><span>parsuomash.</span><wbr><span>affogato.</span><wbr><span>okhttp.</span><wbr><span>android.</span><wbr><span>progress</span></a>
+   </div> 
+   <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-1-0" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android.progress/DownloadStreamResponseBody///PointingToDeclaration//-924715819"> 
+    <div class="overview">
+     <a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android.progress/-download-stream-response-body/index.html"><span>Download</span><wbr><span>Stream</span><wbr><span>Response</span><wbr><span><span>Body</span></span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-1-1" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android.progress/UploadStreamRequestBody///PointingToDeclaration//-924715819"> 
+    <div class="overview">
+     <a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android.progress/-upload-stream-request-body/index.html"><span>Upload</span><wbr><span>Stream</span><wbr><span>Request</span><wbr><span><span>Body</span></span></a>
+    </div> 
+   </div> 
+  </div> 
+ </div>  
  <div class="sideMenuPart" id="affogato-structure-nav-submenu" pageid="affogato-structure::////PointingToDeclaration//-390748097"> 
   <div class="overview">
    <span class="navButton" onclick="document.getElementById(&quot;affogato-structure-nav-submenu&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-structure/index.html"><span><span>affogato-structure</span></span></a>

diff --git a/docs/affogato-metrica-ktx/navigation.html b/docs/affogato-metrica-ktx/navigation.html
@@ -444,6 +444,36 @@
    </div> 
   </div> 
  </div>  
+ <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu" pageid="affogato-okhttp-android::////PointingToDeclaration//-924715819"> 
+  <div class="overview">
+   <span class="navButton" onclick="document.getElementById(&quot;affogato-okhttp-android-nav-submenu&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-okhttp-android/index.html"><span><span>affogato-okhttp-android</span></span></a>
+  </div> 
+  <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-0" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android////PointingToDeclaration//-924715819"> 
+   <div class="overview">
+    <span class="navButton" onclick="document.getElementById(&quot;affogato-okhttp-android-nav-submenu-0&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android/index.html"><span>com.</span><wbr><span>parsuomash.</span><wbr><span>affogato.</span><wbr><span>okhttp.</span><wbr><span>android</span></a>
+   </div> 
+   <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-0-0" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android/OkHttpKt///PointingToDeclaration//-924715819"> 
+    <div class="overview">
+     <a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android/-ok-http-kt/index.html"><span>Ok</span><wbr><span>Http</span><wbr><span><span>Kt</span></span></a>
+    </div> 
+   </div> 
+  </div> 
+  <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-1" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android.progress////PointingToDeclaration//-924715819"> 
+   <div class="overview">
+    <span class="navButton" onclick="document.getElementById(&quot;affogato-okhttp-android-nav-submenu-1&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android.progress/index.html"><span>com.</span><wbr><span>parsuomash.</span><wbr><span>affogato.</span><wbr><span>okhttp.</span><wbr><span>android.</span><wbr><span>progress</span></a>
+   </div> 
+   <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-1-0" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android.progress/DownloadStreamResponseBody///PointingToDeclaration//-924715819"> 
+    <div class="overview">
+     <a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android.progress/-download-stream-response-body/index.html"><span>Download</span><wbr><span>Stream</span><wbr><span>Response</span><wbr><span><span>Body</span></span></a>
+    </div> 
+   </div> 
+   <div class="sideMenuPart" id="affogato-okhttp-android-nav-submenu-1-1" pageid="affogato-okhttp-android::com.parsuomash.affogato.okhttp.android.progress/UploadStreamRequestBody///PointingToDeclaration//-924715819"> 
+    <div class="overview">
+     <a href="../affogato-okhttp-android/com.parsuomash.affogato.okhttp.android.progress/-upload-stream-request-body/index.html"><span>Upload</span><wbr><span>Stream</span><wbr><span>Request</span><wbr><span><span>Body</span></span></a>
+    </div> 
+   </div> 
+  </div> 
+ </div>  
  <div class="sideMenuPart" id="affogato-structure-nav-submenu" pageid="affogato-structure::////PointingToDeclaration//-390748097"> 
   <div class="overview">
    <span class="navButton" onclick="document.getElementById(&quot;affogato-structure-nav-submenu&quot;).classList.toggle(&quot;hidden&quot;);"><span class="navButtonContent"></span></span><a href="../affogato-structure/index.html"><span><span>affogato-structure</span></span></a>