Add request properties mainDocumentURL and httpShouldHandleCookies

Author: lilyball

README.md

@@ -415,9 +415,11 @@ work by you shall be dual licensed as above, without any additional terms or con
 * Percent-encode more characters for `application/x-www-form-urlencoded` bodies and query strings. Notably, semicolon (;) is now percent-encoded, as some servers treat it as a separator.
 * Optimize task metrics collection such that metrics are not collected if `metricsCallback` is `nil` ([#37][]).
 * Extend built-in retry behaviors to support custom strategies ([#35][]).
+* Add `HTTPManagerRequest` properties that correspond to the `URLRequest` properties `mainDocumentURL` and `httpShouldHandleCookies` ([#40][]).
 
 [#35]: https://github.com/postmates/PMHTTP/issues/35
 [#37]: https://github.com/postmates/PMHTTP/issues/37
+[#40]: https://github.com/postmates/PMHTTP/issues/40
 
 #### v4.1.1 (2018-06-21)
 

Sources/HTTPManagerRequest.swift

@@ -135,6 +135,16 @@ public class HTTPManagerRequest: NSObject, NSCopying {
     /// radio is always denied regardless of the request's `allowsCellularAccess` property.
     @objc public var allowsCellularAccess: Bool = true
 
+    /// The main document URL associated with the request.
+    ///
+    /// This URL is used for the cookie "same domain as main document" policy.
+    ///
+    /// - SeeAlso: `URLRequest.mainDocumentURL`.
+    @objc public var mainDocumentURL: URL?
+    
+    /// Indicates whether cookies will be sent with and set for this request. Default is `true`.
+    @objc public var httpShouldHandleCookies: Bool = true
+    
     /// Whether the request represents an action the user is waiting on.
     /// Set this to `true` to increase the priority. Default is `false`.
     @objc public var userInitiated: Bool = false
@@ -261,6 +271,8 @@ public class HTTPManagerRequest: NSObject, NSCopying {
         shouldFollowRedirects = request.shouldFollowRedirects
         defaultResponseCacheStoragePolicy = request.defaultResponseCacheStoragePolicy
         allowsCellularAccess = request.allowsCellularAccess
+        mainDocumentURL = request.mainDocumentURL
+        httpShouldHandleCookies = request.httpShouldHandleCookies
         userInitiated = request.userInitiated
         retryBehavior = request.retryBehavior
         assumeErrorsAreJSON = request.assumeErrorsAreJSON
@@ -282,6 +294,10 @@ public class HTTPManagerRequest: NSObject, NSCopying {
             request.timeoutInterval = timeout
         }
         request.allowsCellularAccess = allowsCellularAccess
+        if let url = mainDocumentURL {
+            request.mainDocumentURL = url
+        }
+        request.httpShouldHandleCookies = httpShouldHandleCookies
         request.allHTTPHeaderFields = headerFields.dictionary
         let contentType = self.contentType
         if contentType.isEmpty {
@@ -1075,6 +1091,8 @@ public final class HTTPManagerParseRequest<T>: HTTPManagerRequest, HTTPManagerRe
         shouldFollowRedirects = request.shouldFollowRedirects
         self.defaultResponseCacheStoragePolicy = defaultResponseCacheStoragePolicy ?? request.defaultResponseCacheStoragePolicy
         allowsCellularAccess = request.allowsCellularAccess
+        mainDocumentURL = request.mainDocumentURL
+        httpShouldHandleCookies = request.httpShouldHandleCookies
         userInitiated = request.userInitiated
         retryBehavior = request.retryBehavior
         assumeErrorsAreJSON = request.assumeErrorsAreJSON

Sources/ObjectiveC.swift

@@ -965,6 +965,16 @@ public final class HTTPManagerObjectParseRequest: HTTPManagerRequest, HTTPManage
         set { _request.allowsCellularAccess = newValue }
     }
 
+    public override var mainDocumentURL: URL? {
+        get { return _request.mainDocumentURL }
+        set { _request.mainDocumentURL = newValue }
+    }
+    
+    public override var httpShouldHandleCookies: Bool {
+        get { return _request.httpShouldHandleCookies }
+        set { _request.httpShouldHandleCookies = newValue }
+    }
+    
     public override var userInitiated: Bool {
         get { return _request.userInitiated }
         set { _request.userInitiated = newValue }

Tests/PMHTTPTests.swift

@@ -1911,4 +1911,18 @@ final class PMHTTPTests: PMHTTPTestCase {
         helper({ HTTP.request(PUT: "foo", parameters: $0) })
         helper({ HTTP.request(DELETE: "foo", parameters: $0) })
     }
+    
+    func testSettingMainDocumentURL() {
+        let request = HTTP.request(GET: "foo")!
+        XCTAssertNil(request.preparedURLRequest.mainDocumentURL, "main document URL")
+        request.mainDocumentURL = URL(string: "http://apple.com")!
+        XCTAssertEqual(request.preparedURLRequest.mainDocumentURL, URL(string: "http://apple.com"), "main document URL")
+    }
+    
+    func testSettingHttpShouldHandleCookies() {
+        let request = HTTP.request(GET: "foo")!
+        XCTAssertTrue(request.preparedURLRequest.httpShouldHandleCookies, "should handle cookies")
+        request.httpShouldHandleCookies = false
+        XCTAssertFalse(request.preparedURLRequest.httpShouldHandleCookies, "should handle cookies")
+    }
 }