Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .spi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
version: 1
builder:
configs:
- documentation_targets: [SessionPlus]
21 changes: 20 additions & 1 deletion Package.resolved

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ let package = Package(
),
],
dependencies: [
.package(url: "https://github.com/swiftlang/swift-testing.git", branch: "swift-6.2-RELEASE"),
.package(url: "https://github.com/richardpiazza/AsyncPlus.git", .upToNextMajor(from: "0.3.2")),
.package(url: "https://github.com/apple/swift-log.git", from: "1.6.2"),
],
Expand All @@ -45,6 +46,7 @@ let package = Package(
dependencies: [
"SessionPlus",
"SessionPlusEmulation",
.product(name: "Testing", package: "swift-testing"),
],
),
],
Expand Down
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

A swift _request & response_ framework for JSON apis.

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Frichardpiazza%2FSessionPlus%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/richardpiazza/SessionPlus)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Frichardpiazza%2FSessionPlus%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/richardpiazza/SessionPlus)
[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Frichardpiazza%2FSessionPlus%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/richardpiazza/SessionPlus)

This package has been designed to work across multiple swift environments by utilizing conditional checks. It has been tested on Apple platforms (macOS, iOS, tvOS, watchOS), as well as Linux (Ubuntu).

Expand Down Expand Up @@ -35,19 +35,6 @@ let response = try await client.request(request) as ApiResult
let response: ApiResult = try await client.request(request)
```

### Flexibility

The `Client` protocol declares up to three forms requests based on platform abilities:

```swift
// async/await for swift 5.5+
func performRequest(_ request: Request) async throws -> Response
// completion handler for backwards compatibility
func performRequest(_ request: Request, completion: @escaping (Result<Response, Error>) -> Void)
// Combine publisher that emits with a response
func performRequest(_ request: Request) -> AnyPublisher<Response, Error>
```

## Installation

**SessionPlus** is distributed using the [Swift Package Manager](https://swift.org/package-manager).
Expand All @@ -63,8 +50,8 @@ let package = Package(
targets: [
.target(
name: "MyPackage",
dependnecies: [
"SessionPlus"
dependencies: [
.product(name: "SessionPlus", package: "SessionPlus"),
]
)
]
Expand Down
15 changes: 8 additions & 7 deletions Tests/SessionPlusTests/FormDataTests.swift
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
import Foundation
@testable import SessionPlus
import XCTest
import Testing

final class FormDataTests: XCTestCase {
struct FormDataTests {

let imageBase64 = "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAxmVYSWZNTQAqAAAACAAHARIAAwAAAAEAAQAAARoABQAAAAEAAABiARsABQAAAAEAAABqASgAAwAAAAEAAgAAATEAAgAAABUAAAByATIAAgAAABQAAACIh2kABAAAAAEAAACcAAAAAAAAAEgAAAABAAAASAAAAAFQaXhlbG1hdG9yIFBybyAyLjAuMwAAMjAxNzowMzoxNyAxMjowMzoyNQAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAAEKADAAQAAAABAAAAEAAAAACvovyCAAAACXBIWXMAAAsTAAALEwEAmpwYAAADgGlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iWE1QIENvcmUgNi4wLjAiPgogICA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPgogICAgICA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIgogICAgICAgICAgICB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iCiAgICAgICAgICAgIHhtbG5zOnRpZmY9Imh0dHA6Ly9ucy5hZG9iZS5jb20vdGlmZi8xLjAvIgogICAgICAgICAgICB4bWxuczpleGlmPSJodHRwOi8vbnMuYWRvYmUuY29tL2V4aWYvMS4wLyI+CiAgICAgICAgIDx4bXA6Q3JlYXRvclRvb2w+UGl4ZWxtYXRvciBQcm8gMi4wLjM8L3htcDpDcmVhdG9yVG9vbD4KICAgICAgICAgPHhtcDpNb2RpZnlEYXRlPjIwMTctMDMtMTdUMTI6MDM6MjU8L3htcDpNb2RpZnlEYXRlPgogICAgICAgICA8dGlmZjpSZXNvbHV0aW9uVW5pdD4yPC90aWZmOlJlc29sdXRpb25Vbml0PgogICAgICAgICA8dGlmZjpYUmVzb2x1dGlvbj43MjwvdGlmZjpYUmVzb2x1dGlvbj4KICAgICAgICAgPHRpZmY6WVJlc29sdXRpb24+NzI8L3RpZmY6WVJlc29sdXRpb24+CiAgICAgICAgIDx0aWZmOk9yaWVudGF0aW9uPjE8L3RpZmY6T3JpZW50YXRpb24+CiAgICAgICAgIDxleGlmOlBpeGVsWERpbWVuc2lvbj4xMDI0PC9leGlmOlBpeGVsWERpbWVuc2lvbj4KICAgICAgICAgPGV4aWY6Q29sb3JTcGFjZT4xPC9leGlmOkNvbG9yU3BhY2U+CiAgICAgICAgIDxleGlmOlBpeGVsWURpbWVuc2lvbj4xMDI0PC9leGlmOlBpeGVsWURpbWVuc2lvbj4KICAgICAgPC9yZGY6RGVzY3JpcHRpb24+CiAgIDwvcmRmOlJERj4KPC94OnhtcG1ldGE+ClO0fnAAAAJvSURBVDgRrVJNaxNBGH5mZ2d3k5C2pLv5UupHMeChSG21Fz0paK2KIAj+A6Eg4j/wKHiwePZHiEHw5MGzHylWD1pCq6RJo03a1NRsdnZ8Z9qU0qsO7M47zzvP877zzAD/ONhhfrFY9MMwdA7jeu04Tlir1X4ezO0LZLPZcaXUAmNsSu+lmEEpgO1uIZwWCAl/R/ODZrP5TQvZ+keDU+KZZVmzNBvAdlxYbgJxtwONxHFscNozRzGnxXX6pKXRfD6foQrnNJnKwrE5koVxjFx7iFTCRcLz4AoOIlNTtIexac3RXCMQRZGgBKcEvOAYUp5AolACn7iL9PFJpEcySE7dhuO6mqxFuOZoAXMEAghnsFkMcfIiRGoY3PXRznxBevomWC9HlbbhfXqJmLrrhbEWMeYMPKD2OAStRP0DupefQjGJzsQjdHIlOA0HmRd1OMkh9ISAtblGnoS6gd0j6ICRgDw6C5kooV+v4teNJ7iUreDezHOofBmbbAbtycdQ/hkwFWmKGcYDE8U94PcaWsEt/Dlbge8vYb7NML+SwahXR/fIMnj1Dezvr3S1PfpeB3R+4z/an4GVj4hUCyVvC351CFE5jyvBKpBZwpZ3GlvDdyCZNnPH3LeRsm27r+JI7vBxsuoEEIXwFZ31RxetzgbSYQos3IZqr4J1FsFkT9r2UF+3MXiJPAiyZctSV5VdACuMYfT8Mi5sRNgWMd62x9CvCPD+IiLZpxuwXq83m3PElwMBBEFwivpaYIinbAbBpAcpLFOBk2kxC4ls6arv6Qrv01P+erADHZuRy+WyUsr99zHAtU+c86jRaKwPsP8y/wXdZu/N6+vP3gAAAABJRU5ErkJggg=="
let filename = "Image.png"

func testFormDataRequest() throws {
let imageData = try XCTUnwrap(Data(base64Encoded: imageBase64))
@Test func formDataRequest() throws {
let imageData = try #require(Data(base64Encoded: imageBase64))

let request = FormData(path: "", field: "image", filename: filename, mimeType: .png, content: imageData)
let contentType = try XCTUnwrap(request.headers?[.contentType] as? String)
let contentType = try #require(request.headers?[.contentType] as? String)
let boundary = contentType.suffix(32)
let body = try XCTUnwrap(request.body)
let body = try #require(request.body)
let data = originalImplementation(data: imageData, filename: filename, boundary: String(boundary))

XCTAssertEqual(body, data)
#expect(body == data)
}

private func originalImplementation(data: Data, filename: String, boundary: String) -> Data {
Expand Down
20 changes: 10 additions & 10 deletions Tests/SessionPlusTests/QueryItemTests.swift
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
import Logging
@testable import SessionPlus
import XCTest
import Testing

final class QueryItemTests: XCTestCase {
struct QueryItemTests {

func testEncodedValue() throws {
@Test func encodedValue() throws {
let nilValue = QueryItem(name: "accept", percentEncoding: nil)
XCTAssertNil(nilValue)
#expect(nilValue == nil)

let unmodified = try XCTUnwrap(QueryItem(name: "item", percentEncoding: "fork"))
XCTAssertEqual(unmodified.value, "fork")
XCTAssertEqual([unmodified].metadata, ["item": .string("fork")])
let unmodified = try #require(QueryItem(name: "item", percentEncoding: "fork"))
#expect(unmodified.value == "fork")
#expect([unmodified].metadata == ["item": .string("fork")])

let encoded = try XCTUnwrap(QueryItem(name: "query", percentEncoding: "search term"))
XCTAssertEqual(encoded.value, "search%20term")
XCTAssertEqual([encoded].metadata, ["query": .string("search%20term")])
let encoded = try #require(QueryItem(name: "query", percentEncoding: "search term"))
#expect(encoded.value == "search%20term")
#expect([encoded].metadata == ["query": .string("search%20term")])
}
}