Backfill unit tests/documentation sparodev#13 (sparodev#14)

* WIP add unit tests around TestSessionManager

* Add additional documentation

* Refactor Client class to instance method based sparodev#13

- Update unit tests for Client refactor
- Added additional unit tests to TestSessionTest, TestSessionManagerTest, ClientTest

* Begin tracking documentation sparodev#13

* Add more documentation sparodev#13

* Expand documentation sparodev#13

* Add jazzy configuration file sparodev#13

* Add more documentation sparodev#13

* Regenerate documentation sparodev#13

* Refactor Test, TestSession and UploadTarget structs to classes. sparodev#13

- Add additional unit tests.
- Remove unused Timer methods.

Author: mwahlig

.jazzy.yaml

@@ -0,0 +1,6 @@
+author: Sparo
+author_url: https://sparohealth.com
+github_url: https://github.com/sparodev/WingKit
+module: WingKit
+output: docs
+theme: fullwidth

README.md

@@ -0,0 +1,52 @@
+![WingKit: a Lung Function Test SDK](../wingkit-logo.png)
+
+WingKit is a library that allows third parties to integrate with the Wing REST API to perform lung function tests.
+
+## Requirements
+
+- iOS 9.0+
+- Xcode 9.0+
+- Swift 4.0+
+
+## Installation
+
+### CocoaPods
+
+[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. To install it, run this command in your terminal:
+```bash
+$ gem install cocoapods
+```
+
+> WingKit requires CocoaPods 1.1+ to build.
+
+To integrate WingKit into your project, specifiy it in your `Podfile`:
+
+#### Production
+
+```ruby
+source 'https://github.com/sparodev/Wing-CocoaPodSpecs'
+platform :ios, '11.0'
+use_frameworks!
+
+target '<Your Target Name>' do
+    pod 'WingKit', '~> 1.0'
+end
+```
+
+#### Development
+
+ 1. Clone the WingKit repository to your mac.
+ 2. Reference the local filepath where you cloned the repo in your Podfile:
+
+```ruby
+platform :ios, '11.0'
+use_frameworks!
+
+target '<Your Target Name>' do
+    pod 'WingKit', :path => '<path/to/repo>'
+end
+```
+
+## Examples
+
+Check out the [WingKitExample repo](https://github.com/sparodev/WingKitExample) for an example of how to integrate with WingKit to perform a lung function test and view the results.

WingKit.podspec

@@ -17,7 +17,7 @@ Pod::Spec.new do |s|
 
   s.name         = "WingKit"
   s.version      = "0.0.1"
-  s.summary      = "A short description of WingKit."
+  s.summary      = "WingKit is a library written in Swift that allows third parties to interface with the Wing REST API in order to perform lung function tests."
 
   # This description is used to generate tags and improve search results.
   #   * Think: What does it do? Why did you write it? What is the focus?

WingKit.xcodeproj/project.pbxproj

@@ -23,6 +23,7 @@
 		6C4708CE1F875B28009CE4E7 /* wavdata.h in Headers */ = {isa = PBXBuildFile; fileRef = 6CF1C17F1F8584DF00C4F952 /* wavdata.h */; };
 		6C4708CF1F875B2D009CE4E7 /* waveTrimming.h in Headers */ = {isa = PBXBuildFile; fileRef = 6CF1C1821F8584DF00C4F952 /* waveTrimming.h */; };
 		6C4708D01F875B2F009CE4E7 /* trimmingTerminalPoints.h in Headers */ = {isa = PBXBuildFile; fileRef = 6CF1C1831F8584DF00C4F952 /* trimmingTerminalPoints.h */; };
+		6C48EE131FABB2F60016BF4F /* TestSessionManagerTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C48EE121FABB2F60016BF4F /* TestSessionManagerTest.swift */; };
 		6C64DD4A1F7C1ECB005ED5AA /* Client+UploadTarget.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C64DD491F7C1ECB005ED5AA /* Client+UploadTarget.swift */; };
 		6C64DD4C1F7C1EE1005ED5AA /* Client+UploadTargetTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C64DD4B1F7C1EE1005ED5AA /* Client+UploadTargetTest.swift */; };
 		6C71FD4B1F7AD14C00465F32 /* UploadTargetTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6C71FD4A1F7AD14C00465F32 /* UploadTargetTest.swift */; };
@@ -33,6 +34,7 @@
 		6CA9A0191F7442ED0085E247 /* Client+TestSession.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6CA9A0181F7442ED0085E247 /* Client+TestSession.swift */; };
 		6CA9A01C1F7443950085E247 /* Network.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6CA9A01B1F7443950085E247 /* Network.swift */; };
 		6CA9A01E1F7446D20085E247 /* Endpoint.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6CA9A01D1F7446D20085E247 /* Endpoint.swift */; };
+		6CAD06B21FBA8628009D1262 /* TestSessionRecorderTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6CAD06B11FBA8628009D1262 /* TestSessionRecorderTest.swift */; };
 		6CAF8DEA1F7971B600BD1BCB /* ClientTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6CAF8DE91F7971B600BD1BCB /* ClientTest.swift */; };
 		6CBBB57F1F799A4E00295FFD /* Client+TestSessionTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6CBBB57E1F799A4E00295FFD /* Client+TestSessionTest.swift */; };
 		6CBBB5811F79A62600295FFD /* NetworkMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6CBBB5801F79A62600295FFD /* NetworkMock.swift */; };
@@ -61,6 +63,7 @@
 		1B34F01B6ECC5BC596F66232 /* Pods-WingKit.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-WingKit.release.xcconfig"; path = "Pods/Target Support Files/Pods-WingKit/Pods-WingKit.release.xcconfig"; sourceTree = "<group>"; };
 		292A38E8462E99CA17292CEC /* Pods-WingKitTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-WingKitTests.release.xcconfig"; path = "Pods/Target Support Files/Pods-WingKitTests/Pods-WingKitTests.release.xcconfig"; sourceTree = "<group>"; };
 		4961034675C9A40D3CB33C13 /* Pods-WingKit.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-WingKit.debug.xcconfig"; path = "Pods/Target Support Files/Pods-WingKit/Pods-WingKit.debug.xcconfig"; sourceTree = "<group>"; };
+		6C48EE121FABB2F60016BF4F /* TestSessionManagerTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestSessionManagerTest.swift; sourceTree = "<group>"; };
 		6C64DD491F7C1ECB005ED5AA /* Client+UploadTarget.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Client+UploadTarget.swift"; sourceTree = "<group>"; };
 		6C64DD4B1F7C1EE1005ED5AA /* Client+UploadTargetTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Client+UploadTargetTest.swift"; sourceTree = "<group>"; };
 		6C71FD4A1F7AD14C00465F32 /* UploadTargetTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UploadTargetTest.swift; sourceTree = "<group>"; };
@@ -75,6 +78,7 @@
 		6CA9A0181F7442ED0085E247 /* Client+TestSession.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Client+TestSession.swift"; sourceTree = "<group>"; };
 		6CA9A01B1F7443950085E247 /* Network.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Network.swift; sourceTree = "<group>"; };
 		6CA9A01D1F7446D20085E247 /* Endpoint.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Endpoint.swift; sourceTree = "<group>"; };
+		6CAD06B11FBA8628009D1262 /* TestSessionRecorderTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TestSessionRecorderTest.swift; sourceTree = "<group>"; };
 		6CAF8DE91F7971B600BD1BCB /* ClientTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ClientTest.swift; sourceTree = "<group>"; };
 		6CBBB57E1F799A4E00295FFD /* Client+TestSessionTest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Client+TestSessionTest.swift"; sourceTree = "<group>"; };
 		6CBBB5801F79A62600295FFD /* NetworkMock.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = NetworkMock.swift; sourceTree = "<group>"; };
@@ -177,6 +181,8 @@
 				6CBBB5821F79A74300295FFD /* WingKitTestCase.swift */,
 				6C71FD4A1F7AD14C00465F32 /* UploadTargetTest.swift */,
 				6C64DD4B1F7C1EE1005ED5AA /* Client+UploadTargetTest.swift */,
+				6C48EE121FABB2F60016BF4F /* TestSessionManagerTest.swift */,
+				6CAD06B11FBA8628009D1262 /* TestSessionRecorderTest.swift */,
 			);
 			path = WingKitTests;
 			sourceTree = "<group>";
@@ -544,9 +550,11 @@
 				6CE17A781F75965B00789D00 /* TestSessionTest.swift in Sources */,
 				6CBBB5811F79A62600295FFD /* NetworkMock.swift in Sources */,
 				6CBBB5831F79A74300295FFD /* WingKitTestCase.swift in Sources */,
+				6C48EE131FABB2F60016BF4F /* TestSessionManagerTest.swift in Sources */,
 				6CE17A7A1F75966D00789D00 /* TestTest.swift in Sources */,
 				6CAF8DEA1F7971B600BD1BCB /* ClientTest.swift in Sources */,
 				6C64DD4C1F7C1EE1005ED5AA /* Client+UploadTargetTest.swift in Sources */,
+				6CAD06B21FBA8628009D1262 /* TestSessionRecorderTest.swift in Sources */,
 				6C71FD4B1F7AD14C00465F32 /* UploadTargetTest.swift in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

WingKit/Classes/Client/Client.swift

@@ -8,28 +8,43 @@
 
 import Foundation
 
+/// Represents the OAuth credentials used to authenticate an application with the Wing API.
 public struct OAuthCredentials {
+
+    /// The client id.
     public var id: String
+
+    /// The client secret.
     public var secret: String
 
+    /**
+     Initializes a `OAuthCredentials` structure.
+
+     - parameter id: The client id of your application.
+     - parameter secret: The client secret of your application.
+     */
     public init(id: String, secret: String) {
         self.id = id
         self.secret = secret
     }
 }
 
-struct OAuthParameterKeys {
+internal struct OAuthParameterKeys {
     static let id = "id"
     static let secret = "secret"
 }
 
+/// The `ClientError` enum describes domain specific errors for the `Client` class.
 public enum ClientError: Error {
+
+    /// Indicates the url of the request is invalid.
     case invalidURL
+
+    /// Indicates the request failed due to authentcataion failing.
     case unauthorized
-    case invalidPatientData
 }
 
-fileprivate enum AuthenticationEndpoint: Endpoint {
+internal enum AuthenticationEndpoint: Endpoint {
     case authenticate
 
     var path: String {
@@ -52,27 +67,33 @@ fileprivate enum AuthenticationEndpoint: Endpoint {
 }
 
 /**
- The 'Client' class acts as the interface for the Wing REST API. All Wing API Requests are routed through this class
+ The `Client` class acts as the interface for the Wing REST API. All Wing API Requests are routed through this class
  to apply the necessary authentication to the requests.
  */
 
 public class Client {
 
     // MARK: - Properties
 
-    public static let baseURLPath = "https://api-development.mywing.io/api/v2"
+    internal let baseURLPath = "https://api-development.mywing.io/api/v2"
 
-    /// The OAuth credentials required to authenticate with the Wing API.
-    public static var oauth: OAuthCredentials? = nil
+    /**
+     The OAuth credentials assigned to your application to access the Wing API. Used to authenticate with the Wing API
+     in order to receive a token to use for subsequent authorized requests.
+     */
+    public var oauth: OAuthCredentials? = nil
 
     /// The authorization token used to make authorized requests.
-    public static var token: String? {
-        return "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IktyNDJ5b2pHdzM4V3oiLCJ0eXBlIjoiYXV0aCIsImtleUdlbiI6IjEyRUJBYmxnTHJOSlAiLCJpYXQiOjE1MDk0NzU1ODcsImV4cCI6MTU0MTAxMTU4N30.PG6wEYDBwuZeWaUhIQGRPtH1UwiFqBXHs-zOqkuP3CI"
-    }
+    public var token: String?
+
+    // MARK: - Initialization
+
+    /// Initializes an instance of the `Client` class.
+    public init() {}
 
-    internal static func request(for endpoint: Endpoint,
-                                parameters: [String: Any]? = nil,
-                                headers: [String: String]? = nil) throws -> NetworkRequest {
+    internal func request(for endpoint: Endpoint,
+                          parameters: [String: Any]? = nil,
+                          headers: [String: String]? = nil) throws -> NetworkRequest {
 
         guard let url = URL(string: baseURLPath + endpoint.path) else {
             throw ClientError.invalidURL
@@ -112,7 +133,7 @@ public class Client {
          - `NetworkError.invalidResponse` if the token could not be parsed from the response.
          - `NetworkError.unacceptableStatusCode` if an failure status code is received in the response.
      */
-    public static func authenticate(completion: @escaping (_ token: String?, _ error: Error?) -> Void) {
+    public func authenticate(completion: @escaping (_ token: String?, _ error: Error?) -> Void) {
 
         guard let oauth = oauth else {
             completion(nil, ClientError.unauthorized)
@@ -141,7 +162,7 @@ public class Client {
 
             guard let json = json,
                 let token = json["token"] as? String else {
-                completion(nil, NetworkError.invalidResponse)
+                completion(nil, ClientError.unauthorized)
                 return
             }
 

WingKit/Classes/Extensions/Timer.swift

@@ -19,25 +19,6 @@ extension Timer {
         return timer
     }
 
-    /// Create and schedule a timer that will call `block` repeatedly in specified time intervals.
-
-    @discardableResult
-    internal class func every(_ interval: TimeInterval, _ block: @escaping () -> Void) -> Timer {
-        let timer = Timer.new(every: interval, block)
-        timer.start()
-        return timer
-    }
-
-    /// Create and schedule a timer that will call `block` repeatedly in specified time intervals.
-    /// (This variant also passes the timer instance to the block)
-
-    @nonobjc @discardableResult
-    internal class func every(_ interval: TimeInterval, _ block: @escaping (Timer) -> Void) -> Timer {
-        let timer = Timer.new(every: interval, block)
-        timer.start()
-        return timer
-    }
-
     // MARK: Create timers without scheduling
 
     /// Create a timer that will call `block` once after the specified time.
@@ -51,32 +32,6 @@ extension Timer {
         }
     }
 
-    /// Create a timer that will call `block` repeatedly in specified time intervals.
-    ///
-    /// - Note: The timer won't fire until it's scheduled on the run loop.
-    ///         Use `NSTimer.every` to create and schedule a timer in one step.
-    /// - Note: The `new` class function is a workaround for a crashing bug when using convenience initializers (rdar://18720947)
-    internal class func new(every interval: TimeInterval, _ block: @escaping () -> Void) -> Timer {
-        return CFRunLoopTimerCreateWithHandler(kCFAllocatorDefault, CFAbsoluteTimeGetCurrent() + interval, interval, 0, 0) { _ in
-            block()
-        }
-    }
-
-    /// Create a timer that will call `block` repeatedly in specified time intervals.
-    /// (This variant also passes the timer instance to the block)
-    ///
-    /// - Note: The timer won't fire until it's scheduled on the run loop.
-    ///         Use `NSTimer.every` to create and schedule a timer in one step.
-    /// - Note: The `new` class function is a workaround for a crashing bug when using convenience initializers (rdar://18720947)
-
-    @nonobjc internal class func new(every interval: TimeInterval, _ block: @escaping (Timer) -> Void) -> Timer {
-        var timer: Timer!
-        timer = CFRunLoopTimerCreateWithHandler(kCFAllocatorDefault, CFAbsoluteTimeGetCurrent() + interval, interval, 0, 0) { _ in
-            block(timer)
-        }
-        return timer
-    }
-
     /// Schedule this timer on the run loop
     ///
     /// By default, the timer is scheduled on the current run loop for the default mode.