Rename Types and Organize Project files (#61)

* feat: sort files by name inside Source folder Resolves: none. * feat: restructure framework project Resolves: none. * feat: update docs Resolves: none. * feat: update docs Resolves: none. * feat: update examples Resolves: none. * feat: update docs Resolves: none. * feat: move common http types to separate framework Resolves: none. * update ci * update ci * feat: add CoreHTTP as swift package Resolves: none. * Update Package.swift * feat: add CoreHTTP as a remote Swift Package Resolves: none. * Update Package.swift * Update Package.swift * feat: update docs Resolves: none. * Update build-macos.yml * Update build-macos.yml * feat: add CoreExample framework Resolves: none. * feat: add CoreExample as a dependency Resolves: none. * feat: add CoreExample to macOS Example Resolves: none. * fix: update code signing for framework Resolves: none. * Update build-macos.yml * Update build-macos.yml * update frameworks flow * Update build-ios.yml * Update Package.resolved * Update project.pbxproj * Update project.pbxproj * Update build-ios.yml * update dependencies * feat: add Session object that can be shared between RESTClient and HTTPClient Resolves: none. * refactor: remove reference to event monitor in RESTClient and HTTPClient Resolves: none. * feat: update ci workflows Resolves: none. * feat: update documentation Resolves: none.
loay-ashraf · Jan 9, 2024 · b6bc7b3 · b6bc7b3
1 parent 66caa61
commit b6bc7b3
Show file tree

Hide file tree

Showing 96 changed files with 1,507 additions and 1,666 deletions.
diff --git a/.github/workflows/build-ios.yml b/.github/workflows/build-ios.yml
@@ -15,14 +15,14 @@ jobs:
       - name: Set Xcode Version
         uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '15.0.0'
+          xcode-version: 'latest-stable'
       - name: Build Framework
         env:
           workspace: RxNetworkKit.xcworkspace
           scheme: RxNetworkKit
           destination: generic/platform=iOS Simulator
         run: |
-          xcodebuild clean build -workspace "${workspace}" -scheme "${scheme}" -destination "${destination}" | xcpretty && exit ${PIPESTATUS[0]}
+          xcodebuild clean build -workspace "${workspace}" -scheme "${scheme}" -destination "${destination}" CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO | xcpretty && exit ${PIPESTATUS[0]}
           
   framework-ios:
     name: Build Framework For iOS Device
@@ -34,14 +34,14 @@ jobs:
       - name: Set Xcode Version
         uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '15.0.0'
+          xcode-version: 'latest-stable'
       - name: Build Framework
         env:
           workspace: RxNetworkKit.xcworkspace
           scheme: RxNetworkKit
           destination: generic/platform=iOS
         run: |
-          xcodebuild clean build -workspace "${workspace}" -scheme "${scheme}" -destination "${destination}" | xcpretty && exit ${PIPESTATUS[0]}
+          xcodebuild clean build -workspace "${workspace}" -scheme "${scheme}" -destination "${destination}" CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO | xcpretty && exit ${PIPESTATUS[0]}
           
   example-ios-simulator:
     name: Build Example For iOS Simulator
@@ -54,7 +54,7 @@ jobs:
       - name: Set Xcode Version
         uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '15.0.0'
+          xcode-version: 'latest-stable'
       - name: Build Example
         env:
           workspace: RxNetworkKit.xcworkspace
@@ -74,7 +74,7 @@ jobs:
       - name: Set Xcode Version
         uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '15.0.0'
+          xcode-version: 'latest-stable'
       - name: Build Example
         env:
           workspace: RxNetworkKit.xcworkspace

diff --git a/.github/workflows/build-macos.yml b/.github/workflows/build-macos.yml
@@ -14,14 +14,14 @@ jobs:
       - name: Set Xcode Version
         uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '15.0.0'
+          xcode-version: 'latest-stable'
       - name: Build Framework
         env:
           workspace: RxNetworkKit.xcworkspace
           scheme: RxNetworkKit
           destination: generic/platform=macOS
         run: |
-          xcodebuild clean build -workspace "${workspace}" -scheme "${scheme}" -destination "${destination}" docbuild | xcpretty && exit ${PIPESTATUS[0]}
+          xcodebuild clean build -workspace "${workspace}" -scheme "${scheme}" -destination "${destination}" CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO | xcpretty && exit ${PIPESTATUS[0]}
           
   example-macos:
     name: Build Example For macOS
@@ -34,7 +34,7 @@ jobs:
       - name: Set Xcode Version
         uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '15.0.0'
+          xcode-version: 'latest-stable'
       - name: Build Example
         env:
           workspace: RxNetworkKit.xcworkspace

diff --git a/Docs.docc/Pages/HTTPClient.md b/Docs.docc/Pages/HTTPClient.md
@@ -0,0 +1,32 @@
+# ``HTTPClient``
+
+## Topics
+
+### Creating a HTTP Client
+
+- ``HTTPClient/init(session:requestInterceptor:)``
+
+### Downloading a File
+
+- ``HTTPDownloadRequestRouter``
+- ``HTTPDownloadRequestEvent``
+- ``HTTPClient/download(_:_:_:)``
+- ``HTTPClient/download(_:_:_:_:)``
+
+### Uploading a File
+
+- ``HTTPUploadRequestRouter``
+- ``HTTPUploadRequestEvent``
+- ``HTTPUploadRequestFile``
+- ``HTTPUploadRequestFormData``
+- ``HTTPClient/upload(_:_:_:_:)-cavg``
+- ``HTTPClient/upload(_:_:_:_:)-2m1kr``
+
+### Connecting to a WebSocket
+
+- ``WebSocket``
+- ``WebSocketMessage``
+- ``WebSocketCloseCode``
+- ``WebSocketCloseHandler``
+- ``WebSocketError``
+- ``HTTPClient/webSocket(_:_:_:)``
diff --git a/Docs.docc/Pages/NetworkManager.md b/Docs.docc/Pages/NetworkManager.md
diff --git a/Docs.docc/Pages/RESTClient.md b/Docs.docc/Pages/RESTClient.md
@@ -0,0 +1,13 @@
+# ``RESTClient``
+
+## Topics
+
+### Creating a REST Client
+
+- ``RESTClient/init(session:requestInterceptor:)``
+
+### Making an API Call
+
+- ``HTTPRequestRouter``
+- ``RESTClient/request(_:_:_:)-8yak0``
+- ``RESTClient/request(_:_:_:)-2spzm``
diff --git a/Docs.docc/Pages/RxNetworkKit.md b/Docs.docc/Pages/RxNetworkKit.md
@@ -18,34 +18,35 @@ It makes use of RxSwift's traits at request level to acheive a high level of spe
 
 ### Foundation
 
-- ``NetworkManager``
+- ``RESTClient``
+- ``HTTPClient``
 
 ### HTTP
 
 - ``HTTPScheme``
 - ``HTTPMethod``
 - ``HTTPStatusCode``
-- ``HTTPErrorBody``
-- ``DefaultHTTPErrorBody``
+- ``HTTPBodyError``
+- ``DefaultHTTPBodyError``
 
 ### Error
 
-- ``NetworkError``
-- ``NetworkAPIError``
-- ``DefaultNetworkAPIError``
-- ``NetworkClientError``
-- ``NetworkServerError``
+- ``HTTPError``
+- ``HTTPAPIError``
+- ``DefaultHTTPAPIError``
+- ``HTTPClientError``
+- ``HTTPServerError``
 
 ### Request Interceptor
 
-- ``NetworkRequestInterceptor``
-- ``NetworkRequestAdapter``
-- ``NetworkRequestRetrier``
-- ``NetworkRequestRetryPolicy``
+- ``HTTPRequestInterceptor``
+- ``HTTPRequestAdapter``
+- ``HTTPRequestRetrier``
+- ``HTTPRequestRetryPolicy``
 
 ### Event Monitor
 
-- ``NetworkEventMonitor``
+- ``HTTPRequestEventMonitor``
 
 ### Network Reachability