added documentation

Author: Adam Debono

NetworkMapper.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name         = "NetworkMapper"
-  s.version      = "0.0.3"
+  s.version      = "0.0.4"
   s.summary      = "A framework to map JSON responses to swift objects"
   s.homepage     = "https://github.com/adamdebono/NetworkMapper"
   s.license      = { :type => "MIT", :file => "LICENSE" }

Source/Error.swift

@@ -1,4 +1,8 @@
 
+/// The error type returned by NetworkMapper
+///
+/// - invalidResponse:  The response JSON was not in a format that could be
+///                     decoded
 public enum ResponseError: Error {
     case invalidResponse
 }

Source/NetworkObjectRequest.swift

@@ -3,22 +3,45 @@ import Alamofire
 import Foundation
 import Unbox
 
+/// A protocol to define network requests that map directly to response objects
 public protocol NetworkObjectRequest: NetworkRequest {
+    /// The type of the response object
     associatedtype ResponseType: NetworkObjectResponse
 
+    /// A callback function to which is called immediately after the response is
+    /// decoded, but before the callback
+    ///
+    /// The default implementation of this funciton does nothing
     func responseDecoded(_ response: ResponseType)
 }
+/// A protocol to define network response objects
 public protocol NetworkObjectResponse: Unboxable {
 
 }
 
 public extension NetworkObjectRequest {
+    /// Performs a network request based on the attributes of this instance, and
+    /// retrieves the response object
+    ///
+    /// - parameter completionHandler:  A callback which is run on the
+    ///                                 completion of the request
+    ///
+    /// - returns: The request that was sent
     @discardableResult
     public func responseObject(completionHandler: @escaping ((DataResponse<ResponseType>) -> Void)) -> DataRequest {
         return self.responseJSON { response in
             self.processObjectResponse(response: response, completionHandler: completionHandler)
         }
     }
+    /// Processes an object response from the server
+    ///
+    /// This can be overridden to provide custom processing. The default
+    /// implementation will attempt to unbox the object response from the root
+    /// json object of the response.
+    ///
+    /// - parameter response:           The response to process
+    /// - parameter completionHandler:  A callback which is run once processing
+    ///                                 is complete
     public func processObjectResponse(response: DataResponse<Any>, completionHandler: @escaping ((DataResponse<ResponseType>) -> Void)) {
         switch response.result {
         case .failure(let error):

Source/NetworkRequest.swift

@@ -2,9 +2,17 @@
 import Alamofire
 import Foundation
 
+/// Contains basic information which is used to create a `URLRequest`
 public struct RequestDetails: URLRequestConvertible {
+  
+    /// The HTTP method of the request
     public let method: HTTPMethod
+    /// The url of the request
     public let url: URL
+    /// Any parameters (or nil) for the request
+    ///
+    /// Parameters are encoded and added to the request based on the method of
+    /// the request
     public let parameters: [String: Any]?
 
     public init(method: HTTPMethod, url: URL, parameters: [String: Any]? = nil) {
@@ -21,12 +29,21 @@ public struct RequestDetails: URLRequestConvertible {
     }
 }
 
+/// A basic protocol to define network requests
 public protocol NetworkRequest: URLRequestConvertible {
+    /// The HTTP method of the request
     var method: HTTPMethod { get }
+    /// The url of the request
     var url: URL { get }
+    /// Any parameters (or nil) for the request
+    ///
+    /// Parameters are encoded and added to the request based on the method of
+    /// the request
     var parameters: [String: Any]? { get }
 }
 public extension NetworkRequest {
+    /// Creates a `RequestDetails` object based on the attributes of the
+    /// instance
     public func getRequestDetails() -> RequestDetails {
         return RequestDetails(
             method: self.method,
@@ -39,11 +56,28 @@ public extension NetworkRequest {
         return try self.getRequestDetails().asURLRequest()
     }
 
+    /// Performs the completionHandler when an error occurs during the response
+    /// handler
+    ///
+    /// This is a convenience function to map the response type to the expected
+    /// completion type
+    ///
+    /// - parameter error:              The error that occurred
+    /// - parameter response:           The response from the Alamofire
+    /// - parameter completionHandler:  The completion handler to run
     public func complete<R, T>(error: Error, response: DataResponse<R>?, completionHandler: (DataResponse<T>) -> Void) {
         let result = Result<T>.failure(error)
         let errorResponse = DataResponse(request: response?.request, response: response?.response, data: response?.data, result: result)
         completionHandler(errorResponse)
     }
+    /// Performs the completionHandler after a response is successfuly handled
+    ///
+    /// This is a convenience function to map the response type to the expected
+    /// completion type
+    ///
+    /// - parameter object:             The decoded response object
+    /// - parameter response:           The response from Alamofire
+    /// - parameter completionHandler:  The completion handler to run
     public func complete<R, T>(object: T, response: DataResponse<R>, completionHandler: (DataResponse<T>) -> Void) {
         let result = Result<T>.success(object)
         let successResponse = DataResponse(request: response.request, response: response.response, data: response.data, result: result)
@@ -52,6 +86,13 @@ public extension NetworkRequest {
 
     // MARK: Data
 
+    /// Performs a network request based on the attributes of this instance, and
+    /// retrieves the response data
+    ///
+    /// - parameter completionHandler:  A callback which is run on completion of
+    ///                                 the request
+    ///
+    /// - returns: The request that was sent
     @discardableResult
     public func responseData(completionHandler: @escaping ((DataResponse<Data>) -> Void)) -> DataRequest {
         return Alamofire.request(self).responseData(completionHandler: { response in
@@ -72,13 +113,28 @@ public extension NetworkRequest {
 
     // MARK: JSON
 
+    /// Performs a network request based on the attributes of this instance, and
+    /// retrieves the response json
+    ///
+    /// - parameter completionHandler:  A callback which is run on completion of
+    ///                                 the request
+    ///
+    /// - returns: The request that was sent
     @discardableResult
     public func responseJSON(completionHandler: @escaping ((DataResponse<Any>) -> Void)) -> DataRequest {
         return Alamofire.request(self).responseJSON { response in
             self.processJSONResponse(response: response, completionHandler: completionHandler)
         }
     }
 
+    /// Processes a JSON response from the server
+    ///
+    /// This can be overridden to provide custom processing. The default
+    /// implementation only checks for request cancellation.
+    ///
+    /// - parameter response:           The response to process
+    /// - parameter completionHandler:  A callback which is run once processing
+    ///                                 is complete
     public func processJSONResponse(response: DataResponse<Any>, completionHandler: @escaping ((DataResponse<Any>) -> Void)) {
         switch response.result {
         case .failure(let error):