Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hellc/catalystnet
Universal AppleOS Apps Networking kit
https://github.com/hellc/catalystnet
Last synced: about 1 month ago
JSON representation
Universal AppleOS Apps Networking kit
- Host: GitHub
- URL: https://github.com/hellc/catalystnet
- Owner: hellc
- License: mit
- Created: 2020-07-01T13:54:41.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-05T16:56:44.000Z (over 2 years ago)
- Last Synced: 2024-10-10T06:09:40.927Z (2 months ago)
- Language: Swift
- Size: 56.6 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CatalystNet
Universal AppleOS Apps Networking kit
[](https://img.shields.io/cocoapods/v/CatalystNet.svg)
## Installation:
### CocoaPods
[CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate CatalystNet into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
pod 'CatalystNet', '~> 1.1.0'
```
### Swift Package Manager
The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift` compiler.
Once you have your Swift package set up, adding CatalystNet as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
```swift
dependencies: [
.package(url: "https://github.com/hellc/CatalystNet.git", .upToNextMajor(from: "1.1.0"))
]
```
### Manually
If you prefer not to use any of the aforementioned dependency managers, you can integrate CatalystNet into your project manually.
## Usage:
### Http client:
#### Import package
```swift
import CatalystNet
```
#### Defining model:
```swift
struct Photo: Decodable {
let albumId: Int
let id: Int
let title: String?
let url: String?
let thumbnailUrl: String?
}
struct CustomError: Decodable {
let message: String?
let code: Int?
}
```
#### Defining base Api class:
```swift
class ExampleApi: Api {
private let client: HttpClient!
init(baseUrl: String = "https://jsonplaceholder.typicode.com") {
self.client = HttpClient(baseUrl: baseUrl)
}
func load(_ resource: Resource,
multitasking: Bool = false,
completion: @escaping (Result) -> Void) {
// Setup auth policy if needed
// Also you could extend "Resource" model with authentication method for simply calling "resource.authenticate()" when needed
super.load(resource, self.client, multitasking: multitasking, completion: completion)
}
}
```
##### Defining Asynchronous Functions (iOS >= 13.0.0)
```swift
@available(iOS 13.0.0, *)
@available(macOS 10.15.0, *)
extension ExampleApi {
func load(_ resource: Resource) async throws -> T {
// Setup auth policy here if needed
return try await super.load(resource, self.client)
}
}
```
#### Defining Api class methods:
```swift
class PhotosApi: ExampleApi {
private struct Endpoints {
static let photos: String = "/photos"
}
func photo(with id: Int, completion: @escaping (Photo?, CatalystError?) -> Void) {
var resource = Resource(path: Api.resource(Endpoints.photos, with: id))
resource.method = .get
// resource.authenticate() // if needed
self.load(resource) { response in
switch response {
case .success(let photo):
completion(photo, nil)
case .failure(let error):
completion(nil, error)
}
}
}
}
```
##### Defining Asynchronous Functions (iOS >= 13.0.0)
```swift
@available(iOS 13.0.0, *)
@available(macOS 10.15.0, *)
extension PhotosApi {
func photo(with id: Int) async throws -> Photo {
var resource = Resource(path: Api.resource(Endpoints.photos, with: id))
resource.method = .get
// resource.authenticate() // if needed
return try await self.load(resource)
}
}
```
#### Try it:
```swift
let photosApi = PhotosApi()
let photoId: Int = 42
self.photosApi.photo(with: photoId) { (photo, error) in
print(photo)
}
```
##### Try it asynchronously:
```swift
let photoId: Int = 42
do {
let photo = try await self.photosApi.photo(with: photoId)
print(photo)
} catch {
print(error)
// TODO: Proceed "error" object
}
```
Output:
```
Photo(
albumId: 1,
id: 42,
title: Optional("voluptatibus a autem molestias voluptas architecto culpa"),
url: Optional("https://via.placeholder.com/600/ca50ac"),
thumbnailUrl: Optional("https://via.placeholder.com/150/ca50ac")
)
```
Please follow Tests/ExampleTests.swift file for more usage examples <3