Merging dev into master (#1)

* Update internal documentation, update readme documentation, move to Result return type of networking methods, improve helpfulness of debugMode property. * Add additional documentation, remove need of authentication class, improve sizing of clickwrap acceptance language * Improve table of contents, add additional delegate methods to psacceptanceviewcontroller and psacceptanceview * Fix table of contents...
pactsafe · Feb 18, 2020 · 0c8a88d · 0c8a88d
1 parent 25d068d
commit 0c8a88d
Show file tree

Hide file tree

Showing 19 changed files with 735 additions and 496 deletions.
diff --git a/Documentation/images/clickwrap-loaded-example.png b/Documentation/images/clickwrap-loaded-example.png
diff --git a/Documentation/images/login-with-alert.png b/Documentation/images/login-with-alert.png
diff --git a/Documentation/images/psacceptanceviewcontroller-example.png b/Documentation/images/psacceptanceviewcontroller-example.png
diff --git a/README.md b/README.md
diff --git a/Sources/PactSafe/PSAcceptanceViewController.swift b/Sources/PactSafe/PSAcceptanceViewController.swift
@@ -8,8 +8,12 @@
 import Foundation
 import UIKit
 
+/// Methods for managing events around the `PSAcceptanceViewController`.
 @objc public protocol PSAcceptanceViewControllerDelegate: AnyObject {
     @objc optional func receivedAcceptance()
+    @objc optional func errorSendingAcceptance(error: Error?)
+    @objc optional func checkboxIsChecked(_ checked: Bool)
+    @objc optional func errorLoadingGroup(error: Error?)
 }
 
 @available(iOS 11.0, *)
@@ -47,7 +51,6 @@ public class PSAcceptanceViewController: UIViewController {
     /// The object that acts as the delegate of the view controller.
     public weak var delegate: PSAcceptanceViewControllerDelegate?
 
-
     // MARK: - Views
 
     // MARK: Top View of Main View
@@ -106,6 +109,7 @@ public class PSAcceptanceViewController: UIViewController {
         configureAndAddClickwrap()
         configureAndAddSubmitButton()
         setupConstraints()
+        checkboxAgreementView.sizeToFit()
     }
 
     private func configureAndAddMainViews() {
@@ -132,6 +136,7 @@ public class PSAcceptanceViewController: UIViewController {
         psClickWrap.checkbox.valueChanged = { (valueChanged) in
             self.configureSubmitButtonState(valueChanged)
             self.checkboxSelected = valueChanged
+            self.delegate?.checkboxIsChecked?(valueChanged)
         }
         psClickWrap.loadContracts(withGroupKey: groupKey)
     }
@@ -148,15 +153,15 @@ public class PSAcceptanceViewController: UIViewController {
         configureSubmitButtonState()
     }
 
-    private func addChangeSummaryText(groupData: PSGroupData) {
+    private func addChangeSummaryText(groupData: PSGroup) {
         let changeSummaryFormatted = changeSummary(groupData: groupData)
         self.changeSummary = changeSummaryFormatted
         self.changeSummaryTextView.text = changeSummaryFormatted
     }
 
     /// Creates a user-friendly view of the contracts that have changed and includes the
     /// the change summary if availlable.
-    private func changeSummary(groupData: PSGroupData?) -> String {
+    private func changeSummary(groupData: PSGroup?) -> String {
         guard let groupData = groupData else { return "" }
 
         guard let contractsData = groupData.contractData else { return "" }
@@ -171,7 +176,7 @@ public class PSAcceptanceViewController: UIViewController {
                 index += 1
                 if let contractIds = contractIds {
                     if contractIds.contains(contractIdKey) {
-                        let contractTitle = contractData.title ?? ""
+                        let contractTitle = contractData.title
                         changeSummaryString.append(contractTitle)
                         if index != contractsData.count && contractsData.count == 2 { changeSummaryString.append(" and ") }
                         if index == contractsData.count { changeSummaryString.append(".") }
@@ -181,7 +186,6 @@ public class PSAcceptanceViewController: UIViewController {
         }
 
         return changeSummaryString
-
     }
 
     private func configureSubmitButtonState(_ state: Bool = false) {
@@ -191,25 +195,21 @@ public class PSAcceptanceViewController: UIViewController {
 
     @objc private func submitPressed(sender: UIButton) {
         if checkboxSelected {
-            // TODO: Make this easier
             let signer = PSSigner(signerId: self.signerId)
-            psClickWrap.sendAgreed(signer: signer) { (response, error) in
+            psClickWrap.sendAgreed(signer: signer) { (error) in
                 if error == nil {
                     DispatchQueue.main.async {
                         self.delegate?.receivedAcceptance?()
                         self.dismiss(animated: true, completion: nil)
                     }
                 } else {
-                    if self.ps.debugMode {
-                        debugPrint(error as Any)
-                    }
+                    self.delegate?.errorSendingAcceptance?(error: error)
                 }
             }
         }
     }
 
     private func setupConstraints() {
-        let clickwrapHeight = self.view.bounds.height / 3
         NSLayoutConstraint.activate([
             // Set up Contracts View
             contractsView.topAnchor.constraint(equalTo: self.view.safeAreaLayoutGuide.topAnchor, constant: 16),
@@ -247,9 +247,12 @@ public class PSAcceptanceViewController: UIViewController {
 
 @available(iOS 11.0, *)
 extension PSAcceptanceViewController: PSClickWrapViewDelegate {
-    public func clickWrapRendered(withGroup groupData: PSGroupData) {
+    public func clickWrapRendered(withGroup groupData: PSGroup) {
         DispatchQueue.main.async {
             self.addChangeSummaryText(groupData: groupData)
         }
     }
+    public func errorLoadingGroup(error: Error?) {
+        self.delegate?.errorLoadingGroup?(error: error)
+    }
 }