Merge pull request #513 from wordpress-mobile/feature/qrcode-login-networking

Add QR Login Remote Service

Author: Emily Laguna

WordPressKit.podspec

@@ -2,7 +2,7 @@
 
 Pod::Spec.new do |s|
   s.name          = 'WordPressKit'
-  s.version       = '4.54.0'
+  s.version       = '4.55.0-beta.1'
 
   s.summary       = 'WordPressKit offers a clean and simple WordPress.com and WordPress.org API.'
   s.description   = <<-DESC

WordPressKit.xcodeproj/project.pbxproj

@@ -0,0 +1,62 @@
+import Foundation
+import WordPressShared
+
+public class QRLoginServiceRemote: ServiceRemoteWordPressComREST {
+    /// Validates the incoming QR Login token and retrieves the requesting browser, and location
+    public func validate(token: String, data: String, success: @escaping (QRLoginValidationResponse) -> Void, failure: @escaping (Error?, QRLoginError?) -> Void) {
+        let path = self.path(forEndpoint: "auth/qr-code/validate", withVersion: ._2_0)
+        let parameters = [ "token": token, "data": data ] as [String: AnyObject]
+
+        wordPressComRestApi.POST(path, parameters: parameters as [String: AnyObject], success: { (response, _) in
+            do {
+                let decoder = JSONDecoder.apiDecoder
+                let data = try JSONSerialization.data(withJSONObject: response, options: [])
+                let envelope = try decoder.decode(QRLoginValidationResponse.self, from: data)
+
+                success(envelope)
+            } catch {
+                failure(nil, .invalidData)
+            }
+        }, failure: { (error, response) in
+            guard let response = response else {
+                failure(error, .invalidData)
+                return
+            }
+
+            let statusCode = response.statusCode
+            failure(error, QRLoginError(statusCode: statusCode))
+        })
+    }
+
+    /// Authenticates the users browser
+    public func authenticate(token: String, data: String, success: @escaping(Bool) -> Void, failure: @escaping(Error) -> Void) {
+        let path = self.path(forEndpoint: "auth/qr-code/authenticate", withVersion: ._2_0)
+        let parameters = [ "token": token, "data": data ] as [String: AnyObject]
+
+        wordPressComRestApi.POST(path, parameters: parameters, success: { (response, _) in
+            guard let authenticated = response["authenticated"] as? Bool else {
+                success(false)
+                return
+            }
+
+            success(authenticated)
+        }, failure: { (error, _) in
+            failure(error)
+        })
+    }
+}
+
+public enum QRLoginError {
+    case invalidData
+    case expired
+
+    init(statusCode: Int) {
+        switch statusCode {
+        case 401:
+            self = .expired
+
+        default:
+            self = .invalidData
+        }
+    }
+}

WordPressKit/QR Login/QRLoginServiceRemote.swift

@@ -0,0 +1,13 @@
+import Foundation
+
+public struct QRLoginValidationResponse: Decodable {
+    /// The name of the browser that the user has requested the login from
+    /// IE: Chrome, Firefox
+    /// This may be null if the browser could not be determined
+    public var browser: String?
+
+
+    /// The City, State the user has requested the login from
+    /// IE: Columbus, Ohio
+    public var location: String
+}

WordPressKit/QR Login/QRLoginValidationResponse.swift

@@ -0,0 +1,4 @@
+{
+    "authenticated": true,
+    "success": true
+}

WordPressKitTests/Mock Data/qrlogin-authenticate-200.json

@@ -0,0 +1,7 @@
+{
+    "code": "rest_invalid_param",
+    "message": "Token does not match",
+    "data": {
+        "status": 400
+    }
+}

WordPressKitTests/Mock Data/qrlogin-authenticate-failed-400.json

@@ -0,0 +1,5 @@
+{
+    "browser": "Chrome",
+    "location": "Mount Laurel, New Jersey",
+    "success": true
+}

WordPressKitTests/Mock Data/qrlogin-validate-200.json

@@ -0,0 +1,7 @@
+{
+    "code": "rest_invalid_param",
+    "message": "Token does not match",
+    "data": {
+        "status": 400
+    }
+}

WordPressKitTests/Mock Data/qrlogin-validate-400.json

@@ -0,0 +1,7 @@
+{
+    "code": "data_invalid",
+    "message": "QR code data expired",
+    "data": {
+        "status": 401
+    }
+}

WordPressKitTests/Mock Data/qrlogin-validate-expired-401.json

@@ -0,0 +1,124 @@
+import XCTest
+@testable import WordPressKit
+
+class QRLoginServiceRemoteTests: RemoteTestCase, RESTTestable {
+    let mockRemoteApi = MockWordPressComRestApi()
+    var qrLoginServiceRemote: QRLoginServiceRemote!
+
+    override func setUp() {
+        qrLoginServiceRemote = QRLoginServiceRemote(wordPressComRestApi: getRestApi())
+    }
+
+    // MARK: - Validate Tests
+
+    // Calls the success block with valid data when the request succeeds
+    //
+    func testValidResponseObject() {
+        let expect = expectation(description: "Validate the response object successfully")
+        stubRemoteResponse("wpcom/v2/auth/qr-code/validate", filename: "qrlogin-validate-200.json", contentType: .ApplicationJSON)
+
+        let browser = "Chrome"
+        let location = "Mount Laurel, New Jersey"
+
+        qrLoginServiceRemote.validate(token: "", data: "") { response in
+            XCTAssertEqual(browser, response.browser)
+            XCTAssertEqual(location, response.location)
+            expect.fulfill()
+        } failure: { _, _ in }
+
+        waitForExpectations(timeout: timeout, handler: nil)
+    }
+
+    // Calls the failure block with invalidData when providing invalid token/data
+    //
+    func testValidateInvalidData() {
+        let expect = expectation(description: "Validate the invalid data error is being handled")
+        stubRemoteResponse("wpcom/v2/auth/qr-code/validate", filename: "qrlogin-validate-400.json", contentType: .ApplicationJSON, status: 400)
+
+        qrLoginServiceRemote.validate(token: "invalid_token", data: "invalid_data") { _ in
+            XCTFail("This request should not succeed")
+        } failure: { _, qrLoginError in
+            XCTAssertEqual(qrLoginError!, .invalidData)
+            expect.fulfill()
+        }
+
+        waitForExpectations(timeout: timeout, handler: nil)
+    }
+
+    // Calls the failure block with expired when providing expired token/data
+    //
+    func testValidateExpired() {
+        let expect = expectation(description: "Validate the expired data error is being handled")
+        stubRemoteResponse("wpcom/v2/auth/qr-code/validate", filename: "qrlogin-validate-expired-401.json", contentType: .ApplicationJSON, status: 401)
+
+        qrLoginServiceRemote.validate(token: "expired_token", data: "expired_data") { _ in
+            XCTFail("This request should not succeed")
+        } failure: { _, qrLoginError in
+            XCTAssertEqual(qrLoginError!, .expired)
+            expect.fulfill()
+        }
+
+        waitForExpectations(timeout: timeout, handler: nil)
+    }
+
+    // Calls the failure block with invalidData when parsing an invalid response
+    //
+    func testInvalidJSON() {
+        let expect = expectation(description: "Validate the failure object is being returned")
+        stubRemoteResponse("wpcom/v2/auth/qr-code/validate", data: "foo".data(using: .utf8)!, contentType: .ApplicationJSON)
+
+        qrLoginServiceRemote.validate(token: "expired_token", data: "expired_data") { _ in
+            XCTFail("This request should not succeed")
+        } failure: { _, qrLoginError in
+            XCTAssertEqual(qrLoginError!, .invalidData)
+            expect.fulfill()
+        }
+
+        waitForExpectations(timeout: timeout, handler: nil)
+    }
+
+    // MARK: - Authenticate Tests
+
+    // Calls the success block when authenticating valid data
+    //
+    func testAuthenticateSuccess() {
+        let expect = expectation(description: "Successful Authentication")
+        stubRemoteResponse("wpcom/v2/auth/qr-code/authenticate", filename: "qrlogin-authenticate-200.json", contentType: .ApplicationJSON)
+
+        qrLoginServiceRemote.authenticate(token: "valid_token", data: "valid_data") { authenticated in
+            XCTAssertTrue(authenticated)
+            expect.fulfill()
+        } failure: { _ in }
+
+        waitForExpectations(timeout: timeout, handler: nil)
+    }
+
+    // Calls the failure block when providing invalid data
+    //
+    func testAuthenticateFailure() {
+        let expect = expectation(description: "Failed Authentication")
+        stubRemoteResponse("wpcom/v2/auth/qr-code/authenticate", filename: "qrlogin-authenticate-failed-400.json", contentType: .ApplicationJSON, status: 400)
+
+        qrLoginServiceRemote.authenticate(token: "valid_token", data: "valid_data") { authenticated in
+            XCTFail("This request should not succeed")
+        } failure: { error in
+            expect.fulfill()
+        }
+
+        waitForExpectations(timeout: timeout, handler: nil)
+    }
+
+    // Calls the failure block when parsing invalid JSON
+    func testAuthenticateInvalidJSON() {
+        let expect = expectation(description: "Failed Authentication")
+        stubRemoteResponse("wpcom/v2/auth/qr-code/authenticate", data: "foo".data(using: .utf8)!, contentType: .ApplicationJSON)
+
+        qrLoginServiceRemote.authenticate(token: "valid_token", data: "valid_data") { authenticated in
+            XCTFail("This request should not succeed")
+        } failure: { error in
+            expect.fulfill()
+        }
+
+        waitForExpectations(timeout: timeout, handler: nil)
+    }
+}