forked from malcommac/SwiftLocation
-
Notifications
You must be signed in to change notification settings - Fork 0
/
IPLocation-IPApi.swift
142 lines (114 loc) · 5.87 KB
/
IPLocation-IPApi.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
//
// IPLocation+IPApi.swift
//
// Copyright (c) 2020 Daniele Margutti (hello@danielemargutti.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.
//
import Foundation
public extension IPLocation {
/// This is the implementation of IPStack location search by ip.
/// https://ip-api.com (documentation: https://ip-api.com/docs/api:jsonfor)
class IPApi: IPServiceProtocol {
public enum ReturnedFields: String {
case continent, // Continent name ('North America')
continentCode, // Two-letter continent code ('NA')
country, // Country name ('United States')
countryCode, // Two-letter country code ISO 3166-1 alpha-2 ('US')
region, // Region/state short code (FIPS or ISO) ('CA or 10')
regionName, // Region/state ('California')
city, // City ('Mountain View')
district, // District (subdivision of city) ('Old Farm District')
zip, // Zip code ('94043')
timezone, // Timezone (tz) ('America/Los_Angeles')
isp, // Internet Service Provider ('Google'),
query, // IP (always fetched)
lat, // latitude (always fetched)
lon // longitude (always fetched)
}
/// Used to retrive data from json.
public var jsonServiceDecoder: IPServiceDecoders = .ipapi
// MARK: - Configurable Settings
/// Optional target IP to discover; `nil` to use current machine internet address.
public var targetIP: String?
/// The API can return the following fields and values.
/// By default `[.city, .region, .regionName, .continent, .continentCode]` are used.
public var returnedFields = Set<ReturnedFields>([.city, .region, .regionName, .continent, .continentCode])
/// Locale identifier as ISO 639.
/// Not all languages are supported (https://ip-api.com/docs/api:json).
public var locale: String?
/// Hostname lookup.
/// By default, the ipstack API does not return information about the hostname the given IP address resolves to.
public var hostnameLookup = false
/// NOTE: This service don't need of API Key.
public var APIKey: String?
// MARK: - Protocol Specific
/// Service underlying.
public var task: URLSessionDataTask?
/// Operation was cancelled.
public var isCancelled = false
/// Timeout interval to execute the call.
public var timeout: TimeInterval = 5
/// Session URL session.
public var session = URLSession.shared
public var description: String {
JSONStringify([
"targetIP": targetIP ?? "",
"fields": Array(returnedFields),
"locale": locale ?? "",
"hostnameLookup": hostnameLookup,
"isCancelled": isCancelled,
"timeout": timeout,
"decoder": jsonServiceDecoder.rawValue
])
}
/// Initialize a new https://ip-api.com service with given parameters.
///
/// - Parameters:
/// - IP: IP to discover; ignore this parameter to get the location of the currently machine.
public init(targetIP: String? = nil) {
self.targetIP = targetIP
}
private func serviceURL() -> URL {
guard let targetIP = targetIP else {
return URL(string: "http://ip-api.com/json")!
}
return URL(string: "http://ip-api.com/json/\(targetIP)")!
}
public func buildRequest() throws -> URLRequest {
var urlComponents = URLComponents(string: serviceURL().absoluteString)
let allReturnedFields = returnedFields.union([.query, .lat, .lon])
urlComponents?.queryItems = [
URLQueryItem(name: "fields", value: Array(allReturnedFields).map({ $0.rawValue }).joined(separator: ",")),
URLQueryItem(name: "lang", value: locale ?? Locale.current.collatorIdentifier?.lowercased() ?? "en")
]
guard let fullURL = urlComponents?.url else {
throw LocationError.internalError
}
let request = URLRequest(url: fullURL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: timeout)
return request
}
public func validateResponse(data: IPLocation.Data, httpResponse: HTTPURLResponse) -> LocationError? {
guard httpResponse.statusCode != 200 else {
return nil
}
return .other(String(httpResponse.statusCode))
}
}
}