Feature/authentication integration (#6)

* Feature/readme (#5)

* added logo and fixed badges

* Added Feature List

* Update macOS.yml

* Update arm.yml

* Update arm.yml

* added authentication parsing

* setting up server

* cleaning up code

* refactoring authentication

* refactoring authentication

* refactoring authentication

* refactoring authentication

* refactored HTTPServer

* removed MKResult

* fixing code factor trailing spaces

* fixing white space issues

Author: leogdion

.github/workflows/arm.yml

@@ -1,6 +1,9 @@
 name: arm
 
-on: [push]
+on:
+  push:
+    branches:
+      - main
 
 jobs:
   build:

.github/workflows/macOS.yml

@@ -4,6 +4,8 @@ on:
   push:
     branches:
       - '*'
+      - 'feature/*'
+      - 'release/*'
 
 jobs:
   build:

Documentation/Reference/classes/MKURLBuilder.md

@@ -19,17 +19,17 @@ public let tokenEncoder: MKTokenEncoder?
 public let connection: MKDatabaseConnection
 ```
 
-### `webAuthenticationToken`
+### `tokenManager`
 
 ```swift
-public var webAuthenticationToken: String?
+public let tokenManager: MKTokenManager?
 ```
 
 ## Methods
-### `init(tokenEncoder:connection:webAuthenticationToken:)`
+### `init(tokenEncoder:connection:tokenManager:)`
 
 ```swift
-public init(tokenEncoder: MKTokenEncoder?, connection: MKDatabaseConnection, webAuthenticationToken: String? = nil)
+public init(tokenEncoder: MKTokenEncoder?, connection: MKDatabaseConnection, tokenManager: MKTokenManager? = nil)
 ```
 
 ### `url(withPathComponents:)`

Documentation/Reference/enums/MKError.md

@@ -7,6 +7,12 @@ public enum MKError: Error
 ```
 
 ## Cases
+### `authenticationRequired(_:)`
+
+```swift
+case authenticationRequired(MKAuthenticationRedirect)
+```
+
 ### `noDataFromStatus(_:)`
 
 ```swift

Documentation/Reference/extensions/MKAuthenticationResponse.md

@@ -0,0 +1,13 @@
+**EXTENSION**
+
+# `MKAuthenticationResponse`
+```swift
+extension MKAuthenticationResponse: MKAuthenticationRedirect
+```
+
+## Properties
+### `url`
+
+```swift
+public var url: URL
+```

Documentation/Reference/protocols/MKAuthenticationRedirect.md

@@ -0,0 +1,14 @@
+**PROTOCOL**
+
+# `MKAuthenticationRedirect`
+
+```swift
+public protocol MKAuthenticationRedirect
+```
+
+## Properties
+### `url`
+
+```swift
+var url: URL
+```

Documentation/Reference/protocols/MKTokenManager.md

@@ -0,0 +1,21 @@
+**PROTOCOL**
+
+# `MKTokenManager`
+
+```swift
+public protocol MKTokenManager: AnyObject
+```
+
+## Properties
+### `webAuthenticationToken`
+
+```swift
+var webAuthenticationToken: String?
+```
+
+## Methods
+### `request(_:_:)`
+
+```swift
+func request(_ request: MKAuthenticationResponse?, _ callback: @escaping (Result<String, Error>) -> Void)
+```

Documentation/Reference/structs/AppleUserRequest.md

@@ -1,9 +1,9 @@
 **STRUCT**
 
-# `MKErrorResponse`
+# `MKAuthenticationResponse`
 
 ```swift
-public struct MKErrorResponse: Codable
+public struct MKAuthenticationResponse: MKDecodable
 ```
 
 ## Properties

…ion/Reference/structs/MKErrorResponse.md …ence/structs/MKAuthenticationResponse.mdDocumentation/Reference/structs/MKErrorResponse.md renamed to Documentation/Reference/structs/MKAuthenticationResponse.md Documentation/Reference/structs/MKErrorResponse.md renamed to Documentation/Reference/structs/MKAuthenticationResponse.md

@@ -7,17 +7,24 @@ public struct MKDatabase<HttpClient: MKHttpClient>
 ```
 
 ## Methods
-### `init(connection:factory:client:authenticationToken:)`
+### `setWebAuthenticationToken(_:)`
 
 ```swift
-public init(connection: MKDatabaseConnection, factory: MKURLBuilderFactory? = nil, client: HttpClient, authenticationToken: String? = nil)
+public nonmutating func setWebAuthenticationToken(_ newValue: String)
 ```
 
-### `perform(request:_:)`
+### `init(connection:factory:client:tokenManager:)`
+
+```swift
+public init(connection: MKDatabaseConnection, factory: MKURLBuilderFactory? = nil, client: HttpClient, tokenManager: MKTokenManager? = nil)
+```
+
+### `perform(request:returnFailedAuthentication:_:)`
 
 ```swift
 public func perform<RequestType: MKRequest, ResponseType>(
   request: RequestType,
+  returnFailedAuthentication: Bool = false,
   _ callback: @escaping ((Result<ResponseType, Error>) -> Void)
 ) where RequestType.Response == ResponseType
 ```