Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/artemisia-absynthium/arachne
Networking layer for apps using Swift Concurrency.
https://github.com/artemisia-absynthium/arachne
async-await hacktoberfest ios macos networking swift swift-concurrency swift-package-manager tvos visionos watchos
Last synced: 26 days ago
JSON representation
Networking layer for apps using Swift Concurrency.
- Host: GitHub
- URL: https://github.com/artemisia-absynthium/arachne
- Owner: artemisia-absynthium
- License: mit
- Created: 2021-10-18T12:34:03.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-17T20:38:50.000Z (5 months ago)
- Last Synced: 2024-10-01T05:22:35.325Z (about 1 month ago)
- Topics: async-await, hacktoberfest, ios, macos, networking, swift, swift-concurrency, swift-package-manager, tvos, visionos, watchos
- Language: Swift
- Homepage: https://arachne.netlify.app
- Size: 939 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Arachne
[](https://github.com/artemisia-absynthium/arachne/actions/workflows/swift.yml)
[](https://app.codacy.com/gh/artemisia-absynthium/arachne/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://codecov.io/gh/artemisia-absynthium/arachne)
Arachne is a lightweight, minimalistic, zero dependencies networking layer for apps using [Swift Concurrency (async/await)](https://docs.swift.org/swift-book/LanguageGuide/Concurrency.html) or [Combine](https://developer.apple.com/documentation/combine) (support to Combine will be discontinued) developed in Swift, that provides an opinionated abstraction layer to remove boilerplate code.
Arachne aims to backport async/await `URLSession` tasks to macOS 10.15, iOS 13, iPadOS 13, tvOS 13 and watchOS 7, while the availability of their native counterpart in the Foundation framework is iOS 15.0+, iPadOS 15.0+, macOS 12.0+, Mac Catalyst 15.0+, tvOS 15.0+, watchOS 8.0+.
This library's design was inspired by [Moya](https://github.com/Moya/Moya), but differently from Moya, Arachne uses only the standard [Foundation framework](https://developer.apple.com/documentation/foundation/url_loading_system) (e.g. `URLSession`).
This makes Arachne suitable for recently created or migrated apps that make use of Apple's frameworks, instead of third party ones, like [Alamofire](https://github.com/Alamofire/Alamofire) or [RxSwift](https://github.com/ReactiveX/RxSwift).
## Usage
You start by defining your APIs like this
```swift
import Foundation
import Arachne
enum MyAPIService {
case info
case userProfile(username: String)
case postEndpoint(body: MyCodableObject, limit: Int)
}
extension MyAPIService: ArachneService {
var baseUrl: String {
"https://myapiservice.com"
}
var path: String {
switch self {
case .info:
"/info"
case .userProfile(let username):
"/users/\(username)"
case .postEndpoint:
"/postendpoint"
}
}
var queryStringItems: [URLQueryItem]? {
switch self {
case .postEndpoint(_, let limit):
[URLQueryItem(name: "limit", value: "\(limit)")]
default:
nil
}
}
var method: HttpMethod {
switch self {
case .postEndpoint:
.post
default:
.get
}
}
var body: Data? {
switch self{
case .postEndpoint(let myCodableObject, _):
try? JSONEncoder().encode(myCodableObject)
default:
nil
}
}
var headers: [String : String]? {
switch self {
case .postEndpoint:
nil
default:
["Accept": "application/json"]
}
}
}
```
Then you can use them like this
Declare your provider
```swift
let provider = ArachneProvider()
```
Get data from your endpoint
```swift
let (data, _) = try await provider.data(.info)
```
Let's see it assembled in an extract of a SwiftUI app
```swift
import SwiftUI
import Arachne
import os
struct Info: Codable {
let name: String
}
class MyApiClient {
private let provider = ArachneProvider()
func loadInfo() async throws -> Info {
let (data, _) = try await provider.data(.info)
return try JSONDecoder().decode(Info.self, from: data)
}
}
@Observable
class MyState {
private let apiClient = MyApiClient()
private let logger = Logger(subsystem: "Arachne", category: "MyInteractor")
var info: Info?
func getInfo() async {
do {
self.info = try await apiClient.loadInfo()
} catch {
logger.error("Error: \(error.localizedDescription)")
}
}
}
struct MyView: View {
@State var state = MyState()
var body: some View {
Text(interactor.info?.name ?? "No name")
.task {
await interactor.getInfo()
}
}
}
```
## Migrate from 0.3.0 to 0.4.0+
A function using a `Combine` publisher, for example:
```swift
func getInfo() {
apiClient.loadInfo()
.sink { completion in
switch completion {
case .finished:
break
case .failure(let error):
// Handle error
}
} receiveValue: { info in
self.info = info
}
.store(in: &cancellables)
}
```
can be easily migrated like this
```swift
func getInfo() async {
do {
self.info = try await apiClient.loadInfo()
} catch {
// Handle error
}
}
```
or if you cannot make your function async
```swift
func getInfo() {
Task {
do {
self.info = try await apiClient.loadInfo()
} catch {
// Handle error
}
}
}
```
## Installation
### Swift Package Manager
#### Using Xcode UI
Go to your Project Settings > Swift Packages and add Arachne by entering `https://github.com/artemisia-absynthium/arachne.git` in the search field.
#### Not using Xcode UI
Add the following as a dependency to your `Package.swift`:
```swift
.package(url: "https://github.com/artemisia-absynthium/arachne.git", .upToNextMajor(from: "0.6.1"))
```
and then specify "Arachne" as a dependency of the Target in which you wish to use it.
### Cocoapods
Support for CocoaPods has been discontinued since version 0.5.0, in order to install the latest version please use Swift Package Manager.
## Roadmap
Currently supported tasks are
* `bytes`
* `data`
* `download`
* `upload`
* Resumable download and download progress updates
Next steps will be π§
* Add support for resumable upload
* Upload progress updates
* Unit test specially for resumable download
## Contributing
Contributions are welcome!
No special steps are required to get up and running developing this project, just clone and open in Xcode, the only requirement is for each PR to have proper unit tests and that all tests pass.
## License
This project is released under the [MIT License](https://github.com/artemisia-absynthium/arachne/blob/main/LICENSE).
## Project status
This project recently experienced a shift of goal, while the initial goal of this library was to provide Combine publishers for tasks that didn't have one, the introduction of async/await in Swift suddenly made using Combine for network requests look cumbersome and this is why no new Combine tasks will be added.
The current goal of this library is to backport async/await `URLSession` tasks to macOS 10.15, iOS 13, iPadOS 13, tvOS 13 and watchOS 7, while the availability of their native counterpart in the Foundation framework is iOS 15.0+, iPadOS 15.0+, macOS 12.0+, Mac Catalyst 15.0+, tvOS 15.0+, watchOS 8.0+ and to provide an opinionated abstraction layer to remove boilerplate code.
In the future, with the progressive drop of platform versions before iOS 15.0+, iPadOS 15.0+, macOS 12.0+, Mac Catalyst 15.0+, tvOS 15.0+, watchOS 8.0+ from the community, the goal of this library will be only to provide an opinionated abstraction layer to remove boilerplate code.
## Why Arachne
Thinking about networking my mind immediately went to the best "networkers" in nature: spiders.
Since I come from classical studies background I liked to use the Greek word for spider: Arachne (αΎ°ΜΟαΎ°ΜΟΞ½Ξ·). Arachne is also the name of the protagonist, a very talented weaver, of [a tale in Greek mythology](https://en.wikipedia.org/wiki/Arachne) and I felt it was really appropriate.