license text changed

more documentation
konkab · Oct 24, 2016 · ad622fe · ad622fe
1 parent 52d3a07
commit ad622fe
Show file tree

Hide file tree

Showing 3 changed files with 204 additions and 149 deletions.
diff --git a/AlamofireNetworkActivityLogger.xcodeproj/project.pbxproj b/AlamofireNetworkActivityLogger.xcodeproj/project.pbxproj
@@ -765,6 +765,7 @@
 				AB2A9A641DBB5067004FC92E /* Release */,
 			);
 			defaultConfigurationIsVisible = 0;
+			defaultConfigurationName = Release;
 		};
 		AB2A9A6F1DBB5119004FC92E /* Build configuration list for PBXNativeTarget "AlamofireNetworkActivityLogger tvOS" */ = {
 			isa = XCConfigurationList;
@@ -773,6 +774,7 @@
 				AB2A9A711DBB5119004FC92E /* Release */,
 			);
 			defaultConfigurationIsVisible = 0;
+			defaultConfigurationName = Release;
 		};
 		AB2A9A7C1DBB512B004FC92E /* Build configuration list for PBXNativeTarget "AlamofireNetworkActivityLogger watchOS" */ = {
 			isa = XCConfigurationList;
@@ -781,6 +783,7 @@
 				AB2A9A7E1DBB512B004FC92E /* Release */,
 			);
 			defaultConfigurationIsVisible = 0;
+			defaultConfigurationName = Release;
 		};
 /* End XCConfigurationList section */
 	};

diff --git a/Source/AlamofireNetworkActivityLogger.h b/Source/AlamofireNetworkActivityLogger.h
@@ -2,9 +2,28 @@
 //  AlamofireNetworkActivityLogger.h
 //  AlamofireNetworkActivityLogger
 //
-//  Created by Konstantin Kabanov on 22/10/2016.
-//  Copyright © 2016 RKT Studio. All rights reserved.
+//  The MIT License (MIT)
 //
+//  Copyright (c) 2016 Konstantin Kabanov
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in all
+//  copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  SOFTWARE.
+
 
 #import <UIKit/UIKit.h>
 

diff --git a/Source/NetworkActivityLogger.swift b/Source/NetworkActivityLogger.swift
@@ -2,160 +2,193 @@
 //  NetworkActivityLogger.swift
 //  AlamofireNetworkActivityLogger
 //
-//  Created by Konstantin Kabanov on 22/10/2016.
-//  Copyright © 2016 RKT Studio. All rights reserved.
+//  The MIT License (MIT)
 //
+//  Copyright (c) 2016 Konstantin Kabanov
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in all
+//  copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  SOFTWARE.
 
 import Alamofire
 import Foundation
 
+/// The level of logging detail.
 public enum NetworkActivityLoggerLevel {
-	case off
-	case debug
-	case info
-	case warn
-	case error
-	case fatal
+    /// Do not log requests or responses.
+    case off
+
+    /// Logs HTTP method, URL, header fields, & request body for requests, and status code, URL, header fields, response string, & elapsed time for responses.
+    case debug
+
+    /// Logs HTTP method & URL for requests, and status code, URL, & elapsed time for responses.
+    case info
+
+    /// Logs HTTP method & URL for requests, and status code, URL, & elapsed time for responses, but only for failed requests.
+    case warn
+
+    /// Equivalent to `.warn`
+    case error
+
+    /// Equivalent to `.off`
+    case fatal
 }
 
+/// `NetworkActivityLogger` logs requests and responses made by Alamofire.SessionManager, with an adjustable level of detail.
 public class NetworkActivityLogger {
-	// MARK: - Properties
-
-	/// The shared network activity logger for the system.
-	public static let shared = NetworkActivityLogger()
-
-	/// The level of logging detail. See NetworkActivityLoggerLevel enum for possible values. .info by default.
-	public var level: NetworkActivityLoggerLevel
-
-	/// Omit requests which match the specified predicate, if provided.
-	public var filterPredicate: NSPredicate?
-
-	private var startDates: [URLSessionTask: Date]
-
-	// MARK: - Internal - Initialization
-
-	init() {
-		level = .info
-		startDates = [URLSessionTask: Date]()
-	}
-
-	deinit {
-		stopLogging()
-	}
-
-	// MARK: - Logging
-
-	public func startLogging() {
-		stopLogging()
-
-		let notificationCenter = NotificationCenter.default
-
-		notificationCenter.addObserver(
-			self,
-			selector: #selector(NetworkActivityLogger.networkRequestDidStart(notification:)),
-			name: Notification.Name.Task.DidResume,
-			object: nil
-		)
-
-		notificationCenter.addObserver(
-			self,
-			selector: #selector(NetworkActivityLogger.networkRequestDidComplete(notification:)),
-			name: Notification.Name.Task.DidComplete,
-			object: nil
-		)
-	}
-
-	public func stopLogging() {
-		NotificationCenter.default.removeObserver(self)
-	}
-
-	// MARK: - Private - Notifications
-
-	@objc private func networkRequestDidStart(notification: Notification) {
-		guard let userInfo = notification.userInfo,
-			let task = userInfo[Notification.Key.Task] as? URLSessionTask,
-			let request = task.originalRequest,
-			let httpMethod = request.httpMethod,
-			let requestURL = request.url
-			else {
-				return
-		}
-
-		if let filterPredicate = filterPredicate, filterPredicate.evaluate(with: request) {
-			return
-		}
-
-		startDates[task] = Date()
-
-		switch level {
-		case .debug:
-			print("\(httpMethod) '\(requestURL.absoluteString)':")
-
-			if let httpHeadersFields = request.allHTTPHeaderFields {
-				for (key, value) in httpHeadersFields {
-					print("\(key): \(value)")
-				}
-			}
-
-			if let httpBody = request.httpBody, let httpBodyString = String(data: httpBody, encoding: .utf8) {
-				print(httpBodyString)
-			}
-		case .info:
-			print("\(httpMethod) '\(requestURL.absoluteString)'")
-		default:
-			break
-		}
-	}
-
-	@objc private func networkRequestDidComplete(notification: Notification) {
-		guard let userInfo = notification.userInfo,
-			let task = userInfo[Notification.Key.Task] as? URLSessionTask,
-			let request = task.originalRequest,
-			let httpMethod = request.httpMethod,
-			let requestURL = request.url
-			else {
-				return
-		}
-
-		if let filterPredicate = filterPredicate, filterPredicate.evaluate(with: request) {
-			return
-		}
-
-		var elapsedTime: TimeInterval = 0.0
-
-		if let startDate = startDates[task] {
-			elapsedTime = Date().timeIntervalSince(startDate)
-			startDates[task] = nil
-		}
-
-		if let error = task.error {
-			switch level {
-			case .debug,
-			     .info,
-			     .warn,
-			     .error:
-				print("[Error] \(httpMethod) '\(requestURL.absoluteString)' [\(String(format: "%.04f", elapsedTime)) s]:")
-				print(error)
-			default:
-				break
-			}
-		} else {
-			guard let response = task.response as? HTTPURLResponse else {
-				return
-			}
-
-			switch level {
-			case .debug:
-				print("\(String(response.statusCode)) '\(requestURL.absoluteString)' [\(String(format: "%.04f", elapsedTime)) s]:")
-
-				for (key, value) in response.allHeaderFields {
-					print("\(key): \(value)")
-				}
-			case .info:
-				print("\(String(response.statusCode)) '\(requestURL.absoluteString)' [\(String(format: "%.04f", elapsedTime)) s]")
-			default:
-				break
-			}
-		}
-	}
+    // MARK: - Properties
+
+    /// The shared network activity logger for the system.
+    public static let shared = NetworkActivityLogger()
+
+    /// The level of logging detail. See NetworkActivityLoggerLevel enum for possible values. .info by default.
+    public var level: NetworkActivityLoggerLevel
+
+    /// Omit requests which match the specified predicate, if provided.
+    public var filterPredicate: NSPredicate?
+
+    private var startDates: [URLSessionTask: Date]
+
+    // MARK: - Internal - Initialization
+
+    init() {
+        level = .info
+        startDates = [URLSessionTask: Date]()
+    }
+
+    deinit {
+        stopLogging()
+    }
+
+    // MARK: - Logging
+
+    /// Start logging requests and responses.
+    public func startLogging() {
+        stopLogging()
+
+        let notificationCenter = NotificationCenter.default
+
+        notificationCenter.addObserver(
+            self,
+            selector: #selector(NetworkActivityLogger.networkRequestDidStart(notification:)),
+            name: Notification.Name.Task.DidResume,
+            object: nil
+        )
+
+        notificationCenter.addObserver(
+            self,
+            selector: #selector(NetworkActivityLogger.networkRequestDidComplete(notification:)),
+            name: Notification.Name.Task.DidComplete,
+            object: nil
+        )
+    }
+
+    /// Stop logging requests and responses.
+    public func stopLogging() {
+        NotificationCenter.default.removeObserver(self)
+    }
+
+    // MARK: - Private - Notifications
+
+    @objc private func networkRequestDidStart(notification: Notification) {
+        guard let userInfo = notification.userInfo,
+            let task = userInfo[Notification.Key.Task] as? URLSessionTask,
+            let request = task.originalRequest,
+            let httpMethod = request.httpMethod,
+            let requestURL = request.url
+            else {
+                return
+        }
+
+        if let filterPredicate = filterPredicate, filterPredicate.evaluate(with: request) {
+            return
+        }
+
+        startDates[task] = Date()
+
+        switch level {
+        case .debug:
+            print("\(httpMethod) '\(requestURL.absoluteString)':")
+
+            if let httpHeadersFields = request.allHTTPHeaderFields {
+                for (key, value) in httpHeadersFields {
+                    print("\(key): \(value)")
+                }
+            }
+
+            if let httpBody = request.httpBody, let httpBodyString = String(data: httpBody, encoding: .utf8) {
+                print(httpBodyString)
+            }
+        case .info:
+            print("\(httpMethod) '\(requestURL.absoluteString)'")
+        default:
+            break
+        }
+    }
+
+    @objc private func networkRequestDidComplete(notification: Notification) {
+        guard let userInfo = notification.userInfo,
+            let task = userInfo[Notification.Key.Task] as? URLSessionTask,
+            let request = task.originalRequest,
+            let httpMethod = request.httpMethod,
+            let requestURL = request.url
+            else {
+                return
+        }
+
+        if let filterPredicate = filterPredicate, filterPredicate.evaluate(with: request) {
+            return
+        }
+
+        var elapsedTime: TimeInterval = 0.0
+
+        if let startDate = startDates[task] {
+            elapsedTime = Date().timeIntervalSince(startDate)
+            startDates[task] = nil
+        }
+
+        if let error = task.error {
+            switch level {
+            case .debug,
+                 .info,
+                 .warn,
+                 .error:
+                print("[Error] \(httpMethod) '\(requestURL.absoluteString)' [\(String(format: "%.04f", elapsedTime)) s]:")
+                print(error)
+            default:
+                break
+            }
+        } else {
+            guard let response = task.response as? HTTPURLResponse else {
+                return
+            }
+
+            switch level {
+            case .debug:
+                print("\(String(response.statusCode)) '\(requestURL.absoluteString)' [\(String(format: "%.04f", elapsedTime)) s]:")
+
+                for (key, value) in response.allHeaderFields {
+                    print("\(key): \(value)")
+                }
+            case .info:
+                print("\(String(response.statusCode)) '\(requestURL.absoluteString)' [\(String(format: "%.04f", elapsedTime)) s]")
+            default:
+                break
+            }
+        }
+    }
 }