Skip to content

Commit c563600

Browse files
joshuawright11joshuawright11
committed
naming
1 parent eae1f85 commit c563600

12 files changed

+45
-46
lines changed

‎Papyrus/Sources/Extensions/URLSession+Papyrus.swift

+7-7
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ extension Provider {
1515
// MARK: `HTTPService` Conformance
1616

1717
extension URLSession: HTTPService {
18-
public func build(method: String, url: URL, headers: [String: String], body: Data?) -> Request {
18+
public func build(method: String, url: URL, headers: [String: String], body: Data?) -> PapyrusRequest {
1919
var request = URLRequest(url: url)
2020
request.httpMethod = method
2121
request.httpBody = body
2222
request.allHTTPHeaderFields = headers
2323
return request
2424
}
2525

26-
public func request(_ req: Request) async -> Response {
26+
public func request(_ req: PapyrusRequest) async -> PapyrusResponse {
2727
#if os(Linux) // Linux doesn't have access to async URLSession APIs
2828
await withCheckedContinuation { continuation in
2929
let urlRequest = req.urlRequest
@@ -46,16 +46,16 @@ extension URLSession: HTTPService {
4646

4747
// MARK: `Response` Conformance
4848

49-
extension Response {
49+
extension PapyrusResponse {
5050
public var urlRequest: URLRequest { (self as! _Response).urlRequest }
5151
public var urlResponse: URLResponse? { (self as! _Response).urlResponse }
5252
}
5353

54-
private struct _Response: Response {
54+
private struct _Response: PapyrusResponse {
5555
let urlRequest: URLRequest
5656
let urlResponse: URLResponse?
5757

58-
var request: Request? { urlRequest }
58+
var request: PapyrusRequest? { urlRequest }
5959
let error: Error?
6060
let body: Data?
6161
let headers: [String: String]?
@@ -85,13 +85,13 @@ private struct _Response: Response {
8585

8686
// MARK: `Request` Conformance
8787

88-
extension Request {
88+
extension PapyrusRequest {
8989
public var urlRequest: URLRequest {
9090
(self as! URLRequest)
9191
}
9292
}
9393

94-
extension URLRequest: Request {
94+
extension URLRequest: PapyrusRequest {
9595
public var body: Data? {
9696
get { httpBody }
9797
set { httpBody = newValue }

‎Papyrus/Sources/HTTPService.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ import Foundation
33
/// A type that can perform arbitrary HTTP requests.
44
public protocol HTTPService {
55
/// Build a `Request` from the given components.
6-
func build(method: String, url: URL, headers: [String: String], body: Data?) -> Request
6+
func build(method: String, url: URL, headers: [String: String], body: Data?) -> PapyrusRequest
77

88
/// Concurrency based API
9-
func request(_ req: Request) async -> Response
9+
func request(_ req: PapyrusRequest) async -> PapyrusResponse
1010
}

‎Papyrus/Sources/Interceptors/CurlInterceptor.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public struct CurlLogger {
2323
}
2424

2525
extension CurlLogger: Interceptor {
26-
public func intercept(req: Request, next: Next) async throws -> Response {
26+
public func intercept(req: PapyrusRequest, next: Next) async throws -> PapyrusResponse {
2727
if condition == .always {
2828
logHandler(req.curl(sortedHeaders: true))
2929
}
@@ -40,7 +40,7 @@ extension CurlLogger: Interceptor {
4040
}
4141
}
4242

43-
public extension Request {
43+
public extension PapyrusRequest {
4444
/// Create a cURL command from this instance
4545
///
4646
/// - Parameter sortedHeaders: sort headers in output

‎Papyrus/Sources/PapyrusError.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@ public struct PapyrusError: Error, CustomDebugStringConvertible {
33
/// What went wrong.
44
public let message: String
55
/// Error related request.
6-
public let request: Request?
6+
public let request: PapyrusRequest?
77
/// Error related response.
8-
public let response: Response?
8+
public let response: PapyrusResponse?
99

1010
/// Create an error with the specified message.
1111
///
1212
/// - Parameter message: What went wrong.
1313
/// - Parameter request: Error related request.
1414
/// - Parameter response: Error related response.
15-
public init(_ message: String, _ request: Request? = nil, _ response: Response? = nil) {
15+
public init(_ message: String, _ request: PapyrusRequest? = nil, _ response: PapyrusResponse? = nil) {
1616
self.message = message
1717
self.request = request
1818
self.response = response

‎Papyrus/Sources/Request.swift renamed to ‎Papyrus/Sources/PapyrusRequest.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import Foundation
22

3-
public protocol Request {
3+
public protocol PapyrusRequest {
44
var url: URL? { get set }
55
var method: String { get set }
66
var headers: [String: String] { get set }

‎Papyrus/Sources/Response.swift renamed to ‎Papyrus/Sources/PapyrusResponse.swift

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
import Foundation
22

3-
public protocol Response {
4-
var request: Request? { get }
3+
public protocol PapyrusResponse {
4+
var request: PapyrusRequest? { get }
55
var body: Data? { get }
66
var headers: [String: String]? { get }
77
var statusCode: Int? { get }
88
var error: Error? { get }
99
}
1010

11-
extension Response {
11+
extension PapyrusResponse {
1212
/// Validates the status code of a Response, as well as any transport errors that may have occurred.
1313
@discardableResult
1414
public func validate() throws -> Self {
@@ -50,20 +50,20 @@ extension Response {
5050
}
5151
}
5252

53-
extension Response where Self == ErrorResponse {
54-
public static func error(_ error: Error) -> Response {
53+
extension PapyrusResponse where Self == ErrorResponse {
54+
public static func error(_ error: Error) -> PapyrusResponse {
5555
ErrorResponse(error)
5656
}
5757
}
5858

59-
public struct ErrorResponse: Response {
59+
public struct ErrorResponse: PapyrusResponse {
6060
let _error: Error?
6161

6262
public init(_ error: Error) {
6363
self._error = error
6464
}
6565

66-
public var request: Request? { nil }
66+
public var request: PapyrusRequest? { nil }
6767
public var body: Data? { nil }
6868
public var headers: [String : String]? { nil }
6969
public var statusCode: Int? { nil }

‎Papyrus/Sources/Provider.swift

+8-8
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ public final class Provider {
3232
}
3333

3434
@discardableResult
35-
public func intercept(action: @escaping (Request, (Request) async throws -> Response) async throws -> Response) -> Self {
35+
public func intercept(action: @escaping (PapyrusRequest, (PapyrusRequest) async throws -> PapyrusResponse) async throws -> PapyrusResponse) -> Self {
3636
struct AnonymousInterceptor: Interceptor {
37-
let action: (Request, Interceptor.Next) async throws -> Response
37+
let action: (PapyrusRequest, Interceptor.Next) async throws -> PapyrusResponse
3838

39-
func intercept(req: Request, next: Interceptor.Next) async throws -> Response {
39+
func intercept(req: PapyrusRequest, next: Interceptor.Next) async throws -> PapyrusResponse {
4040
try await action(req, next)
4141
}
4242
}
@@ -46,9 +46,9 @@ public final class Provider {
4646
}
4747

4848
@discardableResult
49-
public func request(_ builder: inout RequestBuilder) async throws -> Response {
49+
public func request(_ builder: inout RequestBuilder) async throws -> PapyrusResponse {
5050
let request = try createRequest(&builder)
51-
var next: (Request) async throws -> Response = http.request
51+
var next: (PapyrusRequest) async throws -> PapyrusResponse = http.request
5252
for interceptor in interceptors.reversed() {
5353
let _next = next
5454
next = { try await interceptor.intercept(req: $0, next: _next) }
@@ -57,7 +57,7 @@ public final class Provider {
5757
return try await next(request)
5858
}
5959

60-
private func createRequest(_ builder: inout RequestBuilder) throws -> Request {
60+
private func createRequest(_ builder: inout RequestBuilder) throws -> PapyrusRequest {
6161
for modifier in modifiers {
6262
try modifier.modify(req: &builder)
6363
}
@@ -69,8 +69,8 @@ public final class Provider {
6969
}
7070

7171
public protocol Interceptor {
72-
typealias Next = (Request) async throws -> Response
73-
func intercept(req: Request, next: Next) async throws -> Response
72+
typealias Next = (PapyrusRequest) async throws -> PapyrusResponse
73+
func intercept(req: PapyrusRequest, next: Next) async throws -> PapyrusResponse
7474
}
7575

7676
public protocol RequestModifier {

‎Papyrus/Tests/APITests.swift

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import XCTest
2-
import Papyrus
32
@testable import Papyrus
43

54
final class APITests: XCTestCase {
@@ -121,28 +120,28 @@ fileprivate class _HTTPServiceMock: HTTPService {
121120
_responseType = responseType
122121
}
123122

124-
func build(method: String, url: URL, headers: [String : String], body: Data?) -> Request {
123+
func build(method: String, url: URL, headers: [String : String], body: Data?) -> PapyrusRequest {
125124
_Request(method: "", headers: [:])
126125
}
127126

128-
func request(_ req: Papyrus.Request) async -> Papyrus.Response {
127+
func request(_ req: PapyrusRequest) async -> PapyrusResponse {
129128
_Response(body: _responseType.value?.data(using: .utf8), statusCode: 200)
130129
}
131130

132-
func request(_ req: Papyrus.Request, completionHandler: @escaping (Papyrus.Response) -> Void) {
131+
func request(_ req: PapyrusRequest, completionHandler: @escaping (PapyrusResponse) -> Void) {
133132
completionHandler(_Response(body: "".data(using: .utf8)))
134133
}
135134
}
136135

137-
fileprivate struct _Request: Request {
136+
fileprivate struct _Request: PapyrusRequest {
138137
var url: URL?
139138
var method: String
140139
var headers: [String : String]
141140
var body: Data?
142141
}
143142

144-
fileprivate struct _Response: Response {
145-
var request: Papyrus.Request?
143+
fileprivate struct _Response: PapyrusResponse {
144+
var request: PapyrusRequest?
146145
var body: Data?
147146
var headers: [String : String]?
148147
var statusCode: Int?

‎Papyrus/Tests/CurlTests.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -186,15 +186,15 @@ final class CurlTests: XCTestCase {
186186
}
187187
}
188188

189-
private struct TestResponse: Response {
190-
var request: Request? = nil
189+
private struct TestResponse: PapyrusResponse {
190+
var request: PapyrusRequest? = nil
191191
var body: Data? = nil
192192
var headers: [String : String]? = nil
193193
var statusCode: Int? = nil
194194
var error: Error? = nil
195195
}
196196

197-
private struct TestRequest: Request {
197+
private struct TestRequest: PapyrusRequest {
198198
var method: String
199199
var url: URL?
200200
var headers: [String : String]

‎Papyrus/Tests/ProviderTests.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ final class ProviderTests: XCTestCase {
1212
}
1313

1414
private struct TestHTTPService: HTTPService {
15-
func build(method: String, url: URL, headers: [String : String], body: Data?) -> Request {
15+
func build(method: String, url: URL, headers: [String : String], body: Data?) -> PapyrusRequest {
1616
fatalError()
1717
}
1818

19-
func request(_ req: Request) async -> Response {
19+
func request(_ req: PapyrusRequest) async -> PapyrusResponse {
2020
fatalError()
2121
}
2222

23-
func request(_ req: Request, completionHandler: @escaping (Response) -> Void) {
23+
func request(_ req: PapyrusRequest, completionHandler: @escaping (PapyrusResponse) -> Void) {
2424

2525
}
2626
}

‎Papyrus/Tests/ResponseDecoderTests.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ fileprivate struct _Person: Decodable {
7272
let name: String
7373
}
7474

75-
fileprivate class _Response : Response {
76-
var request: Papyrus.Request?
75+
fileprivate class _Response : PapyrusResponse {
76+
var request: PapyrusRequest?
7777
var body: Data?
7878
var headers: [String : String]?
7979
var statusCode: Int?

‎Papyrus/Tests/ResponseTests.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ final class ResponseTests: XCTestCase {
77
case test
88
}
99

10-
let res: Response = .error(TestError.test)
10+
let res: PapyrusResponse = .error(TestError.test)
1111
XCTAssertThrowsError(try res.validate())
1212
}
1313
}

0 commit comments

Comments
 (0)