Add some comments

Author: reloni

Readme.md

@@ -15,7 +15,7 @@ RxHttpClient is a "reactive wrapper" around NSURLSession. Under the hood it impl
 Now only [Carthage](https://github.com/Carthage/Carthage) supported:
 ```
 github "ReactiveX/RxSwift" ~> 3.1
-github "Reloni/RxHttpClient"
+github "RxSwiftCommunity/RxHttpClient"
 ```
 RxHttpClient uses RxSwift so it should be included into cartfile.
 

RxHttpClient/HttpClient.swift

@@ -3,17 +3,15 @@ import RxSwift
 
 public final class HttpClient {
 	/// Scheduler for observing data task events
-	internal let dataTaskScheduler =
-		SerialDispatchQueueScheduler(qos: .utility, internalSerialQueueName: "com.RxHttpClient.HttpClient.DataTask")
+	internal let dataTaskScheduler = SerialDispatchQueueScheduler(qos: .utility, internalSerialQueueName: "com.RxHttpClient.HttpClient.DataTask")
 	/// Default concurrent scheduler for observing observable sequence created by loadStreamData method
-	internal let streamDataObservingScheduler =
-		SerialDispatchQueueScheduler(qos: .utility, internalSerialQueueName: "com.RxHttpClient.HttpClient.Stream")
+	internal let streamDataObservingScheduler = SerialDispatchQueueScheduler(qos: .utility, internalSerialQueueName: "com.RxHttpClient.HttpClient.Stream")
 	internal let sessionObserver = NSURLSessionDataEventsObserver()
 	internal let urlSession: URLSessionType
 
 	public let urlRequestCacheProvider: UrlRequestCacheProviderType?
-    
-    public let requestPlugin: RequestPluginType?
+	
+	public let requestPlugin: RequestPluginType?
 
 	/**
 	Creates an instance of HttpClient
@@ -53,7 +51,7 @@ extension HttpClient : HttpClientType {
 			// clears cache provider before start
 			dataCacheProvider?.clearData()
 
-            let useRequest = object.requestPlugin?.prepare(request: request) ?? request
+			let useRequest = object.requestPlugin?.prepare(request: request) ?? request
 
 			let task = object.createStreamDataTask(request: useRequest, dataCacheProvider: dataCacheProvider)
 
@@ -65,7 +63,7 @@ extension HttpClient : HttpClientType {
 				task.cancel()
 				disposable.dispose()
 			}
-			}.observeOn(streamDataObservingScheduler)
+			}.subscribeOn(dataTaskScheduler).observeOn(streamDataObservingScheduler)
 	}
 
 	public func createStreamDataTask(taskUid: String, request: URLRequest, dataCacheProvider: DataCacheProviderType?) -> StreamDataTaskType {

RxHttpClient/RequestPlugin/ActivityIndicatorPlugin.swift

@@ -15,16 +15,15 @@ protocol UIApplicationType : class {
 
 extension UIApplication : UIApplicationType { }
 
+/// Plugin that shows Network activity indicator if there is active network request
 public final class NetworkActivityIndicatorPlugin : RequestPluginType {
 	let application: UIApplicationType
 
 	var counter = 0 {
-		didSet {
-			application.isNetworkActivityIndicatorVisible = counter != 0
-		}
+		didSet { application.isNetworkActivityIndicatorVisible = counter != 0 }
 	}
 
-	convenience public init(application: UIApplication) {
+	convenience public init(application: UIApplication = UIApplication.shared) {
 		self.init(applicationType: application)
 	}
 

RxHttpClient/RequestPlugin/RequestPluginType.swift

@@ -8,13 +8,22 @@
 
 import Foundation
 
+/// Plugin that receives callbacks from HttpClient and StreamDataTask
+/// HttpClient calls only prepare method, all onter methods are called by StreamDataTask
 public protocol RequestPluginType {
+	/// HttpClient calls this method before creting actual URLSessionDataTask (and StreamDataTask)
 	func prepare(request: URLRequest) -> URLRequest
+	/// Called right before StreamDataTask starts underluing URLSessionDataTask
 	func beforeSend(request: URLRequest)
+	/// Called after StreamDataTask received didCompleteWithError event from URLSession 
+	///(and this method does not contain error)
 	func afterSuccess(response: URLResponse?, data: Data?)
+	/// Called after StreamDataTask received didCompleteWithError with error or if HTTPURLResponse status code is not within 200...299 range.
+	/// Also this method is callded if StreamDataTask receives didBecomeInvalidWithError event from URLSession
 	func afterFailure(response: URLResponse?, error: Error, data: Data?)
 }
 
+/// Plugin that holds collection of plugins and send all events to them
 public final class CompositeRequestPlugin : RequestPluginType {
 	let plugins: [RequestPluginType]
 

RxHttpClient/StreamDataTask.swift

@@ -102,7 +102,7 @@ internal final class StreamDataTask {
 						observer.onNext(StreamTaskEvents.error(error))
 					} else {
 						if let response = object.response as? HTTPURLResponse, !(200...299 ~= response.statusCode) {
-							// send failure message to plugin because HTTP response cone is not within 200...299 range
+							// send failure message to plugin because HTTP response code is not within 200...299 range
 							object.requestPlugin?.afterFailure(response: object.response,
 							                                   error: error ?? HttpClientError.sessionExplicitlyInvalidated,
 							                                   data: object.dataCacheProvider?.getData())