Merge pull request #44 from RxSwiftCommunity/custom-caching

Allow to specify cached http methods

Author: reloni

RxHttpClient/HttpClientType+Extensions.swift

@@ -9,11 +9,14 @@ public struct CacheMode {
 	public let returnCachedResponse: Bool
 	/// If true, HttpClient will invoke request
 	public let invokeRequest: Bool
+    /// Specifies which HTTP methods should be cached
+    public let cacheHttpMethods: Set<HttpMethod>
 
-	public init(cacheResponse: Bool = true, returnCachedResponse: Bool = true, invokeRequest: Bool = true) {
+	public init(cacheResponse: Bool = true, returnCachedResponse: Bool = true, invokeRequest: Bool = true, cacheHttpMethods: [HttpMethod] = [.get]) {
 		self.cacheResponse = cacheResponse
 		self.returnCachedResponse = returnCachedResponse
 		self.invokeRequest = invokeRequest
+        self.cacheHttpMethods = Set(cacheHttpMethods)
 	}
 
 	/// Only cached response will be returned
@@ -26,6 +29,14 @@ public struct CacheMode {
 	public static let `default` = CacheMode(cacheResponse: true, returnCachedResponse: true, invokeRequest: true)
 }
 
+extension CacheMode {
+    func shouldCache(_ request: URLRequest) -> Bool {
+        guard let raw = request.httpMethod else { return false }
+        guard let method = HttpMethod(rawValue: raw) else { return false }
+        return cacheHttpMethods.contains(method)
+    }
+}
+
 public extension HttpClientType {
 	/**
 	Creates StreamDataTask
@@ -165,9 +176,9 @@ public extension HttpClientType {
 		let dataCacheProvider = MemoryDataCacheProvider(uid: UUID().uuidString)
 		// variable for response with error
 		var errorResponse: HTTPURLResponse? = nil
-		
+        
 		let cachedRequest: Observable<Data> = {
-			if urlRequest.httpMethod == HttpMethod.get.rawValue, requestCacheMode.returnCachedResponse, let url = urlRequest.url, let cached = urlRequestCacheProvider?.load(resourceUrl: url) {
+			if requestCacheMode.shouldCache(urlRequest), requestCacheMode.returnCachedResponse, let url = urlRequest.url, let cached = urlRequestCacheProvider?.load(resourceUrl: url) {
 				// return cached response
 				return Observable.just(cached)
 			}
@@ -199,7 +210,7 @@ public extension HttpClientType {
 					guard let errorResponse = errorResponse else {
 						let requestData = dataCacheProvider.getData()
 
-						if urlRequest.httpMethod == HttpMethod.get.rawValue, requestCacheMode.cacheResponse, let url = urlRequest.url  {
+						if requestCacheMode.shouldCache(urlRequest), requestCacheMode.cacheResponse, let url = urlRequest.url  {
 							// sache response
 							self?.urlRequestCacheProvider?.save(resourceUrl: url, data: requestData)
 						}

RxHttpClientTests/HttpClientCachingTests.swift

@@ -32,6 +32,23 @@ class HttpClientCachingTests: XCTestCase {
 		XCTAssertTrue(cachedData.elementsEqual(data), "Should cache data")
 		XCTAssertEqual(1, try! FileManager.default.contentsOfDirectory(atPath: cacheDirectory.path).count, "Should save data on disk")
 	}
+    
+    func testCacheCustomMethodResponse() {
+        let data = "Some responded data".data(using: .utf8)!
+        let requestUrl = URL(string: "https://test.com/json")!
+        let _ = stub(condition: { $0.url == requestUrl    && $0.httpMethod == HttpMethod.put.rawValue }) { _ in
+            return OHHTTPStubsResponse(data: data, statusCode: 200, headers: nil)
+        }
+        
+        let cacheMode = CacheMode(cacheResponse: true, returnCachedResponse: true, invokeRequest: true, cacheHttpMethods: [.put])
+        let exp = expectation(description: "Should complete request")
+        _ = client.requestData(url: requestUrl, method: .put, requestCacheMode: cacheMode).subscribe(onCompleted: { exp.fulfill() })
+        waitForExpectations(timeout: waitTimeout, handler: nil)
+        
+        let cachedData = try! Data(contentsOf: cacheDirectory.appendingPathComponent(requestUrl.sha1()))
+        XCTAssertTrue(cachedData.elementsEqual(data), "Should cache data")
+        XCTAssertEqual(1, try! FileManager.default.contentsOfDirectory(atPath: cacheDirectory.path).count, "Should save data on disk")
+    }
 
 	func testReturnCachedResponse() {
 		let data = "Some responded data".data(using: .utf8)!