Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/siamakrostami/srnetworklayer
A robust Swift-based network layer for iOS applications, supporting Combine and async/await for seamless asynchronous operations.
https://github.com/siamakrostami/srnetworklayer
async-await combine interceptor networking networklayer retryer swift thread-safe urlsession
Last synced: about 1 month ago
JSON representation
A robust Swift-based network layer for iOS applications, supporting Combine and async/await for seamless asynchronous operations.
- Host: GitHub
- URL: https://github.com/siamakrostami/srnetworklayer
- Owner: siamakrostami
- Created: 2024-07-25T18:19:36.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-10T18:04:55.000Z (5 months ago)
- Last Synced: 2024-08-10T19:33:29.127Z (5 months ago)
- Topics: async-await, combine, interceptor, networking, networklayer, retryer, swift, thread-safe, urlsession
- Language: Swift
- Homepage:
- Size: 40 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SRNetworkLayer
SRNetworkLayer is a Swift-based network layer designed to simplify network communication in your iOS applications. It provides a robust and flexible structure for making network requests, handling responses, and managing dependencies.
## Features
- Asynchronous network requests using Combine and async/await.
- Support for file uploads with progress tracking.
- Retry logic with customizable interceptors.
- Dependency injection for better testability and modularity.
- Comprehensive error handling and logging.
## Requirements
- iOS 13.0+
- Swift 5.0+
- Xcode 11.0+
## Usage
### Setting Up the Environment
Initialize the `AppEnvironment` in your `AppDelegate` or `SceneDelegate`:
```swift
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
let _ = AppEnvironment.setup()
return true
}
}
```
### Making a Network Request
To make a network request, use the `NetworkRepositories` class:
```swift
import Combine
import Foundation
// MARK: - LoginViewModel
class LoginViewModel: BaseViewModel {
@Published var userModel: UserResponseModel?
@Published var isLoading: Bool = false
var loginCancellableSet = Set()
}
extension LoginViewModel {
func login(email: String, password: String) {
isLoading = true
remoteRepositories.loginServices?
.login(email: email, password: password)
.sink(receiveCompletion: { [weak self] completion in
switch completion {
case .finished:
break
case .failure(let failure):
self?.isLoading = false
self?.error.send(failure)
}
}, receiveValue: { [weak self] model in
self?.isLoading = false
self?.userModel = model
}).store(in: &loginCancellableSet)
}
@MainActor
func asyncLogin(email: String, password: String) {
isLoading = true
Task {
do {
let response = try await remoteRepositories.loginServices?.asyncLogin(email: email, password: password)
userModel = response
isLoading = false
} catch let error as NetworkError {
isLoading = false
self.error.send(error)
}
}
}
}
```
### Handling File Uploads
To upload a file, use the `asyncUploadRequest` method:
```swift
class UploadViewModel: BaseViewModel {
@MainActor
func uploadProfilePicture(file: Data?, fileName: String) {
isLoading = true
Task {
do{
let response = try await remoteRepositories.profilePictureServices?.asyncUpload(file: file, name: fileName, uploadProgress: { [weak self] progress in
guard let _ = self else {return}
debugPrint(progress)
})
self.isLoading = false
self.uploadPhotoModel = response
}catch let error as NetworkError{
self.isLoading = false
self.error.send(error)
}
}
}
}
```
## Documentation
For full documentation, please refer to the source code and the comments within. Each method is documented to provide clarity on its purpose, parameters, return values, and potential errors.
## License
SRNetworkLayer is released under the MIT license. See [LICENSE](LICENSE) for details.