Merge pull request #311 from ishkawa/feature/typed-data-parser

Add types to DataParser response

Author: Econa77

Sources/APIKit/DataParser/FormURLEncodedDataParser.swift

@@ -21,9 +21,9 @@ public class FormURLEncodedDataParser: DataParser {
         return "application/x-www-form-urlencoded"
     }
 
-    /// Return `Any` that expresses structure of response.
+    /// Return `[String: Any]` that expresses structure of response.
     /// - Throws: `FormURLEncodedDataParser.Error` when the parser fails to initialize `String` from `Data`.
-    public func parse(data: Data) throws -> Any {
+    public func parse(data: Data) throws -> [String: Any] {
         guard let string = String(data: data, encoding: encoding) else {
             throw Error.cannotGetStringFromData(data)
         }

Sources/APIKit/DataParser/ProtobufDataParser.swift

@@ -12,8 +12,8 @@ public class ProtobufDataParser: DataParser {
         return "application/protobuf"
     }
 
-    /// Return `Any` that expresses structure of Data response.
-    public func parse(data: Data) throws -> Any {
+    /// Return `Data` that expresses structure of Data response.
+    public func parse(data: Data) throws -> Data {
         return data
     }
 }

Sources/APIKit/DataParser/StringDataParser.swift

@@ -23,7 +23,7 @@ public class StringDataParser: DataParser {
 
     /// Return `String` that converted from `Data`.
     /// - Throws: `StringDataParser.Error` when the parser fails to initialize `String` from `Data`.
-    public func parse(data: Data) throws -> Any {
+    public func parse(data: Data) throws -> String {
         guard let string = String(data: data, encoding: encoding) else {
             throw Error.invalidData(data)
         }

Sources/APIKit/Request/Request.swift

@@ -144,7 +144,7 @@ public extension Request {
 }
 
 public extension Request where Response == Void {
-    func response(from object: Any, urlResponse: HTTPURLResponse) throws {
+    func response(from object: DataParser.Parsed, urlResponse: HTTPURLResponse) throws {
         return
     }
 }

Tests/APIKitTests/DataParserType/FormURLEncodedDataParserTests.swift

@@ -14,10 +14,9 @@ class FormURLEncodedDataParserTests: XCTestCase {
         let parser = FormURLEncodedDataParser(encoding: .utf8)
 
         let object = try parser.parse(data: data)
-        let dictionary = object as? [String: String]
-        XCTAssertEqual(dictionary?["foo"], "1")
-        XCTAssertEqual(dictionary?["bar"], "2")
-        XCTAssertEqual(dictionary?["baz"], "3")
+        XCTAssertEqual(object["foo"] as? String, "1")
+        XCTAssertEqual(object["bar"] as? String, "2")
+        XCTAssertEqual(object["baz"] as? String, "3")
     }
 
     func testInvalidString() {

Tests/APIKitTests/DataParserType/JSONDataParserTests.swift

@@ -8,7 +8,7 @@ class JSONDataParserTests: XCTestCase {
         XCTAssertEqual(parser.contentType, "application/json")
     }
 
-    func testJSONSuccess() throws {
+    func testDictionaryJSONSuccess() throws {
         let string = "{\"foo\": 1, \"bar\": 2, \"baz\": 3}"
         let data = string.data(using: .utf8, allowLossyConversion: false)!
         let parser = JSONDataParser(readingOptions: [])
@@ -19,4 +19,16 @@ class JSONDataParserTests: XCTestCase {
         XCTAssertEqual(dictionary?["bar"], 2)
         XCTAssertEqual(dictionary?["baz"], 3)
     }
+
+    func testArrayJSONSuccess() throws {
+        let string = "[1, 2, 3]"
+        let data = string.data(using: .utf8, allowLossyConversion: false)!
+        let parser = JSONDataParser(readingOptions: [])
+
+        let object = try parser.parse(data: data)
+        let array = object as? [Int]
+        XCTAssertEqual(array?[0], 1)
+        XCTAssertEqual(array?[1], 2)
+        XCTAssertEqual(array?[2], 3)
+    }
 }

Tests/APIKitTests/DataParserType/ProtobufDataParserTests.swift

@@ -12,7 +12,7 @@ class ProtobufDataParserTests: XCTestCase {
         let data = try XCTUnwrap("data".data(using: .utf8))
         let parser = ProtobufDataParser()
 
-        let object = try XCTUnwrap(try parser.parse(data: data) as? Data)
+        let object = try parser.parse(data: data)
         let string = String(data: object, encoding: .utf8)
         XCTAssertEqual(string, "data")
     }

Tests/APIKitTests/DataParserType/StringDataParserTests.swift

@@ -14,7 +14,7 @@ class StringDataParserTests: XCTestCase {
         let parser = StringDataParser(encoding: .utf8)
 
         let object = try parser.parse(data: data)
-        XCTAssertEqual(object as? String, string)
+        XCTAssertEqual(object, string)
     }
 
     func testInvalidString() {