Merge pull request #613 from wordpress-mobile/feature/eu-us-compliance-locator

[EU-US Compliance] Add `IPLocationRemote`

Author: alpavanoglu

CHANGELOG.md

@@ -38,6 +38,7 @@ _None._
 
 ### New Features
 
+- Add `IPLocationRemote` [#613]
 - Add `ui_status` field to `BlazeCampaign` [#611]
 
 ### Bug Fixes

WordPressKit.xcodeproj/project.pbxproj

@@ -8,6 +8,8 @@
 
 /* Begin PBXBuildFile section */
 		0152100C28EDA9E400DD6783 /* StatsAnnualAndMostPopularTimeInsightDecodingTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0152100B28EDA9E400DD6783 /* StatsAnnualAndMostPopularTimeInsightDecodingTests.swift */; };
+		0847B92C2A4442730044D32F /* IPLocationRemote.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0847B92B2A4442730044D32F /* IPLocationRemote.swift */; };
+		08C7493E2A45EA11000DA0E2 /* IPLocationRemoteTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 08C7493D2A45EA11000DA0E2 /* IPLocationRemoteTests.swift */; };
 		0CB1905E2A2A5E83004D3E80 /* BlazeCampaign.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0CB1905D2A2A5E83004D3E80 /* BlazeCampaign.swift */; };
 		0CB190612A2A6A13004D3E80 /* blaze-campaigns-search.json in Resources */ = {isa = PBXBuildFile; fileRef = 0CB1905F2A2A6943004D3E80 /* blaze-campaigns-search.json */; };
 		0CB190652A2A7569004D3E80 /* BlazeCampaignsSearchResponse.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0CB190642A2A7569004D3E80 /* BlazeCampaignsSearchResponse.swift */; };
@@ -687,6 +689,8 @@
 
 /* Begin PBXFileReference section */
 		0152100B28EDA9E400DD6783 /* StatsAnnualAndMostPopularTimeInsightDecodingTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StatsAnnualAndMostPopularTimeInsightDecodingTests.swift; sourceTree = "<group>"; };
+		0847B92B2A4442730044D32F /* IPLocationRemote.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IPLocationRemote.swift; sourceTree = "<group>"; };
+		08C7493D2A45EA11000DA0E2 /* IPLocationRemoteTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IPLocationRemoteTests.swift; sourceTree = "<group>"; };
 		0C3A2A412A2E7BA500FD91D6 /* CHANGELOG.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = CHANGELOG.md; sourceTree = "<group>"; };
 		0CB1905D2A2A5E83004D3E80 /* BlazeCampaign.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BlazeCampaign.swift; sourceTree = "<group>"; };
 		0CB1905F2A2A6943004D3E80 /* blaze-campaigns-search.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "blaze-campaigns-search.json"; sourceTree = "<group>"; };
@@ -1389,6 +1393,14 @@
 /* End PBXFrameworksBuildPhase section */
 
 /* Begin PBXGroup section */
+		08C7493C2A45E9E3000DA0E2 /* Privacy */ = {
+			isa = PBXGroup;
+			children = (
+				08C7493D2A45EA11000DA0E2 /* IPLocationRemoteTests.swift */,
+			);
+			name = Privacy;
+			sourceTree = "<group>";
+		};
 		0CB1905C2A2A5E7B004D3E80 /* Blaze */ = {
 			isa = PBXGroup;
 			children = (
@@ -1763,6 +1775,7 @@
 				7433BC061EFC456B002D9E92 /* Plans */,
 				E13EE14A1F332C3100C15787 /* Plugins */,
 				740B23D41F17F6D200067A2A /* Post */,
+				08C7493C2A45E9E3000DA0E2 /* Privacy */,
 				C738CAED286222C9001BE107 /* QR Login */,
 				7430C9BF1F192C210051B8E6 /* Reader */,
 				74E2294C1F1E73650085F7F2 /* Sharing */,
@@ -1883,6 +1896,7 @@
 				F9E56DF724EB125600916770 /* FeatureFlagRemote.swift */,
 				74650F711F0EA1A700188EDB /* GravatarServiceRemote.swift */,
 				1769DEA924729AFF00F42EFC /* HomepageSettingsServiceRemote.swift */,
+				0847B92B2A4442730044D32F /* IPLocationRemote.swift */,
 				FAD1344425908F5F00A8FEB1 /* JetpackBackupServiceRemote.swift */,
 				8B749DEC25AF3E4600023F03 /* JetpackCapabilitiesServiceRemote.swift */,
 				32FC1D27255C91ED00CD0A7B /* JetpackScanServiceRemote.swift */,
@@ -3224,6 +3238,7 @@
 				9F4E52002088E38200424676 /* ObjectValidation.swift in Sources */,
 				7EC60EC022DC5D7C00FB0336 /* EditorSettings.swift in Sources */,
 				7403A3021EF0726E00DED7DC /* AccountSettings.swift in Sources */,
+				0847B92C2A4442730044D32F /* IPLocationRemote.swift in Sources */,
 				40E7FEA9220FA4060032834E /* StatsEmailFollowersInsight.swift in Sources */,
 				404057DA221C9D560060250C /* StatsTopReferrersTimeIntervalData.swift in Sources */,
 				826016F11F9FA13A00533B6C /* ActivityServiceRemote.swift in Sources */,
@@ -3384,6 +3399,7 @@
 				E13EE14C1F332C4400C15787 /* PluginServiceRemoteTests.swift in Sources */,
 				736C971021E80D48007A4200 /* SiteVerticalsPromptResponseDecodingTests.swift in Sources */,
 				74B335D81F06F1CA0053A184 /* MockWordPressComRestApi.swift in Sources */,
+				08C7493E2A45EA11000DA0E2 /* IPLocationRemoteTests.swift in Sources */,
 				32AF21E3236DEB3C001C6502 /* PostServiceRemoteRESTAutosaveTests.swift in Sources */,
 				3236F79A24AE406D0088E8F3 /* ReaderTopicServiceRemote+InterestsTests.swift in Sources */,
 				FEE4EF5B27302317003CDA3C /* CommentServiceRemoteREST+APIv2Tests.swift in Sources */,

WordPressKit/IPLocationRemote.swift

@@ -0,0 +1,55 @@
+import Foundation
+
+/// Remote type to fetch the user's IP Location using the public `geo` API.
+///
+public final class IPLocationRemote {
+    private enum Constants {
+        static let jsonDecoder = JSONDecoder()
+    }
+
+    private let urlSession: URLSession
+
+    init(urlSession: URLSession = URLSession.shared) {
+        self.urlSession = urlSession
+    }
+
+    /// Fetches the country code from the device ip.
+    ///
+    public func fetchIPCountryCode(completion: @escaping (Result<String, Error>) -> Void) {
+        let path = WordPressComOAuthClient.WordPressComOAuthDefaultApiBaseUrl + "/geo/"
+        guard let url = URL(string: path) else {
+            return completion(.failure(IPLocationError.malformedURL))
+        }
+
+        let request = URLRequest(url: url)
+        let task = urlSession.dataTask(with: request) { data, _, error in
+            guard let data else {
+                completion(.failure(IPLocationError.requestFailure(error)))
+                return
+            }
+
+            do {
+                let result = try Constants.jsonDecoder.decode(RemoteIPCountryCode.self, from: data)
+                completion(.success(result.countryCode))
+            } catch {
+                completion(.failure(error))
+            }
+        }
+        task.resume()
+    }
+}
+
+public extension IPLocationRemote {
+    enum IPLocationError: Error {
+        case malformedURL
+        case requestFailure(Error?)
+    }
+}
+
+public struct RemoteIPCountryCode: Decodable {
+    enum CodingKeys: String, CodingKey {
+        case countryCode = "country_short"
+    }
+
+    let countryCode: String
+}

WordPressKitTests/IPLocationRemoteTests.swift

@@ -0,0 +1,83 @@
+import XCTest
+@testable import WordPressKit
+
+
+final class IPLocationRemoteTests: XCTestCase {
+    var remote: IPLocationRemote!
+    let apiURL = URL(string: "https://public-api.wordpress.com/geo/")!
+
+    override func setUp() {
+        super.setUp()
+        let configuration = URLSessionConfiguration.default
+        configuration.protocolClasses = [MockURLProtocol.self]
+        let urlSession = URLSession.init(configuration: configuration)
+
+        remote = IPLocationRemote(urlSession: urlSession)
+    }
+
+    func testCountryCodeIsCorrectlyParsed() {
+        let expectation = expectation(description: "The country code should be parsed as DE")
+        let jsonString = """
+                         {
+                             "latitude": "24.917202",
+                             "longitude": "16.559613",
+                             "country_short": "DE",
+                             "country_long": "Germany",
+                             "region": "Brandenburg",
+                             "city": "Potsdam"
+                         }
+                         """
+
+        let data = jsonString.data(using: .utf8)
+
+        MockURLProtocol.requestHandler = { request in
+          let response = HTTPURLResponse(url: self.apiURL, statusCode: 200, httpVersion: nil, headerFields: nil)!
+          return (response, data)
+        }
+
+        remote.fetchIPCountryCode { result in
+          switch result {
+          case .success(let countryCode):
+            XCTAssertEqual(countryCode, "DE")
+          case .failure(let error):
+            XCTFail("Error was not expected: \(error)")
+          }
+          expectation.fulfill()
+        }
+        wait(for: [expectation], timeout: 1.0)
+    }
+}
+
+final class MockURLProtocol: URLProtocol {
+    static var requestHandler: ((URLRequest) throws -> (HTTPURLResponse, Data?))?
+
+    override class func canInit(with request: URLRequest) -> Bool {
+        return true
+    }
+
+    override class func canonicalRequest(for request: URLRequest) -> URLRequest {
+        return request
+    }
+
+
+    override func startLoading() {
+        guard let handler = MockURLProtocol.requestHandler else {
+            fatalError("Handler is unavailable.")
+        }
+
+        do {
+            let (response, data) = try handler(request)
+            client?.urlProtocol(self, didReceive: response, cacheStoragePolicy: .notAllowed)
+
+            if let data = data {
+                client?.urlProtocol(self, didLoad: data)
+            }
+            client?.urlProtocolDidFinishLoading(self)
+        } catch {
+            client?.urlProtocol(self, didFailWithError: error)
+        }
+    }
+
+
+    override func stopLoading() { }
+}