This repository has been archived by the owner on Mar 30, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Response.swift
158 lines (121 loc) · 4.46 KB
/
Response.swift
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
//
// Response.swift
//
// Copyright (c) 2015 Recrea (http://recreahq.com/)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
/// A response returned once a request is finished.
public enum Response<Value> {
/// The request was successful.
case success(Value, Page?)
/// The request failed.
case failure(ErrorResponse)
/// Whether the response is an error.
var isError: Bool {
switch self {
case .success:
return false
case .failure:
return true
}
}
/// The associated value in case of success.
var value: Value? {
guard case let .success(value, _) = self else {
return nil
}
return value
}
/// The page in case of success.
var page: Page? {
guard case let .success(_, page) = self else {
return nil
}
return page
}
/// The associated error in case of failure.
var error: ErrorResponse? {
guard case let .failure(error) = self else {
return nil
}
return error
}
}
/// A response handler for a JSON object.
public typealias JSONResponseHandler = (Response<[String: Any]>) -> Void
/// A response handler for an array of JSON objects.
public typealias JSONArrayResponseHandler = (Response<[[String: Any]]>) -> Void
/// A response handler for an empty response.
public typealias EmptyResponseHandler = (ErrorResponse?) -> Void
// MARK: -
/// Information about the page when request paginated results.
///
/// - Seealso: [Pagination](https://quaderno.io/docs/api/#pagination).
public struct Page {
/// The number of the page returned in the response.
let number: Int
/// The total number of pages for the resource requested.
let totalPages: Int
}
extension Page {
/// Keys in HTTP header related to pagination.
enum HTTPHeader: String {
case currentPage = "X-Pages-CurrentPage"
case totalPages = "X-Pages-TotalPages"
}
/// Initialize a page with an HTTP response.
///
/// - Parameter httpResponse: An HTTP response.
init?(httpResponse: HTTPURLResponse?) {
guard let httpHeaders = httpResponse?.allHeaderFields as? [String: Any] else {
return nil
}
guard let currentPageValue = httpHeaders[HTTPHeader.currentPage.rawValue] as? String else {
return nil
}
guard let currentPage = Int(currentPageValue) else {
return nil
}
guard let totalPagesValue = httpHeaders[HTTPHeader.totalPages.rawValue] as? String else {
return nil
}
guard let totalPages = Int(totalPagesValue) else {
return nil
}
self.number = currentPage
self.totalPages = totalPages
}
}
// MARK: -
/// The errors that can occurred when processing a response.
public enum ErrorResponse: Error, CustomStringConvertible {
/// A response returned a value type different than the one expected.
case typeMismatch(expected: Any, found: Any)
/// The associated request caused an error in the web service.
case serviceError(NSError)
// MARK: CustomStringConvertible
public var description: String {
switch self {
case .typeMismatch(let expectedType, let actualType):
return "The response was expected to be \(expectedType), but \(actualType) was found instead."
case .serviceError(let error):
return error.localizedDescription
}
}
}