Extract Response into a protocol and rename code in statusCode #56

Author: MP0w

KakapoExample/KakapoTests/RouterTests.swift

@@ -13,6 +13,18 @@ import Nimble
 
 @testable import Kakapo
 
+struct CustomResponse: ResponseFieldsProvider {
+    let statusCode: Int
+    let body: Serializable
+    let headerFields: [String : String]?
+    
+    init(statusCode: Int, body: Serializable, headerFields: [String : String]? = nil) {
+        self.statusCode = statusCode
+        self.body = body
+        self.headerFields = headerFields
+    }
+}
+
 class RouterTests: QuickSpec {
 
     override func spec() {
@@ -304,7 +316,7 @@ class RouterTests: QuickSpec {
                 var responseDictionary: NSDictionary? = nil
 
                 router.get("/users/:id"){ request in
-                    return Response(code: 200, body: db.find(UserFactory.self, id: Int(request.components["id"]!)!))
+                    return Response(statusCode: 200, body: db.find(UserFactory.self, id: Int(request.components["id"]!)!))
                 }
 
                 NSURLSession.sharedSession().dataTaskWithURL(NSURL(string: "http://www.test.com/users/2")!) { (data, response, _) in
@@ -324,7 +336,7 @@ class RouterTests: QuickSpec {
 
                 router.get("/users/:id"){ request in
                     // Optional.Some("none") -> not valid JSON object
-                    return Response(code: 400, body: Optional.Some("none"))
+                    return Response(statusCode: 400, body: Optional.Some("none"))
                 }
 
                 NSURLSession.sharedSession().dataTaskWithURL(NSURL(string: "http://www.test.com/users/2")!) { (data, response, _) in
@@ -341,7 +353,7 @@ class RouterTests: QuickSpec {
                 var allHeaders: [String : String]? = nil
 
                 router.get("/users/:id"){ request in
-                    return Response(code: 400, body: ["id" : "foo", "type" : "User"], headerFields: ["access_token" : "094850348502", "user_id" : "124"])
+                    return Response(statusCode: 400, body: ["id" : "foo", "type" : "User"], headerFields: ["access_token" : "094850348502", "user_id" : "124"])
                 }
 
                 NSURLSession.sharedSession().dataTaskWithURL(NSURL(string: "http://www.test.com/users/2")!) { (data, response, _) in
@@ -354,6 +366,27 @@ class RouterTests: QuickSpec {
                 expect(allHeaders?["bar"]).toEventually(beNil())
             }
 
+            it("should gets the response fields from custom response object adopting the ResponseFieldsProvider protocol") {
+                var allHeaders: [String : String]? = nil
+                var responseDictionary: NSDictionary? = nil
+                var statusCode: Int? = nil
+                
+                router.get("/users/:id"){ request in
+                    return CustomResponse(statusCode: 400, body: ["id" : 2], headerFields: ["access_token" : "094850348502"])
+                }
+                
+                NSURLSession.sharedSession().dataTaskWithURL(NSURL(string: "http://www.test.com/users/2")!) { (data, response, _) in
+                    let response = response as! NSHTTPURLResponse
+                    allHeaders = response.allHeaderFields as? [String : String]
+                    responseDictionary = try! NSJSONSerialization.JSONObjectWithData(data!, options: .MutableLeaves) as? NSDictionary
+                    statusCode = response.statusCode
+                    }.resume()
+                
+                expect(allHeaders?["access_token"]).toEventually(equal("094850348502"))
+                expect(statusCode).toEventually(equal(400))
+                expect(responseDictionary?["id"]).toEventually(be(2))
+            }
+            
             it("should return the specified array of objects when requesting a registered url") {
                 db.create(UserFactory.self, number: 20)
 
@@ -610,6 +643,7 @@ class RouterTests: QuickSpec {
 
                 expect(thirdInfo).toEventually(beNil())
                 expect(thirdResponseURL?.host).toEventually(equal("www.another.com"))
+                Swift.assert(thirdResponseURL?.host != nil)
             }
 
             it("Should fail when not properly registering Routers") {

Source/Router.swift

@@ -12,7 +12,7 @@ import Foundation
  A RouteHandler used when registering different HTTP methods, which can return any Serializable object.
 
  By default, though, the Router will return a 200 status code and no header fields when only returning a Serializable object.
- In order to customize that behavior, check `Response` to provide custom status code and header fields.
+ In order to customize that behavior, check `ResponseFieldsProvider` to provide custom status code and header fields.
  */
 public typealias RouteHandler = Request -> Serializable?
 
@@ -34,29 +34,47 @@ public struct Request {
 }
 
 /**
- A Response struct which can be used in `RouteHandlers` to provide valid responses.
+ A protocol to adopt when a Serializable Object needs to also provide response status code and/or headerFields
+ You may usually use `Response` to wrap your `Serializable` object to just achieve the result or directly implement the protocol. For examply `JSONAPISerializer` implement the protocol in order to be able to provide custom status code in the response.
+ */
+public protocol ResponseFieldsProvider: CustomSerializable {
+    /// The response status code
+    var statusCode: Int { get }
+    
+    /// The Serializable body object
+    var body: Serializable { get }
+
+    /// An optional dictionary holding the response header fields
+    var headerFields: [String : String]? { get }
+}
+
+extension ResponseFieldsProvider {
+    
+    public func customSerialize() -> AnyObject? {
+        return body.serialize()
+    }
+}
+
+/**
+ A ResponseFieldsProvider implementation which can be used in `RouteHandlers` to provide valid responses that can return different status code than the default (200) or headerFields.
 
  The struct provides, appart from a Serializable `body` object, a status code and header fields. 
  */
-public struct Response: CustomSerializable {
-    /// The response code
-    let code: Int
+public struct Response: ResponseFieldsProvider {
+    /// The response status code
+    public let statusCode: Int
 
     /// The Serializable body object
-    let body: Serializable
+    public let body: Serializable
 
     /// An optional dictionary holding the response header fields
-    let headerFields: [String : String]?
+    public let headerFields: [String : String]?
 
-    public init(code: Int, body: Serializable, headerFields: [String : String]? = nil) {
-        self.code = code
+    public init(statusCode: Int, body: Serializable, headerFields: [String : String]? = nil) {
+        self.statusCode = statusCode
         self.body = body
         self.headerFields = headerFields
     }
-    
-    public func customSerialize() -> AnyObject? {
-        return body.serialize()
-    }
 }
 
 /**
@@ -146,8 +164,8 @@ public class Router {
             }
         }
 
-        if let serializableObject = serializableObject as? Response {
-            statusCode = serializableObject.code
+        if let serializableObject = serializableObject as? ResponseFieldsProvider {
+            statusCode = serializableObject.statusCode
             headerFields = serializableObject.headerFields
         }