Merge branch 'link_header_support' into swift-2.0

Author: dduan

Docs/QuickStart.playground/Contents.swift

@@ -178,6 +178,22 @@ if let json = Just.post(
 }
 
 
+//: ## Link Headers
+//: Many HTTP APIs feature Link headers. They make APIs more self describing
+//: and discoverable.
+//:
+//: Github uses these for pagination in their API, for example:
+
+let gh = Just.head("https://api.github.com/users/dduan/repos?page=1&per_page=5")
+gh.headers["link"] // <https://api.github.com/user/75067/repos?page=2&per_page=5>; rel="next", <https://api.github.com/user/75067/repos?page=9&per_page=5>; rel="last"
+
+//: Just will automatically parse these link headers and make them easily consumable:
+
+gh.links["next"] // ["rel": "next", "url":"https://api.github.com/user/75067/repos?page=2&per_page=5"]
+gh.links["last"] // ["rel": "last", "url":"https://api.github.com/user/75067/repos?page=9&per_page=5"]
+
+//: (be aware of Github's rate limits when you play with these)
+
 //: ## Cookies
 //:
 //: If you expect the server to return some cookie, you can find them this way:

Docs/QuickStart.playground/timeline.xctimeline

@@ -3,7 +3,17 @@
    version = "3.0">
    <TimelineItems>
       <LoggerValueHistoryTimelineItem
-         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=0&amp;EndingColumnNumber=20&amp;EndingLineNumber=179&amp;StartingColumnNumber=9&amp;StartingLineNumber=179&amp;Timestamp=455693370.322447"
+         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=0&amp;EndingColumnNumber=20&amp;EndingLineNumber=182&amp;StartingColumnNumber=9&amp;StartingLineNumber=182&amp;Timestamp=462872685.952829"
+         selectedRepresentationIndex = "0"
+         shouldTrackSuperviewWidth = "NO">
+      </LoggerValueHistoryTimelineItem>
+      <LoggerValueHistoryTimelineItem
+         documentLocation = "#CharacterRangeLen=6&amp;CharacterRangeLoc=2853&amp;EndingColumnNumber=7&amp;EndingLineNumber=81&amp;StartingColumnNumber=1&amp;StartingLineNumber=81&amp;Timestamp=462872716.632806"
+         selectedRepresentationIndex = "0"
+         shouldTrackSuperviewWidth = "NO">
+      </LoggerValueHistoryTimelineItem>
+      <LoggerValueHistoryTimelineItem
+         documentLocation = "#CharacterRangeLen=0&amp;CharacterRangeLoc=7062&amp;EndingColumnNumber=17&amp;EndingLineNumber=195&amp;StartingColumnNumber=1&amp;StartingLineNumber=194&amp;Timestamp=462873916.609416"
          selectedRepresentationIndex = "0"
          shouldTrackSuperviewWidth = "NO">
       </LoggerValueHistoryTimelineItem>

Docs/QuickStart.zip

@@ -117,6 +117,7 @@ public final class HTTPResult : NSObject {
         }
         return nil
     }
+
     public var statusCode: Int? {
         if let theResponse = self.response as? NSHTTPURLResponse {
             return theResponse.statusCode
@@ -133,7 +134,7 @@ public final class HTTPResult : NSObject {
 
     public lazy var headers:CaseInsensitiveDictionary<String,String> = {
         return CaseInsensitiveDictionary<String,String>(dictionary: (self.response as? NSHTTPURLResponse)?.allHeaderFields as? [String:String] ?? [:])
-        }()
+    }()
 
     public lazy var cookies:[String:NSHTTPCookie] = {
         let foundCookies: [NSHTTPCookie]
@@ -156,6 +157,35 @@ public final class HTTPResult : NSObject {
     public var url:NSURL? {
         return response?.URL
     }
+    public lazy var links: [String:[String:String]] = {
+        var result = [String:[String:String]]()
+        if let content = self.headers["link"] {
+            content.componentsSeparatedByString(",").forEach { s in
+                let linkComponents = s.componentsSeparatedByString(";").map { ($0 as NSString).stringByTrimmingCharactersInSet(NSCharacterSet.whitespaceCharacterSet()) }
+                if linkComponents.count > 1 { // although a link without a rel is valid, there's no way to reference it
+                    let urlComponent = linkComponents.first!
+                    let urlRange = urlComponent.startIndex.advancedBy(1)..<urlComponent.endIndex.advancedBy(-1)
+                    var link: [String: String] = ["url": String(urlComponent.characters[urlRange])]
+                    linkComponents.dropFirst().forEach { s in
+                        if let equalIndex = s.characters.indexOf("=") {
+                            let componentKey = String(s.characters[s.startIndex..<equalIndex])
+                            let componentValueCharacters = s.characters[equalIndex.advancedBy(1)..<s.endIndex]
+                            if componentValueCharacters.first == "\"" && componentValueCharacters.last == "\"" {
+                                let unquotedValueRange = componentValueCharacters.startIndex.advancedBy(1)..<componentValueCharacters.endIndex.advancedBy(-1)
+                                link[componentKey] = String(componentValueCharacters[unquotedValueRange])
+                            } else {
+                                link[componentKey] = String(componentValueCharacters)
+                            }
+                        }
+                    }
+                    if let rel = link["rel"] {
+                        result[rel] = link
+                    }
+                }
+            }
+        }
+        return result
+    }()
 }
 
 

Just/Just.swift

@@ -640,5 +640,27 @@ class JustSpec: QuickSpec {
                 expect(r.ok).to(beTrue())
             }
         }
+
+        describe("link header support") {
+            it("should always have a value for .links") {
+                expect(Just.get("https://api.github.com/users/dduan/repos?page=1&per_page=10").links).toNot(beNil())
+            }
+            it("should contain key \"next\" for this specific github API") {
+                let r = Just.get("https://api.github.com/users/dduan/repos?page=1&per_page=10")
+                expect(r.ok).to(beTrue())
+                expect(r.links["next"]).toNot(beNil())
+            }
+            it("should contain key \"last\" for this specific github API") {
+                let r = Just.get("https://api.github.com/users/dduan/repos?page=1&per_page=10")
+                expect(r.ok).to(beTrue())
+                expect(r.links["last"]).toNot(beNil())
+            }
+            it("should contain key \"url\" in \"next\" and \"last\" for this specific github API") {
+                let r = Just.get("https://api.github.com/users/dduan/repos?page=1&per_page=10")
+                expect(r.links["next"]?["url"]).toNot(beNil())
+                expect(r.links["last"]?["url"]).toNot(beNil())
+
+            }
+        }
     }
 }

JustTests/JustSpecs.swift

@@ -25,6 +25,7 @@ Just lets you to the following effortlessly:
 -   timeouts
 -   synchrounous / asyncrounous requests
 -   upload / download progress tracking for asynchronous requests
+    link headers
 -   friendly accessible results
 
 #  Use