Cleaned up access control

Author: Christian König

Source/Core/Request.swift

@@ -208,7 +208,7 @@ internal enum Endpoint {
         }
     }
 
-    var needsBasicAuthHeader: Bool {
+    internal var needsBasicAuthHeader: Bool {
         switch self {
         case .loginUser, .refreshToken, .revokeToken, .createNewFigoUser:
             return true
@@ -217,7 +217,7 @@ internal enum Endpoint {
         }
     }
 
-    var URLRequest: NSMutableURLRequest {
+    internal var URLRequest: NSMutableURLRequest {
         let URL = Foundation.URL(string: Endpoint.baseURLString)!
         let request = NSMutableURLRequest(url: URL.appendingPathComponent(path))
         request.httpMethod = self.method.rawValue

Source/FigoClient.swift

@@ -32,19 +32,19 @@ internal let POLLING_COUNTDOWN_INITIAL_VALUE = 100 // 100 x 400 ms = 40 s
  - Important: Completion handlers are NOT executed on the main thread
 
  */
-open class FigoClient {
+public class FigoClient {
 
-    let sessionDelegate = FigoURLSessionDelegate()
-    let session: URLSession
+    private let sessionDelegate = FigoURLSessionDelegate()
+    private let session: URLSession
 
     // Used for Basic HTTP authentication, derived from CliendID and ClientSecret
-    var basicAuthCredentials: String?
+    internal var basicAuthCredentials: String?
 
     /// OAuth2 access token
-    var accessToken: String?
+    internal var accessToken: String?
 
     /// OAuth2 refresh token
-    var refreshToken: String?
+    internal var refreshToken: String?
 
 
     public convenience init() {
@@ -70,7 +70,7 @@ open class FigoClient {
         }
     }
 
-    func request(_ endpoint: Endpoint, completion: @escaping (FigoResult<Data>) -> Void) {
+    internal func request(_ endpoint: Endpoint, completion: @escaping (FigoResult<Data>) -> Void) {
         let mutableURLRequest = endpoint.URLRequest
 
         if endpoint.needsBasicAuthHeader {
@@ -132,7 +132,7 @@ open class FigoClient {
     /**
      Check's the server's certificates to make sure that you are really talking to the figo server
      */
-    open class func dispositionForChallenge(_ challenge: URLAuthenticationChallenge) -> URLSession.AuthChallengeDisposition {
+    internal class func dispositionForChallenge(_ challenge: URLAuthenticationChallenge) -> URLSession.AuthChallengeDisposition {
 
         var disposition: URLSession.AuthChallengeDisposition = .performDefaultHandling
 
@@ -159,7 +159,7 @@ open class FigoClient {
 }
 
 
-internal class FigoURLSessionDelegate: NSObject, URLSessionDelegate {
+private class FigoURLSessionDelegate: NSObject, URLSessionDelegate {
 
     func urlSession(_ session: URLSession, didReceive challenge: URLAuthenticationChallenge, completionHandler: @escaping (URLSession.AuthChallengeDisposition, URLCredential?) -> Void) {
         completionHandler(FigoClient.dispositionForChallenge(challenge), nil)

Source/FigoDate.swift

@@ -9,7 +9,7 @@
 import Foundation
 
 
-/// Provides a NSDate representation for the server's timestamps
+/// Provides a Foundation.Date representation for the server's timestamps
 public struct FigoDate: UnboxableByTransform, CustomStringConvertible {
 
     public typealias UnboxRawValue = String
@@ -19,14 +19,14 @@ public struct FigoDate: UnboxableByTransform, CustomStringConvertible {
     public var formattedShort: String
     public var formattedLong: String
 
-    init() {
+    internal init() {
         self.date = Foundation.Date.distantPast
         self.timestamp = ""
         self.formattedShort = "Invalid date"
         self.formattedLong = "Invalid date"
     }
 
-    init? (timestamp: String) {
+    public init? (timestamp: String) {
         if let date = FigoDate.posixFormatter.date(from: timestamp) {
             self.date = date
             self.timestamp = timestamp

Source/FigoError.swift

@@ -9,21 +9,36 @@
 import Foundation
 
 
+/**
+ If an error occurs, the API returns an error object with a couple of fields providing further details.
+ */
 public struct FigoError: Error, CustomStringConvertible, Unboxable {
 
+    /// Error code (see http://docs.figo.io/#error-handling)
     public let code: Int
+    
+    // String identifying the source of the error
     public let group: String?
+    
+    /// Error message
     public let message: String?
+    
+    /// Error name
     public let name: String?
-    public let originalDescription: String?
+    
+    /// Error description (Renamed to allow a non-optinal implementation of CustomStringConvertible)
+    public let narrative: String?
+    
+    /// Any additional data
     public let data: [String:Any]?
 
+    
     public init(unboxer: Unboxer) throws {
         code                = (try? unboxer.unbox(key: "code")) ?? 0
         group               = unboxer.unbox(key: "group")
         message             = unboxer.unbox(key: "message")
         name                = unboxer.unbox(key: "name")
-        originalDescription = unboxer.unbox(key: "description")
+        narrative           = unboxer.unbox(key: "description")
         data                = unboxer.unbox(key: "data")
     }
 
@@ -32,13 +47,14 @@ public struct FigoError: Error, CustomStringConvertible, Unboxable {
         group = nil
         message = nil
         name = nil
-        originalDescription = error.description
+        narrative = error.description
         data = nil
     }
 
+    /// Narrative, message, name or code (depending on what values are available)
     public var description: String {
         get {
-            if let description = originalDescription {
+            if let description = narrative {
                 return description
             }
             if let description = message {
@@ -50,11 +66,14 @@ public struct FigoError: Error, CustomStringConvertible, Unboxable {
             return "\(code)"
         }
     }
-
+    
 }
 
 
-public enum InternalError: Error, CustomStringConvertible {
+/**
+ Internal error type which is transformed into an FigoError
+ */
+internal enum InternalError: Error, CustomStringConvertible {
 
     case noActiveSession
     case emptyResponse
@@ -65,7 +84,7 @@ public enum InternalError: Error, CustomStringConvertible {
     case taskProcessingTimeout
     case unboxingError(String)
 
-    public var code: Int {
+    var code: Int {
         get {
             switch self {
             case .noActiveSession:
@@ -88,7 +107,7 @@ public enum InternalError: Error, CustomStringConvertible {
         }
     }
 
-    public var description: String {
+    var description: String {
         get {
             switch self {
             case .noActiveSession:

Source/FigoResult.swift

@@ -7,6 +7,11 @@
 //
 
 
+/**
+ Result type used for all API calls
+ 
+ Contains a generic value on success and a FigoError object on failure.
+ */
 public enum FigoResult<Value>: CustomStringConvertible, CustomDebugStringConvertible {
 
     case success(Value)

Source/Types/Account.swift

@@ -132,7 +132,7 @@ public struct Account: Unboxable {
         type                = try unboxer.unbox(key: "type")
 
         // Special treatment for supported payments because the payment type values are stored in keys instead of values
-        supportedPayments      = try (unboxer.unbox(key: "supported_payments") as [String: AnyObject]).keys.map() { paymentType in
+        supportedPayments   = try (unboxer.unbox(key: "supported_payments") as [String: AnyObject]).keys.map() { paymentType in
             return (PaymentType(rawValue: paymentType) ?? PaymentType.Unknown, try unboxer.unbox(keyPath: "supported_payments.\(paymentType)"))
         }
     }